@wix/auto_sdk_multilingual_machine-translation 1.0.13 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.mts} +13 -10
- package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.ts} +13 -10
- package/build/index.js +907 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +850 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.mts} +13 -10
- package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → internal/index.d.ts} +13 -10
- package/build/internal/index.js +907 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +850 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.mts} +247 -206
- package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → internal/meta.d.ts} +247 -206
- package/build/internal/meta.js +412 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +384 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/internal/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts → multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.mts} +242 -253
- package/build/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts → internal/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.ts} +242 -253
- package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.mts} +247 -206
- package/build/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.ts} +247 -206
- package/build/meta.js +412 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +384 -0
- package/build/meta.mjs.map +1 -0
- package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts → multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.mts} +242 -253
- package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts → multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.ts} +242 -253
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -41
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -388
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -66
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -51
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -598
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -754
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -6
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -383
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -38
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -14
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -595
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -726
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -41
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -388
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -66
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -51
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -598
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -754
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -6
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -383
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -38
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -14
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -595
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -726
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* A translatable content is a unit of content to translate.
|
|
4
3
|
*
|
|
5
4
|
* Use [Machine Translate](/machine-translation/machine-translate) to translate a single unit of translatable content, or [Bulk Machine Translate](/machine-translation/bulk-machine-translate)
|
|
6
5
|
* to translate many.
|
|
7
6
|
*/
|
|
8
|
-
|
|
7
|
+
interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
9
8
|
/**
|
|
10
9
|
* Plain text.
|
|
11
10
|
* @minLength 1
|
|
@@ -26,10 +25,10 @@ export interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
|
26
25
|
*/
|
|
27
26
|
_id?: string | null;
|
|
28
27
|
/** Format of the translatable content. */
|
|
29
|
-
format?:
|
|
28
|
+
format?: FormatWithLiterals;
|
|
30
29
|
}
|
|
31
30
|
/** @oneof */
|
|
32
|
-
|
|
31
|
+
interface TranslatableContentContentOneOf {
|
|
33
32
|
/**
|
|
34
33
|
* Plain text.
|
|
35
34
|
* @minLength 1
|
|
@@ -45,7 +44,7 @@ export interface TranslatableContentContentOneOf {
|
|
|
45
44
|
/** Rich content. */
|
|
46
45
|
richContent?: RichContent;
|
|
47
46
|
}
|
|
48
|
-
|
|
47
|
+
declare enum Format {
|
|
49
48
|
/** Unspecified format. */
|
|
50
49
|
UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
|
|
51
50
|
/** Plain text content. */
|
|
@@ -55,7 +54,9 @@ export declare enum Format {
|
|
|
55
54
|
/** Rich Content. */
|
|
56
55
|
RICH = "RICH"
|
|
57
56
|
}
|
|
58
|
-
|
|
57
|
+
/** @enumType */
|
|
58
|
+
type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'PLAIN_TEXT' | 'HTML' | 'RICH';
|
|
59
|
+
interface RichContent {
|
|
59
60
|
/** Node objects representing a rich content document. */
|
|
60
61
|
nodes?: Node[];
|
|
61
62
|
/** Object metadata. */
|
|
@@ -63,7 +64,7 @@ export interface RichContent {
|
|
|
63
64
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
64
65
|
documentStyle?: DocumentStyle;
|
|
65
66
|
}
|
|
66
|
-
|
|
67
|
+
interface Node extends NodeDataOneOf {
|
|
67
68
|
/** Data for a button node. */
|
|
68
69
|
buttonData?: ButtonData;
|
|
69
70
|
/** Data for a code block node. */
|
|
@@ -119,7 +120,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
119
120
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
120
121
|
layoutCellData?: LayoutCellData;
|
|
121
122
|
/** 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. */
|
|
122
|
-
type?:
|
|
123
|
+
type?: NodeTypeWithLiterals;
|
|
123
124
|
/** Node ID. */
|
|
124
125
|
id?: string;
|
|
125
126
|
/** A list of child nodes. */
|
|
@@ -128,7 +129,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
128
129
|
style?: NodeStyle;
|
|
129
130
|
}
|
|
130
131
|
/** @oneof */
|
|
131
|
-
|
|
132
|
+
interface NodeDataOneOf {
|
|
132
133
|
/** Data for a button node. */
|
|
133
134
|
buttonData?: ButtonData;
|
|
134
135
|
/** Data for a code block node. */
|
|
@@ -184,7 +185,7 @@ export interface NodeDataOneOf {
|
|
|
184
185
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
185
186
|
layoutCellData?: LayoutCellData;
|
|
186
187
|
}
|
|
187
|
-
|
|
188
|
+
declare enum NodeType {
|
|
188
189
|
PARAGRAPH = "PARAGRAPH",
|
|
189
190
|
TEXT = "TEXT",
|
|
190
191
|
HEADING = "HEADING",
|
|
@@ -220,7 +221,9 @@ export declare enum NodeType {
|
|
|
220
221
|
LAYOUT = "LAYOUT",
|
|
221
222
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
222
223
|
}
|
|
223
|
-
|
|
224
|
+
/** @enumType */
|
|
225
|
+
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';
|
|
226
|
+
interface NodeStyle {
|
|
224
227
|
/** The top padding value in pixels. */
|
|
225
228
|
paddingTop?: string | null;
|
|
226
229
|
/** The bottom padding value in pixels. */
|
|
@@ -228,11 +231,11 @@ export interface NodeStyle {
|
|
|
228
231
|
/** The background color as a hexadecimal value. */
|
|
229
232
|
backgroundColor?: string | null;
|
|
230
233
|
}
|
|
231
|
-
|
|
234
|
+
interface ButtonData {
|
|
232
235
|
/** Styling for the button's container. */
|
|
233
236
|
containerData?: PluginContainerData;
|
|
234
237
|
/** The button type. */
|
|
235
|
-
type?:
|
|
238
|
+
type?: TypeWithLiterals;
|
|
236
239
|
/** Styling for the button. */
|
|
237
240
|
styles?: Styles;
|
|
238
241
|
/** The text to display on the button. */
|
|
@@ -240,7 +243,7 @@ export interface ButtonData {
|
|
|
240
243
|
/** Button link details. */
|
|
241
244
|
link?: Link;
|
|
242
245
|
}
|
|
243
|
-
|
|
246
|
+
interface Border {
|
|
244
247
|
/**
|
|
245
248
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
246
249
|
* @deprecated
|
|
@@ -252,7 +255,7 @@ export interface Border {
|
|
|
252
255
|
*/
|
|
253
256
|
radius?: number | null;
|
|
254
257
|
}
|
|
255
|
-
|
|
258
|
+
interface Colors {
|
|
256
259
|
/**
|
|
257
260
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
258
261
|
* @deprecated
|
|
@@ -269,11 +272,11 @@ export interface Colors {
|
|
|
269
272
|
*/
|
|
270
273
|
background?: string | null;
|
|
271
274
|
}
|
|
272
|
-
|
|
275
|
+
interface PluginContainerData {
|
|
273
276
|
/** The width of the node when it's displayed. */
|
|
274
277
|
width?: PluginContainerDataWidth;
|
|
275
278
|
/** The node's alignment within its container. */
|
|
276
|
-
alignment?:
|
|
279
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
277
280
|
/** Spoiler cover settings for the node. */
|
|
278
281
|
spoiler?: Spoiler;
|
|
279
282
|
/** The height of the node when it's displayed. */
|
|
@@ -281,7 +284,7 @@ export interface PluginContainerData {
|
|
|
281
284
|
/** 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`. */
|
|
282
285
|
textWrap?: boolean | null;
|
|
283
286
|
}
|
|
284
|
-
|
|
287
|
+
declare enum WidthType {
|
|
285
288
|
/** Width matches the content width */
|
|
286
289
|
CONTENT = "CONTENT",
|
|
287
290
|
/** Small Width */
|
|
@@ -291,7 +294,9 @@ export declare enum WidthType {
|
|
|
291
294
|
/** coast-to-coast display */
|
|
292
295
|
FULL_WIDTH = "FULL_WIDTH"
|
|
293
296
|
}
|
|
294
|
-
|
|
297
|
+
/** @enumType */
|
|
298
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
299
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
295
300
|
/**
|
|
296
301
|
* One of the following predefined width options:
|
|
297
302
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -299,12 +304,12 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
299
304
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
300
305
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
301
306
|
*/
|
|
302
|
-
size?:
|
|
307
|
+
size?: WidthTypeWithLiterals;
|
|
303
308
|
/** A custom width value in pixels. */
|
|
304
309
|
custom?: string | null;
|
|
305
310
|
}
|
|
306
311
|
/** @oneof */
|
|
307
|
-
|
|
312
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
308
313
|
/**
|
|
309
314
|
* One of the following predefined width options:
|
|
310
315
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -312,11 +317,11 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
312
317
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
313
318
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
314
319
|
*/
|
|
315
|
-
size?:
|
|
320
|
+
size?: WidthTypeWithLiterals;
|
|
316
321
|
/** A custom width value in pixels. */
|
|
317
322
|
custom?: string | null;
|
|
318
323
|
}
|
|
319
|
-
|
|
324
|
+
declare enum PluginContainerDataAlignment {
|
|
320
325
|
/** Center Alignment */
|
|
321
326
|
CENTER = "CENTER",
|
|
322
327
|
/** Left Alignment */
|
|
@@ -324,7 +329,9 @@ export declare enum PluginContainerDataAlignment {
|
|
|
324
329
|
/** Right Alignment */
|
|
325
330
|
RIGHT = "RIGHT"
|
|
326
331
|
}
|
|
327
|
-
|
|
332
|
+
/** @enumType */
|
|
333
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
334
|
+
interface Spoiler {
|
|
328
335
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
329
336
|
enabled?: boolean | null;
|
|
330
337
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -332,17 +339,19 @@ export interface Spoiler {
|
|
|
332
339
|
/** The text for the button used to remove the spoiler cover. */
|
|
333
340
|
buttonText?: string | null;
|
|
334
341
|
}
|
|
335
|
-
|
|
342
|
+
interface Height {
|
|
336
343
|
/** A custom height value in pixels. */
|
|
337
344
|
custom?: string | null;
|
|
338
345
|
}
|
|
339
|
-
|
|
346
|
+
declare enum Type {
|
|
340
347
|
/** Regular link button */
|
|
341
348
|
LINK = "LINK",
|
|
342
349
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
343
350
|
ACTION = "ACTION"
|
|
344
351
|
}
|
|
345
|
-
|
|
352
|
+
/** @enumType */
|
|
353
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
354
|
+
interface Styles {
|
|
346
355
|
/**
|
|
347
356
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
348
357
|
* @deprecated
|
|
@@ -395,7 +404,7 @@ export interface Styles {
|
|
|
395
404
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
396
405
|
buttonSize?: string | null;
|
|
397
406
|
}
|
|
398
|
-
|
|
407
|
+
interface Link extends LinkDataOneOf {
|
|
399
408
|
/** The absolute URL for the linked document. */
|
|
400
409
|
url?: string;
|
|
401
410
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -407,20 +416,20 @@ export interface Link extends LinkDataOneOf {
|
|
|
407
416
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
408
417
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
409
418
|
*/
|
|
410
|
-
target?:
|
|
419
|
+
target?: TargetWithLiterals;
|
|
411
420
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
412
421
|
rel?: Rel;
|
|
413
422
|
/** A serialized object used for a custom or external link panel. */
|
|
414
423
|
customData?: string | null;
|
|
415
424
|
}
|
|
416
425
|
/** @oneof */
|
|
417
|
-
|
|
426
|
+
interface LinkDataOneOf {
|
|
418
427
|
/** The absolute URL for the linked document. */
|
|
419
428
|
url?: string;
|
|
420
429
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
421
430
|
anchor?: string;
|
|
422
431
|
}
|
|
423
|
-
|
|
432
|
+
declare enum Target {
|
|
424
433
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
425
434
|
SELF = "SELF",
|
|
426
435
|
/** Opens the linked document in a new window or tab */
|
|
@@ -430,7 +439,9 @@ export declare enum Target {
|
|
|
430
439
|
/** Opens the linked document in the full body of the window */
|
|
431
440
|
TOP = "TOP"
|
|
432
441
|
}
|
|
433
|
-
|
|
442
|
+
/** @enumType */
|
|
443
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
444
|
+
interface Rel {
|
|
434
445
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
435
446
|
nofollow?: boolean | null;
|
|
436
447
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -440,17 +451,17 @@ export interface Rel {
|
|
|
440
451
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
441
452
|
noreferrer?: boolean | null;
|
|
442
453
|
}
|
|
443
|
-
|
|
454
|
+
interface CodeBlockData {
|
|
444
455
|
/** Styling for the code block's text. */
|
|
445
456
|
textStyle?: TextStyle;
|
|
446
457
|
}
|
|
447
|
-
|
|
458
|
+
interface TextStyle {
|
|
448
459
|
/** Text alignment. Defaults to `AUTO`. */
|
|
449
|
-
textAlignment?:
|
|
460
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
450
461
|
/** 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. */
|
|
451
462
|
lineHeight?: string | null;
|
|
452
463
|
}
|
|
453
|
-
|
|
464
|
+
declare enum TextAlignment {
|
|
454
465
|
/** browser default, eqivalent to `initial` */
|
|
455
466
|
AUTO = "AUTO",
|
|
456
467
|
/** Left align */
|
|
@@ -462,17 +473,19 @@ export declare enum TextAlignment {
|
|
|
462
473
|
/** 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 */
|
|
463
474
|
JUSTIFY = "JUSTIFY"
|
|
464
475
|
}
|
|
465
|
-
|
|
476
|
+
/** @enumType */
|
|
477
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
478
|
+
interface DividerData {
|
|
466
479
|
/** Styling for the divider's container. */
|
|
467
480
|
containerData?: PluginContainerData;
|
|
468
481
|
/** Divider line style. */
|
|
469
|
-
lineStyle?:
|
|
482
|
+
lineStyle?: LineStyleWithLiterals;
|
|
470
483
|
/** Divider width. */
|
|
471
|
-
width?:
|
|
484
|
+
width?: WidthWithLiterals;
|
|
472
485
|
/** Divider alignment. */
|
|
473
|
-
alignment?:
|
|
486
|
+
alignment?: AlignmentWithLiterals;
|
|
474
487
|
}
|
|
475
|
-
|
|
488
|
+
declare enum LineStyle {
|
|
476
489
|
/** Single Line */
|
|
477
490
|
SINGLE = "SINGLE",
|
|
478
491
|
/** Double Line */
|
|
@@ -482,7 +495,9 @@ export declare enum LineStyle {
|
|
|
482
495
|
/** Dotted Line */
|
|
483
496
|
DOTTED = "DOTTED"
|
|
484
497
|
}
|
|
485
|
-
|
|
498
|
+
/** @enumType */
|
|
499
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
500
|
+
declare enum Width {
|
|
486
501
|
/** Large line */
|
|
487
502
|
LARGE = "LARGE",
|
|
488
503
|
/** Medium line */
|
|
@@ -490,7 +505,9 @@ export declare enum Width {
|
|
|
490
505
|
/** Small line */
|
|
491
506
|
SMALL = "SMALL"
|
|
492
507
|
}
|
|
493
|
-
|
|
508
|
+
/** @enumType */
|
|
509
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
510
|
+
declare enum Alignment {
|
|
494
511
|
/** Center alignment */
|
|
495
512
|
CENTER = "CENTER",
|
|
496
513
|
/** Left alignment */
|
|
@@ -498,7 +515,9 @@ export declare enum Alignment {
|
|
|
498
515
|
/** Right alignment */
|
|
499
516
|
RIGHT = "RIGHT"
|
|
500
517
|
}
|
|
501
|
-
|
|
518
|
+
/** @enumType */
|
|
519
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
520
|
+
interface FileData {
|
|
502
521
|
/** Styling for the file's container. */
|
|
503
522
|
containerData?: PluginContainerData;
|
|
504
523
|
/** The source for the file's data. */
|
|
@@ -521,7 +540,7 @@ export interface FileData {
|
|
|
521
540
|
/** File size in KB. */
|
|
522
541
|
sizeInKb?: string | null;
|
|
523
542
|
}
|
|
524
|
-
|
|
543
|
+
declare enum ViewMode {
|
|
525
544
|
/** No PDF view */
|
|
526
545
|
NONE = "NONE",
|
|
527
546
|
/** Full PDF view */
|
|
@@ -529,7 +548,9 @@ export declare enum ViewMode {
|
|
|
529
548
|
/** Mini PDF view */
|
|
530
549
|
MINI = "MINI"
|
|
531
550
|
}
|
|
532
|
-
|
|
551
|
+
/** @enumType */
|
|
552
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
553
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
533
554
|
/** The absolute URL for the file's source. */
|
|
534
555
|
url?: string | null;
|
|
535
556
|
/**
|
|
@@ -543,7 +564,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
543
564
|
private?: boolean | null;
|
|
544
565
|
}
|
|
545
566
|
/** @oneof */
|
|
546
|
-
|
|
567
|
+
interface FileSourceDataOneOf {
|
|
547
568
|
/** The absolute URL for the file's source. */
|
|
548
569
|
url?: string | null;
|
|
549
570
|
/**
|
|
@@ -554,20 +575,20 @@ export interface FileSourceDataOneOf {
|
|
|
554
575
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
555
576
|
id?: string | null;
|
|
556
577
|
}
|
|
557
|
-
|
|
578
|
+
interface PDFSettings {
|
|
558
579
|
/**
|
|
559
580
|
* PDF view mode. One of the following:
|
|
560
581
|
* `NONE` : The PDF isn't displayed.
|
|
561
582
|
* `FULL` : A full page view of the PDF is displayed.
|
|
562
583
|
* `MINI` : A mini view of the PDF is displayed.
|
|
563
584
|
*/
|
|
564
|
-
viewMode?:
|
|
585
|
+
viewMode?: ViewModeWithLiterals;
|
|
565
586
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
566
587
|
disableDownload?: boolean | null;
|
|
567
588
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
568
589
|
disablePrint?: boolean | null;
|
|
569
590
|
}
|
|
570
|
-
|
|
591
|
+
interface GalleryData {
|
|
571
592
|
/** Styling for the gallery's container. */
|
|
572
593
|
containerData?: PluginContainerData;
|
|
573
594
|
/** The items in the gallery. */
|
|
@@ -579,7 +600,7 @@ export interface GalleryData {
|
|
|
579
600
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
580
601
|
disableDownload?: boolean | null;
|
|
581
602
|
}
|
|
582
|
-
|
|
603
|
+
interface Media {
|
|
583
604
|
/** The source for the media's data. */
|
|
584
605
|
src?: FileSource;
|
|
585
606
|
/** Media width in pixels. */
|
|
@@ -589,19 +610,19 @@ export interface Media {
|
|
|
589
610
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
590
611
|
duration?: number | null;
|
|
591
612
|
}
|
|
592
|
-
|
|
613
|
+
interface Image {
|
|
593
614
|
/** Image file details. */
|
|
594
615
|
media?: Media;
|
|
595
616
|
/** Link details for images that are links. */
|
|
596
617
|
link?: Link;
|
|
597
618
|
}
|
|
598
|
-
|
|
619
|
+
interface Video {
|
|
599
620
|
/** Video file details. */
|
|
600
621
|
media?: Media;
|
|
601
622
|
/** Video thumbnail file details. */
|
|
602
623
|
thumbnail?: Media;
|
|
603
624
|
}
|
|
604
|
-
|
|
625
|
+
interface Item extends ItemDataOneOf {
|
|
605
626
|
/** An image item. */
|
|
606
627
|
image?: Image;
|
|
607
628
|
/** A video item. */
|
|
@@ -612,13 +633,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
612
633
|
altText?: string | null;
|
|
613
634
|
}
|
|
614
635
|
/** @oneof */
|
|
615
|
-
|
|
636
|
+
interface ItemDataOneOf {
|
|
616
637
|
/** An image item. */
|
|
617
638
|
image?: Image;
|
|
618
639
|
/** A video item. */
|
|
619
640
|
video?: Video;
|
|
620
641
|
}
|
|
621
|
-
|
|
642
|
+
interface GalleryOptions {
|
|
622
643
|
/** Gallery layout. */
|
|
623
644
|
layout?: Layout;
|
|
624
645
|
/** Styling for gallery items. */
|
|
@@ -626,7 +647,7 @@ export interface GalleryOptions {
|
|
|
626
647
|
/** Styling for gallery thumbnail images. */
|
|
627
648
|
thumbnails?: Thumbnails;
|
|
628
649
|
}
|
|
629
|
-
|
|
650
|
+
declare enum LayoutType {
|
|
630
651
|
/** Collage type */
|
|
631
652
|
COLLAGE = "COLLAGE",
|
|
632
653
|
/** Masonry type */
|
|
@@ -648,19 +669,25 @@ export declare enum LayoutType {
|
|
|
648
669
|
/** Fullsize images type */
|
|
649
670
|
FULLSIZE = "FULLSIZE"
|
|
650
671
|
}
|
|
651
|
-
|
|
672
|
+
/** @enumType */
|
|
673
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
674
|
+
declare enum Orientation {
|
|
652
675
|
/** Rows Orientation */
|
|
653
676
|
ROWS = "ROWS",
|
|
654
677
|
/** Columns Orientation */
|
|
655
678
|
COLUMNS = "COLUMNS"
|
|
656
679
|
}
|
|
657
|
-
|
|
680
|
+
/** @enumType */
|
|
681
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
682
|
+
declare enum Crop {
|
|
658
683
|
/** Crop to fill */
|
|
659
684
|
FILL = "FILL",
|
|
660
685
|
/** Crop to fit */
|
|
661
686
|
FIT = "FIT"
|
|
662
687
|
}
|
|
663
|
-
|
|
688
|
+
/** @enumType */
|
|
689
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
690
|
+
declare enum ThumbnailsAlignment {
|
|
664
691
|
/** Top alignment */
|
|
665
692
|
TOP = "TOP",
|
|
666
693
|
/** Right alignment */
|
|
@@ -672,35 +699,37 @@ export declare enum ThumbnailsAlignment {
|
|
|
672
699
|
/** No thumbnail */
|
|
673
700
|
NONE = "NONE"
|
|
674
701
|
}
|
|
675
|
-
|
|
702
|
+
/** @enumType */
|
|
703
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
704
|
+
interface Layout {
|
|
676
705
|
/** Gallery layout type. */
|
|
677
|
-
type?:
|
|
706
|
+
type?: LayoutTypeWithLiterals;
|
|
678
707
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
679
708
|
horizontalScroll?: boolean | null;
|
|
680
709
|
/** Gallery orientation. */
|
|
681
|
-
orientation?:
|
|
710
|
+
orientation?: OrientationWithLiterals;
|
|
682
711
|
/** The number of columns to display on full size screens. */
|
|
683
712
|
numberOfColumns?: number | null;
|
|
684
713
|
/** The number of columns to display on mobile screens. */
|
|
685
714
|
mobileNumberOfColumns?: number | null;
|
|
686
715
|
}
|
|
687
|
-
|
|
716
|
+
interface ItemStyle {
|
|
688
717
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
689
718
|
targetSize?: number | null;
|
|
690
719
|
/** Item ratio */
|
|
691
720
|
ratio?: number | null;
|
|
692
721
|
/** Sets how item images are cropped. */
|
|
693
|
-
crop?:
|
|
722
|
+
crop?: CropWithLiterals;
|
|
694
723
|
/** The spacing between items in pixels. */
|
|
695
724
|
spacing?: number | null;
|
|
696
725
|
}
|
|
697
|
-
|
|
726
|
+
interface Thumbnails {
|
|
698
727
|
/** Thumbnail alignment. */
|
|
699
|
-
placement?:
|
|
728
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
700
729
|
/** Spacing between thumbnails in pixels. */
|
|
701
730
|
spacing?: number | null;
|
|
702
731
|
}
|
|
703
|
-
|
|
732
|
+
interface GIFData {
|
|
704
733
|
/** Styling for the GIF's container. */
|
|
705
734
|
containerData?: PluginContainerData;
|
|
706
735
|
/** The source of the full size GIF. */
|
|
@@ -712,9 +741,9 @@ export interface GIFData {
|
|
|
712
741
|
/** Width in pixels. */
|
|
713
742
|
width?: number;
|
|
714
743
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
715
|
-
gifType?:
|
|
744
|
+
gifType?: GIFTypeWithLiterals;
|
|
716
745
|
}
|
|
717
|
-
|
|
746
|
+
interface GIF {
|
|
718
747
|
/**
|
|
719
748
|
* GIF format URL.
|
|
720
749
|
* @format WEB_URL
|
|
@@ -731,11 +760,13 @@ export interface GIF {
|
|
|
731
760
|
*/
|
|
732
761
|
still?: string | null;
|
|
733
762
|
}
|
|
734
|
-
|
|
763
|
+
declare enum GIFType {
|
|
735
764
|
NORMAL = "NORMAL",
|
|
736
765
|
STICKER = "STICKER"
|
|
737
766
|
}
|
|
738
|
-
|
|
767
|
+
/** @enumType */
|
|
768
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
769
|
+
interface HeadingData {
|
|
739
770
|
/** Heading level from 1-6. */
|
|
740
771
|
level?: number;
|
|
741
772
|
/** Styling for the heading text. */
|
|
@@ -743,7 +774,7 @@ export interface HeadingData {
|
|
|
743
774
|
/** Indentation level from 1-4. */
|
|
744
775
|
indentation?: number | null;
|
|
745
776
|
}
|
|
746
|
-
|
|
777
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
747
778
|
/** The URL for the HTML code for the node. */
|
|
748
779
|
url?: string;
|
|
749
780
|
/** The HTML code for the node. */
|
|
@@ -756,12 +787,12 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
756
787
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
757
788
|
containerData?: PluginContainerData;
|
|
758
789
|
/** The type of HTML code. */
|
|
759
|
-
source?:
|
|
790
|
+
source?: SourceWithLiterals;
|
|
760
791
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
761
792
|
autoHeight?: boolean | null;
|
|
762
793
|
}
|
|
763
794
|
/** @oneof */
|
|
764
|
-
|
|
795
|
+
interface HTMLDataDataOneOf {
|
|
765
796
|
/** The URL for the HTML code for the node. */
|
|
766
797
|
url?: string;
|
|
767
798
|
/** The HTML code for the node. */
|
|
@@ -772,11 +803,13 @@ export interface HTMLDataDataOneOf {
|
|
|
772
803
|
*/
|
|
773
804
|
isAdsense?: boolean | null;
|
|
774
805
|
}
|
|
775
|
-
|
|
806
|
+
declare enum Source {
|
|
776
807
|
HTML = "HTML",
|
|
777
808
|
ADSENSE = "ADSENSE"
|
|
778
809
|
}
|
|
779
|
-
|
|
810
|
+
/** @enumType */
|
|
811
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
812
|
+
interface ImageData {
|
|
780
813
|
/** Styling for the image's container. */
|
|
781
814
|
containerData?: PluginContainerData;
|
|
782
815
|
/** Image file details. */
|
|
@@ -799,7 +832,7 @@ export interface ImageData {
|
|
|
799
832
|
/** Styling for the image. */
|
|
800
833
|
styles?: ImageDataStyles;
|
|
801
834
|
}
|
|
802
|
-
|
|
835
|
+
interface StylesBorder {
|
|
803
836
|
/** Border width in pixels. */
|
|
804
837
|
width?: number | null;
|
|
805
838
|
/**
|
|
@@ -810,11 +843,11 @@ export interface StylesBorder {
|
|
|
810
843
|
/** Border radius in pixels. */
|
|
811
844
|
radius?: number | null;
|
|
812
845
|
}
|
|
813
|
-
|
|
846
|
+
interface ImageDataStyles {
|
|
814
847
|
/** Border attributes. */
|
|
815
848
|
border?: StylesBorder;
|
|
816
849
|
}
|
|
817
|
-
|
|
850
|
+
interface LinkPreviewData {
|
|
818
851
|
/** Styling for the link preview's container. */
|
|
819
852
|
containerData?: PluginContainerData;
|
|
820
853
|
/** Link details. */
|
|
@@ -830,7 +863,7 @@ export interface LinkPreviewData {
|
|
|
830
863
|
/** Styling for the link preview. */
|
|
831
864
|
styles?: LinkPreviewDataStyles;
|
|
832
865
|
}
|
|
833
|
-
|
|
866
|
+
declare enum Position {
|
|
834
867
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
835
868
|
START = "START",
|
|
836
869
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -840,7 +873,9 @@ export declare enum Position {
|
|
|
840
873
|
/** Thumbnail hidden and not displayed */
|
|
841
874
|
HIDDEN = "HIDDEN"
|
|
842
875
|
}
|
|
843
|
-
|
|
876
|
+
/** @enumType */
|
|
877
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
878
|
+
interface LinkPreviewDataStyles {
|
|
844
879
|
/**
|
|
845
880
|
* Background color as a hexadecimal value.
|
|
846
881
|
* @format COLOR_HEX
|
|
@@ -871,15 +906,15 @@ export interface LinkPreviewDataStyles {
|
|
|
871
906
|
*/
|
|
872
907
|
borderColor?: string | null;
|
|
873
908
|
/** Position of thumbnail. Defaults to `START`. */
|
|
874
|
-
thumbnailPosition?:
|
|
909
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
875
910
|
}
|
|
876
|
-
|
|
911
|
+
interface MapData {
|
|
877
912
|
/** Styling for the map's container. */
|
|
878
913
|
containerData?: PluginContainerData;
|
|
879
914
|
/** Map settings. */
|
|
880
915
|
mapSettings?: MapSettings;
|
|
881
916
|
}
|
|
882
|
-
|
|
917
|
+
interface MapSettings {
|
|
883
918
|
/** The address to display on the map. */
|
|
884
919
|
address?: string | null;
|
|
885
920
|
/** Sets whether the map is draggable. */
|
|
@@ -901,9 +936,9 @@ export interface MapSettings {
|
|
|
901
936
|
/** Initial zoom value. */
|
|
902
937
|
initialZoom?: number | null;
|
|
903
938
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
904
|
-
mapType?:
|
|
939
|
+
mapType?: MapTypeWithLiterals;
|
|
905
940
|
}
|
|
906
|
-
|
|
941
|
+
declare enum MapType {
|
|
907
942
|
/** Roadmap map type */
|
|
908
943
|
ROADMAP = "ROADMAP",
|
|
909
944
|
/** Satellite map type */
|
|
@@ -913,7 +948,9 @@ export declare enum MapType {
|
|
|
913
948
|
/** Terrain map type */
|
|
914
949
|
TERRAIN = "TERRAIN"
|
|
915
950
|
}
|
|
916
|
-
|
|
951
|
+
/** @enumType */
|
|
952
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
953
|
+
interface ParagraphData {
|
|
917
954
|
/** Styling for the paragraph text. */
|
|
918
955
|
textStyle?: TextStyle;
|
|
919
956
|
/** Indentation level from 1-4. */
|
|
@@ -921,7 +958,7 @@ export interface ParagraphData {
|
|
|
921
958
|
/** Paragraph level */
|
|
922
959
|
level?: number | null;
|
|
923
960
|
}
|
|
924
|
-
|
|
961
|
+
interface PollData {
|
|
925
962
|
/** Styling for the poll's container. */
|
|
926
963
|
containerData?: PluginContainerData;
|
|
927
964
|
/** Poll data. */
|
|
@@ -931,7 +968,7 @@ export interface PollData {
|
|
|
931
968
|
/** Styling for the poll and voting options. */
|
|
932
969
|
design?: Design;
|
|
933
970
|
}
|
|
934
|
-
|
|
971
|
+
declare enum ViewRole {
|
|
935
972
|
/** Only Poll creator can view the results */
|
|
936
973
|
CREATOR = "CREATOR",
|
|
937
974
|
/** Anyone who voted can see the results */
|
|
@@ -939,21 +976,25 @@ export declare enum ViewRole {
|
|
|
939
976
|
/** Anyone can see the results, even if one didn't vote */
|
|
940
977
|
EVERYONE = "EVERYONE"
|
|
941
978
|
}
|
|
942
|
-
|
|
979
|
+
/** @enumType */
|
|
980
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
981
|
+
declare enum VoteRole {
|
|
943
982
|
/** Logged in member */
|
|
944
983
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
945
984
|
/** Anyone */
|
|
946
985
|
ALL = "ALL"
|
|
947
986
|
}
|
|
948
|
-
|
|
987
|
+
/** @enumType */
|
|
988
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
989
|
+
interface Permissions {
|
|
949
990
|
/** Sets who can view the poll results. */
|
|
950
|
-
view?:
|
|
991
|
+
view?: ViewRoleWithLiterals;
|
|
951
992
|
/** Sets who can vote. */
|
|
952
|
-
vote?:
|
|
993
|
+
vote?: VoteRoleWithLiterals;
|
|
953
994
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
954
995
|
allowMultipleVotes?: boolean | null;
|
|
955
996
|
}
|
|
956
|
-
|
|
997
|
+
interface Option {
|
|
957
998
|
/** Option ID. */
|
|
958
999
|
id?: string | null;
|
|
959
1000
|
/** Option title. */
|
|
@@ -961,7 +1002,7 @@ export interface Option {
|
|
|
961
1002
|
/** The image displayed with the option. */
|
|
962
1003
|
image?: Media;
|
|
963
1004
|
}
|
|
964
|
-
|
|
1005
|
+
interface Settings {
|
|
965
1006
|
/** Permissions settings for voting. */
|
|
966
1007
|
permissions?: Permissions;
|
|
967
1008
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -969,31 +1010,35 @@ export interface Settings {
|
|
|
969
1010
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
970
1011
|
showVotesCount?: boolean | null;
|
|
971
1012
|
}
|
|
972
|
-
|
|
1013
|
+
declare enum PollLayoutType {
|
|
973
1014
|
/** List */
|
|
974
1015
|
LIST = "LIST",
|
|
975
1016
|
/** Grid */
|
|
976
1017
|
GRID = "GRID"
|
|
977
1018
|
}
|
|
978
|
-
|
|
1019
|
+
/** @enumType */
|
|
1020
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1021
|
+
declare enum PollLayoutDirection {
|
|
979
1022
|
/** Left-to-right */
|
|
980
1023
|
LTR = "LTR",
|
|
981
1024
|
/** Right-to-left */
|
|
982
1025
|
RTL = "RTL"
|
|
983
1026
|
}
|
|
984
|
-
|
|
1027
|
+
/** @enumType */
|
|
1028
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1029
|
+
interface PollLayout {
|
|
985
1030
|
/** The layout for displaying the voting options. */
|
|
986
|
-
type?:
|
|
1031
|
+
type?: PollLayoutTypeWithLiterals;
|
|
987
1032
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
988
|
-
direction?:
|
|
1033
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
989
1034
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
990
1035
|
enableImage?: boolean | null;
|
|
991
1036
|
}
|
|
992
|
-
|
|
1037
|
+
interface OptionLayout {
|
|
993
1038
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
994
1039
|
enableImage?: boolean | null;
|
|
995
1040
|
}
|
|
996
|
-
|
|
1041
|
+
declare enum BackgroundType {
|
|
997
1042
|
/** Color background type */
|
|
998
1043
|
COLOR = "COLOR",
|
|
999
1044
|
/** Image background type */
|
|
@@ -1001,7 +1046,9 @@ export declare enum BackgroundType {
|
|
|
1001
1046
|
/** Gradiant background type */
|
|
1002
1047
|
GRADIENT = "GRADIENT"
|
|
1003
1048
|
}
|
|
1004
|
-
|
|
1049
|
+
/** @enumType */
|
|
1050
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1051
|
+
interface Gradient {
|
|
1005
1052
|
/** The gradient angle in degrees. */
|
|
1006
1053
|
angle?: number | null;
|
|
1007
1054
|
/**
|
|
@@ -1015,7 +1062,7 @@ export interface Gradient {
|
|
|
1015
1062
|
*/
|
|
1016
1063
|
lastColor?: string | null;
|
|
1017
1064
|
}
|
|
1018
|
-
|
|
1065
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1019
1066
|
/**
|
|
1020
1067
|
* The background color as a hexademical value.
|
|
1021
1068
|
* @format COLOR_HEX
|
|
@@ -1026,10 +1073,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1026
1073
|
/** Details for a gradient background. */
|
|
1027
1074
|
gradient?: Gradient;
|
|
1028
1075
|
/** Background type. For each option, include the relevant details. */
|
|
1029
|
-
type?:
|
|
1076
|
+
type?: BackgroundTypeWithLiterals;
|
|
1030
1077
|
}
|
|
1031
1078
|
/** @oneof */
|
|
1032
|
-
|
|
1079
|
+
interface BackgroundBackgroundOneOf {
|
|
1033
1080
|
/**
|
|
1034
1081
|
* The background color as a hexademical value.
|
|
1035
1082
|
* @format COLOR_HEX
|
|
@@ -1040,17 +1087,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1040
1087
|
/** Details for a gradient background. */
|
|
1041
1088
|
gradient?: Gradient;
|
|
1042
1089
|
}
|
|
1043
|
-
|
|
1090
|
+
interface PollDesign {
|
|
1044
1091
|
/** Background styling. */
|
|
1045
1092
|
background?: Background;
|
|
1046
1093
|
/** Border radius in pixels. */
|
|
1047
1094
|
borderRadius?: number | null;
|
|
1048
1095
|
}
|
|
1049
|
-
|
|
1096
|
+
interface OptionDesign {
|
|
1050
1097
|
/** Border radius in pixels. */
|
|
1051
1098
|
borderRadius?: number | null;
|
|
1052
1099
|
}
|
|
1053
|
-
|
|
1100
|
+
interface Poll {
|
|
1054
1101
|
/** Poll ID. */
|
|
1055
1102
|
id?: string | null;
|
|
1056
1103
|
/** Poll title. */
|
|
@@ -1064,26 +1111,26 @@ export interface Poll {
|
|
|
1064
1111
|
/** The poll's permissions and display settings. */
|
|
1065
1112
|
settings?: Settings;
|
|
1066
1113
|
}
|
|
1067
|
-
|
|
1114
|
+
interface PollDataLayout {
|
|
1068
1115
|
/** Poll layout settings. */
|
|
1069
1116
|
poll?: PollLayout;
|
|
1070
1117
|
/** Voting otpions layout settings. */
|
|
1071
1118
|
options?: OptionLayout;
|
|
1072
1119
|
}
|
|
1073
|
-
|
|
1120
|
+
interface Design {
|
|
1074
1121
|
/** Styling for the poll. */
|
|
1075
1122
|
poll?: PollDesign;
|
|
1076
1123
|
/** Styling for voting options. */
|
|
1077
1124
|
options?: OptionDesign;
|
|
1078
1125
|
}
|
|
1079
|
-
|
|
1126
|
+
interface TextData {
|
|
1080
1127
|
/** The text to apply decorations to. */
|
|
1081
1128
|
text?: string;
|
|
1082
1129
|
/** The decorations to apply. */
|
|
1083
1130
|
decorations?: Decoration[];
|
|
1084
1131
|
}
|
|
1085
1132
|
/** Adds appearence changes to text */
|
|
1086
|
-
|
|
1133
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1087
1134
|
/** Data for an anchor link decoration. */
|
|
1088
1135
|
anchorData?: AnchorData;
|
|
1089
1136
|
/** Data for a color decoration. */
|
|
@@ -1105,10 +1152,10 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1105
1152
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1106
1153
|
strikethroughData?: boolean | null;
|
|
1107
1154
|
/** The type of decoration to apply. */
|
|
1108
|
-
type?:
|
|
1155
|
+
type?: DecorationTypeWithLiterals;
|
|
1109
1156
|
}
|
|
1110
1157
|
/** @oneof */
|
|
1111
|
-
|
|
1158
|
+
interface DecorationDataOneOf {
|
|
1112
1159
|
/** Data for an anchor link decoration. */
|
|
1113
1160
|
anchorData?: AnchorData;
|
|
1114
1161
|
/** Data for a color decoration. */
|
|
@@ -1130,7 +1177,7 @@ export interface DecorationDataOneOf {
|
|
|
1130
1177
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1131
1178
|
strikethroughData?: boolean | null;
|
|
1132
1179
|
}
|
|
1133
|
-
|
|
1180
|
+
declare enum DecorationType {
|
|
1134
1181
|
BOLD = "BOLD",
|
|
1135
1182
|
ITALIC = "ITALIC",
|
|
1136
1183
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1143,21 +1190,23 @@ export declare enum DecorationType {
|
|
|
1143
1190
|
EXTERNAL = "EXTERNAL",
|
|
1144
1191
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1145
1192
|
}
|
|
1146
|
-
|
|
1193
|
+
/** @enumType */
|
|
1194
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1195
|
+
interface AnchorData {
|
|
1147
1196
|
/** The target node's ID. */
|
|
1148
1197
|
anchor?: string;
|
|
1149
1198
|
}
|
|
1150
|
-
|
|
1199
|
+
interface ColorData {
|
|
1151
1200
|
/** The text's background color as a hexadecimal value. */
|
|
1152
1201
|
background?: string | null;
|
|
1153
1202
|
/** The text's foreground color as a hexadecimal value. */
|
|
1154
1203
|
foreground?: string | null;
|
|
1155
1204
|
}
|
|
1156
|
-
|
|
1205
|
+
interface LinkData {
|
|
1157
1206
|
/** Link details. */
|
|
1158
1207
|
link?: Link;
|
|
1159
1208
|
}
|
|
1160
|
-
|
|
1209
|
+
interface MentionData {
|
|
1161
1210
|
/** The mentioned user's name. */
|
|
1162
1211
|
name?: string;
|
|
1163
1212
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1165,27 +1214,29 @@ export interface MentionData {
|
|
|
1165
1214
|
/** Mentioned user's ID. */
|
|
1166
1215
|
id?: string | null;
|
|
1167
1216
|
}
|
|
1168
|
-
|
|
1217
|
+
interface FontSizeData {
|
|
1169
1218
|
/** The units used for the font size. */
|
|
1170
|
-
unit?:
|
|
1219
|
+
unit?: FontTypeWithLiterals;
|
|
1171
1220
|
/** Font size value. */
|
|
1172
1221
|
value?: number | null;
|
|
1173
1222
|
}
|
|
1174
|
-
|
|
1223
|
+
declare enum FontType {
|
|
1175
1224
|
PX = "PX",
|
|
1176
1225
|
EM = "EM"
|
|
1177
1226
|
}
|
|
1178
|
-
|
|
1227
|
+
/** @enumType */
|
|
1228
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1229
|
+
interface SpoilerData {
|
|
1179
1230
|
/** Spoiler ID. */
|
|
1180
1231
|
id?: string | null;
|
|
1181
1232
|
}
|
|
1182
|
-
|
|
1233
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1183
1234
|
/** Data for embedded Wix Bookings content. */
|
|
1184
1235
|
bookingData?: BookingData;
|
|
1185
1236
|
/** Data for embedded Wix Events content. */
|
|
1186
1237
|
eventData?: EventData;
|
|
1187
1238
|
/** The type of Wix App content being embedded. */
|
|
1188
|
-
type?:
|
|
1239
|
+
type?: AppTypeWithLiterals;
|
|
1189
1240
|
/** The ID of the embedded content. */
|
|
1190
1241
|
itemId?: string | null;
|
|
1191
1242
|
/** The name of the embedded content. */
|
|
@@ -1201,28 +1252,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1201
1252
|
image?: Media;
|
|
1202
1253
|
}
|
|
1203
1254
|
/** @oneof */
|
|
1204
|
-
|
|
1255
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1205
1256
|
/** Data for embedded Wix Bookings content. */
|
|
1206
1257
|
bookingData?: BookingData;
|
|
1207
1258
|
/** Data for embedded Wix Events content. */
|
|
1208
1259
|
eventData?: EventData;
|
|
1209
1260
|
}
|
|
1210
|
-
|
|
1261
|
+
declare enum AppType {
|
|
1211
1262
|
PRODUCT = "PRODUCT",
|
|
1212
1263
|
EVENT = "EVENT",
|
|
1213
1264
|
BOOKING = "BOOKING"
|
|
1214
1265
|
}
|
|
1215
|
-
|
|
1266
|
+
/** @enumType */
|
|
1267
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1268
|
+
interface BookingData {
|
|
1216
1269
|
/** Booking duration in minutes. */
|
|
1217
1270
|
durations?: string | null;
|
|
1218
1271
|
}
|
|
1219
|
-
|
|
1272
|
+
interface EventData {
|
|
1220
1273
|
/** Event schedule. */
|
|
1221
1274
|
scheduling?: string | null;
|
|
1222
1275
|
/** Event location. */
|
|
1223
1276
|
location?: string | null;
|
|
1224
1277
|
}
|
|
1225
|
-
|
|
1278
|
+
interface VideoData {
|
|
1226
1279
|
/** Styling for the video's container. */
|
|
1227
1280
|
containerData?: PluginContainerData;
|
|
1228
1281
|
/** Video details. */
|
|
@@ -1236,7 +1289,7 @@ export interface VideoData {
|
|
|
1236
1289
|
/** Video options. */
|
|
1237
1290
|
options?: PlaybackOptions;
|
|
1238
1291
|
}
|
|
1239
|
-
|
|
1292
|
+
interface PlaybackOptions {
|
|
1240
1293
|
/** Sets whether the media will automatically start playing. */
|
|
1241
1294
|
autoPlay?: boolean | null;
|
|
1242
1295
|
/** Sets whether media's will be looped. */
|
|
@@ -1244,7 +1297,7 @@ export interface PlaybackOptions {
|
|
|
1244
1297
|
/** Sets whether media's controls will be shown. */
|
|
1245
1298
|
showControls?: boolean | null;
|
|
1246
1299
|
}
|
|
1247
|
-
|
|
1300
|
+
interface EmbedData {
|
|
1248
1301
|
/** Styling for the oEmbed node's container. */
|
|
1249
1302
|
containerData?: PluginContainerData;
|
|
1250
1303
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1252,7 +1305,7 @@ export interface EmbedData {
|
|
|
1252
1305
|
/** Origin asset source. */
|
|
1253
1306
|
src?: string | null;
|
|
1254
1307
|
}
|
|
1255
|
-
|
|
1308
|
+
interface Oembed {
|
|
1256
1309
|
/** The resource type. */
|
|
1257
1310
|
type?: string | null;
|
|
1258
1311
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1284,19 +1337,19 @@ export interface Oembed {
|
|
|
1284
1337
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1285
1338
|
version?: string | null;
|
|
1286
1339
|
}
|
|
1287
|
-
|
|
1340
|
+
interface CollapsibleListData {
|
|
1288
1341
|
/** Styling for the collapsible list's container. */
|
|
1289
1342
|
containerData?: PluginContainerData;
|
|
1290
1343
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1291
1344
|
expandOnlyOne?: boolean | null;
|
|
1292
1345
|
/** Sets which items are expanded when the page loads. */
|
|
1293
|
-
initialExpandedItems?:
|
|
1346
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
1294
1347
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1295
|
-
direction?:
|
|
1348
|
+
direction?: DirectionWithLiterals;
|
|
1296
1349
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1297
1350
|
isQapageData?: boolean | null;
|
|
1298
1351
|
}
|
|
1299
|
-
|
|
1352
|
+
declare enum InitialExpandedItems {
|
|
1300
1353
|
/** First item will be expended initally */
|
|
1301
1354
|
FIRST = "FIRST",
|
|
1302
1355
|
/** All items will expended initally */
|
|
@@ -1304,13 +1357,17 @@ export declare enum InitialExpandedItems {
|
|
|
1304
1357
|
/** All items collapsed initally */
|
|
1305
1358
|
NONE = "NONE"
|
|
1306
1359
|
}
|
|
1307
|
-
|
|
1360
|
+
/** @enumType */
|
|
1361
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1362
|
+
declare enum Direction {
|
|
1308
1363
|
/** Left-to-right */
|
|
1309
1364
|
LTR = "LTR",
|
|
1310
1365
|
/** Right-to-left */
|
|
1311
1366
|
RTL = "RTL"
|
|
1312
1367
|
}
|
|
1313
|
-
|
|
1368
|
+
/** @enumType */
|
|
1369
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1370
|
+
interface TableData {
|
|
1314
1371
|
/** Styling for the table's container. */
|
|
1315
1372
|
containerData?: PluginContainerData;
|
|
1316
1373
|
/** The table's dimensions. */
|
|
@@ -1325,7 +1382,7 @@ export interface TableData {
|
|
|
1325
1382
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1326
1383
|
columnHeader?: boolean | null;
|
|
1327
1384
|
}
|
|
1328
|
-
|
|
1385
|
+
interface Dimensions {
|
|
1329
1386
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1330
1387
|
colsWidthRatio?: number[];
|
|
1331
1388
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1333,13 +1390,13 @@ export interface Dimensions {
|
|
|
1333
1390
|
/** An array representing the minimum width of each column in pixels. */
|
|
1334
1391
|
colsMinWidth?: number[];
|
|
1335
1392
|
}
|
|
1336
|
-
|
|
1393
|
+
interface TableCellData {
|
|
1337
1394
|
/** Styling for the cell's background color and text alignment. */
|
|
1338
1395
|
cellStyle?: CellStyle;
|
|
1339
1396
|
/** The cell's border colors. */
|
|
1340
1397
|
borderColors?: BorderColors;
|
|
1341
1398
|
}
|
|
1342
|
-
|
|
1399
|
+
declare enum VerticalAlignment {
|
|
1343
1400
|
/** Top alignment */
|
|
1344
1401
|
TOP = "TOP",
|
|
1345
1402
|
/** Middle alignment */
|
|
@@ -1347,16 +1404,18 @@ export declare enum VerticalAlignment {
|
|
|
1347
1404
|
/** Bottom alignment */
|
|
1348
1405
|
BOTTOM = "BOTTOM"
|
|
1349
1406
|
}
|
|
1350
|
-
|
|
1407
|
+
/** @enumType */
|
|
1408
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1409
|
+
interface CellStyle {
|
|
1351
1410
|
/** Vertical alignment for the cell's text. */
|
|
1352
|
-
verticalAlignment?:
|
|
1411
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1353
1412
|
/**
|
|
1354
1413
|
* Cell background color as a hexadecimal value.
|
|
1355
1414
|
* @format COLOR_HEX
|
|
1356
1415
|
*/
|
|
1357
1416
|
backgroundColor?: string | null;
|
|
1358
1417
|
}
|
|
1359
|
-
|
|
1418
|
+
interface BorderColors {
|
|
1360
1419
|
/**
|
|
1361
1420
|
* Left border color as a hexadecimal value.
|
|
1362
1421
|
* @format COLOR_HEX
|
|
@@ -1384,7 +1443,7 @@ export interface BorderColors {
|
|
|
1384
1443
|
*
|
|
1385
1444
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1386
1445
|
*/
|
|
1387
|
-
|
|
1446
|
+
declare enum NullValue {
|
|
1388
1447
|
/** Null value. */
|
|
1389
1448
|
NULL_VALUE = "NULL_VALUE"
|
|
1390
1449
|
}
|
|
@@ -1393,11 +1452,11 @@ export declare enum NullValue {
|
|
|
1393
1452
|
*
|
|
1394
1453
|
* The JSON representation for `ListValue` is JSON array.
|
|
1395
1454
|
*/
|
|
1396
|
-
|
|
1455
|
+
interface ListValue {
|
|
1397
1456
|
/** Repeated field of dynamically typed values. */
|
|
1398
1457
|
values?: any[];
|
|
1399
1458
|
}
|
|
1400
|
-
|
|
1459
|
+
interface AudioData {
|
|
1401
1460
|
/** Styling for the audio node's container. */
|
|
1402
1461
|
containerData?: PluginContainerData;
|
|
1403
1462
|
/** Audio file details. */
|
|
@@ -1413,7 +1472,7 @@ export interface AudioData {
|
|
|
1413
1472
|
/** An HTML version of the audio node. */
|
|
1414
1473
|
html?: string | null;
|
|
1415
1474
|
}
|
|
1416
|
-
|
|
1475
|
+
interface OrderedListData {
|
|
1417
1476
|
/** Indentation level from 0-4. */
|
|
1418
1477
|
indentation?: number;
|
|
1419
1478
|
/** Offset level from 0-4. */
|
|
@@ -1421,24 +1480,24 @@ export interface OrderedListData {
|
|
|
1421
1480
|
/** List start number. */
|
|
1422
1481
|
start?: number | null;
|
|
1423
1482
|
}
|
|
1424
|
-
|
|
1483
|
+
interface BulletedListData {
|
|
1425
1484
|
/** Indentation level from 0-4. */
|
|
1426
1485
|
indentation?: number;
|
|
1427
1486
|
/** Offset level from 0-4. */
|
|
1428
1487
|
offset?: number | null;
|
|
1429
1488
|
}
|
|
1430
|
-
|
|
1489
|
+
interface BlockquoteData {
|
|
1431
1490
|
/** Indentation level from 1-4. */
|
|
1432
1491
|
indentation?: number;
|
|
1433
1492
|
}
|
|
1434
|
-
|
|
1493
|
+
interface CaptionData {
|
|
1435
1494
|
textStyle?: TextStyle;
|
|
1436
1495
|
}
|
|
1437
|
-
|
|
1496
|
+
interface LayoutCellData {
|
|
1438
1497
|
/** Size of the cell in 12 columns grid. */
|
|
1439
1498
|
colSpan?: number | null;
|
|
1440
1499
|
}
|
|
1441
|
-
|
|
1500
|
+
interface Metadata {
|
|
1442
1501
|
/** Schema version. */
|
|
1443
1502
|
version?: number;
|
|
1444
1503
|
/**
|
|
@@ -1455,7 +1514,7 @@ export interface Metadata {
|
|
|
1455
1514
|
/** Object ID. */
|
|
1456
1515
|
_id?: string | null;
|
|
1457
1516
|
}
|
|
1458
|
-
|
|
1517
|
+
interface DocumentStyle {
|
|
1459
1518
|
/** Styling for H1 nodes. */
|
|
1460
1519
|
headerOne?: TextNodeStyle;
|
|
1461
1520
|
/** Styling for H2 nodes. */
|
|
@@ -1475,7 +1534,7 @@ export interface DocumentStyle {
|
|
|
1475
1534
|
/** Styling for code block nodes. */
|
|
1476
1535
|
codeBlock?: TextNodeStyle;
|
|
1477
1536
|
}
|
|
1478
|
-
|
|
1537
|
+
interface TextNodeStyle {
|
|
1479
1538
|
/** The decorations to apply to the node. */
|
|
1480
1539
|
decorations?: Decoration[];
|
|
1481
1540
|
/** Padding and background color for the node. */
|
|
@@ -1483,15 +1542,15 @@ export interface TextNodeStyle {
|
|
|
1483
1542
|
/** Line height for text in the node. */
|
|
1484
1543
|
lineHeight?: string | null;
|
|
1485
1544
|
}
|
|
1486
|
-
|
|
1545
|
+
interface MachineTranslateRequest {
|
|
1487
1546
|
/** Language of the source text to translate. */
|
|
1488
|
-
sourceLanguage:
|
|
1547
|
+
sourceLanguage: SupportedLanguageWithLiterals;
|
|
1489
1548
|
/** Language to translate text into. */
|
|
1490
|
-
targetLanguage:
|
|
1549
|
+
targetLanguage: SupportedLanguageWithLiterals;
|
|
1491
1550
|
/** The content to translate. */
|
|
1492
1551
|
contentToTranslate: TranslatableContent;
|
|
1493
1552
|
}
|
|
1494
|
-
|
|
1553
|
+
declare enum SupportedLanguage {
|
|
1495
1554
|
/** Undefined Language */
|
|
1496
1555
|
UNDEFINED_SUPPORTED_LANGUAGE = "UNDEFINED_SUPPORTED_LANGUAGE",
|
|
1497
1556
|
/** Afrikaans */
|
|
@@ -1765,34 +1824,36 @@ export declare enum SupportedLanguage {
|
|
|
1765
1824
|
/** Zulu */
|
|
1766
1825
|
ZU = "ZU"
|
|
1767
1826
|
}
|
|
1768
|
-
|
|
1827
|
+
/** @enumType */
|
|
1828
|
+
type SupportedLanguageWithLiterals = SupportedLanguage | 'UNDEFINED_SUPPORTED_LANGUAGE' | 'AF' | 'SQ' | 'AM' | 'AR' | 'HY' | 'AS' | 'AY' | 'AZ' | 'BM' | 'EU' | 'BE' | 'BN' | 'BHO' | 'BS' | 'BG' | 'CA' | 'CEB' | 'ZH_CN' | 'ZH_TW' | 'ZH' | 'CO' | 'HR' | 'CS' | 'DA' | 'DV' | 'DOI' | 'NL' | 'EN' | 'EO' | 'ET' | 'EE' | 'FIL' | 'FI' | 'FR' | 'FY' | 'GL' | 'KA' | 'DE' | 'EL' | 'GN' | 'GU' | 'HT' | 'HA' | 'HAW' | 'HE' | 'HI' | 'HMN' | 'HU' | 'IS' | 'IG' | 'ILO' | 'ID' | 'GA' | 'IT' | 'JA' | 'JW' | 'KN' | 'KK' | 'KM' | 'RW' | 'GOM' | 'KO' | 'KRI' | 'KU' | 'CKB' | 'KY' | 'LO' | 'LA' | 'LV' | 'LN' | 'LT' | 'LG' | 'LB' | 'MK' | 'MAI' | 'MG' | 'MS' | 'ML' | 'MT' | 'MI' | 'MR' | 'MNI_MTEI' | 'LUS' | 'MN' | 'MY' | 'NE' | 'NO' | 'NY' | 'OR' | 'OM' | 'PS' | 'FA' | 'PL' | 'PT' | 'PA' | 'QU' | 'RO' | 'RU' | 'SM' | 'SA' | 'GD' | 'NSO' | 'SR' | 'ST' | 'SN' | 'SD' | 'SI' | 'SK' | 'SL' | 'SO' | 'ES' | 'SU' | 'SW' | 'SV' | 'TL' | 'TG' | 'TA' | 'TT' | 'TE' | 'TH' | 'TI' | 'TS' | 'TR' | 'TK' | 'AK' | 'UK' | 'UR' | 'UG' | 'UZ' | 'VI' | 'CY' | 'XH' | 'YI' | 'YO' | 'ZU';
|
|
1829
|
+
interface MachineTranslateResponse {
|
|
1769
1830
|
/** The translated content. */
|
|
1770
1831
|
translatedContent?: TranslatableContent;
|
|
1771
1832
|
}
|
|
1772
|
-
|
|
1833
|
+
interface NotEnoughCreditsError {
|
|
1773
1834
|
/** The number of credits required to translate the content in the request. */
|
|
1774
1835
|
creditsRequired?: number;
|
|
1775
1836
|
}
|
|
1776
|
-
|
|
1837
|
+
interface TextTooLongError {
|
|
1777
1838
|
/** The maximum length of text that can be translated. */
|
|
1778
1839
|
maxLength?: number;
|
|
1779
1840
|
/** The actual length of the text that was sent for translation. */
|
|
1780
1841
|
actualLength?: number;
|
|
1781
1842
|
}
|
|
1782
|
-
|
|
1843
|
+
interface UnknownFormatError {
|
|
1783
1844
|
}
|
|
1784
|
-
|
|
1845
|
+
interface SameLanguageArgumentsError {
|
|
1785
1846
|
/**
|
|
1786
1847
|
* The language supplied as both the source and the target languages
|
|
1787
1848
|
* @maxLength 16
|
|
1788
1849
|
*/
|
|
1789
1850
|
language?: string;
|
|
1790
1851
|
}
|
|
1791
|
-
|
|
1852
|
+
interface BulkMachineTranslateRequest {
|
|
1792
1853
|
/** Language of the source text to translate. */
|
|
1793
|
-
sourceLanguage:
|
|
1854
|
+
sourceLanguage: SupportedLanguageWithLiterals;
|
|
1794
1855
|
/** Language to translate text into. */
|
|
1795
|
-
targetLanguage:
|
|
1856
|
+
targetLanguage: SupportedLanguageWithLiterals;
|
|
1796
1857
|
/**
|
|
1797
1858
|
* The content to translate.
|
|
1798
1859
|
* @minSize 1
|
|
@@ -1800,7 +1861,7 @@ export interface BulkMachineTranslateRequest {
|
|
|
1800
1861
|
*/
|
|
1801
1862
|
contentToTranslate?: TranslatableContent[];
|
|
1802
1863
|
}
|
|
1803
|
-
|
|
1864
|
+
interface BulkMachineTranslateResponse {
|
|
1804
1865
|
/**
|
|
1805
1866
|
* List of results for each item in the bulk request.
|
|
1806
1867
|
* @minSize 1
|
|
@@ -1810,13 +1871,13 @@ export interface BulkMachineTranslateResponse {
|
|
|
1810
1871
|
/** Metadata for the overall bulk action, including success and failure counts. */
|
|
1811
1872
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1812
1873
|
}
|
|
1813
|
-
|
|
1874
|
+
interface BulkTranslateResult {
|
|
1814
1875
|
/** Metadata for the individual item in the request. */
|
|
1815
1876
|
itemMetadata?: ItemMetadata;
|
|
1816
1877
|
/** The translated content. */
|
|
1817
1878
|
item?: TranslatableContent;
|
|
1818
1879
|
}
|
|
1819
|
-
|
|
1880
|
+
interface ItemMetadata {
|
|
1820
1881
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1821
1882
|
_id?: string | null;
|
|
1822
1883
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -1826,7 +1887,7 @@ export interface ItemMetadata {
|
|
|
1826
1887
|
/** Details about the error in case of failure. */
|
|
1827
1888
|
error?: ApplicationError;
|
|
1828
1889
|
}
|
|
1829
|
-
|
|
1890
|
+
interface ApplicationError {
|
|
1830
1891
|
/** Error code. */
|
|
1831
1892
|
code?: string;
|
|
1832
1893
|
/** Description of the error. */
|
|
@@ -1834,7 +1895,7 @@ export interface ApplicationError {
|
|
|
1834
1895
|
/** Data related to the error. */
|
|
1835
1896
|
data?: Record<string, any> | null;
|
|
1836
1897
|
}
|
|
1837
|
-
|
|
1898
|
+
interface BulkActionMetadata {
|
|
1838
1899
|
/** Number of items that were successfully processed. */
|
|
1839
1900
|
totalSuccesses?: number;
|
|
1840
1901
|
/** Number of items that couldn't be processed. */
|
|
@@ -1842,88 +1903,15 @@ export interface BulkActionMetadata {
|
|
|
1842
1903
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1843
1904
|
undetailedFailures?: number;
|
|
1844
1905
|
}
|
|
1845
|
-
|
|
1846
|
-
/**
|
|
1847
|
-
* Translates the text of a translatable unit of content from one supported language to another.
|
|
1848
|
-
*
|
|
1849
|
-
* The `translatedContent` object returns with the same `id` used for `contentToTranslate.id` but the text within the
|
|
1850
|
-
* content fields is replaced with the translated text. Note that Wix does not overwrite the original content object.
|
|
1851
|
-
* To retrieve the translated content later, make sure to store it separately.
|
|
1852
|
-
*
|
|
1853
|
-
* Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
|
|
1854
|
-
* cannot be translated using this method.
|
|
1855
|
-
*
|
|
1856
|
-
* The translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
|
|
1857
|
-
* For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
|
|
1858
|
-
* The total translatable content may be more than 5,000 characters as long as no individual node surpasses this limit.
|
|
1859
|
-
* If any node exceeds 5,000 characters, the entire request fails.
|
|
1860
|
-
*
|
|
1861
|
-
* Each site has a word credit balance indicating the number of words available for translation. Successful translation requests reduce the word credits by the number of words in `contentToTranslate`.
|
|
1862
|
-
* If the site does not have sufficient word credits to translate all of the text in the request, the request fails
|
|
1863
|
-
* with a `NOT_ENOUGH_CREDITS` error. You can also call the [Credit Data API](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/introduction)'s [Check Sufficient Credits](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/check-sufficient-credits) method at any time to check whether the site has enough credits to translate the specified number of words.
|
|
1864
|
-
* Wix users can receive additional word credits by [purchasing a translation package](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site#purchasing-translation-packages) in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager) at any time.
|
|
1865
|
-
*
|
|
1866
|
-
* To translate up to 1,000 `translatableContent` units at once, use [Bulk Machine Translate](/machine-translation/bulk-machine-translate).
|
|
1867
|
-
* @param sourceLanguage - Language of the source text to translate.
|
|
1868
|
-
* @public
|
|
1869
|
-
* @requiredField options
|
|
1870
|
-
* @requiredField options.contentToTranslate
|
|
1871
|
-
* @requiredField options.targetLanguage
|
|
1872
|
-
* @requiredField sourceLanguage
|
|
1873
|
-
* @permissionId WIX_MULTILINGUAL.MACHINE_TRANSLATE
|
|
1874
|
-
* @permissionScope Wix Multilingual - Translation API
|
|
1875
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1876
|
-
* @applicableIdentity APP
|
|
1877
|
-
* @fqn wix.multilingual.machine.v3.MachineTranslation.MachineTranslate
|
|
1878
|
-
*/
|
|
1879
|
-
export declare function machineTranslate(sourceLanguage: SupportedLanguage, options: NonNullablePaths<MachineTranslateOptions, `contentToTranslate` | `targetLanguage`>): Promise<NonNullablePaths<MachineTranslateResponse, {
|
|
1880
|
-
[P in TranslatableContentNonNullablePaths]: `translatedContent.${P}`;
|
|
1881
|
-
}[TranslatableContentNonNullablePaths]>>;
|
|
1882
|
-
export interface MachineTranslateOptions {
|
|
1906
|
+
interface MachineTranslateOptions {
|
|
1883
1907
|
/** Language to translate text into. */
|
|
1884
|
-
targetLanguage:
|
|
1908
|
+
targetLanguage: SupportedLanguageWithLiterals;
|
|
1885
1909
|
/** The content to translate. */
|
|
1886
1910
|
contentToTranslate: TranslatableContent;
|
|
1887
1911
|
}
|
|
1888
|
-
|
|
1889
|
-
* Translates the text of multiple units of translatable content from one supported language to another.
|
|
1890
|
-
*
|
|
1891
|
-
* Each translated content item in the `results` array returns with the same `id` as the corresponding `contentToTranslate.id`, but with the text in the
|
|
1892
|
-
* content fields replaced with the translated text. Note that Wix does not overwrite the original content source,
|
|
1893
|
-
* to retrieve the translated content later, make sure to store it separately.
|
|
1894
|
-
*
|
|
1895
|
-
* Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
|
|
1896
|
-
* cannot be translated using this method.
|
|
1897
|
-
*
|
|
1898
|
-
* Each unit of translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
|
|
1899
|
-
* For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
|
|
1900
|
-
* The total request may exceed 5,000 characters as long as no individual node surpasses this limit.
|
|
1901
|
-
* If any node exceeds 5,000 characters, then the request fails for that specific `contentToTranslate` item and the error details for that
|
|
1902
|
-
* error are returned in `itemMetadata`. Even if some translations fail due to the character limit,
|
|
1903
|
-
* the machine translation for other items will succeed if they are under the character limit.
|
|
1904
|
-
*
|
|
1905
|
-
* Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
|
|
1906
|
-
* Each successful translation request reduces the word credits by the number of words included in `contentToTranslate`.
|
|
1907
|
-
* If the site does not have sufficient word credits to complete the translation, then the entire request fails
|
|
1908
|
-
* with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
|
|
1909
|
-
*
|
|
1910
|
-
* To translate a single unit of `translatableContent`, use [Machine Translate](/machine-translation/machine-translate).
|
|
1911
|
-
* @param sourceLanguage - Language of the source text to translate.
|
|
1912
|
-
* @public
|
|
1913
|
-
* @requiredField options.targetLanguage
|
|
1914
|
-
* @requiredField sourceLanguage
|
|
1915
|
-
* @permissionId WIX_MULTILINGUAL.MACHINE_TRANSLATE
|
|
1916
|
-
* @permissionScope Wix Multilingual - Translation API
|
|
1917
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1918
|
-
* @applicableIdentity APP
|
|
1919
|
-
* @fqn wix.multilingual.machine.v3.MachineTranslation.BulkMachineTranslate
|
|
1920
|
-
*/
|
|
1921
|
-
export declare function bulkMachineTranslate(sourceLanguage: SupportedLanguage, options?: NonNullablePaths<BulkMachineTranslateOptions, `targetLanguage`>): Promise<NonNullablePaths<BulkMachineTranslateResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
1922
|
-
[P in TranslatableContentNonNullablePaths]: `results.${number}.item.${P}`;
|
|
1923
|
-
}[TranslatableContentNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
1924
|
-
export interface BulkMachineTranslateOptions {
|
|
1912
|
+
interface BulkMachineTranslateOptions {
|
|
1925
1913
|
/** Language to translate text into. */
|
|
1926
|
-
targetLanguage:
|
|
1914
|
+
targetLanguage: SupportedLanguageWithLiterals;
|
|
1927
1915
|
/**
|
|
1928
1916
|
* The content to translate.
|
|
1929
1917
|
* @minSize 1
|
|
@@ -1931,4 +1919,5 @@ export interface BulkMachineTranslateOptions {
|
|
|
1931
1919
|
*/
|
|
1932
1920
|
contentToTranslate?: TranslatableContent[];
|
|
1933
1921
|
}
|
|
1934
|
-
|
|
1922
|
+
|
|
1923
|
+
export { type LinkDataOneOf as $, Alignment as A, type BulkMachineTranslateOptions as B, Crop as C, DecorationType as D, type ButtonData as E, Format as F, GIFType as G, type Border as H, InitialExpandedItems as I, type Colors as J, type PluginContainerData as K, LineStyle as L, type MachineTranslateOptions as M, NodeType as N, Orientation as O, PluginContainerDataAlignment as P, type PluginContainerDataWidth as Q, type RichContent as R, type SupportedLanguageWithLiterals as S, Type as T, type PluginContainerDataWidthDataOneOf as U, ViewMode as V, WidthType as W, type Spoiler as X, type Height as Y, type Styles as Z, type Link as _, type MachineTranslateResponse as a, type TableData as a$, type Rel as a0, type CodeBlockData as a1, type TextStyle as a2, type DividerData as a3, type FileData as a4, type FileSource as a5, type FileSourceDataOneOf as a6, type PDFSettings as a7, type GalleryData as a8, type Media as a9, type OptionLayout as aA, type Gradient as aB, type Background as aC, type BackgroundBackgroundOneOf as aD, type PollDesign as aE, type OptionDesign as aF, type Poll as aG, type PollDataLayout as aH, type Design as aI, type TextData as aJ, type Decoration as aK, type DecorationDataOneOf as aL, type AnchorData as aM, type ColorData as aN, type LinkData as aO, type MentionData as aP, type FontSizeData as aQ, type SpoilerData as aR, type AppEmbedData as aS, type AppEmbedDataAppDataOneOf as aT, type BookingData as aU, type EventData as aV, type VideoData as aW, type PlaybackOptions as aX, type EmbedData as aY, type Oembed as aZ, type CollapsibleListData as a_, type Image as aa, type Video as ab, type Item as ac, type ItemDataOneOf as ad, type GalleryOptions as ae, type Layout as af, type ItemStyle as ag, type Thumbnails as ah, type GIFData as ai, type GIF as aj, type HeadingData as ak, type HTMLData as al, type HTMLDataDataOneOf as am, type ImageData as an, type StylesBorder as ao, type ImageDataStyles as ap, type LinkPreviewData as aq, type LinkPreviewDataStyles as ar, type MapData as as, type MapSettings as at, type ParagraphData as au, type PollData as av, type Permissions as aw, type Option as ax, type Settings as ay, type PollLayout as az, type BulkMachineTranslateResponse as b, type Dimensions as b0, type TableCellData as b1, type CellStyle as b2, type BorderColors as b3, type ListValue as b4, type AudioData as b5, type OrderedListData as b6, type BulletedListData as b7, type BlockquoteData as b8, type CaptionData as b9, type LayoutCellData as ba, type Metadata as bb, type DocumentStyle as bc, type TextNodeStyle as bd, type MachineTranslateRequest as be, type NotEnoughCreditsError as bf, type TextTooLongError as bg, type UnknownFormatError as bh, type SameLanguageArgumentsError as bi, type BulkMachineTranslateRequest as bj, type BulkTranslateResult as bk, type ItemMetadata as bl, type ApplicationError as bm, type BulkActionMetadata as bn, Target as c, TextAlignment as d, Width as e, LayoutType as f, ThumbnailsAlignment as g, Source as h, Position as i, MapType as j, ViewRole as k, VoteRole as l, PollLayoutType as m, PollLayoutDirection as n, BackgroundType as o, FontType as p, AppType as q, Direction as r, VerticalAlignment as s, NullValue as t, SupportedLanguage as u, type TranslatableContent as v, type TranslatableContentContentOneOf as w, type Node as x, type NodeDataOneOf as y, type NodeStyle as z };
|