@wix/auto_sdk_quick-pages_contents 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2628 -0
- package/build/cjs/index.js +1388 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +1343 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2400 -0
- package/build/cjs/meta.js +843 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/es/index.d.mts +2628 -0
- package/build/es/index.mjs +1314 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/index.typings.d.mts +1 -0
- package/build/es/index.typings.mjs +1269 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2400 -0
- package/build/es/meta.mjs +812 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/internal/cjs/index.d.ts +78 -0
- package/build/internal/cjs/index.js +1388 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +2698 -0
- package/build/internal/cjs/index.typings.js +1343 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2401 -0
- package/build/internal/cjs/meta.js +843 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/es/index.d.mts +78 -0
- package/build/internal/es/index.mjs +1314 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/index.typings.d.mts +2698 -0
- package/build/internal/es/index.typings.mjs +1269 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2401 -0
- package/build/internal/es/meta.mjs +812 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +54 -0
|
@@ -0,0 +1,2628 @@
|
|
|
1
|
+
/** A QuickPage Content. */
|
|
2
|
+
interface Content {
|
|
3
|
+
/**
|
|
4
|
+
* QuickPage Content ID.
|
|
5
|
+
* @format GUID
|
|
6
|
+
* @readonly
|
|
7
|
+
*/
|
|
8
|
+
_id?: string | null;
|
|
9
|
+
/**
|
|
10
|
+
* Content number, which increments by 1 each time the QuickPage Content is updated.
|
|
11
|
+
* To prevent conflicting changes,
|
|
12
|
+
* the current content must be passed when updating the QuickPage Content.
|
|
13
|
+
*
|
|
14
|
+
* Ignored when creating a QuickPage Content.
|
|
15
|
+
* @readonly
|
|
16
|
+
*/
|
|
17
|
+
revision?: string | null;
|
|
18
|
+
/**
|
|
19
|
+
* QuickPage page ID.
|
|
20
|
+
* @format GUID
|
|
21
|
+
* @immutable
|
|
22
|
+
*/
|
|
23
|
+
pageId?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* Date and time the QuickPage Content was created.
|
|
26
|
+
* @readonly
|
|
27
|
+
*/
|
|
28
|
+
_createdDate?: Date | null;
|
|
29
|
+
/**
|
|
30
|
+
* Date and time the QuickPage Content was last updated.
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
33
|
+
_updatedDate?: Date | null;
|
|
34
|
+
/**
|
|
35
|
+
* Previous QuickPage Content ID.
|
|
36
|
+
* @format GUID
|
|
37
|
+
* @immutable
|
|
38
|
+
*/
|
|
39
|
+
previousContentId?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* Status which defines whether the content can be updated
|
|
42
|
+
* @readonly
|
|
43
|
+
*/
|
|
44
|
+
locked?: boolean;
|
|
45
|
+
/** Design settings for the QuickPage Content */
|
|
46
|
+
design?: Design;
|
|
47
|
+
/** The rich content of the QuickPage Content. */
|
|
48
|
+
richContent?: RichContent;
|
|
49
|
+
/**
|
|
50
|
+
* Date and time the QuickPage Content was last edited by user action.
|
|
51
|
+
* @readonly
|
|
52
|
+
*/
|
|
53
|
+
lastEditedDate?: Date | null;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Design represents the complete visual styling configuration for a quick page.
|
|
57
|
+
* It encapsulates all design elements including colors, fonts, and component styling.
|
|
58
|
+
*/
|
|
59
|
+
interface Design {
|
|
60
|
+
/**
|
|
61
|
+
* Palette of colors used in the design
|
|
62
|
+
* Limited to 6 colors in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
63
|
+
* @format COLOR_HEX
|
|
64
|
+
* @maxSize 6
|
|
65
|
+
*/
|
|
66
|
+
colorPalette?: string[];
|
|
67
|
+
/**
|
|
68
|
+
* Custom colors defined by the user
|
|
69
|
+
* Limited to 20 colors in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
70
|
+
* @format COLOR_HEX
|
|
71
|
+
* @maxSize 20
|
|
72
|
+
*/
|
|
73
|
+
customColors?: string[];
|
|
74
|
+
/**
|
|
75
|
+
* Font groups used in the page design
|
|
76
|
+
* Each group represents a different language or script system
|
|
77
|
+
* There are 7 in total
|
|
78
|
+
* @maxSize 7
|
|
79
|
+
*/
|
|
80
|
+
fontGroup?: GroupWithLiterals[];
|
|
81
|
+
/**
|
|
82
|
+
* Background configuration for the page
|
|
83
|
+
* Can be either a solid color or an image with various styling options
|
|
84
|
+
*/
|
|
85
|
+
background?: Background;
|
|
86
|
+
/**
|
|
87
|
+
* Typography settings for various text elements
|
|
88
|
+
* Includes styling for headings and paragraphs
|
|
89
|
+
*/
|
|
90
|
+
typography?: Typography;
|
|
91
|
+
/**
|
|
92
|
+
* Button styling configuration
|
|
93
|
+
* Defines how buttons appear, including their hover states
|
|
94
|
+
*/
|
|
95
|
+
button?: Button;
|
|
96
|
+
/**
|
|
97
|
+
* Image styling configuration
|
|
98
|
+
* Defines how images appear, including borders
|
|
99
|
+
*/
|
|
100
|
+
image?: Image;
|
|
101
|
+
/**
|
|
102
|
+
* Custom gradients defined by the user
|
|
103
|
+
* Limited to 10 gradients
|
|
104
|
+
* @maxSize 10
|
|
105
|
+
*/
|
|
106
|
+
customGradients?: Gradient[];
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Group enum represents different font groups organized by language/script support.
|
|
110
|
+
* This allows for appropriate font selection based on content language.
|
|
111
|
+
*/
|
|
112
|
+
declare enum Group {
|
|
113
|
+
/** Default value when font group is not specified */
|
|
114
|
+
UNKNOWN_FONT_GROUP = "UNKNOWN_FONT_GROUP",
|
|
115
|
+
/** Standard Latin character set (English, Western European languages) */
|
|
116
|
+
LATIN = "LATIN",
|
|
117
|
+
/** Extended Latin character set (Eastern and Central European languages) */
|
|
118
|
+
LATIN_EXT = "LATIN_EXT",
|
|
119
|
+
/** Hebrew character set */
|
|
120
|
+
HEBREW = "HEBREW",
|
|
121
|
+
/** Cyrillic character set (Russian, Bulgarian, etc.) */
|
|
122
|
+
CYRILLIC = "CYRILLIC",
|
|
123
|
+
/** Arabic character set */
|
|
124
|
+
ARABIC = "ARABIC",
|
|
125
|
+
/** Japanese character set */
|
|
126
|
+
JAPANESE = "JAPANESE",
|
|
127
|
+
/** Korean character set */
|
|
128
|
+
KOREAN = "KOREAN"
|
|
129
|
+
}
|
|
130
|
+
/** @enumType */
|
|
131
|
+
type GroupWithLiterals = Group | 'UNKNOWN_FONT_GROUP' | 'LATIN' | 'LATIN_EXT' | 'HEBREW' | 'CYRILLIC' | 'ARABIC' | 'JAPANESE' | 'KOREAN';
|
|
132
|
+
/**
|
|
133
|
+
* Background defines the styling for a page's background.
|
|
134
|
+
* Supports either color or image backgrounds with configuration options for each.
|
|
135
|
+
*/
|
|
136
|
+
interface Background extends BackgroundBackgroundTypeOptionsOneOf {
|
|
137
|
+
/** Settings for color backgrounds, available when type = COLOR */
|
|
138
|
+
colorOptions?: ColorOptions;
|
|
139
|
+
/** Settings for image backgrounds, available when type = IMAGE */
|
|
140
|
+
imageOptions?: ImageOptions;
|
|
141
|
+
/** Background type determines whether this is a color or image background */
|
|
142
|
+
type?: BackgroundTypeWithLiterals;
|
|
143
|
+
}
|
|
144
|
+
/** @oneof */
|
|
145
|
+
interface BackgroundBackgroundTypeOptionsOneOf {
|
|
146
|
+
/** Settings for color backgrounds, available when type = COLOR */
|
|
147
|
+
colorOptions?: ColorOptions;
|
|
148
|
+
/** Settings for image backgrounds, available when type = IMAGE */
|
|
149
|
+
imageOptions?: ImageOptions;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* ColorSwatch defines a color or gradient that can be used for styling elements.
|
|
153
|
+
* Supports either solid colors or gradients with configuration options for each.
|
|
154
|
+
*/
|
|
155
|
+
interface ColorSwatch extends ColorSwatchColorTypeOptionsOneOf {
|
|
156
|
+
/**
|
|
157
|
+
* Solid color value, available when type = COLOR
|
|
158
|
+
* @format COLOR_HEX
|
|
159
|
+
*/
|
|
160
|
+
colorOptions?: string | null;
|
|
161
|
+
/** Gradient configuration, available when type = GRADIENT */
|
|
162
|
+
gradientOptions?: Gradient;
|
|
163
|
+
/** Type determines whether this is a solid color or gradient */
|
|
164
|
+
type?: ColorSwatchTypeWithLiterals;
|
|
165
|
+
}
|
|
166
|
+
/** @oneof */
|
|
167
|
+
interface ColorSwatchColorTypeOptionsOneOf {
|
|
168
|
+
/**
|
|
169
|
+
* Solid color value, available when type = COLOR
|
|
170
|
+
* @format COLOR_HEX
|
|
171
|
+
*/
|
|
172
|
+
colorOptions?: string | null;
|
|
173
|
+
/** Gradient configuration, available when type = GRADIENT */
|
|
174
|
+
gradientOptions?: Gradient;
|
|
175
|
+
}
|
|
176
|
+
/** ColorSwatchType determines what kind of color styling is being used. */
|
|
177
|
+
declare enum ColorSwatchType {
|
|
178
|
+
/** Default value when color swatch type is not specified */
|
|
179
|
+
UNKNOWN_COLOR_SWATCH_TYPE = "UNKNOWN_COLOR_SWATCH_TYPE",
|
|
180
|
+
/** Color swatch is a solid color */
|
|
181
|
+
COLOR = "COLOR",
|
|
182
|
+
/** Color swatch is a gradient */
|
|
183
|
+
GRADIENT = "GRADIENT"
|
|
184
|
+
}
|
|
185
|
+
/** @enumType */
|
|
186
|
+
type ColorSwatchTypeWithLiterals = ColorSwatchType | 'UNKNOWN_COLOR_SWATCH_TYPE' | 'COLOR' | 'GRADIENT';
|
|
187
|
+
/**
|
|
188
|
+
* Gradient defines a color gradient configuration.
|
|
189
|
+
* Supports both linear and radial gradients with multiple color stops.
|
|
190
|
+
*/
|
|
191
|
+
interface Gradient extends GradientGradientTypeOptionsOneOf {
|
|
192
|
+
/**
|
|
193
|
+
* Angle in degrees for linear gradients (0-360)
|
|
194
|
+
* @max 360
|
|
195
|
+
*/
|
|
196
|
+
linearOptions?: number | null;
|
|
197
|
+
/** Center point for radial gradients */
|
|
198
|
+
radialOptions?: Center;
|
|
199
|
+
/** Type determines whether this is a linear or radial gradient */
|
|
200
|
+
type?: GradientTypeWithLiterals;
|
|
201
|
+
/**
|
|
202
|
+
* Color stops that define the gradient colors and positions
|
|
203
|
+
* @maxSize 10
|
|
204
|
+
*/
|
|
205
|
+
stops?: GradientStop[];
|
|
206
|
+
/**
|
|
207
|
+
* Global opacity of the gradients (0.0 to 1.0)
|
|
208
|
+
* @max 1
|
|
209
|
+
*/
|
|
210
|
+
opacity?: number | null;
|
|
211
|
+
}
|
|
212
|
+
/** @oneof */
|
|
213
|
+
interface GradientGradientTypeOptionsOneOf {
|
|
214
|
+
/**
|
|
215
|
+
* Angle in degrees for linear gradients (0-360)
|
|
216
|
+
* @max 360
|
|
217
|
+
*/
|
|
218
|
+
linearOptions?: number | null;
|
|
219
|
+
/** Center point for radial gradients */
|
|
220
|
+
radialOptions?: Center;
|
|
221
|
+
}
|
|
222
|
+
/** GradientType determines what kind of gradient is being used. */
|
|
223
|
+
declare enum GradientType {
|
|
224
|
+
/** Default value when gradient type is not specified */
|
|
225
|
+
UNKNOWN_GRADIENT_TYPE = "UNKNOWN_GRADIENT_TYPE",
|
|
226
|
+
/** Linear gradient that transitions colors along a straight line */
|
|
227
|
+
LINEAR = "LINEAR",
|
|
228
|
+
/** Radial gradient that transitions colors outward from a center point */
|
|
229
|
+
RADIAL = "RADIAL"
|
|
230
|
+
}
|
|
231
|
+
/** @enumType */
|
|
232
|
+
type GradientTypeWithLiterals = GradientType | 'UNKNOWN_GRADIENT_TYPE' | 'LINEAR' | 'RADIAL';
|
|
233
|
+
/**
|
|
234
|
+
* GradientStop defines a color position within a gradient.
|
|
235
|
+
* Each stop has a color, opacity, and position value.
|
|
236
|
+
*/
|
|
237
|
+
interface GradientStop {
|
|
238
|
+
/**
|
|
239
|
+
* Color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
240
|
+
* @format COLOR_HEX
|
|
241
|
+
*/
|
|
242
|
+
color?: string | null;
|
|
243
|
+
/**
|
|
244
|
+
* Opacity of the color at this stop (0.0 to 1.0)
|
|
245
|
+
* @max 1
|
|
246
|
+
*/
|
|
247
|
+
opacity?: number | null;
|
|
248
|
+
/**
|
|
249
|
+
* Position of this stop within the gradient (0.0 to 1.0)
|
|
250
|
+
* 0.0 represents the start of the gradient, 1.0 represents the end
|
|
251
|
+
* @max 1
|
|
252
|
+
*/
|
|
253
|
+
position?: number | null;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Center defines the center point for a radial gradient.
|
|
257
|
+
* Uses normalized coordinates (0.0 to 1.0) where (0,0) is top-left
|
|
258
|
+
* and (1,1) is bottom-right of the container.
|
|
259
|
+
*/
|
|
260
|
+
interface Center {
|
|
261
|
+
/**
|
|
262
|
+
* X-coordinate of the center point (0.0 to 1.0)
|
|
263
|
+
* @max 1
|
|
264
|
+
*/
|
|
265
|
+
x?: number | null;
|
|
266
|
+
/**
|
|
267
|
+
* Y-coordinate of the center point (0.0 to 1.0)
|
|
268
|
+
* @max 1
|
|
269
|
+
*/
|
|
270
|
+
y?: number | null;
|
|
271
|
+
}
|
|
272
|
+
/** ImageScaling defines how the background image should be sized. */
|
|
273
|
+
declare enum ImageScaling {
|
|
274
|
+
/** Default value when scaling is not specified */
|
|
275
|
+
UNKNOWN_IMAGE_SCALING = "UNKNOWN_IMAGE_SCALING",
|
|
276
|
+
/** Image will cover the entire container, potentially cropping parts of the image */
|
|
277
|
+
COVER = "COVER",
|
|
278
|
+
/** Image will be contained within the container, maintaining its aspect ratio */
|
|
279
|
+
CONTAIN = "CONTAIN",
|
|
280
|
+
/** Image will use its original size without scaling */
|
|
281
|
+
AUTO = "AUTO"
|
|
282
|
+
}
|
|
283
|
+
/** @enumType */
|
|
284
|
+
type ImageScalingWithLiterals = ImageScaling | 'UNKNOWN_IMAGE_SCALING' | 'COVER' | 'CONTAIN' | 'AUTO';
|
|
285
|
+
/** ImagePosition defines how the image is positioned within its container. */
|
|
286
|
+
declare enum ImagePosition {
|
|
287
|
+
/** Default value when position is not specified */
|
|
288
|
+
UNKNOWN_IMAGE_POSITION = "UNKNOWN_IMAGE_POSITION",
|
|
289
|
+
/** Position image at the top center of the container */
|
|
290
|
+
TOP = "TOP",
|
|
291
|
+
/** Position image at the top left corner of the container */
|
|
292
|
+
TOP_LEFT = "TOP_LEFT",
|
|
293
|
+
/** Position image at the top right corner of the container */
|
|
294
|
+
TOP_RIGHT = "TOP_RIGHT",
|
|
295
|
+
/** Position image at the center of the container */
|
|
296
|
+
CENTER = "CENTER",
|
|
297
|
+
/** Position image at the middle left of the container */
|
|
298
|
+
CENTER_LEFT = "CENTER_LEFT",
|
|
299
|
+
/** Position image at the middle right of the container */
|
|
300
|
+
CENTER_RIGHT = "CENTER_RIGHT",
|
|
301
|
+
/** Position image at the bottom center of the container */
|
|
302
|
+
BOTTOM = "BOTTOM",
|
|
303
|
+
/** Position image at the bottom left corner of the container */
|
|
304
|
+
BOTTOM_LEFT = "BOTTOM_LEFT",
|
|
305
|
+
/** Position image at the bottom right corner of the container */
|
|
306
|
+
BOTTOM_RIGHT = "BOTTOM_RIGHT"
|
|
307
|
+
}
|
|
308
|
+
/** @enumType */
|
|
309
|
+
type ImagePositionWithLiterals = ImagePosition | 'UNKNOWN_IMAGE_POSITION' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
310
|
+
/** BackgroundType determines what kind of background is being used. */
|
|
311
|
+
declare enum BackgroundType {
|
|
312
|
+
/** Default value when background type is not specified */
|
|
313
|
+
UNKNOWN_BACKGROUND_TYPE = "UNKNOWN_BACKGROUND_TYPE",
|
|
314
|
+
/** Background is a solid color */
|
|
315
|
+
COLOR = "COLOR",
|
|
316
|
+
/** Background is an image */
|
|
317
|
+
IMAGE = "IMAGE"
|
|
318
|
+
}
|
|
319
|
+
/** @enumType */
|
|
320
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'UNKNOWN_BACKGROUND_TYPE' | 'COLOR' | 'IMAGE';
|
|
321
|
+
/**
|
|
322
|
+
* Options for configuring a solid color background.
|
|
323
|
+
* Includes color and opacity settings.
|
|
324
|
+
*/
|
|
325
|
+
interface ColorOptions {
|
|
326
|
+
/** Background color swatch, supporting both solid colors and gradients */
|
|
327
|
+
color?: ColorSwatch;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* Options for configuring an image background.
|
|
331
|
+
* Includes image source, positioning, scaling, and overlay settings.
|
|
332
|
+
*/
|
|
333
|
+
interface ImageOptions {
|
|
334
|
+
/**
|
|
335
|
+
* Background image URL pointing to the source image
|
|
336
|
+
* @format WEB_URL
|
|
337
|
+
*/
|
|
338
|
+
url?: string | null;
|
|
339
|
+
/**
|
|
340
|
+
* Image opacity, ranging from 0 (fully transparent) to 1 (fully opaque)
|
|
341
|
+
* @max 1
|
|
342
|
+
*/
|
|
343
|
+
opacity?: number | null;
|
|
344
|
+
/** Image background color (overlay color) swatch, supporting both solid colors and gradients */
|
|
345
|
+
color?: ColorSwatch;
|
|
346
|
+
/** Image scaling method that determines how the image fits in the container */
|
|
347
|
+
scaling?: ImageScalingWithLiterals;
|
|
348
|
+
/** Image position within the container when it doesn't fill the entire space */
|
|
349
|
+
position?: ImagePositionWithLiterals;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Typography defines styling for all text elements in a quick-page.
|
|
353
|
+
* Includes configurations for different heading levels and paragraph text.
|
|
354
|
+
*/
|
|
355
|
+
interface Typography {
|
|
356
|
+
/** Styling for primary/largest heading (h1) */
|
|
357
|
+
heading1?: TextStyle;
|
|
358
|
+
/** Styling for secondary heading (h2) */
|
|
359
|
+
heading2?: TextStyle;
|
|
360
|
+
/** Styling for tertiary heading (h3) */
|
|
361
|
+
heading3?: TextStyle;
|
|
362
|
+
/** Styling for fourth-level heading (h4) */
|
|
363
|
+
heading4?: TextStyle;
|
|
364
|
+
/** Styling for fifth-level heading (h5) */
|
|
365
|
+
heading5?: TextStyle;
|
|
366
|
+
/** Styling for sixth-level heading (h6) */
|
|
367
|
+
heading6?: TextStyle;
|
|
368
|
+
/** Styling for regular paragraph text */
|
|
369
|
+
paragraph?: TextStyle;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* TextStyle defines the visual properties of text elements.
|
|
373
|
+
* Includes font family, weight, color, size, and spacing options.
|
|
374
|
+
*/
|
|
375
|
+
interface TextStyle {
|
|
376
|
+
/**
|
|
377
|
+
* Font family name, limited to 50 characters
|
|
378
|
+
* Determines the typeface used for the text
|
|
379
|
+
* @maxLength 50
|
|
380
|
+
*/
|
|
381
|
+
fontFamily?: string | null;
|
|
382
|
+
/**
|
|
383
|
+
* Font weight value (0-1000)
|
|
384
|
+
* Standard values: 400 (normal), 700 (bold)
|
|
385
|
+
* @max 1000
|
|
386
|
+
*/
|
|
387
|
+
weight?: number | null;
|
|
388
|
+
/**
|
|
389
|
+
* Text color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
390
|
+
* @format COLOR_HEX
|
|
391
|
+
*/
|
|
392
|
+
color?: string | null;
|
|
393
|
+
/**
|
|
394
|
+
* Font size in pixels (0-400)
|
|
395
|
+
* @max 400
|
|
396
|
+
*/
|
|
397
|
+
size?: number | null;
|
|
398
|
+
/**
|
|
399
|
+
* Defines the spacing between each line of the text (0-10)
|
|
400
|
+
* 1.0 is standard single line spacing
|
|
401
|
+
* @max 10
|
|
402
|
+
*/
|
|
403
|
+
lineHeight?: number | null;
|
|
404
|
+
/**
|
|
405
|
+
* The text letter spacing in em units (0-10)
|
|
406
|
+
* Controls the space between each character
|
|
407
|
+
* @max 10
|
|
408
|
+
*/
|
|
409
|
+
letterSpacing?: number | null;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Button defines the styling configuration for buttons.
|
|
413
|
+
* Includes normal state styling and hover effects.
|
|
414
|
+
*/
|
|
415
|
+
interface Button {
|
|
416
|
+
/**
|
|
417
|
+
* Background color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
418
|
+
* @format COLOR_HEX
|
|
419
|
+
*/
|
|
420
|
+
backgroundColor?: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Text color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
423
|
+
* @format COLOR_HEX
|
|
424
|
+
*/
|
|
425
|
+
textColor?: string | null;
|
|
426
|
+
/** Button size preset (small, medium, large) */
|
|
427
|
+
size?: ButtonSizeWithLiterals;
|
|
428
|
+
/** Border configuration */
|
|
429
|
+
border?: Border;
|
|
430
|
+
/** Hover state styling when user's cursor is over the button */
|
|
431
|
+
hover?: Hover;
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* ButtonSize defines the preset size options for buttons.
|
|
435
|
+
* Affects padding, font size, and overall button dimensions.
|
|
436
|
+
*/
|
|
437
|
+
declare enum ButtonSize {
|
|
438
|
+
/** Default value when button size is not specified */
|
|
439
|
+
UNKNOWN_BUTTON_SIZE = "UNKNOWN_BUTTON_SIZE",
|
|
440
|
+
/** Small button size - minimal padding, smaller text */
|
|
441
|
+
SMALL = "SMALL",
|
|
442
|
+
/** Medium button size - standard padding and text size */
|
|
443
|
+
MEDIUM = "MEDIUM",
|
|
444
|
+
/** Large button size - generous padding, larger text */
|
|
445
|
+
LARGE = "LARGE"
|
|
446
|
+
}
|
|
447
|
+
/** @enumType */
|
|
448
|
+
type ButtonSizeWithLiterals = ButtonSize | 'UNKNOWN_BUTTON_SIZE' | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
449
|
+
/**
|
|
450
|
+
* Border defines the styling for button borders.
|
|
451
|
+
* Includes settings for radius, width, color, and opacity.
|
|
452
|
+
*/
|
|
453
|
+
interface Border {
|
|
454
|
+
/**
|
|
455
|
+
* Border radius in pixels (0-100)
|
|
456
|
+
* Controls how rounded the corners of the button will be
|
|
457
|
+
* @max 100
|
|
458
|
+
*/
|
|
459
|
+
radius?: number | null;
|
|
460
|
+
/**
|
|
461
|
+
* Border width in pixels (0-10)
|
|
462
|
+
* Controls the thickness of the border around the button
|
|
463
|
+
* @max 10
|
|
464
|
+
*/
|
|
465
|
+
width?: number | null;
|
|
466
|
+
/**
|
|
467
|
+
* Border color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
468
|
+
* @format COLOR_HEX
|
|
469
|
+
*/
|
|
470
|
+
color?: string | null;
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* Hover defines styling for the button's hover state.
|
|
474
|
+
* These styles are applied when the user's cursor is over the button.
|
|
475
|
+
*/
|
|
476
|
+
interface Hover {
|
|
477
|
+
/**
|
|
478
|
+
* Background color on hover in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
479
|
+
* @format COLOR_HEX
|
|
480
|
+
*/
|
|
481
|
+
backgroundColor?: string | null;
|
|
482
|
+
/**
|
|
483
|
+
* Text color on hover in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
484
|
+
* @format COLOR_HEX
|
|
485
|
+
*/
|
|
486
|
+
textColor?: string | null;
|
|
487
|
+
/**
|
|
488
|
+
* Border color on hover in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
489
|
+
* @format COLOR_HEX
|
|
490
|
+
*/
|
|
491
|
+
borderColor?: string | null;
|
|
492
|
+
}
|
|
493
|
+
/**
|
|
494
|
+
* Image message defines styling configurations for images used in quick-pages.
|
|
495
|
+
* Currently supports border styling with plans for additional image styling options.
|
|
496
|
+
*/
|
|
497
|
+
interface Image {
|
|
498
|
+
/** Border configuration for the image */
|
|
499
|
+
border?: ImageBorder;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* Border defines the styling for image borders.
|
|
503
|
+
* Includes settings for radius, width, color, and opacity.
|
|
504
|
+
*/
|
|
505
|
+
interface ImageBorder {
|
|
506
|
+
/**
|
|
507
|
+
* Border radius in pixels (0-100)
|
|
508
|
+
* Controls how rounded the corners of the image will be
|
|
509
|
+
* @max 100
|
|
510
|
+
*/
|
|
511
|
+
radius?: number | null;
|
|
512
|
+
/**
|
|
513
|
+
* Border width in pixels (0-10)
|
|
514
|
+
* Controls the thickness of the border around the image
|
|
515
|
+
* @max 10
|
|
516
|
+
*/
|
|
517
|
+
width?: number | null;
|
|
518
|
+
/**
|
|
519
|
+
* Border color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
520
|
+
* @format COLOR_HEX
|
|
521
|
+
*/
|
|
522
|
+
color?: string | null;
|
|
523
|
+
}
|
|
524
|
+
interface RichContent {
|
|
525
|
+
/** Node objects representing a rich content document. */
|
|
526
|
+
nodes?: Node[];
|
|
527
|
+
/** Object metadata. */
|
|
528
|
+
metadata?: Metadata;
|
|
529
|
+
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
530
|
+
documentStyle?: DocumentStyle;
|
|
531
|
+
}
|
|
532
|
+
interface Node extends NodeDataOneOf {
|
|
533
|
+
/** Data for a button node. */
|
|
534
|
+
buttonData?: ButtonData;
|
|
535
|
+
/** Data for a code block node. */
|
|
536
|
+
codeBlockData?: CodeBlockData;
|
|
537
|
+
/** Data for a divider node. */
|
|
538
|
+
dividerData?: DividerData;
|
|
539
|
+
/** Data for a file node. */
|
|
540
|
+
fileData?: FileData;
|
|
541
|
+
/** Data for a gallery node. */
|
|
542
|
+
galleryData?: GalleryData;
|
|
543
|
+
/** Data for a GIF node. */
|
|
544
|
+
gifData?: GIFData;
|
|
545
|
+
/** Data for a heading node. */
|
|
546
|
+
headingData?: HeadingData;
|
|
547
|
+
/** Data for an embedded HTML node. */
|
|
548
|
+
htmlData?: HTMLData;
|
|
549
|
+
/** Data for an image node. */
|
|
550
|
+
imageData?: ImageData;
|
|
551
|
+
/** Data for a link preview node. */
|
|
552
|
+
linkPreviewData?: LinkPreviewData;
|
|
553
|
+
/** @deprecated */
|
|
554
|
+
mapData?: MapData;
|
|
555
|
+
/** Data for a paragraph node. */
|
|
556
|
+
paragraphData?: ParagraphData;
|
|
557
|
+
/** Data for a poll node. */
|
|
558
|
+
pollData?: PollData;
|
|
559
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
560
|
+
textData?: TextData;
|
|
561
|
+
/** Data for an app embed node. */
|
|
562
|
+
appEmbedData?: AppEmbedData;
|
|
563
|
+
/** Data for a video node. */
|
|
564
|
+
videoData?: VideoData;
|
|
565
|
+
/** Data for an oEmbed node. */
|
|
566
|
+
embedData?: EmbedData;
|
|
567
|
+
/** Data for a collapsible list node. */
|
|
568
|
+
collapsibleListData?: CollapsibleListData;
|
|
569
|
+
/** Data for a table node. */
|
|
570
|
+
tableData?: TableData;
|
|
571
|
+
/** Data for a table cell node. */
|
|
572
|
+
tableCellData?: TableCellData;
|
|
573
|
+
/** Data for a custom external node. */
|
|
574
|
+
externalData?: Record<string, any> | null;
|
|
575
|
+
/** Data for an audio node. */
|
|
576
|
+
audioData?: AudioData;
|
|
577
|
+
/** Data for an ordered list node. */
|
|
578
|
+
orderedListData?: OrderedListData;
|
|
579
|
+
/** Data for a bulleted list node. */
|
|
580
|
+
bulletedListData?: BulletedListData;
|
|
581
|
+
/** Data for a block quote node. */
|
|
582
|
+
blockquoteData?: BlockquoteData;
|
|
583
|
+
/** Data for a caption node. */
|
|
584
|
+
captionData?: CaptionData;
|
|
585
|
+
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
586
|
+
layoutCellData?: LayoutCellData;
|
|
587
|
+
/** 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. */
|
|
588
|
+
type?: NodeTypeWithLiterals;
|
|
589
|
+
/** Node ID. */
|
|
590
|
+
id?: string;
|
|
591
|
+
/** A list of child nodes. */
|
|
592
|
+
nodes?: Node[];
|
|
593
|
+
/** Padding and background color styling for the node. */
|
|
594
|
+
style?: NodeStyle;
|
|
595
|
+
}
|
|
596
|
+
/** @oneof */
|
|
597
|
+
interface NodeDataOneOf {
|
|
598
|
+
/** Data for a button node. */
|
|
599
|
+
buttonData?: ButtonData;
|
|
600
|
+
/** Data for a code block node. */
|
|
601
|
+
codeBlockData?: CodeBlockData;
|
|
602
|
+
/** Data for a divider node. */
|
|
603
|
+
dividerData?: DividerData;
|
|
604
|
+
/** Data for a file node. */
|
|
605
|
+
fileData?: FileData;
|
|
606
|
+
/** Data for a gallery node. */
|
|
607
|
+
galleryData?: GalleryData;
|
|
608
|
+
/** Data for a GIF node. */
|
|
609
|
+
gifData?: GIFData;
|
|
610
|
+
/** Data for a heading node. */
|
|
611
|
+
headingData?: HeadingData;
|
|
612
|
+
/** Data for an embedded HTML node. */
|
|
613
|
+
htmlData?: HTMLData;
|
|
614
|
+
/** Data for an image node. */
|
|
615
|
+
imageData?: ImageData;
|
|
616
|
+
/** Data for a link preview node. */
|
|
617
|
+
linkPreviewData?: LinkPreviewData;
|
|
618
|
+
/** @deprecated */
|
|
619
|
+
mapData?: MapData;
|
|
620
|
+
/** Data for a paragraph node. */
|
|
621
|
+
paragraphData?: ParagraphData;
|
|
622
|
+
/** Data for a poll node. */
|
|
623
|
+
pollData?: PollData;
|
|
624
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
625
|
+
textData?: TextData;
|
|
626
|
+
/** Data for an app embed node. */
|
|
627
|
+
appEmbedData?: AppEmbedData;
|
|
628
|
+
/** Data for a video node. */
|
|
629
|
+
videoData?: VideoData;
|
|
630
|
+
/** Data for an oEmbed node. */
|
|
631
|
+
embedData?: EmbedData;
|
|
632
|
+
/** Data for a collapsible list node. */
|
|
633
|
+
collapsibleListData?: CollapsibleListData;
|
|
634
|
+
/** Data for a table node. */
|
|
635
|
+
tableData?: TableData;
|
|
636
|
+
/** Data for a table cell node. */
|
|
637
|
+
tableCellData?: TableCellData;
|
|
638
|
+
/** Data for a custom external node. */
|
|
639
|
+
externalData?: Record<string, any> | null;
|
|
640
|
+
/** Data for an audio node. */
|
|
641
|
+
audioData?: AudioData;
|
|
642
|
+
/** Data for an ordered list node. */
|
|
643
|
+
orderedListData?: OrderedListData;
|
|
644
|
+
/** Data for a bulleted list node. */
|
|
645
|
+
bulletedListData?: BulletedListData;
|
|
646
|
+
/** Data for a block quote node. */
|
|
647
|
+
blockquoteData?: BlockquoteData;
|
|
648
|
+
/** Data for a caption node. */
|
|
649
|
+
captionData?: CaptionData;
|
|
650
|
+
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
651
|
+
layoutCellData?: LayoutCellData;
|
|
652
|
+
}
|
|
653
|
+
declare enum NodeType {
|
|
654
|
+
PARAGRAPH = "PARAGRAPH",
|
|
655
|
+
TEXT = "TEXT",
|
|
656
|
+
HEADING = "HEADING",
|
|
657
|
+
BULLETED_LIST = "BULLETED_LIST",
|
|
658
|
+
ORDERED_LIST = "ORDERED_LIST",
|
|
659
|
+
LIST_ITEM = "LIST_ITEM",
|
|
660
|
+
BLOCKQUOTE = "BLOCKQUOTE",
|
|
661
|
+
CODE_BLOCK = "CODE_BLOCK",
|
|
662
|
+
VIDEO = "VIDEO",
|
|
663
|
+
DIVIDER = "DIVIDER",
|
|
664
|
+
FILE = "FILE",
|
|
665
|
+
GALLERY = "GALLERY",
|
|
666
|
+
GIF = "GIF",
|
|
667
|
+
HTML = "HTML",
|
|
668
|
+
IMAGE = "IMAGE",
|
|
669
|
+
LINK_PREVIEW = "LINK_PREVIEW",
|
|
670
|
+
/** @deprecated */
|
|
671
|
+
MAP = "MAP",
|
|
672
|
+
POLL = "POLL",
|
|
673
|
+
APP_EMBED = "APP_EMBED",
|
|
674
|
+
BUTTON = "BUTTON",
|
|
675
|
+
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
676
|
+
TABLE = "TABLE",
|
|
677
|
+
EMBED = "EMBED",
|
|
678
|
+
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
679
|
+
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
680
|
+
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
681
|
+
TABLE_CELL = "TABLE_CELL",
|
|
682
|
+
TABLE_ROW = "TABLE_ROW",
|
|
683
|
+
EXTERNAL = "EXTERNAL",
|
|
684
|
+
AUDIO = "AUDIO",
|
|
685
|
+
CAPTION = "CAPTION",
|
|
686
|
+
LAYOUT = "LAYOUT",
|
|
687
|
+
LAYOUT_CELL = "LAYOUT_CELL"
|
|
688
|
+
}
|
|
689
|
+
/** @enumType */
|
|
690
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
691
|
+
interface NodeStyle {
|
|
692
|
+
/** The top padding value in pixels. */
|
|
693
|
+
paddingTop?: string | null;
|
|
694
|
+
/** The bottom padding value in pixels. */
|
|
695
|
+
paddingBottom?: string | null;
|
|
696
|
+
/** The background color as a hexadecimal value. */
|
|
697
|
+
backgroundColor?: string | null;
|
|
698
|
+
}
|
|
699
|
+
interface ButtonData {
|
|
700
|
+
/** Styling for the button's container. */
|
|
701
|
+
containerData?: PluginContainerData;
|
|
702
|
+
/** The button type. */
|
|
703
|
+
type?: ButtonDataTypeWithLiterals;
|
|
704
|
+
/** Styling for the button. */
|
|
705
|
+
styles?: Styles;
|
|
706
|
+
/** The text to display on the button. */
|
|
707
|
+
text?: string | null;
|
|
708
|
+
/** Button link details. */
|
|
709
|
+
link?: Link;
|
|
710
|
+
}
|
|
711
|
+
interface StylesBorder {
|
|
712
|
+
/**
|
|
713
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
714
|
+
* @deprecated
|
|
715
|
+
*/
|
|
716
|
+
width?: number | null;
|
|
717
|
+
/**
|
|
718
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
719
|
+
* @deprecated
|
|
720
|
+
*/
|
|
721
|
+
radius?: number | null;
|
|
722
|
+
}
|
|
723
|
+
interface Colors {
|
|
724
|
+
/**
|
|
725
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
726
|
+
* @deprecated
|
|
727
|
+
*/
|
|
728
|
+
text?: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
731
|
+
* @deprecated
|
|
732
|
+
*/
|
|
733
|
+
border?: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
736
|
+
* @deprecated
|
|
737
|
+
*/
|
|
738
|
+
background?: string | null;
|
|
739
|
+
}
|
|
740
|
+
interface PluginContainerData {
|
|
741
|
+
/** The width of the node when it's displayed. */
|
|
742
|
+
width?: PluginContainerDataWidth;
|
|
743
|
+
/** The node's alignment within its container. */
|
|
744
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
745
|
+
/** Spoiler cover settings for the node. */
|
|
746
|
+
spoiler?: Spoiler;
|
|
747
|
+
/** The height of the node when it's displayed. */
|
|
748
|
+
height?: Height;
|
|
749
|
+
/** 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`. */
|
|
750
|
+
textWrap?: boolean | null;
|
|
751
|
+
}
|
|
752
|
+
declare enum WidthType {
|
|
753
|
+
/** Width matches the content width */
|
|
754
|
+
CONTENT = "CONTENT",
|
|
755
|
+
/** Small Width */
|
|
756
|
+
SMALL = "SMALL",
|
|
757
|
+
/** Width will match the original asset width */
|
|
758
|
+
ORIGINAL = "ORIGINAL",
|
|
759
|
+
/** coast-to-coast display */
|
|
760
|
+
FULL_WIDTH = "FULL_WIDTH"
|
|
761
|
+
}
|
|
762
|
+
/** @enumType */
|
|
763
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
764
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
765
|
+
/**
|
|
766
|
+
* One of the following predefined width options:
|
|
767
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
768
|
+
* `SMALL`: A small width.
|
|
769
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
770
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
771
|
+
*/
|
|
772
|
+
size?: WidthTypeWithLiterals;
|
|
773
|
+
/** A custom width value in pixels. */
|
|
774
|
+
custom?: string | null;
|
|
775
|
+
}
|
|
776
|
+
/** @oneof */
|
|
777
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
778
|
+
/**
|
|
779
|
+
* One of the following predefined width options:
|
|
780
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
781
|
+
* `SMALL`: A small width.
|
|
782
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
783
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
784
|
+
*/
|
|
785
|
+
size?: WidthTypeWithLiterals;
|
|
786
|
+
/** A custom width value in pixels. */
|
|
787
|
+
custom?: string | null;
|
|
788
|
+
}
|
|
789
|
+
declare enum PluginContainerDataAlignment {
|
|
790
|
+
/** Center Alignment */
|
|
791
|
+
CENTER = "CENTER",
|
|
792
|
+
/** Left Alignment */
|
|
793
|
+
LEFT = "LEFT",
|
|
794
|
+
/** Right Alignment */
|
|
795
|
+
RIGHT = "RIGHT"
|
|
796
|
+
}
|
|
797
|
+
/** @enumType */
|
|
798
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
799
|
+
interface Spoiler {
|
|
800
|
+
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
801
|
+
enabled?: boolean | null;
|
|
802
|
+
/** The description displayed on top of the spoiler cover. */
|
|
803
|
+
description?: string | null;
|
|
804
|
+
/** The text for the button used to remove the spoiler cover. */
|
|
805
|
+
buttonText?: string | null;
|
|
806
|
+
}
|
|
807
|
+
interface Height {
|
|
808
|
+
/** A custom height value in pixels. */
|
|
809
|
+
custom?: string | null;
|
|
810
|
+
}
|
|
811
|
+
declare enum ButtonDataType {
|
|
812
|
+
/** Regular link button */
|
|
813
|
+
LINK = "LINK",
|
|
814
|
+
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
815
|
+
ACTION = "ACTION"
|
|
816
|
+
}
|
|
817
|
+
/** @enumType */
|
|
818
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
819
|
+
interface Styles {
|
|
820
|
+
/**
|
|
821
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
822
|
+
* @deprecated
|
|
823
|
+
*/
|
|
824
|
+
border?: StylesBorder;
|
|
825
|
+
/**
|
|
826
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
827
|
+
* @deprecated
|
|
828
|
+
*/
|
|
829
|
+
colors?: Colors;
|
|
830
|
+
/** Border width in pixels. */
|
|
831
|
+
borderWidth?: number | null;
|
|
832
|
+
/**
|
|
833
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
834
|
+
* @deprecated
|
|
835
|
+
*/
|
|
836
|
+
borderWidthHover?: number | null;
|
|
837
|
+
/** Border radius in pixels. */
|
|
838
|
+
borderRadius?: number | null;
|
|
839
|
+
/**
|
|
840
|
+
* Border color as a hexadecimal value.
|
|
841
|
+
* @format COLOR_HEX
|
|
842
|
+
*/
|
|
843
|
+
borderColor?: string | null;
|
|
844
|
+
/**
|
|
845
|
+
* Border color as a hexadecimal value (hover state).
|
|
846
|
+
* @format COLOR_HEX
|
|
847
|
+
*/
|
|
848
|
+
borderColorHover?: string | null;
|
|
849
|
+
/**
|
|
850
|
+
* Text color as a hexadecimal value.
|
|
851
|
+
* @format COLOR_HEX
|
|
852
|
+
*/
|
|
853
|
+
textColor?: string | null;
|
|
854
|
+
/**
|
|
855
|
+
* Text color as a hexadecimal value (hover state).
|
|
856
|
+
* @format COLOR_HEX
|
|
857
|
+
*/
|
|
858
|
+
textColorHover?: string | null;
|
|
859
|
+
/**
|
|
860
|
+
* Background color as a hexadecimal value.
|
|
861
|
+
* @format COLOR_HEX
|
|
862
|
+
*/
|
|
863
|
+
backgroundColor?: string | null;
|
|
864
|
+
/**
|
|
865
|
+
* Background color as a hexadecimal value (hover state).
|
|
866
|
+
* @format COLOR_HEX
|
|
867
|
+
*/
|
|
868
|
+
backgroundColorHover?: string | null;
|
|
869
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
870
|
+
buttonSize?: string | null;
|
|
871
|
+
}
|
|
872
|
+
interface Link extends LinkDataOneOf {
|
|
873
|
+
/** The absolute URL for the linked document. */
|
|
874
|
+
url?: string;
|
|
875
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
876
|
+
anchor?: string;
|
|
877
|
+
/**
|
|
878
|
+
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
879
|
+
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
880
|
+
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
881
|
+
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
882
|
+
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
883
|
+
*/
|
|
884
|
+
target?: TargetWithLiterals;
|
|
885
|
+
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
886
|
+
rel?: Rel;
|
|
887
|
+
/** A serialized object used for a custom or external link panel. */
|
|
888
|
+
customData?: string | null;
|
|
889
|
+
}
|
|
890
|
+
/** @oneof */
|
|
891
|
+
interface LinkDataOneOf {
|
|
892
|
+
/** The absolute URL for the linked document. */
|
|
893
|
+
url?: string;
|
|
894
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
895
|
+
anchor?: string;
|
|
896
|
+
}
|
|
897
|
+
declare enum Target {
|
|
898
|
+
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
899
|
+
SELF = "SELF",
|
|
900
|
+
/** Opens the linked document in a new window or tab */
|
|
901
|
+
BLANK = "BLANK",
|
|
902
|
+
/** Opens the linked document in the parent frame */
|
|
903
|
+
PARENT = "PARENT",
|
|
904
|
+
/** Opens the linked document in the full body of the window */
|
|
905
|
+
TOP = "TOP"
|
|
906
|
+
}
|
|
907
|
+
/** @enumType */
|
|
908
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
909
|
+
interface Rel {
|
|
910
|
+
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
911
|
+
nofollow?: boolean | null;
|
|
912
|
+
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
913
|
+
sponsored?: boolean | null;
|
|
914
|
+
/** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
|
|
915
|
+
ugc?: boolean | null;
|
|
916
|
+
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
917
|
+
noreferrer?: boolean | null;
|
|
918
|
+
}
|
|
919
|
+
interface CodeBlockData {
|
|
920
|
+
/** Styling for the code block's text. */
|
|
921
|
+
textStyle?: V1TextStyle;
|
|
922
|
+
}
|
|
923
|
+
interface V1TextStyle {
|
|
924
|
+
/** Text alignment. Defaults to `AUTO`. */
|
|
925
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
926
|
+
/** 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. */
|
|
927
|
+
lineHeight?: string | null;
|
|
928
|
+
}
|
|
929
|
+
declare enum TextAlignment {
|
|
930
|
+
/** browser default, eqivalent to `initial` */
|
|
931
|
+
AUTO = "AUTO",
|
|
932
|
+
/** Left align */
|
|
933
|
+
LEFT = "LEFT",
|
|
934
|
+
/** Right align */
|
|
935
|
+
RIGHT = "RIGHT",
|
|
936
|
+
/** Center align */
|
|
937
|
+
CENTER = "CENTER",
|
|
938
|
+
/** 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 */
|
|
939
|
+
JUSTIFY = "JUSTIFY"
|
|
940
|
+
}
|
|
941
|
+
/** @enumType */
|
|
942
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
943
|
+
interface DividerData {
|
|
944
|
+
/** Styling for the divider's container. */
|
|
945
|
+
containerData?: PluginContainerData;
|
|
946
|
+
/** Divider line style. */
|
|
947
|
+
lineStyle?: LineStyleWithLiterals;
|
|
948
|
+
/** Divider width. */
|
|
949
|
+
width?: WidthWithLiterals;
|
|
950
|
+
/** Divider alignment. */
|
|
951
|
+
alignment?: DividerDataAlignmentWithLiterals;
|
|
952
|
+
}
|
|
953
|
+
declare enum LineStyle {
|
|
954
|
+
/** Single Line */
|
|
955
|
+
SINGLE = "SINGLE",
|
|
956
|
+
/** Double Line */
|
|
957
|
+
DOUBLE = "DOUBLE",
|
|
958
|
+
/** Dashed Line */
|
|
959
|
+
DASHED = "DASHED",
|
|
960
|
+
/** Dotted Line */
|
|
961
|
+
DOTTED = "DOTTED"
|
|
962
|
+
}
|
|
963
|
+
/** @enumType */
|
|
964
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
965
|
+
declare enum Width {
|
|
966
|
+
/** Large line */
|
|
967
|
+
LARGE = "LARGE",
|
|
968
|
+
/** Medium line */
|
|
969
|
+
MEDIUM = "MEDIUM",
|
|
970
|
+
/** Small line */
|
|
971
|
+
SMALL = "SMALL"
|
|
972
|
+
}
|
|
973
|
+
/** @enumType */
|
|
974
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
975
|
+
declare enum DividerDataAlignment {
|
|
976
|
+
/** Center alignment */
|
|
977
|
+
CENTER = "CENTER",
|
|
978
|
+
/** Left alignment */
|
|
979
|
+
LEFT = "LEFT",
|
|
980
|
+
/** Right alignment */
|
|
981
|
+
RIGHT = "RIGHT"
|
|
982
|
+
}
|
|
983
|
+
/** @enumType */
|
|
984
|
+
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
985
|
+
interface FileData {
|
|
986
|
+
/** Styling for the file's container. */
|
|
987
|
+
containerData?: PluginContainerData;
|
|
988
|
+
/** The source for the file's data. */
|
|
989
|
+
src?: FileSource;
|
|
990
|
+
/** File name. */
|
|
991
|
+
name?: string | null;
|
|
992
|
+
/** File type. */
|
|
993
|
+
type?: string | null;
|
|
994
|
+
/**
|
|
995
|
+
* Use `sizeInKb` instead.
|
|
996
|
+
* @deprecated
|
|
997
|
+
*/
|
|
998
|
+
size?: number | null;
|
|
999
|
+
/** Settings for PDF files. */
|
|
1000
|
+
pdfSettings?: PDFSettings;
|
|
1001
|
+
/** File MIME type. */
|
|
1002
|
+
mimeType?: string | null;
|
|
1003
|
+
/** File path. */
|
|
1004
|
+
path?: string | null;
|
|
1005
|
+
/** File size in KB. */
|
|
1006
|
+
sizeInKb?: string | null;
|
|
1007
|
+
}
|
|
1008
|
+
declare enum ViewMode {
|
|
1009
|
+
/** No PDF view */
|
|
1010
|
+
NONE = "NONE",
|
|
1011
|
+
/** Full PDF view */
|
|
1012
|
+
FULL = "FULL",
|
|
1013
|
+
/** Mini PDF view */
|
|
1014
|
+
MINI = "MINI"
|
|
1015
|
+
}
|
|
1016
|
+
/** @enumType */
|
|
1017
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1018
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1019
|
+
/** The absolute URL for the file's source. */
|
|
1020
|
+
url?: string | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Custom ID. Use `id` instead.
|
|
1023
|
+
* @deprecated
|
|
1024
|
+
*/
|
|
1025
|
+
custom?: string | null;
|
|
1026
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
1027
|
+
id?: string | null;
|
|
1028
|
+
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
1029
|
+
private?: boolean | null;
|
|
1030
|
+
}
|
|
1031
|
+
/** @oneof */
|
|
1032
|
+
interface FileSourceDataOneOf {
|
|
1033
|
+
/** The absolute URL for the file's source. */
|
|
1034
|
+
url?: string | null;
|
|
1035
|
+
/**
|
|
1036
|
+
* Custom ID. Use `id` instead.
|
|
1037
|
+
* @deprecated
|
|
1038
|
+
*/
|
|
1039
|
+
custom?: string | null;
|
|
1040
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
1041
|
+
id?: string | null;
|
|
1042
|
+
}
|
|
1043
|
+
interface PDFSettings {
|
|
1044
|
+
/**
|
|
1045
|
+
* PDF view mode. One of the following:
|
|
1046
|
+
* `NONE` : The PDF isn't displayed.
|
|
1047
|
+
* `FULL` : A full page view of the PDF is displayed.
|
|
1048
|
+
* `MINI` : A mini view of the PDF is displayed.
|
|
1049
|
+
*/
|
|
1050
|
+
viewMode?: ViewModeWithLiterals;
|
|
1051
|
+
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1052
|
+
disableDownload?: boolean | null;
|
|
1053
|
+
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1054
|
+
disablePrint?: boolean | null;
|
|
1055
|
+
}
|
|
1056
|
+
interface GalleryData {
|
|
1057
|
+
/** Styling for the gallery's container. */
|
|
1058
|
+
containerData?: PluginContainerData;
|
|
1059
|
+
/** The items in the gallery. */
|
|
1060
|
+
items?: Item[];
|
|
1061
|
+
/** Options for defining the gallery's appearance. */
|
|
1062
|
+
options?: GalleryOptions;
|
|
1063
|
+
/** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
|
|
1064
|
+
disableExpand?: boolean | null;
|
|
1065
|
+
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1066
|
+
disableDownload?: boolean | null;
|
|
1067
|
+
}
|
|
1068
|
+
interface Media {
|
|
1069
|
+
/** The source for the media's data. */
|
|
1070
|
+
src?: FileSource;
|
|
1071
|
+
/** Media width in pixels. */
|
|
1072
|
+
width?: number | null;
|
|
1073
|
+
/** Media height in pixels. */
|
|
1074
|
+
height?: number | null;
|
|
1075
|
+
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1076
|
+
duration?: number | null;
|
|
1077
|
+
}
|
|
1078
|
+
interface ItemImage {
|
|
1079
|
+
/** Image file details. */
|
|
1080
|
+
media?: Media;
|
|
1081
|
+
/** Link details for images that are links. */
|
|
1082
|
+
link?: Link;
|
|
1083
|
+
}
|
|
1084
|
+
interface Video {
|
|
1085
|
+
/** Video file details. */
|
|
1086
|
+
media?: Media;
|
|
1087
|
+
/** Video thumbnail file details. */
|
|
1088
|
+
thumbnail?: Media;
|
|
1089
|
+
}
|
|
1090
|
+
interface Item extends ItemDataOneOf {
|
|
1091
|
+
/** An image item. */
|
|
1092
|
+
image?: ItemImage;
|
|
1093
|
+
/** A video item. */
|
|
1094
|
+
video?: Video;
|
|
1095
|
+
/** Item title. */
|
|
1096
|
+
title?: string | null;
|
|
1097
|
+
/** Item's alternative text. */
|
|
1098
|
+
altText?: string | null;
|
|
1099
|
+
}
|
|
1100
|
+
/** @oneof */
|
|
1101
|
+
interface ItemDataOneOf {
|
|
1102
|
+
/** An image item. */
|
|
1103
|
+
image?: ItemImage;
|
|
1104
|
+
/** A video item. */
|
|
1105
|
+
video?: Video;
|
|
1106
|
+
}
|
|
1107
|
+
interface GalleryOptions {
|
|
1108
|
+
/** Gallery layout. */
|
|
1109
|
+
layout?: GalleryOptionsLayout;
|
|
1110
|
+
/** Styling for gallery items. */
|
|
1111
|
+
item?: ItemStyle;
|
|
1112
|
+
/** Styling for gallery thumbnail images. */
|
|
1113
|
+
thumbnails?: Thumbnails;
|
|
1114
|
+
}
|
|
1115
|
+
declare enum LayoutType {
|
|
1116
|
+
/** Collage type */
|
|
1117
|
+
COLLAGE = "COLLAGE",
|
|
1118
|
+
/** Masonry type */
|
|
1119
|
+
MASONRY = "MASONRY",
|
|
1120
|
+
/** Grid type */
|
|
1121
|
+
GRID = "GRID",
|
|
1122
|
+
/** Thumbnail type */
|
|
1123
|
+
THUMBNAIL = "THUMBNAIL",
|
|
1124
|
+
/** Slider type */
|
|
1125
|
+
SLIDER = "SLIDER",
|
|
1126
|
+
/** Slideshow type */
|
|
1127
|
+
SLIDESHOW = "SLIDESHOW",
|
|
1128
|
+
/** Panorama type */
|
|
1129
|
+
PANORAMA = "PANORAMA",
|
|
1130
|
+
/** Column type */
|
|
1131
|
+
COLUMN = "COLUMN",
|
|
1132
|
+
/** Magic type */
|
|
1133
|
+
MAGIC = "MAGIC",
|
|
1134
|
+
/** Fullsize images type */
|
|
1135
|
+
FULLSIZE = "FULLSIZE"
|
|
1136
|
+
}
|
|
1137
|
+
/** @enumType */
|
|
1138
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1139
|
+
declare enum Orientation {
|
|
1140
|
+
/** Rows Orientation */
|
|
1141
|
+
ROWS = "ROWS",
|
|
1142
|
+
/** Columns Orientation */
|
|
1143
|
+
COLUMNS = "COLUMNS"
|
|
1144
|
+
}
|
|
1145
|
+
/** @enumType */
|
|
1146
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1147
|
+
declare enum Crop {
|
|
1148
|
+
/** Crop to fill */
|
|
1149
|
+
FILL = "FILL",
|
|
1150
|
+
/** Crop to fit */
|
|
1151
|
+
FIT = "FIT"
|
|
1152
|
+
}
|
|
1153
|
+
/** @enumType */
|
|
1154
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1155
|
+
declare enum ThumbnailsAlignment {
|
|
1156
|
+
/** Top alignment */
|
|
1157
|
+
TOP = "TOP",
|
|
1158
|
+
/** Right alignment */
|
|
1159
|
+
RIGHT = "RIGHT",
|
|
1160
|
+
/** Bottom alignment */
|
|
1161
|
+
BOTTOM = "BOTTOM",
|
|
1162
|
+
/** Left alignment */
|
|
1163
|
+
LEFT = "LEFT",
|
|
1164
|
+
/** No thumbnail */
|
|
1165
|
+
NONE = "NONE"
|
|
1166
|
+
}
|
|
1167
|
+
/** @enumType */
|
|
1168
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1169
|
+
interface GalleryOptionsLayout {
|
|
1170
|
+
/** Gallery layout type. */
|
|
1171
|
+
type?: LayoutTypeWithLiterals;
|
|
1172
|
+
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1173
|
+
horizontalScroll?: boolean | null;
|
|
1174
|
+
/** Gallery orientation. */
|
|
1175
|
+
orientation?: OrientationWithLiterals;
|
|
1176
|
+
/** The number of columns to display on full size screens. */
|
|
1177
|
+
numberOfColumns?: number | null;
|
|
1178
|
+
/** The number of columns to display on mobile screens. */
|
|
1179
|
+
mobileNumberOfColumns?: number | null;
|
|
1180
|
+
}
|
|
1181
|
+
interface ItemStyle {
|
|
1182
|
+
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1183
|
+
targetSize?: number | null;
|
|
1184
|
+
/** Item ratio */
|
|
1185
|
+
ratio?: number | null;
|
|
1186
|
+
/** Sets how item images are cropped. */
|
|
1187
|
+
crop?: CropWithLiterals;
|
|
1188
|
+
/** The spacing between items in pixels. */
|
|
1189
|
+
spacing?: number | null;
|
|
1190
|
+
}
|
|
1191
|
+
interface Thumbnails {
|
|
1192
|
+
/** Thumbnail alignment. */
|
|
1193
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1194
|
+
/** Spacing between thumbnails in pixels. */
|
|
1195
|
+
spacing?: number | null;
|
|
1196
|
+
}
|
|
1197
|
+
interface GIFData {
|
|
1198
|
+
/** Styling for the GIF's container. */
|
|
1199
|
+
containerData?: PluginContainerData;
|
|
1200
|
+
/** The source of the full size GIF. */
|
|
1201
|
+
original?: GIF;
|
|
1202
|
+
/** The source of the downsized GIF. */
|
|
1203
|
+
downsized?: GIF;
|
|
1204
|
+
/** Height in pixels. */
|
|
1205
|
+
height?: number;
|
|
1206
|
+
/** Width in pixels. */
|
|
1207
|
+
width?: number;
|
|
1208
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1209
|
+
gifType?: GIFTypeWithLiterals;
|
|
1210
|
+
}
|
|
1211
|
+
interface GIF {
|
|
1212
|
+
/**
|
|
1213
|
+
* GIF format URL.
|
|
1214
|
+
* @format WEB_URL
|
|
1215
|
+
*/
|
|
1216
|
+
gif?: string | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* MP4 format URL.
|
|
1219
|
+
* @format WEB_URL
|
|
1220
|
+
*/
|
|
1221
|
+
mp4?: string | null;
|
|
1222
|
+
/**
|
|
1223
|
+
* Thumbnail URL.
|
|
1224
|
+
* @format WEB_URL
|
|
1225
|
+
*/
|
|
1226
|
+
still?: string | null;
|
|
1227
|
+
}
|
|
1228
|
+
declare enum GIFType {
|
|
1229
|
+
NORMAL = "NORMAL",
|
|
1230
|
+
STICKER = "STICKER"
|
|
1231
|
+
}
|
|
1232
|
+
/** @enumType */
|
|
1233
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1234
|
+
interface HeadingData {
|
|
1235
|
+
/** Heading level from 1-6. */
|
|
1236
|
+
level?: number;
|
|
1237
|
+
/** Styling for the heading text. */
|
|
1238
|
+
textStyle?: V1TextStyle;
|
|
1239
|
+
/** Indentation level from 1-4. */
|
|
1240
|
+
indentation?: number | null;
|
|
1241
|
+
}
|
|
1242
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1243
|
+
/** The URL for the HTML code for the node. */
|
|
1244
|
+
url?: string;
|
|
1245
|
+
/** The HTML code for the node. */
|
|
1246
|
+
html?: string;
|
|
1247
|
+
/**
|
|
1248
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1249
|
+
* @deprecated
|
|
1250
|
+
*/
|
|
1251
|
+
isAdsense?: boolean | null;
|
|
1252
|
+
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1253
|
+
containerData?: PluginContainerData;
|
|
1254
|
+
/** The type of HTML code. */
|
|
1255
|
+
source?: SourceWithLiterals;
|
|
1256
|
+
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1257
|
+
autoHeight?: boolean | null;
|
|
1258
|
+
}
|
|
1259
|
+
/** @oneof */
|
|
1260
|
+
interface HTMLDataDataOneOf {
|
|
1261
|
+
/** The URL for the HTML code for the node. */
|
|
1262
|
+
url?: string;
|
|
1263
|
+
/** The HTML code for the node. */
|
|
1264
|
+
html?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1267
|
+
* @deprecated
|
|
1268
|
+
*/
|
|
1269
|
+
isAdsense?: boolean | null;
|
|
1270
|
+
}
|
|
1271
|
+
declare enum Source {
|
|
1272
|
+
HTML = "HTML",
|
|
1273
|
+
ADSENSE = "ADSENSE"
|
|
1274
|
+
}
|
|
1275
|
+
/** @enumType */
|
|
1276
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1277
|
+
interface ImageData {
|
|
1278
|
+
/** Styling for the image's container. */
|
|
1279
|
+
containerData?: PluginContainerData;
|
|
1280
|
+
/** Image file details. */
|
|
1281
|
+
image?: Media;
|
|
1282
|
+
/** Link details for images that are links. */
|
|
1283
|
+
link?: Link;
|
|
1284
|
+
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
|
|
1285
|
+
disableExpand?: boolean | null;
|
|
1286
|
+
/** Image's alternative text. */
|
|
1287
|
+
altText?: string | null;
|
|
1288
|
+
/**
|
|
1289
|
+
* Deprecated: use Caption node instead.
|
|
1290
|
+
* @deprecated
|
|
1291
|
+
*/
|
|
1292
|
+
caption?: string | null;
|
|
1293
|
+
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1294
|
+
disableDownload?: boolean | null;
|
|
1295
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1296
|
+
decorative?: boolean | null;
|
|
1297
|
+
/** Styling for the image. */
|
|
1298
|
+
styles?: ImageDataStyles;
|
|
1299
|
+
}
|
|
1300
|
+
interface ImageDataStylesBorder {
|
|
1301
|
+
/** Border width in pixels. */
|
|
1302
|
+
width?: number | null;
|
|
1303
|
+
/**
|
|
1304
|
+
* Border color as a hexadecimal value.
|
|
1305
|
+
* @format COLOR_HEX
|
|
1306
|
+
*/
|
|
1307
|
+
color?: string | null;
|
|
1308
|
+
/** Border radius in pixels. */
|
|
1309
|
+
radius?: number | null;
|
|
1310
|
+
}
|
|
1311
|
+
interface ImageDataStyles {
|
|
1312
|
+
/** Border attributes. */
|
|
1313
|
+
border?: ImageDataStylesBorder;
|
|
1314
|
+
}
|
|
1315
|
+
interface LinkPreviewData {
|
|
1316
|
+
/** Styling for the link preview's container. */
|
|
1317
|
+
containerData?: PluginContainerData;
|
|
1318
|
+
/** Link details. */
|
|
1319
|
+
link?: Link;
|
|
1320
|
+
/** Preview title. */
|
|
1321
|
+
title?: string | null;
|
|
1322
|
+
/** Preview thumbnail URL. */
|
|
1323
|
+
thumbnailUrl?: string | null;
|
|
1324
|
+
/** Preview description. */
|
|
1325
|
+
description?: string | null;
|
|
1326
|
+
/** The preview content as HTML. */
|
|
1327
|
+
html?: string | null;
|
|
1328
|
+
/** Styling for the link preview. */
|
|
1329
|
+
styles?: LinkPreviewDataStyles;
|
|
1330
|
+
}
|
|
1331
|
+
declare enum StylesPosition {
|
|
1332
|
+
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1333
|
+
START = "START",
|
|
1334
|
+
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1335
|
+
END = "END",
|
|
1336
|
+
/** Thumbnail positioned at the top */
|
|
1337
|
+
TOP = "TOP",
|
|
1338
|
+
/** Thumbnail hidden and not displayed */
|
|
1339
|
+
HIDDEN = "HIDDEN"
|
|
1340
|
+
}
|
|
1341
|
+
/** @enumType */
|
|
1342
|
+
type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1343
|
+
interface LinkPreviewDataStyles {
|
|
1344
|
+
/**
|
|
1345
|
+
* Background color as a hexadecimal value.
|
|
1346
|
+
* @format COLOR_HEX
|
|
1347
|
+
*/
|
|
1348
|
+
backgroundColor?: string | null;
|
|
1349
|
+
/**
|
|
1350
|
+
* Title color as a hexadecimal value.
|
|
1351
|
+
* @format COLOR_HEX
|
|
1352
|
+
*/
|
|
1353
|
+
titleColor?: string | null;
|
|
1354
|
+
/**
|
|
1355
|
+
* Subtitle color as a hexadecimal value.
|
|
1356
|
+
* @format COLOR_HEX
|
|
1357
|
+
*/
|
|
1358
|
+
subtitleColor?: string | null;
|
|
1359
|
+
/**
|
|
1360
|
+
* Link color as a hexadecimal value.
|
|
1361
|
+
* @format COLOR_HEX
|
|
1362
|
+
*/
|
|
1363
|
+
linkColor?: string | null;
|
|
1364
|
+
/** Border width in pixels. */
|
|
1365
|
+
borderWidth?: number | null;
|
|
1366
|
+
/** Border radius in pixels. */
|
|
1367
|
+
borderRadius?: number | null;
|
|
1368
|
+
/**
|
|
1369
|
+
* Border color as a hexadecimal value.
|
|
1370
|
+
* @format COLOR_HEX
|
|
1371
|
+
*/
|
|
1372
|
+
borderColor?: string | null;
|
|
1373
|
+
/** Position of thumbnail. Defaults to `START`. */
|
|
1374
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
1375
|
+
}
|
|
1376
|
+
interface MapData {
|
|
1377
|
+
/** Styling for the map's container. */
|
|
1378
|
+
containerData?: PluginContainerData;
|
|
1379
|
+
/** Map settings. */
|
|
1380
|
+
mapSettings?: MapSettings;
|
|
1381
|
+
}
|
|
1382
|
+
interface MapSettings {
|
|
1383
|
+
/** The address to display on the map. */
|
|
1384
|
+
address?: string | null;
|
|
1385
|
+
/** Sets whether the map is draggable. */
|
|
1386
|
+
draggable?: boolean | null;
|
|
1387
|
+
/** Sets whether the location marker is visible. */
|
|
1388
|
+
marker?: boolean | null;
|
|
1389
|
+
/** Sets whether street view control is enabled. */
|
|
1390
|
+
streetViewControl?: boolean | null;
|
|
1391
|
+
/** Sets whether zoom control is enabled. */
|
|
1392
|
+
zoomControl?: boolean | null;
|
|
1393
|
+
/** Location latitude. */
|
|
1394
|
+
lat?: number | null;
|
|
1395
|
+
/** Location longitude. */
|
|
1396
|
+
lng?: number | null;
|
|
1397
|
+
/** Location name. */
|
|
1398
|
+
locationName?: string | null;
|
|
1399
|
+
/** Sets whether view mode control is enabled. */
|
|
1400
|
+
viewModeControl?: boolean | null;
|
|
1401
|
+
/** Initial zoom value. */
|
|
1402
|
+
initialZoom?: number | null;
|
|
1403
|
+
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1404
|
+
mapType?: MapTypeWithLiterals;
|
|
1405
|
+
}
|
|
1406
|
+
declare enum MapType {
|
|
1407
|
+
/** Roadmap map type */
|
|
1408
|
+
ROADMAP = "ROADMAP",
|
|
1409
|
+
/** Satellite map type */
|
|
1410
|
+
SATELITE = "SATELITE",
|
|
1411
|
+
/** Hybrid map type */
|
|
1412
|
+
HYBRID = "HYBRID",
|
|
1413
|
+
/** Terrain map type */
|
|
1414
|
+
TERRAIN = "TERRAIN"
|
|
1415
|
+
}
|
|
1416
|
+
/** @enumType */
|
|
1417
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1418
|
+
interface ParagraphData {
|
|
1419
|
+
/** Styling for the paragraph text. */
|
|
1420
|
+
textStyle?: V1TextStyle;
|
|
1421
|
+
/** Indentation level from 1-4. */
|
|
1422
|
+
indentation?: number | null;
|
|
1423
|
+
/** Paragraph level */
|
|
1424
|
+
level?: number | null;
|
|
1425
|
+
}
|
|
1426
|
+
interface PollData {
|
|
1427
|
+
/** Styling for the poll's container. */
|
|
1428
|
+
containerData?: PluginContainerData;
|
|
1429
|
+
/** Poll data. */
|
|
1430
|
+
poll?: Poll;
|
|
1431
|
+
/** Layout settings for the poll and voting options. */
|
|
1432
|
+
layout?: PollDataLayout;
|
|
1433
|
+
/** Styling for the poll and voting options. */
|
|
1434
|
+
design?: PollDataDesign;
|
|
1435
|
+
}
|
|
1436
|
+
declare enum ViewRole {
|
|
1437
|
+
/** Only Poll creator can view the results */
|
|
1438
|
+
CREATOR = "CREATOR",
|
|
1439
|
+
/** Anyone who voted can see the results */
|
|
1440
|
+
VOTERS = "VOTERS",
|
|
1441
|
+
/** Anyone can see the results, even if one didn't vote */
|
|
1442
|
+
EVERYONE = "EVERYONE"
|
|
1443
|
+
}
|
|
1444
|
+
/** @enumType */
|
|
1445
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1446
|
+
declare enum VoteRole {
|
|
1447
|
+
/** Logged in member */
|
|
1448
|
+
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1449
|
+
/** Anyone */
|
|
1450
|
+
ALL = "ALL"
|
|
1451
|
+
}
|
|
1452
|
+
/** @enumType */
|
|
1453
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1454
|
+
interface Permissions {
|
|
1455
|
+
/** Sets who can view the poll results. */
|
|
1456
|
+
view?: ViewRoleWithLiterals;
|
|
1457
|
+
/** Sets who can vote. */
|
|
1458
|
+
vote?: VoteRoleWithLiterals;
|
|
1459
|
+
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1460
|
+
allowMultipleVotes?: boolean | null;
|
|
1461
|
+
}
|
|
1462
|
+
interface Option {
|
|
1463
|
+
/** Option ID. */
|
|
1464
|
+
id?: string | null;
|
|
1465
|
+
/** Option title. */
|
|
1466
|
+
title?: string | null;
|
|
1467
|
+
/** The image displayed with the option. */
|
|
1468
|
+
image?: Media;
|
|
1469
|
+
}
|
|
1470
|
+
interface Settings {
|
|
1471
|
+
/** Permissions settings for voting. */
|
|
1472
|
+
permissions?: Permissions;
|
|
1473
|
+
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
1474
|
+
showVoters?: boolean | null;
|
|
1475
|
+
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1476
|
+
showVotesCount?: boolean | null;
|
|
1477
|
+
}
|
|
1478
|
+
declare enum PollLayoutType {
|
|
1479
|
+
/** List */
|
|
1480
|
+
LIST = "LIST",
|
|
1481
|
+
/** Grid */
|
|
1482
|
+
GRID = "GRID"
|
|
1483
|
+
}
|
|
1484
|
+
/** @enumType */
|
|
1485
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1486
|
+
declare enum PollLayoutDirection {
|
|
1487
|
+
/** Left-to-right */
|
|
1488
|
+
LTR = "LTR",
|
|
1489
|
+
/** Right-to-left */
|
|
1490
|
+
RTL = "RTL"
|
|
1491
|
+
}
|
|
1492
|
+
/** @enumType */
|
|
1493
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1494
|
+
interface PollLayout {
|
|
1495
|
+
/** The layout for displaying the voting options. */
|
|
1496
|
+
type?: PollLayoutTypeWithLiterals;
|
|
1497
|
+
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1498
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
1499
|
+
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1500
|
+
enableImage?: boolean | null;
|
|
1501
|
+
}
|
|
1502
|
+
interface OptionLayout {
|
|
1503
|
+
/** Sets whether to display option images. Defaults to `false`. */
|
|
1504
|
+
enableImage?: boolean | null;
|
|
1505
|
+
}
|
|
1506
|
+
declare enum PollDesignBackgroundType {
|
|
1507
|
+
/** Color background type */
|
|
1508
|
+
COLOR = "COLOR",
|
|
1509
|
+
/** Image background type */
|
|
1510
|
+
IMAGE = "IMAGE",
|
|
1511
|
+
/** Gradiant background type */
|
|
1512
|
+
GRADIENT = "GRADIENT"
|
|
1513
|
+
}
|
|
1514
|
+
/** @enumType */
|
|
1515
|
+
type PollDesignBackgroundTypeWithLiterals = PollDesignBackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1516
|
+
interface BackgroundGradient {
|
|
1517
|
+
/** The gradient angle in degrees. */
|
|
1518
|
+
angle?: number | null;
|
|
1519
|
+
/**
|
|
1520
|
+
* The start color as a hexademical value.
|
|
1521
|
+
* @format COLOR_HEX
|
|
1522
|
+
*/
|
|
1523
|
+
startColor?: string | null;
|
|
1524
|
+
/**
|
|
1525
|
+
* The end color as a hexademical value.
|
|
1526
|
+
* @format COLOR_HEX
|
|
1527
|
+
*/
|
|
1528
|
+
lastColor?: string | null;
|
|
1529
|
+
}
|
|
1530
|
+
interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
|
|
1531
|
+
/**
|
|
1532
|
+
* The background color as a hexademical value.
|
|
1533
|
+
* @format COLOR_HEX
|
|
1534
|
+
*/
|
|
1535
|
+
color?: string | null;
|
|
1536
|
+
/** An image to use for the background. */
|
|
1537
|
+
image?: Media;
|
|
1538
|
+
/** Details for a gradient background. */
|
|
1539
|
+
gradient?: BackgroundGradient;
|
|
1540
|
+
/** Background type. For each option, include the relevant details. */
|
|
1541
|
+
type?: PollDesignBackgroundTypeWithLiterals;
|
|
1542
|
+
}
|
|
1543
|
+
/** @oneof */
|
|
1544
|
+
interface PollDesignBackgroundBackgroundOneOf {
|
|
1545
|
+
/**
|
|
1546
|
+
* The background color as a hexademical value.
|
|
1547
|
+
* @format COLOR_HEX
|
|
1548
|
+
*/
|
|
1549
|
+
color?: string | null;
|
|
1550
|
+
/** An image to use for the background. */
|
|
1551
|
+
image?: Media;
|
|
1552
|
+
/** Details for a gradient background. */
|
|
1553
|
+
gradient?: BackgroundGradient;
|
|
1554
|
+
}
|
|
1555
|
+
interface PollDesign {
|
|
1556
|
+
/** Background styling. */
|
|
1557
|
+
background?: PollDesignBackground;
|
|
1558
|
+
/** Border radius in pixels. */
|
|
1559
|
+
borderRadius?: number | null;
|
|
1560
|
+
}
|
|
1561
|
+
interface OptionDesign {
|
|
1562
|
+
/** Border radius in pixels. */
|
|
1563
|
+
borderRadius?: number | null;
|
|
1564
|
+
}
|
|
1565
|
+
interface Poll {
|
|
1566
|
+
/** Poll ID. */
|
|
1567
|
+
id?: string | null;
|
|
1568
|
+
/** Poll title. */
|
|
1569
|
+
title?: string | null;
|
|
1570
|
+
/** Poll creator ID. */
|
|
1571
|
+
creatorId?: string | null;
|
|
1572
|
+
/** Main poll image. */
|
|
1573
|
+
image?: Media;
|
|
1574
|
+
/** Voting options. */
|
|
1575
|
+
options?: Option[];
|
|
1576
|
+
/** The poll's permissions and display settings. */
|
|
1577
|
+
settings?: Settings;
|
|
1578
|
+
}
|
|
1579
|
+
interface PollDataLayout {
|
|
1580
|
+
/** Poll layout settings. */
|
|
1581
|
+
poll?: PollLayout;
|
|
1582
|
+
/** Voting otpions layout settings. */
|
|
1583
|
+
options?: OptionLayout;
|
|
1584
|
+
}
|
|
1585
|
+
interface PollDataDesign {
|
|
1586
|
+
/** Styling for the poll. */
|
|
1587
|
+
poll?: PollDesign;
|
|
1588
|
+
/** Styling for voting options. */
|
|
1589
|
+
options?: OptionDesign;
|
|
1590
|
+
}
|
|
1591
|
+
interface TextData {
|
|
1592
|
+
/** The text to apply decorations to. */
|
|
1593
|
+
text?: string;
|
|
1594
|
+
/** The decorations to apply. */
|
|
1595
|
+
decorations?: Decoration[];
|
|
1596
|
+
}
|
|
1597
|
+
/** Adds appearence changes to text */
|
|
1598
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1599
|
+
/** Data for an anchor link decoration. */
|
|
1600
|
+
anchorData?: AnchorData;
|
|
1601
|
+
/** Data for a color decoration. */
|
|
1602
|
+
colorData?: ColorData;
|
|
1603
|
+
/** Data for an external link decoration. */
|
|
1604
|
+
linkData?: LinkData;
|
|
1605
|
+
/** Data for a mention decoration. */
|
|
1606
|
+
mentionData?: MentionData;
|
|
1607
|
+
/** Data for a font size decoration. */
|
|
1608
|
+
fontSizeData?: FontSizeData;
|
|
1609
|
+
/** Font weight for a bold decoration. */
|
|
1610
|
+
fontWeightValue?: number | null;
|
|
1611
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
1612
|
+
italicData?: boolean | null;
|
|
1613
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
1614
|
+
underlineData?: boolean | null;
|
|
1615
|
+
/** Data for a spoiler decoration. */
|
|
1616
|
+
spoilerData?: SpoilerData;
|
|
1617
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1618
|
+
strikethroughData?: boolean | null;
|
|
1619
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1620
|
+
superscriptData?: boolean | null;
|
|
1621
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1622
|
+
subscriptData?: boolean | null;
|
|
1623
|
+
/** The type of decoration to apply. */
|
|
1624
|
+
type?: DecorationTypeWithLiterals;
|
|
1625
|
+
}
|
|
1626
|
+
/** @oneof */
|
|
1627
|
+
interface DecorationDataOneOf {
|
|
1628
|
+
/** Data for an anchor link decoration. */
|
|
1629
|
+
anchorData?: AnchorData;
|
|
1630
|
+
/** Data for a color decoration. */
|
|
1631
|
+
colorData?: ColorData;
|
|
1632
|
+
/** Data for an external link decoration. */
|
|
1633
|
+
linkData?: LinkData;
|
|
1634
|
+
/** Data for a mention decoration. */
|
|
1635
|
+
mentionData?: MentionData;
|
|
1636
|
+
/** Data for a font size decoration. */
|
|
1637
|
+
fontSizeData?: FontSizeData;
|
|
1638
|
+
/** Font weight for a bold decoration. */
|
|
1639
|
+
fontWeightValue?: number | null;
|
|
1640
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
1641
|
+
italicData?: boolean | null;
|
|
1642
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
1643
|
+
underlineData?: boolean | null;
|
|
1644
|
+
/** Data for a spoiler decoration. */
|
|
1645
|
+
spoilerData?: SpoilerData;
|
|
1646
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1647
|
+
strikethroughData?: boolean | null;
|
|
1648
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1649
|
+
superscriptData?: boolean | null;
|
|
1650
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1651
|
+
subscriptData?: boolean | null;
|
|
1652
|
+
}
|
|
1653
|
+
declare enum DecorationType {
|
|
1654
|
+
BOLD = "BOLD",
|
|
1655
|
+
ITALIC = "ITALIC",
|
|
1656
|
+
UNDERLINE = "UNDERLINE",
|
|
1657
|
+
SPOILER = "SPOILER",
|
|
1658
|
+
ANCHOR = "ANCHOR",
|
|
1659
|
+
MENTION = "MENTION",
|
|
1660
|
+
LINK = "LINK",
|
|
1661
|
+
COLOR = "COLOR",
|
|
1662
|
+
FONT_SIZE = "FONT_SIZE",
|
|
1663
|
+
EXTERNAL = "EXTERNAL",
|
|
1664
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1665
|
+
SUPERSCRIPT = "SUPERSCRIPT",
|
|
1666
|
+
SUBSCRIPT = "SUBSCRIPT"
|
|
1667
|
+
}
|
|
1668
|
+
/** @enumType */
|
|
1669
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
|
|
1670
|
+
interface AnchorData {
|
|
1671
|
+
/** The target node's ID. */
|
|
1672
|
+
anchor?: string;
|
|
1673
|
+
}
|
|
1674
|
+
interface ColorData {
|
|
1675
|
+
/** The text's background color as a hexadecimal value. */
|
|
1676
|
+
background?: string | null;
|
|
1677
|
+
/** The text's foreground color as a hexadecimal value. */
|
|
1678
|
+
foreground?: string | null;
|
|
1679
|
+
}
|
|
1680
|
+
interface LinkData {
|
|
1681
|
+
/** Link details. */
|
|
1682
|
+
link?: Link;
|
|
1683
|
+
}
|
|
1684
|
+
interface MentionData {
|
|
1685
|
+
/** The mentioned user's name. */
|
|
1686
|
+
name?: string;
|
|
1687
|
+
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1688
|
+
slug?: string;
|
|
1689
|
+
/** Mentioned user's ID. */
|
|
1690
|
+
id?: string | null;
|
|
1691
|
+
}
|
|
1692
|
+
interface FontSizeData {
|
|
1693
|
+
/** The units used for the font size. */
|
|
1694
|
+
unit?: FontTypeWithLiterals;
|
|
1695
|
+
/** Font size value. */
|
|
1696
|
+
value?: number | null;
|
|
1697
|
+
}
|
|
1698
|
+
declare enum FontType {
|
|
1699
|
+
PX = "PX",
|
|
1700
|
+
EM = "EM"
|
|
1701
|
+
}
|
|
1702
|
+
/** @enumType */
|
|
1703
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1704
|
+
interface SpoilerData {
|
|
1705
|
+
/** Spoiler ID. */
|
|
1706
|
+
id?: string | null;
|
|
1707
|
+
}
|
|
1708
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1709
|
+
/** Data for embedded Wix Bookings content. */
|
|
1710
|
+
bookingData?: BookingData;
|
|
1711
|
+
/** Data for embedded Wix Events content. */
|
|
1712
|
+
eventData?: EventData;
|
|
1713
|
+
/** The type of Wix App content being embedded. */
|
|
1714
|
+
type?: AppTypeWithLiterals;
|
|
1715
|
+
/** The ID of the embedded content. */
|
|
1716
|
+
itemId?: string | null;
|
|
1717
|
+
/** The name of the embedded content. */
|
|
1718
|
+
name?: string | null;
|
|
1719
|
+
/**
|
|
1720
|
+
* Deprecated: Use `image` instead.
|
|
1721
|
+
* @deprecated
|
|
1722
|
+
*/
|
|
1723
|
+
imageSrc?: string | null;
|
|
1724
|
+
/** The URL for the embedded content. */
|
|
1725
|
+
url?: string | null;
|
|
1726
|
+
/** An image for the embedded content. */
|
|
1727
|
+
image?: Media;
|
|
1728
|
+
/** Whether to hide the image. */
|
|
1729
|
+
hideImage?: boolean | null;
|
|
1730
|
+
/** Whether to hide the title. */
|
|
1731
|
+
hideTitle?: boolean | null;
|
|
1732
|
+
/** Whether to hide the price. */
|
|
1733
|
+
hidePrice?: boolean | null;
|
|
1734
|
+
/** Whether to hide the description (Event and Booking). */
|
|
1735
|
+
hideDescription?: boolean | null;
|
|
1736
|
+
/** Whether to hide the date and time (Event). */
|
|
1737
|
+
hideDateTime?: boolean | null;
|
|
1738
|
+
/** Whether to hide the location (Event). */
|
|
1739
|
+
hideLocation?: boolean | null;
|
|
1740
|
+
/** Whether to hide the duration (Booking). */
|
|
1741
|
+
hideDuration?: boolean | null;
|
|
1742
|
+
/** Whether to hide the button. */
|
|
1743
|
+
hideButton?: boolean | null;
|
|
1744
|
+
/** Whether to hide the ribbon. */
|
|
1745
|
+
hideRibbon?: boolean | null;
|
|
1746
|
+
/** Button styling options. */
|
|
1747
|
+
buttonStyles?: ButtonStyles;
|
|
1748
|
+
/** Image styling options. */
|
|
1749
|
+
imageStyles?: ImageStyles;
|
|
1750
|
+
/** Ribbon styling options. */
|
|
1751
|
+
ribbonStyles?: RibbonStyles;
|
|
1752
|
+
/** Card styling options. */
|
|
1753
|
+
cardStyles?: CardStyles;
|
|
1754
|
+
/** Styling for the app embed's container. */
|
|
1755
|
+
containerData?: PluginContainerData;
|
|
1756
|
+
/** Pricing data for embedded Wix App content. */
|
|
1757
|
+
pricingData?: PricingData;
|
|
1758
|
+
}
|
|
1759
|
+
/** @oneof */
|
|
1760
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1761
|
+
/** Data for embedded Wix Bookings content. */
|
|
1762
|
+
bookingData?: BookingData;
|
|
1763
|
+
/** Data for embedded Wix Events content. */
|
|
1764
|
+
eventData?: EventData;
|
|
1765
|
+
}
|
|
1766
|
+
declare enum Position {
|
|
1767
|
+
/** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1768
|
+
START = "START",
|
|
1769
|
+
/** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1770
|
+
END = "END",
|
|
1771
|
+
/** Image positioned at the top */
|
|
1772
|
+
TOP = "TOP"
|
|
1773
|
+
}
|
|
1774
|
+
/** @enumType */
|
|
1775
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
|
|
1776
|
+
declare enum AspectRatio {
|
|
1777
|
+
/** 1:1 aspect ratio */
|
|
1778
|
+
SQUARE = "SQUARE",
|
|
1779
|
+
/** 16:9 aspect ratio */
|
|
1780
|
+
RECTANGLE = "RECTANGLE"
|
|
1781
|
+
}
|
|
1782
|
+
/** @enumType */
|
|
1783
|
+
type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
|
|
1784
|
+
declare enum Resizing {
|
|
1785
|
+
/** Fill the container, may crop the image */
|
|
1786
|
+
FILL = "FILL",
|
|
1787
|
+
/** Fit the image within the container */
|
|
1788
|
+
FIT = "FIT"
|
|
1789
|
+
}
|
|
1790
|
+
/** @enumType */
|
|
1791
|
+
type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
|
|
1792
|
+
declare enum Placement {
|
|
1793
|
+
/** Ribbon placed on the image */
|
|
1794
|
+
IMAGE = "IMAGE",
|
|
1795
|
+
/** Ribbon placed on the product information */
|
|
1796
|
+
PRODUCT_INFO = "PRODUCT_INFO"
|
|
1797
|
+
}
|
|
1798
|
+
/** @enumType */
|
|
1799
|
+
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
|
1800
|
+
declare enum Type {
|
|
1801
|
+
/** Card with visible border and background */
|
|
1802
|
+
CONTAINED = "CONTAINED",
|
|
1803
|
+
/** Card without visible border */
|
|
1804
|
+
FRAMELESS = "FRAMELESS"
|
|
1805
|
+
}
|
|
1806
|
+
/** @enumType */
|
|
1807
|
+
type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
|
|
1808
|
+
declare enum Alignment {
|
|
1809
|
+
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
|
1810
|
+
START = "START",
|
|
1811
|
+
/** Content centered */
|
|
1812
|
+
CENTER = "CENTER",
|
|
1813
|
+
/** Content aligned to end (right in LTR layouts, left in RTL layouts) */
|
|
1814
|
+
END = "END"
|
|
1815
|
+
}
|
|
1816
|
+
/** @enumType */
|
|
1817
|
+
type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
|
|
1818
|
+
declare enum Layout {
|
|
1819
|
+
/** Elements stacked vertically */
|
|
1820
|
+
STACKED = "STACKED",
|
|
1821
|
+
/** Elements arranged horizontally */
|
|
1822
|
+
SIDE_BY_SIDE = "SIDE_BY_SIDE"
|
|
1823
|
+
}
|
|
1824
|
+
/** @enumType */
|
|
1825
|
+
type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
|
|
1826
|
+
declare enum AppType {
|
|
1827
|
+
PRODUCT = "PRODUCT",
|
|
1828
|
+
EVENT = "EVENT",
|
|
1829
|
+
BOOKING = "BOOKING"
|
|
1830
|
+
}
|
|
1831
|
+
/** @enumType */
|
|
1832
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1833
|
+
interface BookingData {
|
|
1834
|
+
/** Booking duration in minutes. */
|
|
1835
|
+
durations?: string | null;
|
|
1836
|
+
}
|
|
1837
|
+
interface EventData {
|
|
1838
|
+
/** Event schedule. */
|
|
1839
|
+
scheduling?: string | null;
|
|
1840
|
+
/** Event location. */
|
|
1841
|
+
location?: string | null;
|
|
1842
|
+
}
|
|
1843
|
+
interface ButtonStyles {
|
|
1844
|
+
/** Text to display on the button. */
|
|
1845
|
+
buttonText?: string | null;
|
|
1846
|
+
/** Border width in pixels. */
|
|
1847
|
+
borderWidth?: number | null;
|
|
1848
|
+
/** Border radius in pixels. */
|
|
1849
|
+
borderRadius?: number | null;
|
|
1850
|
+
/**
|
|
1851
|
+
* Border color as a hexadecimal value.
|
|
1852
|
+
* @format COLOR_HEX
|
|
1853
|
+
*/
|
|
1854
|
+
borderColor?: string | null;
|
|
1855
|
+
/**
|
|
1856
|
+
* Text color as a hexadecimal value.
|
|
1857
|
+
* @format COLOR_HEX
|
|
1858
|
+
*/
|
|
1859
|
+
textColor?: string | null;
|
|
1860
|
+
/**
|
|
1861
|
+
* Background color as a hexadecimal value.
|
|
1862
|
+
* @format COLOR_HEX
|
|
1863
|
+
*/
|
|
1864
|
+
backgroundColor?: string | null;
|
|
1865
|
+
/**
|
|
1866
|
+
* Border color as a hexadecimal value (hover state).
|
|
1867
|
+
* @format COLOR_HEX
|
|
1868
|
+
*/
|
|
1869
|
+
borderColorHover?: string | null;
|
|
1870
|
+
/**
|
|
1871
|
+
* Text color as a hexadecimal value (hover state).
|
|
1872
|
+
* @format COLOR_HEX
|
|
1873
|
+
*/
|
|
1874
|
+
textColorHover?: string | null;
|
|
1875
|
+
/**
|
|
1876
|
+
* Background color as a hexadecimal value (hover state).
|
|
1877
|
+
* @format COLOR_HEX
|
|
1878
|
+
*/
|
|
1879
|
+
backgroundColorHover?: string | null;
|
|
1880
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1881
|
+
buttonSize?: string | null;
|
|
1882
|
+
}
|
|
1883
|
+
interface ImageStyles {
|
|
1884
|
+
/** Whether to hide the image. */
|
|
1885
|
+
hideImage?: boolean | null;
|
|
1886
|
+
/** Position of image. Defaults to `START`. */
|
|
1887
|
+
imagePosition?: PositionWithLiterals;
|
|
1888
|
+
/** Aspect ratio for the image. Defaults to `SQUARE`. */
|
|
1889
|
+
aspectRatio?: AspectRatioWithLiterals;
|
|
1890
|
+
/** How the image should be resized. Defaults to `FILL`. */
|
|
1891
|
+
resizing?: ResizingWithLiterals;
|
|
1892
|
+
/**
|
|
1893
|
+
* Image border color as a hexadecimal value.
|
|
1894
|
+
* @format COLOR_HEX
|
|
1895
|
+
*/
|
|
1896
|
+
borderColor?: string | null;
|
|
1897
|
+
/** Image border width in pixels. */
|
|
1898
|
+
borderWidth?: number | null;
|
|
1899
|
+
/** Image border radius in pixels. */
|
|
1900
|
+
borderRadius?: number | null;
|
|
1901
|
+
}
|
|
1902
|
+
interface RibbonStyles {
|
|
1903
|
+
/** Text to display on the ribbon. */
|
|
1904
|
+
ribbonText?: string | null;
|
|
1905
|
+
/**
|
|
1906
|
+
* Ribbon background color as a hexadecimal value.
|
|
1907
|
+
* @format COLOR_HEX
|
|
1908
|
+
*/
|
|
1909
|
+
backgroundColor?: string | null;
|
|
1910
|
+
/**
|
|
1911
|
+
* Ribbon text color as a hexadecimal value.
|
|
1912
|
+
* @format COLOR_HEX
|
|
1913
|
+
*/
|
|
1914
|
+
textColor?: string | null;
|
|
1915
|
+
/**
|
|
1916
|
+
* Ribbon border color as a hexadecimal value.
|
|
1917
|
+
* @format COLOR_HEX
|
|
1918
|
+
*/
|
|
1919
|
+
borderColor?: string | null;
|
|
1920
|
+
/** Ribbon border width in pixels. */
|
|
1921
|
+
borderWidth?: number | null;
|
|
1922
|
+
/** Ribbon border radius in pixels. */
|
|
1923
|
+
borderRadius?: number | null;
|
|
1924
|
+
/** Placement of the ribbon. Defaults to `IMAGE`. */
|
|
1925
|
+
ribbonPlacement?: PlacementWithLiterals;
|
|
1926
|
+
}
|
|
1927
|
+
interface CardStyles {
|
|
1928
|
+
/**
|
|
1929
|
+
* Card background color as a hexadecimal value.
|
|
1930
|
+
* @format COLOR_HEX
|
|
1931
|
+
*/
|
|
1932
|
+
backgroundColor?: string | null;
|
|
1933
|
+
/**
|
|
1934
|
+
* Card border color as a hexadecimal value.
|
|
1935
|
+
* @format COLOR_HEX
|
|
1936
|
+
*/
|
|
1937
|
+
borderColor?: string | null;
|
|
1938
|
+
/** Card border width in pixels. */
|
|
1939
|
+
borderWidth?: number | null;
|
|
1940
|
+
/** Card border radius in pixels. */
|
|
1941
|
+
borderRadius?: number | null;
|
|
1942
|
+
/** Card type. Defaults to `CONTAINED`. */
|
|
1943
|
+
type?: TypeWithLiterals;
|
|
1944
|
+
/** Content alignment. Defaults to `START`. */
|
|
1945
|
+
alignment?: AlignmentWithLiterals;
|
|
1946
|
+
/** Layout for title and price. Defaults to `STACKED`. */
|
|
1947
|
+
titlePriceLayout?: LayoutWithLiterals;
|
|
1948
|
+
/**
|
|
1949
|
+
* Title text color as a hexadecimal value.
|
|
1950
|
+
* @format COLOR_HEX
|
|
1951
|
+
*/
|
|
1952
|
+
titleColor?: string | null;
|
|
1953
|
+
/**
|
|
1954
|
+
* Text color as a hexadecimal value.
|
|
1955
|
+
* @format COLOR_HEX
|
|
1956
|
+
*/
|
|
1957
|
+
textColor?: string | null;
|
|
1958
|
+
}
|
|
1959
|
+
interface PricingData {
|
|
1960
|
+
/**
|
|
1961
|
+
* Minimum numeric price value as string (e.g., "10.99").
|
|
1962
|
+
* @decimalValue options { maxScale:2 }
|
|
1963
|
+
*/
|
|
1964
|
+
valueFrom?: string | null;
|
|
1965
|
+
/**
|
|
1966
|
+
* Maximum numeric price value as string (e.g., "19.99").
|
|
1967
|
+
* @decimalValue options { maxScale:2 }
|
|
1968
|
+
*/
|
|
1969
|
+
valueTo?: string | null;
|
|
1970
|
+
/**
|
|
1971
|
+
* Numeric price value as string after discount application (e.g., "15.99").
|
|
1972
|
+
* @decimalValue options { maxScale:2 }
|
|
1973
|
+
*/
|
|
1974
|
+
discountedValue?: string | null;
|
|
1975
|
+
/**
|
|
1976
|
+
* Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
|
|
1977
|
+
* @format CURRENCY
|
|
1978
|
+
*/
|
|
1979
|
+
currency?: string | null;
|
|
1980
|
+
/**
|
|
1981
|
+
* Pricing plan ID.
|
|
1982
|
+
* @format GUID
|
|
1983
|
+
*/
|
|
1984
|
+
pricingPlanId?: string | null;
|
|
1985
|
+
}
|
|
1986
|
+
interface VideoData {
|
|
1987
|
+
/** Styling for the video's container. */
|
|
1988
|
+
containerData?: PluginContainerData;
|
|
1989
|
+
/** Video details. */
|
|
1990
|
+
video?: Media;
|
|
1991
|
+
/** Video thumbnail details. */
|
|
1992
|
+
thumbnail?: Media;
|
|
1993
|
+
/** Sets whether the video's download button is disabled. Defaults to `false`. */
|
|
1994
|
+
disableDownload?: boolean | null;
|
|
1995
|
+
/** Video title. */
|
|
1996
|
+
title?: string | null;
|
|
1997
|
+
/** Video options. */
|
|
1998
|
+
options?: PlaybackOptions;
|
|
1999
|
+
}
|
|
2000
|
+
interface PlaybackOptions {
|
|
2001
|
+
/** Sets whether the media will automatically start playing. */
|
|
2002
|
+
autoPlay?: boolean | null;
|
|
2003
|
+
/** Sets whether media's will be looped. */
|
|
2004
|
+
playInLoop?: boolean | null;
|
|
2005
|
+
/** Sets whether media's controls will be shown. */
|
|
2006
|
+
showControls?: boolean | null;
|
|
2007
|
+
}
|
|
2008
|
+
interface EmbedData {
|
|
2009
|
+
/** Styling for the oEmbed node's container. */
|
|
2010
|
+
containerData?: PluginContainerData;
|
|
2011
|
+
/** An [oEmbed](https://www.oembed.com) object. */
|
|
2012
|
+
oembed?: Oembed;
|
|
2013
|
+
/** Origin asset source. */
|
|
2014
|
+
src?: string | null;
|
|
2015
|
+
}
|
|
2016
|
+
interface Oembed {
|
|
2017
|
+
/** The resource type. */
|
|
2018
|
+
type?: string | null;
|
|
2019
|
+
/** The width of the resource specified in the `url` property in pixels. */
|
|
2020
|
+
width?: number | null;
|
|
2021
|
+
/** The height of the resource specified in the `url` property in pixels. */
|
|
2022
|
+
height?: number | null;
|
|
2023
|
+
/** Resource title. */
|
|
2024
|
+
title?: string | null;
|
|
2025
|
+
/** The source URL for the resource. */
|
|
2026
|
+
url?: string | null;
|
|
2027
|
+
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
2028
|
+
html?: string | null;
|
|
2029
|
+
/** The name of the author or owner of the resource. */
|
|
2030
|
+
authorName?: string | null;
|
|
2031
|
+
/** The URL for the author or owner of the resource. */
|
|
2032
|
+
authorUrl?: string | null;
|
|
2033
|
+
/** The name of the resource provider. */
|
|
2034
|
+
providerName?: string | null;
|
|
2035
|
+
/** The URL for the resource provider. */
|
|
2036
|
+
providerUrl?: string | null;
|
|
2037
|
+
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
2038
|
+
thumbnailUrl?: string | null;
|
|
2039
|
+
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
2040
|
+
thumbnailWidth?: string | null;
|
|
2041
|
+
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
2042
|
+
thumbnailHeight?: string | null;
|
|
2043
|
+
/** The URL for an embedded viedo. */
|
|
2044
|
+
videoUrl?: string | null;
|
|
2045
|
+
/** The oEmbed version number. This value must be `1.0`. */
|
|
2046
|
+
version?: string | null;
|
|
2047
|
+
}
|
|
2048
|
+
interface CollapsibleListData {
|
|
2049
|
+
/** Styling for the collapsible list's container. */
|
|
2050
|
+
containerData?: PluginContainerData;
|
|
2051
|
+
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2052
|
+
expandOnlyOne?: boolean | null;
|
|
2053
|
+
/** Sets which items are expanded when the page loads. */
|
|
2054
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2055
|
+
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2056
|
+
direction?: DirectionWithLiterals;
|
|
2057
|
+
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2058
|
+
isQapageData?: boolean | null;
|
|
2059
|
+
}
|
|
2060
|
+
declare enum InitialExpandedItems {
|
|
2061
|
+
/** First item will be expended initally */
|
|
2062
|
+
FIRST = "FIRST",
|
|
2063
|
+
/** All items will expended initally */
|
|
2064
|
+
ALL = "ALL",
|
|
2065
|
+
/** All items collapsed initally */
|
|
2066
|
+
NONE = "NONE"
|
|
2067
|
+
}
|
|
2068
|
+
/** @enumType */
|
|
2069
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2070
|
+
declare enum Direction {
|
|
2071
|
+
/** Left-to-right */
|
|
2072
|
+
LTR = "LTR",
|
|
2073
|
+
/** Right-to-left */
|
|
2074
|
+
RTL = "RTL"
|
|
2075
|
+
}
|
|
2076
|
+
/** @enumType */
|
|
2077
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2078
|
+
interface TableData {
|
|
2079
|
+
/** Styling for the table's container. */
|
|
2080
|
+
containerData?: PluginContainerData;
|
|
2081
|
+
/** The table's dimensions. */
|
|
2082
|
+
dimensions?: Dimensions;
|
|
2083
|
+
/**
|
|
2084
|
+
* Deprecated: Use `rowHeader` and `columnHeader` instead.
|
|
2085
|
+
* @deprecated
|
|
2086
|
+
*/
|
|
2087
|
+
header?: boolean | null;
|
|
2088
|
+
/** Sets whether the table's first row is a header. Defaults to `false`. */
|
|
2089
|
+
rowHeader?: boolean | null;
|
|
2090
|
+
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2091
|
+
columnHeader?: boolean | null;
|
|
2092
|
+
}
|
|
2093
|
+
interface Dimensions {
|
|
2094
|
+
/** An array representing relative width of each column in relation to the other columns. */
|
|
2095
|
+
colsWidthRatio?: number[];
|
|
2096
|
+
/** An array representing the height of each row in pixels. */
|
|
2097
|
+
rowsHeight?: number[];
|
|
2098
|
+
/** An array representing the minimum width of each column in pixels. */
|
|
2099
|
+
colsMinWidth?: number[];
|
|
2100
|
+
}
|
|
2101
|
+
interface TableCellData {
|
|
2102
|
+
/** Styling for the cell's background color and text alignment. */
|
|
2103
|
+
cellStyle?: CellStyle;
|
|
2104
|
+
/** The cell's border colors. */
|
|
2105
|
+
borderColors?: BorderColors;
|
|
2106
|
+
}
|
|
2107
|
+
declare enum VerticalAlignment {
|
|
2108
|
+
/** Top alignment */
|
|
2109
|
+
TOP = "TOP",
|
|
2110
|
+
/** Middle alignment */
|
|
2111
|
+
MIDDLE = "MIDDLE",
|
|
2112
|
+
/** Bottom alignment */
|
|
2113
|
+
BOTTOM = "BOTTOM"
|
|
2114
|
+
}
|
|
2115
|
+
/** @enumType */
|
|
2116
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2117
|
+
interface CellStyle {
|
|
2118
|
+
/** Vertical alignment for the cell's text. */
|
|
2119
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2120
|
+
/**
|
|
2121
|
+
* Cell background color as a hexadecimal value.
|
|
2122
|
+
* @format COLOR_HEX
|
|
2123
|
+
*/
|
|
2124
|
+
backgroundColor?: string | null;
|
|
2125
|
+
}
|
|
2126
|
+
interface BorderColors {
|
|
2127
|
+
/**
|
|
2128
|
+
* Left border color as a hexadecimal value.
|
|
2129
|
+
* @format COLOR_HEX
|
|
2130
|
+
*/
|
|
2131
|
+
left?: string | null;
|
|
2132
|
+
/**
|
|
2133
|
+
* Right border color as a hexadecimal value.
|
|
2134
|
+
* @format COLOR_HEX
|
|
2135
|
+
*/
|
|
2136
|
+
right?: string | null;
|
|
2137
|
+
/**
|
|
2138
|
+
* Top border color as a hexadecimal value.
|
|
2139
|
+
* @format COLOR_HEX
|
|
2140
|
+
*/
|
|
2141
|
+
top?: string | null;
|
|
2142
|
+
/**
|
|
2143
|
+
* Bottom border color as a hexadecimal value.
|
|
2144
|
+
* @format COLOR_HEX
|
|
2145
|
+
*/
|
|
2146
|
+
bottom?: string | null;
|
|
2147
|
+
}
|
|
2148
|
+
/**
|
|
2149
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
2150
|
+
* `Value` type union.
|
|
2151
|
+
*
|
|
2152
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
|
2153
|
+
*/
|
|
2154
|
+
declare enum NullValue {
|
|
2155
|
+
/** Null value. */
|
|
2156
|
+
NULL_VALUE = "NULL_VALUE"
|
|
2157
|
+
}
|
|
2158
|
+
/** @enumType */
|
|
2159
|
+
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2160
|
+
/**
|
|
2161
|
+
* `ListValue` is a wrapper around a repeated field of values.
|
|
2162
|
+
*
|
|
2163
|
+
* The JSON representation for `ListValue` is JSON array.
|
|
2164
|
+
*/
|
|
2165
|
+
interface ListValue {
|
|
2166
|
+
/** Repeated field of dynamically typed values. */
|
|
2167
|
+
values?: any[];
|
|
2168
|
+
}
|
|
2169
|
+
interface AudioData {
|
|
2170
|
+
/** Styling for the audio node's container. */
|
|
2171
|
+
containerData?: PluginContainerData;
|
|
2172
|
+
/** Audio file details. */
|
|
2173
|
+
audio?: Media;
|
|
2174
|
+
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
|
|
2175
|
+
disableDownload?: boolean | null;
|
|
2176
|
+
/** Cover image. */
|
|
2177
|
+
coverImage?: Media;
|
|
2178
|
+
/** Track name. */
|
|
2179
|
+
name?: string | null;
|
|
2180
|
+
/** Author name. */
|
|
2181
|
+
authorName?: string | null;
|
|
2182
|
+
/** An HTML version of the audio node. */
|
|
2183
|
+
html?: string | null;
|
|
2184
|
+
}
|
|
2185
|
+
interface OrderedListData {
|
|
2186
|
+
/** Indentation level from 0-4. */
|
|
2187
|
+
indentation?: number;
|
|
2188
|
+
/** Offset level from 0-4. */
|
|
2189
|
+
offset?: number | null;
|
|
2190
|
+
/** List start number. */
|
|
2191
|
+
start?: number | null;
|
|
2192
|
+
}
|
|
2193
|
+
interface BulletedListData {
|
|
2194
|
+
/** Indentation level from 0-4. */
|
|
2195
|
+
indentation?: number;
|
|
2196
|
+
/** Offset level from 0-4. */
|
|
2197
|
+
offset?: number | null;
|
|
2198
|
+
}
|
|
2199
|
+
interface BlockquoteData {
|
|
2200
|
+
/** Indentation level from 1-4. */
|
|
2201
|
+
indentation?: number;
|
|
2202
|
+
}
|
|
2203
|
+
interface CaptionData {
|
|
2204
|
+
textStyle?: V1TextStyle;
|
|
2205
|
+
}
|
|
2206
|
+
interface LayoutCellData {
|
|
2207
|
+
/** Size of the cell in 12 columns grid. */
|
|
2208
|
+
colSpan?: number | null;
|
|
2209
|
+
}
|
|
2210
|
+
interface Metadata {
|
|
2211
|
+
/** Schema version. */
|
|
2212
|
+
version?: number;
|
|
2213
|
+
/**
|
|
2214
|
+
* When the object was created.
|
|
2215
|
+
* @readonly
|
|
2216
|
+
* @deprecated
|
|
2217
|
+
*/
|
|
2218
|
+
createdTimestamp?: Date | null;
|
|
2219
|
+
/**
|
|
2220
|
+
* When the object was most recently updated.
|
|
2221
|
+
* @deprecated
|
|
2222
|
+
*/
|
|
2223
|
+
updatedTimestamp?: Date | null;
|
|
2224
|
+
/** Object ID. */
|
|
2225
|
+
_id?: string | null;
|
|
2226
|
+
}
|
|
2227
|
+
interface DocumentStyle {
|
|
2228
|
+
/** Styling for H1 nodes. */
|
|
2229
|
+
headerOne?: TextNodeStyle;
|
|
2230
|
+
/** Styling for H2 nodes. */
|
|
2231
|
+
headerTwo?: TextNodeStyle;
|
|
2232
|
+
/** Styling for H3 nodes. */
|
|
2233
|
+
headerThree?: TextNodeStyle;
|
|
2234
|
+
/** Styling for H4 nodes. */
|
|
2235
|
+
headerFour?: TextNodeStyle;
|
|
2236
|
+
/** Styling for H5 nodes. */
|
|
2237
|
+
headerFive?: TextNodeStyle;
|
|
2238
|
+
/** Styling for H6 nodes. */
|
|
2239
|
+
headerSix?: TextNodeStyle;
|
|
2240
|
+
/** Styling for paragraph nodes. */
|
|
2241
|
+
paragraph?: TextNodeStyle;
|
|
2242
|
+
/** Styling for block quote nodes. */
|
|
2243
|
+
blockquote?: TextNodeStyle;
|
|
2244
|
+
/** Styling for code block nodes. */
|
|
2245
|
+
codeBlock?: TextNodeStyle;
|
|
2246
|
+
}
|
|
2247
|
+
interface TextNodeStyle {
|
|
2248
|
+
/** The decorations to apply to the node. */
|
|
2249
|
+
decorations?: Decoration[];
|
|
2250
|
+
/** Padding and background color for the node. */
|
|
2251
|
+
nodeStyle?: NodeStyle;
|
|
2252
|
+
/** Line height for text in the node. */
|
|
2253
|
+
lineHeight?: string | null;
|
|
2254
|
+
}
|
|
2255
|
+
interface CreateContentRequest {
|
|
2256
|
+
/** Content to be created. */
|
|
2257
|
+
content?: Content;
|
|
2258
|
+
}
|
|
2259
|
+
interface CreateContentResponse {
|
|
2260
|
+
/** The created Content. */
|
|
2261
|
+
content?: Content;
|
|
2262
|
+
}
|
|
2263
|
+
interface GetContentRequest {
|
|
2264
|
+
/**
|
|
2265
|
+
* ID of the Content to retrieve.
|
|
2266
|
+
* @format GUID
|
|
2267
|
+
*/
|
|
2268
|
+
contentId: string;
|
|
2269
|
+
}
|
|
2270
|
+
interface GetContentResponse {
|
|
2271
|
+
/** The requested Content. */
|
|
2272
|
+
content?: Content;
|
|
2273
|
+
}
|
|
2274
|
+
interface SubmitContentRequest {
|
|
2275
|
+
/**
|
|
2276
|
+
* The ID of the Content which is being submitted
|
|
2277
|
+
* @format GUID
|
|
2278
|
+
*/
|
|
2279
|
+
contentId: string;
|
|
2280
|
+
/** The revision of the content */
|
|
2281
|
+
revision: string | null;
|
|
2282
|
+
/** The Design settings to submit */
|
|
2283
|
+
design: Design;
|
|
2284
|
+
/** The RichContent to submit */
|
|
2285
|
+
richContent: RichContent;
|
|
2286
|
+
/** Create new content instead of updating existing one, even when it is viable */
|
|
2287
|
+
forceCreate?: boolean | null;
|
|
2288
|
+
}
|
|
2289
|
+
interface SubmitContentResponse {
|
|
2290
|
+
/** The updated Content. */
|
|
2291
|
+
content?: Content;
|
|
2292
|
+
}
|
|
2293
|
+
interface GetLatestContentByPageIdRequest {
|
|
2294
|
+
/**
|
|
2295
|
+
* ID of the QuickPage page to retrieve the latest Content for.
|
|
2296
|
+
* @format GUID
|
|
2297
|
+
*/
|
|
2298
|
+
pageId: string;
|
|
2299
|
+
}
|
|
2300
|
+
interface GetLatestContentByPageIdResponse {
|
|
2301
|
+
/** The requested Content. */
|
|
2302
|
+
content?: Content;
|
|
2303
|
+
}
|
|
2304
|
+
interface LockLatestContentByPageIdRequest {
|
|
2305
|
+
/**
|
|
2306
|
+
* ID of the QuickPage page to lock the latest Content for.
|
|
2307
|
+
* @format GUID
|
|
2308
|
+
*/
|
|
2309
|
+
pageId: string;
|
|
2310
|
+
}
|
|
2311
|
+
interface LockLatestContentByPageIdResponse {
|
|
2312
|
+
/** The locked Content. */
|
|
2313
|
+
content?: Content;
|
|
2314
|
+
}
|
|
2315
|
+
interface QueryContentsRequest {
|
|
2316
|
+
/** WQL expression. */
|
|
2317
|
+
query?: CursorQuery;
|
|
2318
|
+
}
|
|
2319
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2320
|
+
/** 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`. */
|
|
2321
|
+
cursorPaging?: CursorPaging;
|
|
2322
|
+
/**
|
|
2323
|
+
* Filter object in the following format:
|
|
2324
|
+
* `"filter" : {
|
|
2325
|
+
* "fieldName1": "value1",
|
|
2326
|
+
* "fieldName2":{"$operator":"value2"}
|
|
2327
|
+
* }`
|
|
2328
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
2329
|
+
*/
|
|
2330
|
+
filter?: Record<string, any> | null;
|
|
2331
|
+
/**
|
|
2332
|
+
* Sort object in the following format:
|
|
2333
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2334
|
+
* @maxSize 5
|
|
2335
|
+
*/
|
|
2336
|
+
sort?: Sorting[];
|
|
2337
|
+
}
|
|
2338
|
+
/** @oneof */
|
|
2339
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2340
|
+
/** 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`. */
|
|
2341
|
+
cursorPaging?: CursorPaging;
|
|
2342
|
+
}
|
|
2343
|
+
interface Sorting {
|
|
2344
|
+
/**
|
|
2345
|
+
* Name of the field to sort by.
|
|
2346
|
+
* @maxLength 512
|
|
2347
|
+
*/
|
|
2348
|
+
fieldName?: string;
|
|
2349
|
+
/** Sort order. */
|
|
2350
|
+
order?: SortOrderWithLiterals;
|
|
2351
|
+
}
|
|
2352
|
+
declare enum SortOrder {
|
|
2353
|
+
ASC = "ASC",
|
|
2354
|
+
DESC = "DESC"
|
|
2355
|
+
}
|
|
2356
|
+
/** @enumType */
|
|
2357
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2358
|
+
interface CursorPaging {
|
|
2359
|
+
/**
|
|
2360
|
+
* Maximum number of items to return in the results.
|
|
2361
|
+
* @max 100
|
|
2362
|
+
*/
|
|
2363
|
+
limit?: number | null;
|
|
2364
|
+
/**
|
|
2365
|
+
* Pointer to the next or previous page in the list of results.
|
|
2366
|
+
*
|
|
2367
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2368
|
+
* Not relevant for the first request.
|
|
2369
|
+
* @maxLength 16000
|
|
2370
|
+
*/
|
|
2371
|
+
cursor?: string | null;
|
|
2372
|
+
}
|
|
2373
|
+
interface QueryContentsResponse {
|
|
2374
|
+
/** List of Contents. */
|
|
2375
|
+
contents?: Content[];
|
|
2376
|
+
/** Paging metadata */
|
|
2377
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
2378
|
+
}
|
|
2379
|
+
interface CursorPagingMetadata {
|
|
2380
|
+
/** Number of items returned in the response. */
|
|
2381
|
+
count?: number | null;
|
|
2382
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
2383
|
+
cursors?: Cursors;
|
|
2384
|
+
/**
|
|
2385
|
+
* Whether there are more pages to retrieve following the current page.
|
|
2386
|
+
*
|
|
2387
|
+
* + `true`: Another page of results can be retrieved.
|
|
2388
|
+
* + `false`: This is the last page.
|
|
2389
|
+
*/
|
|
2390
|
+
hasNext?: boolean | null;
|
|
2391
|
+
}
|
|
2392
|
+
interface Cursors {
|
|
2393
|
+
/**
|
|
2394
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2395
|
+
* @maxLength 16000
|
|
2396
|
+
*/
|
|
2397
|
+
next?: string | null;
|
|
2398
|
+
/**
|
|
2399
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2400
|
+
* @maxLength 16000
|
|
2401
|
+
*/
|
|
2402
|
+
prev?: string | null;
|
|
2403
|
+
}
|
|
2404
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2405
|
+
createdEvent?: EntityCreatedEvent;
|
|
2406
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2407
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2408
|
+
actionEvent?: ActionEvent;
|
|
2409
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2410
|
+
_id?: string;
|
|
2411
|
+
/**
|
|
2412
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2413
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2414
|
+
*/
|
|
2415
|
+
entityFqdn?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2418
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2419
|
+
*/
|
|
2420
|
+
slug?: string;
|
|
2421
|
+
/** ID of the entity associated with the event. */
|
|
2422
|
+
entityId?: string;
|
|
2423
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2424
|
+
eventTime?: Date | null;
|
|
2425
|
+
/**
|
|
2426
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2427
|
+
* (for example, GDPR).
|
|
2428
|
+
*/
|
|
2429
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2430
|
+
/** If present, indicates the action that triggered the event. */
|
|
2431
|
+
originatedFrom?: string | null;
|
|
2432
|
+
/**
|
|
2433
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
2434
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2435
|
+
*/
|
|
2436
|
+
entityEventSequence?: string | null;
|
|
2437
|
+
}
|
|
2438
|
+
/** @oneof */
|
|
2439
|
+
interface DomainEventBodyOneOf {
|
|
2440
|
+
createdEvent?: EntityCreatedEvent;
|
|
2441
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2442
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2443
|
+
actionEvent?: ActionEvent;
|
|
2444
|
+
}
|
|
2445
|
+
interface EntityCreatedEvent {
|
|
2446
|
+
entity?: string;
|
|
2447
|
+
}
|
|
2448
|
+
interface RestoreInfo {
|
|
2449
|
+
deletedDate?: Date | null;
|
|
2450
|
+
}
|
|
2451
|
+
interface EntityUpdatedEvent {
|
|
2452
|
+
/**
|
|
2453
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2454
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2455
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2456
|
+
*/
|
|
2457
|
+
currentEntity?: string;
|
|
2458
|
+
}
|
|
2459
|
+
interface EntityDeletedEvent {
|
|
2460
|
+
/** Entity that was deleted. */
|
|
2461
|
+
deletedEntity?: string | null;
|
|
2462
|
+
}
|
|
2463
|
+
interface ActionEvent {
|
|
2464
|
+
body?: string;
|
|
2465
|
+
}
|
|
2466
|
+
interface Empty {
|
|
2467
|
+
}
|
|
2468
|
+
interface MessageEnvelope {
|
|
2469
|
+
/**
|
|
2470
|
+
* App instance ID.
|
|
2471
|
+
* @format GUID
|
|
2472
|
+
*/
|
|
2473
|
+
instanceId?: string | null;
|
|
2474
|
+
/**
|
|
2475
|
+
* Event type.
|
|
2476
|
+
* @maxLength 150
|
|
2477
|
+
*/
|
|
2478
|
+
eventType?: string;
|
|
2479
|
+
/** The identification type and identity data. */
|
|
2480
|
+
identity?: IdentificationData;
|
|
2481
|
+
/** Stringify payload. */
|
|
2482
|
+
data?: string;
|
|
2483
|
+
}
|
|
2484
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2485
|
+
/**
|
|
2486
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2487
|
+
* @format GUID
|
|
2488
|
+
*/
|
|
2489
|
+
anonymousVisitorId?: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* ID of a site visitor that has logged in to the site.
|
|
2492
|
+
* @format GUID
|
|
2493
|
+
*/
|
|
2494
|
+
memberId?: string;
|
|
2495
|
+
/**
|
|
2496
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2497
|
+
* @format GUID
|
|
2498
|
+
*/
|
|
2499
|
+
wixUserId?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* ID of an app.
|
|
2502
|
+
* @format GUID
|
|
2503
|
+
*/
|
|
2504
|
+
appId?: string;
|
|
2505
|
+
/** @readonly */
|
|
2506
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2507
|
+
}
|
|
2508
|
+
/** @oneof */
|
|
2509
|
+
interface IdentificationDataIdOneOf {
|
|
2510
|
+
/**
|
|
2511
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2512
|
+
* @format GUID
|
|
2513
|
+
*/
|
|
2514
|
+
anonymousVisitorId?: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* ID of a site visitor that has logged in to the site.
|
|
2517
|
+
* @format GUID
|
|
2518
|
+
*/
|
|
2519
|
+
memberId?: string;
|
|
2520
|
+
/**
|
|
2521
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2522
|
+
* @format GUID
|
|
2523
|
+
*/
|
|
2524
|
+
wixUserId?: string;
|
|
2525
|
+
/**
|
|
2526
|
+
* ID of an app.
|
|
2527
|
+
* @format GUID
|
|
2528
|
+
*/
|
|
2529
|
+
appId?: string;
|
|
2530
|
+
}
|
|
2531
|
+
declare enum WebhookIdentityType {
|
|
2532
|
+
UNKNOWN = "UNKNOWN",
|
|
2533
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2534
|
+
MEMBER = "MEMBER",
|
|
2535
|
+
WIX_USER = "WIX_USER",
|
|
2536
|
+
APP = "APP"
|
|
2537
|
+
}
|
|
2538
|
+
/** @enumType */
|
|
2539
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2540
|
+
interface SubmitContentOptions {
|
|
2541
|
+
/** The revision of the content */
|
|
2542
|
+
revision: string | null;
|
|
2543
|
+
/** The Design settings to submit */
|
|
2544
|
+
design: Design;
|
|
2545
|
+
/** The RichContent to submit */
|
|
2546
|
+
richContent: RichContent;
|
|
2547
|
+
/** Create new content instead of updating existing one, even when it is viable */
|
|
2548
|
+
forceCreate?: boolean | null;
|
|
2549
|
+
}
|
|
2550
|
+
interface QueryCursorResult {
|
|
2551
|
+
cursors: Cursors;
|
|
2552
|
+
hasNext: () => boolean;
|
|
2553
|
+
hasPrev: () => boolean;
|
|
2554
|
+
length: number;
|
|
2555
|
+
pageSize: number;
|
|
2556
|
+
}
|
|
2557
|
+
interface ContentsQueryResult extends QueryCursorResult {
|
|
2558
|
+
items: Content[];
|
|
2559
|
+
query: ContentsQueryBuilder;
|
|
2560
|
+
next: () => Promise<ContentsQueryResult>;
|
|
2561
|
+
prev: () => Promise<ContentsQueryResult>;
|
|
2562
|
+
}
|
|
2563
|
+
interface ContentsQueryBuilder {
|
|
2564
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2565
|
+
* @param value - Value to compare against.
|
|
2566
|
+
* @documentationMaturity preview
|
|
2567
|
+
*/
|
|
2568
|
+
eq: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2569
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2570
|
+
* @param value - Value to compare against.
|
|
2571
|
+
* @documentationMaturity preview
|
|
2572
|
+
*/
|
|
2573
|
+
ne: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2574
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2575
|
+
* @param value - Value to compare against.
|
|
2576
|
+
* @documentationMaturity preview
|
|
2577
|
+
*/
|
|
2578
|
+
ge: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2579
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2580
|
+
* @param value - Value to compare against.
|
|
2581
|
+
* @documentationMaturity preview
|
|
2582
|
+
*/
|
|
2583
|
+
gt: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2584
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2585
|
+
* @param value - Value to compare against.
|
|
2586
|
+
* @documentationMaturity preview
|
|
2587
|
+
*/
|
|
2588
|
+
le: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2589
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2590
|
+
* @param value - Value to compare against.
|
|
2591
|
+
* @documentationMaturity preview
|
|
2592
|
+
*/
|
|
2593
|
+
lt: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2594
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
2595
|
+
* @param string - String to compare against. Case-insensitive.
|
|
2596
|
+
* @documentationMaturity preview
|
|
2597
|
+
*/
|
|
2598
|
+
startsWith: (propertyName: '_id' | 'pageId', value: string) => ContentsQueryBuilder;
|
|
2599
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2600
|
+
* @param values - List of values to compare against.
|
|
2601
|
+
* @documentationMaturity preview
|
|
2602
|
+
*/
|
|
2603
|
+
hasSome: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any[]) => ContentsQueryBuilder;
|
|
2604
|
+
/** @documentationMaturity preview */
|
|
2605
|
+
in: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: any) => ContentsQueryBuilder;
|
|
2606
|
+
/** @documentationMaturity preview */
|
|
2607
|
+
exists: (propertyName: '_id' | 'pageId' | '_createdDate' | 'lastEditedDate', value: boolean) => ContentsQueryBuilder;
|
|
2608
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2609
|
+
* @documentationMaturity preview
|
|
2610
|
+
*/
|
|
2611
|
+
ascending: (...propertyNames: Array<'_id' | 'pageId' | '_createdDate' | 'lastEditedDate'>) => ContentsQueryBuilder;
|
|
2612
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2613
|
+
* @documentationMaturity preview
|
|
2614
|
+
*/
|
|
2615
|
+
descending: (...propertyNames: Array<'_id' | 'pageId' | '_createdDate' | 'lastEditedDate'>) => ContentsQueryBuilder;
|
|
2616
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
2617
|
+
* @documentationMaturity preview
|
|
2618
|
+
*/
|
|
2619
|
+
limit: (limit: number) => ContentsQueryBuilder;
|
|
2620
|
+
/** @param cursor - A pointer to specific record
|
|
2621
|
+
* @documentationMaturity preview
|
|
2622
|
+
*/
|
|
2623
|
+
skipTo: (cursor: string) => ContentsQueryBuilder;
|
|
2624
|
+
/** @documentationMaturity preview */
|
|
2625
|
+
find: () => Promise<ContentsQueryResult>;
|
|
2626
|
+
}
|
|
2627
|
+
|
|
2628
|
+
export { type AspectRatioWithLiterals as A, type ActionEvent, Alignment, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, AspectRatio, type AudioData, type BackgroundTypeWithLiterals as B, type Background, type BackgroundBackgroundTypeOptionsOneOf, type BackgroundGradient, BackgroundType, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type Button, type ButtonData, ButtonDataType, ButtonSize, type ButtonStyles, type ColorSwatchTypeWithLiterals as C, type CaptionData, type CardStyles, type CellStyle, type Center, type CodeBlockData, type CollapsibleListData, type ColorData, type ColorOptions, type ColorSwatch, type ColorSwatchColorTypeOptionsOneOf, ColorSwatchType, type Colors, type Content, type ContentsQueryBuilder, type ContentsQueryResult, type CreateContentRequest, type CreateContentResponse, Crop, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DividerDataAlignmentWithLiterals as D, type Decoration, type DecorationDataOneOf, DecorationType, type Design, type Dimensions, Direction, type DividerData, DividerDataAlignment, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type NullValueWithLiterals as E, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type FontTypeWithLiterals as F, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type GroupWithLiterals as G, type GIF, type GIFData, GIFType, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetContentRequest, type GetContentResponse, type GetLatestContentByPageIdRequest, type GetLatestContentByPageIdResponse, type Gradient, type GradientGradientTypeOptionsOneOf, type GradientStop, GradientType, Group, type SortOrderWithLiterals as H, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type Hover, type ImageScalingWithLiterals as I, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageBorder, type ImageData, type ImageDataStyles, type ImageDataStylesBorder, type ImageOptions, ImagePosition, ImageScaling, type ImageStyles, InitialExpandedItems, type Item, type ItemDataOneOf, type ItemImage, type ItemStyle, type WebhookIdentityTypeWithLiterals as J, type LineStyleWithLiterals as L, Layout, type LayoutCellData, LayoutType, LineStyle, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type LockLatestContentByPageIdRequest, type LockLatestContentByPageIdResponse, type MapTypeWithLiterals as M, type MapData, type MapSettings, MapType, type Media, type MentionData, type MessageEnvelope, type Metadata, type NodeTypeWithLiterals as N, type Node, type NodeDataOneOf, type NodeStyle, NodeType, NullValue, type OrientationWithLiterals as O, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type PluginContainerDataAlignmentWithLiterals as P, type PDFSettings, type ParagraphData, type Permissions, Placement, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataDesign, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollLayout, PollLayoutDirection, PollLayoutType, Position, type PricingData, type QueryContentsRequest, type QueryContentsResponse, type ResizingWithLiterals as R, type Rel, Resizing, type RestoreInfo, type RibbonStyles, type RichContent, type SourceWithLiterals as S, type Settings, SortOrder, type Sorting, Source, type Spoiler, type SpoilerData, type Styles, type StylesBorder, StylesPosition, type SubmitContentOptions, type SubmitContentRequest, type SubmitContentResponse, type TargetWithLiterals as T, type TableCellData, type TableData, Target, TextAlignment, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, Type, type Typography, type ViewModeWithLiterals as V, type V1TextStyle, VerticalAlignment, type Video, type VideoData, ViewMode, ViewRole, VoteRole, type WidthTypeWithLiterals as W, WebhookIdentityType, Width, WidthType, type GradientTypeWithLiterals as a, type ImagePositionWithLiterals as b, type ButtonSizeWithLiterals as c, type ButtonDataTypeWithLiterals as d, type TextAlignmentWithLiterals as e, type WidthWithLiterals as f, type LayoutTypeWithLiterals as g, type CropWithLiterals as h, type ThumbnailsAlignmentWithLiterals as i, type GIFTypeWithLiterals as j, type StylesPositionWithLiterals as k, type ViewRoleWithLiterals as l, type VoteRoleWithLiterals as m, type PollLayoutTypeWithLiterals as n, type PollLayoutDirectionWithLiterals as o, type PollDesignBackgroundTypeWithLiterals as p, type DecorationTypeWithLiterals as q, type PositionWithLiterals as r, type PlacementWithLiterals as s, type TypeWithLiterals as t, type AlignmentWithLiterals as u, type LayoutWithLiterals as v, type AppTypeWithLiterals as w, type InitialExpandedItemsWithLiterals as x, type DirectionWithLiterals as y, type VerticalAlignmentWithLiterals as z };
|