@wix/auto_sdk_multilingual_machine-translation 1.0.10 → 1.0.12
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +6 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +41 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +1 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +49 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +388 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +1 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +14 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +66 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +1 -0
- package/build/{index.d.ts → cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts} +8 -11
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +51 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +1 -0
- package/build/{meta.d.mts → cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts} +177 -151
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +598 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +1 -0
- package/build/{multilingual-machine-v3-translatable-content-machine-translation.universal-DdGZM6gD.d.mts → cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts} +222 -144
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +750 -0
- package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +6 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +6 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +1 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +49 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +383 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +1 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +14 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +38 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +1 -0
- package/build/{internal/index.d.ts → es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts} +8 -11
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +14 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +1 -0
- package/build/{internal/meta.d.mts → es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts} +177 -151
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +595 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +1 -0
- package/build/{internal/multilingual-machine-v3-translatable-content-machine-translation.universal-DdGZM6gD.d.mts → es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts} +222 -144
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +722 -0
- package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +6 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +41 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +1 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +49 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +388 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +1 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +14 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +66 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +1 -0
- package/build/{index.d.mts → internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts} +8 -11
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +51 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +1 -0
- package/build/internal/{meta.d.ts → cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts} +177 -151
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +598 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +1 -0
- package/build/{multilingual-machine-v3-translatable-content-machine-translation.universal-DdGZM6gD.d.ts → internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts} +222 -144
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +750 -0
- package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +6 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +6 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +1 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +49 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +383 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +1 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +14 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +38 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +1 -0
- package/build/internal/{index.d.mts → es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts} +8 -11
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +14 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +1 -0
- package/build/{meta.d.ts → internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts} +177 -151
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +595 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +1 -0
- package/build/internal/{multilingual-machine-v3-translatable-content-machine-translation.universal-DdGZM6gD.d.ts → es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts} +222 -144
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +722 -0
- package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.js +0 -896
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -839
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js +0 -896
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -839
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js +0 -412
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -384
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js +0 -412
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -384
- package/build/meta.mjs.map +0 -1
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/**
|
|
2
3
|
* A translatable content is a unit of content to translate.
|
|
3
4
|
*
|
|
4
5
|
* Use [Machine Translate](/machine-translation/machine-translate) to translate a single unit of translatable content, or [Bulk Machine Translate](/machine-translation/bulk-machine-translate)
|
|
5
6
|
* to translate many.
|
|
6
7
|
*/
|
|
7
|
-
interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
8
|
+
export interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
8
9
|
/**
|
|
9
10
|
* Plain text.
|
|
10
11
|
* @minLength 1
|
|
@@ -28,7 +29,7 @@ interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
|
28
29
|
format?: Format;
|
|
29
30
|
}
|
|
30
31
|
/** @oneof */
|
|
31
|
-
interface TranslatableContentContentOneOf {
|
|
32
|
+
export interface TranslatableContentContentOneOf {
|
|
32
33
|
/**
|
|
33
34
|
* Plain text.
|
|
34
35
|
* @minLength 1
|
|
@@ -44,7 +45,7 @@ interface TranslatableContentContentOneOf {
|
|
|
44
45
|
/** Rich content. */
|
|
45
46
|
richContent?: RichContent;
|
|
46
47
|
}
|
|
47
|
-
declare enum Format {
|
|
48
|
+
export declare enum Format {
|
|
48
49
|
/** Unspecified format. */
|
|
49
50
|
UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
|
|
50
51
|
/** Plain text content. */
|
|
@@ -54,7 +55,7 @@ declare enum Format {
|
|
|
54
55
|
/** Rich Content. */
|
|
55
56
|
RICH = "RICH"
|
|
56
57
|
}
|
|
57
|
-
interface RichContent {
|
|
58
|
+
export interface RichContent {
|
|
58
59
|
/** Node objects representing a rich content document. */
|
|
59
60
|
nodes?: Node[];
|
|
60
61
|
/** Object metadata. */
|
|
@@ -62,7 +63,7 @@ interface RichContent {
|
|
|
62
63
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
63
64
|
documentStyle?: DocumentStyle;
|
|
64
65
|
}
|
|
65
|
-
interface Node extends NodeDataOneOf {
|
|
66
|
+
export interface Node extends NodeDataOneOf {
|
|
66
67
|
/** Data for a button node. */
|
|
67
68
|
buttonData?: ButtonData;
|
|
68
69
|
/** Data for a code block node. */
|
|
@@ -127,7 +128,7 @@ interface Node extends NodeDataOneOf {
|
|
|
127
128
|
style?: NodeStyle;
|
|
128
129
|
}
|
|
129
130
|
/** @oneof */
|
|
130
|
-
interface NodeDataOneOf {
|
|
131
|
+
export interface NodeDataOneOf {
|
|
131
132
|
/** Data for a button node. */
|
|
132
133
|
buttonData?: ButtonData;
|
|
133
134
|
/** Data for a code block node. */
|
|
@@ -183,7 +184,7 @@ interface NodeDataOneOf {
|
|
|
183
184
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
184
185
|
layoutCellData?: LayoutCellData;
|
|
185
186
|
}
|
|
186
|
-
declare enum NodeType {
|
|
187
|
+
export declare enum NodeType {
|
|
187
188
|
PARAGRAPH = "PARAGRAPH",
|
|
188
189
|
TEXT = "TEXT",
|
|
189
190
|
HEADING = "HEADING",
|
|
@@ -219,7 +220,7 @@ declare enum NodeType {
|
|
|
219
220
|
LAYOUT = "LAYOUT",
|
|
220
221
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
221
222
|
}
|
|
222
|
-
interface NodeStyle {
|
|
223
|
+
export interface NodeStyle {
|
|
223
224
|
/** The top padding value in pixels. */
|
|
224
225
|
paddingTop?: string | null;
|
|
225
226
|
/** The bottom padding value in pixels. */
|
|
@@ -227,7 +228,7 @@ interface NodeStyle {
|
|
|
227
228
|
/** The background color as a hexadecimal value. */
|
|
228
229
|
backgroundColor?: string | null;
|
|
229
230
|
}
|
|
230
|
-
interface ButtonData {
|
|
231
|
+
export interface ButtonData {
|
|
231
232
|
/** Styling for the button's container. */
|
|
232
233
|
containerData?: PluginContainerData;
|
|
233
234
|
/** The button type. */
|
|
@@ -239,7 +240,7 @@ interface ButtonData {
|
|
|
239
240
|
/** Button link details. */
|
|
240
241
|
link?: Link;
|
|
241
242
|
}
|
|
242
|
-
interface Border {
|
|
243
|
+
export interface Border {
|
|
243
244
|
/**
|
|
244
245
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
245
246
|
* @deprecated
|
|
@@ -251,7 +252,7 @@ interface Border {
|
|
|
251
252
|
*/
|
|
252
253
|
radius?: number | null;
|
|
253
254
|
}
|
|
254
|
-
interface Colors {
|
|
255
|
+
export interface Colors {
|
|
255
256
|
/**
|
|
256
257
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
257
258
|
* @deprecated
|
|
@@ -268,7 +269,7 @@ interface Colors {
|
|
|
268
269
|
*/
|
|
269
270
|
background?: string | null;
|
|
270
271
|
}
|
|
271
|
-
interface PluginContainerData {
|
|
272
|
+
export interface PluginContainerData {
|
|
272
273
|
/** The width of the node when it's displayed. */
|
|
273
274
|
width?: PluginContainerDataWidth;
|
|
274
275
|
/** The node's alignment within its container. */
|
|
@@ -280,7 +281,7 @@ interface PluginContainerData {
|
|
|
280
281
|
/** 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`. */
|
|
281
282
|
textWrap?: boolean | null;
|
|
282
283
|
}
|
|
283
|
-
declare enum WidthType {
|
|
284
|
+
export declare enum WidthType {
|
|
284
285
|
/** Width matches the content width */
|
|
285
286
|
CONTENT = "CONTENT",
|
|
286
287
|
/** Small Width */
|
|
@@ -290,7 +291,7 @@ declare enum WidthType {
|
|
|
290
291
|
/** coast-to-coast display */
|
|
291
292
|
FULL_WIDTH = "FULL_WIDTH"
|
|
292
293
|
}
|
|
293
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
294
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
294
295
|
/**
|
|
295
296
|
* One of the following predefined width options:
|
|
296
297
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -303,7 +304,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
303
304
|
custom?: string | null;
|
|
304
305
|
}
|
|
305
306
|
/** @oneof */
|
|
306
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
307
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
307
308
|
/**
|
|
308
309
|
* One of the following predefined width options:
|
|
309
310
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -315,7 +316,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
315
316
|
/** A custom width value in pixels. */
|
|
316
317
|
custom?: string | null;
|
|
317
318
|
}
|
|
318
|
-
declare enum PluginContainerDataAlignment {
|
|
319
|
+
export declare enum PluginContainerDataAlignment {
|
|
319
320
|
/** Center Alignment */
|
|
320
321
|
CENTER = "CENTER",
|
|
321
322
|
/** Left Alignment */
|
|
@@ -323,7 +324,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
323
324
|
/** Right Alignment */
|
|
324
325
|
RIGHT = "RIGHT"
|
|
325
326
|
}
|
|
326
|
-
interface Spoiler {
|
|
327
|
+
export interface Spoiler {
|
|
327
328
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
328
329
|
enabled?: boolean | null;
|
|
329
330
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -331,17 +332,17 @@ interface Spoiler {
|
|
|
331
332
|
/** The text for the button used to remove the spoiler cover. */
|
|
332
333
|
buttonText?: string | null;
|
|
333
334
|
}
|
|
334
|
-
interface Height {
|
|
335
|
+
export interface Height {
|
|
335
336
|
/** A custom height value in pixels. */
|
|
336
337
|
custom?: string | null;
|
|
337
338
|
}
|
|
338
|
-
declare enum Type {
|
|
339
|
+
export declare enum Type {
|
|
339
340
|
/** Regular link button */
|
|
340
341
|
LINK = "LINK",
|
|
341
342
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
342
343
|
ACTION = "ACTION"
|
|
343
344
|
}
|
|
344
|
-
interface Styles {
|
|
345
|
+
export interface Styles {
|
|
345
346
|
/**
|
|
346
347
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
347
348
|
* @deprecated
|
|
@@ -394,7 +395,7 @@ interface Styles {
|
|
|
394
395
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
395
396
|
buttonSize?: string | null;
|
|
396
397
|
}
|
|
397
|
-
interface Link extends LinkDataOneOf {
|
|
398
|
+
export interface Link extends LinkDataOneOf {
|
|
398
399
|
/** The absolute URL for the linked document. */
|
|
399
400
|
url?: string;
|
|
400
401
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -413,13 +414,13 @@ interface Link extends LinkDataOneOf {
|
|
|
413
414
|
customData?: string | null;
|
|
414
415
|
}
|
|
415
416
|
/** @oneof */
|
|
416
|
-
interface LinkDataOneOf {
|
|
417
|
+
export interface LinkDataOneOf {
|
|
417
418
|
/** The absolute URL for the linked document. */
|
|
418
419
|
url?: string;
|
|
419
420
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
420
421
|
anchor?: string;
|
|
421
422
|
}
|
|
422
|
-
declare enum Target {
|
|
423
|
+
export declare enum Target {
|
|
423
424
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
424
425
|
SELF = "SELF",
|
|
425
426
|
/** Opens the linked document in a new window or tab */
|
|
@@ -429,7 +430,7 @@ declare enum Target {
|
|
|
429
430
|
/** Opens the linked document in the full body of the window */
|
|
430
431
|
TOP = "TOP"
|
|
431
432
|
}
|
|
432
|
-
interface Rel {
|
|
433
|
+
export interface Rel {
|
|
433
434
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
434
435
|
nofollow?: boolean | null;
|
|
435
436
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -439,17 +440,17 @@ interface Rel {
|
|
|
439
440
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
440
441
|
noreferrer?: boolean | null;
|
|
441
442
|
}
|
|
442
|
-
interface CodeBlockData {
|
|
443
|
+
export interface CodeBlockData {
|
|
443
444
|
/** Styling for the code block's text. */
|
|
444
445
|
textStyle?: TextStyle;
|
|
445
446
|
}
|
|
446
|
-
interface TextStyle {
|
|
447
|
+
export interface TextStyle {
|
|
447
448
|
/** Text alignment. Defaults to `AUTO`. */
|
|
448
449
|
textAlignment?: TextAlignment;
|
|
449
450
|
/** 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. */
|
|
450
451
|
lineHeight?: string | null;
|
|
451
452
|
}
|
|
452
|
-
declare enum TextAlignment {
|
|
453
|
+
export declare enum TextAlignment {
|
|
453
454
|
/** browser default, eqivalent to `initial` */
|
|
454
455
|
AUTO = "AUTO",
|
|
455
456
|
/** Left align */
|
|
@@ -461,7 +462,7 @@ declare enum TextAlignment {
|
|
|
461
462
|
/** 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 */
|
|
462
463
|
JUSTIFY = "JUSTIFY"
|
|
463
464
|
}
|
|
464
|
-
interface DividerData {
|
|
465
|
+
export interface DividerData {
|
|
465
466
|
/** Styling for the divider's container. */
|
|
466
467
|
containerData?: PluginContainerData;
|
|
467
468
|
/** Divider line style. */
|
|
@@ -471,7 +472,7 @@ interface DividerData {
|
|
|
471
472
|
/** Divider alignment. */
|
|
472
473
|
alignment?: Alignment;
|
|
473
474
|
}
|
|
474
|
-
declare enum LineStyle {
|
|
475
|
+
export declare enum LineStyle {
|
|
475
476
|
/** Single Line */
|
|
476
477
|
SINGLE = "SINGLE",
|
|
477
478
|
/** Double Line */
|
|
@@ -481,7 +482,7 @@ declare enum LineStyle {
|
|
|
481
482
|
/** Dotted Line */
|
|
482
483
|
DOTTED = "DOTTED"
|
|
483
484
|
}
|
|
484
|
-
declare enum Width {
|
|
485
|
+
export declare enum Width {
|
|
485
486
|
/** Large line */
|
|
486
487
|
LARGE = "LARGE",
|
|
487
488
|
/** Medium line */
|
|
@@ -489,7 +490,7 @@ declare enum Width {
|
|
|
489
490
|
/** Small line */
|
|
490
491
|
SMALL = "SMALL"
|
|
491
492
|
}
|
|
492
|
-
declare enum Alignment {
|
|
493
|
+
export declare enum Alignment {
|
|
493
494
|
/** Center alignment */
|
|
494
495
|
CENTER = "CENTER",
|
|
495
496
|
/** Left alignment */
|
|
@@ -497,7 +498,7 @@ declare enum Alignment {
|
|
|
497
498
|
/** Right alignment */
|
|
498
499
|
RIGHT = "RIGHT"
|
|
499
500
|
}
|
|
500
|
-
interface FileData {
|
|
501
|
+
export interface FileData {
|
|
501
502
|
/** Styling for the file's container. */
|
|
502
503
|
containerData?: PluginContainerData;
|
|
503
504
|
/** The source for the file's data. */
|
|
@@ -520,7 +521,7 @@ interface FileData {
|
|
|
520
521
|
/** File size in KB. */
|
|
521
522
|
sizeInKb?: string | null;
|
|
522
523
|
}
|
|
523
|
-
declare enum ViewMode {
|
|
524
|
+
export declare enum ViewMode {
|
|
524
525
|
/** No PDF view */
|
|
525
526
|
NONE = "NONE",
|
|
526
527
|
/** Full PDF view */
|
|
@@ -528,7 +529,7 @@ declare enum ViewMode {
|
|
|
528
529
|
/** Mini PDF view */
|
|
529
530
|
MINI = "MINI"
|
|
530
531
|
}
|
|
531
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
532
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
532
533
|
/** The absolute URL for the file's source. */
|
|
533
534
|
url?: string | null;
|
|
534
535
|
/**
|
|
@@ -542,7 +543,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
542
543
|
private?: boolean | null;
|
|
543
544
|
}
|
|
544
545
|
/** @oneof */
|
|
545
|
-
interface FileSourceDataOneOf {
|
|
546
|
+
export interface FileSourceDataOneOf {
|
|
546
547
|
/** The absolute URL for the file's source. */
|
|
547
548
|
url?: string | null;
|
|
548
549
|
/**
|
|
@@ -553,7 +554,7 @@ interface FileSourceDataOneOf {
|
|
|
553
554
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
554
555
|
_id?: string | null;
|
|
555
556
|
}
|
|
556
|
-
interface PDFSettings {
|
|
557
|
+
export interface PDFSettings {
|
|
557
558
|
/**
|
|
558
559
|
* PDF view mode. One of the following:
|
|
559
560
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -566,7 +567,7 @@ interface PDFSettings {
|
|
|
566
567
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
567
568
|
disablePrint?: boolean | null;
|
|
568
569
|
}
|
|
569
|
-
interface GalleryData {
|
|
570
|
+
export interface GalleryData {
|
|
570
571
|
/** Styling for the gallery's container. */
|
|
571
572
|
containerData?: PluginContainerData;
|
|
572
573
|
/** The items in the gallery. */
|
|
@@ -578,7 +579,7 @@ interface GalleryData {
|
|
|
578
579
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
579
580
|
disableDownload?: boolean | null;
|
|
580
581
|
}
|
|
581
|
-
interface Media {
|
|
582
|
+
export interface Media {
|
|
582
583
|
/** The source for the media's data. */
|
|
583
584
|
src?: FileSource;
|
|
584
585
|
/** Media width in pixels. */
|
|
@@ -588,19 +589,19 @@ interface Media {
|
|
|
588
589
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
589
590
|
duration?: number | null;
|
|
590
591
|
}
|
|
591
|
-
interface Image {
|
|
592
|
+
export interface Image {
|
|
592
593
|
/** Image file details. */
|
|
593
594
|
media?: Media;
|
|
594
595
|
/** Link details for images that are links. */
|
|
595
596
|
link?: Link;
|
|
596
597
|
}
|
|
597
|
-
interface Video {
|
|
598
|
+
export interface Video {
|
|
598
599
|
/** Video file details. */
|
|
599
600
|
media?: Media;
|
|
600
601
|
/** Video thumbnail file details. */
|
|
601
602
|
thumbnail?: Media;
|
|
602
603
|
}
|
|
603
|
-
interface Item extends ItemDataOneOf {
|
|
604
|
+
export interface Item extends ItemDataOneOf {
|
|
604
605
|
/** An image item. */
|
|
605
606
|
image?: Image;
|
|
606
607
|
/** A video item. */
|
|
@@ -611,13 +612,13 @@ interface Item extends ItemDataOneOf {
|
|
|
611
612
|
altText?: string | null;
|
|
612
613
|
}
|
|
613
614
|
/** @oneof */
|
|
614
|
-
interface ItemDataOneOf {
|
|
615
|
+
export interface ItemDataOneOf {
|
|
615
616
|
/** An image item. */
|
|
616
617
|
image?: Image;
|
|
617
618
|
/** A video item. */
|
|
618
619
|
video?: Video;
|
|
619
620
|
}
|
|
620
|
-
interface GalleryOptions {
|
|
621
|
+
export interface GalleryOptions {
|
|
621
622
|
/** Gallery layout. */
|
|
622
623
|
layout?: Layout;
|
|
623
624
|
/** Styling for gallery items. */
|
|
@@ -625,7 +626,7 @@ interface GalleryOptions {
|
|
|
625
626
|
/** Styling for gallery thumbnail images. */
|
|
626
627
|
thumbnails?: Thumbnails;
|
|
627
628
|
}
|
|
628
|
-
declare enum LayoutType {
|
|
629
|
+
export declare enum LayoutType {
|
|
629
630
|
/** Collage type */
|
|
630
631
|
COLLAGE = "COLLAGE",
|
|
631
632
|
/** Masonry type */
|
|
@@ -647,19 +648,19 @@ declare enum LayoutType {
|
|
|
647
648
|
/** Fullsize images type */
|
|
648
649
|
FULLSIZE = "FULLSIZE"
|
|
649
650
|
}
|
|
650
|
-
declare enum Orientation {
|
|
651
|
+
export declare enum Orientation {
|
|
651
652
|
/** Rows Orientation */
|
|
652
653
|
ROWS = "ROWS",
|
|
653
654
|
/** Columns Orientation */
|
|
654
655
|
COLUMNS = "COLUMNS"
|
|
655
656
|
}
|
|
656
|
-
declare enum Crop {
|
|
657
|
+
export declare enum Crop {
|
|
657
658
|
/** Crop to fill */
|
|
658
659
|
FILL = "FILL",
|
|
659
660
|
/** Crop to fit */
|
|
660
661
|
FIT = "FIT"
|
|
661
662
|
}
|
|
662
|
-
declare enum ThumbnailsAlignment {
|
|
663
|
+
export declare enum ThumbnailsAlignment {
|
|
663
664
|
/** Top alignment */
|
|
664
665
|
TOP = "TOP",
|
|
665
666
|
/** Right alignment */
|
|
@@ -671,7 +672,7 @@ declare enum ThumbnailsAlignment {
|
|
|
671
672
|
/** No thumbnail */
|
|
672
673
|
NONE = "NONE"
|
|
673
674
|
}
|
|
674
|
-
interface Layout {
|
|
675
|
+
export interface Layout {
|
|
675
676
|
/** Gallery layout type. */
|
|
676
677
|
type?: LayoutType;
|
|
677
678
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -683,7 +684,7 @@ interface Layout {
|
|
|
683
684
|
/** The number of columns to display on mobile screens. */
|
|
684
685
|
mobileNumberOfColumns?: number | null;
|
|
685
686
|
}
|
|
686
|
-
interface ItemStyle {
|
|
687
|
+
export interface ItemStyle {
|
|
687
688
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
688
689
|
targetSize?: number | null;
|
|
689
690
|
/** Item ratio */
|
|
@@ -693,13 +694,13 @@ interface ItemStyle {
|
|
|
693
694
|
/** The spacing between items in pixels. */
|
|
694
695
|
spacing?: number | null;
|
|
695
696
|
}
|
|
696
|
-
interface Thumbnails {
|
|
697
|
+
export interface Thumbnails {
|
|
697
698
|
/** Thumbnail alignment. */
|
|
698
699
|
placement?: ThumbnailsAlignment;
|
|
699
700
|
/** Spacing between thumbnails in pixels. */
|
|
700
701
|
spacing?: number | null;
|
|
701
702
|
}
|
|
702
|
-
interface GIFData {
|
|
703
|
+
export interface GIFData {
|
|
703
704
|
/** Styling for the GIF's container. */
|
|
704
705
|
containerData?: PluginContainerData;
|
|
705
706
|
/** The source of the full size GIF. */
|
|
@@ -713,7 +714,7 @@ interface GIFData {
|
|
|
713
714
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
714
715
|
gifType?: GIFType;
|
|
715
716
|
}
|
|
716
|
-
interface GIF {
|
|
717
|
+
export interface GIF {
|
|
717
718
|
/**
|
|
718
719
|
* GIF format URL.
|
|
719
720
|
* @format WEB_URL
|
|
@@ -730,11 +731,11 @@ interface GIF {
|
|
|
730
731
|
*/
|
|
731
732
|
still?: string | null;
|
|
732
733
|
}
|
|
733
|
-
declare enum GIFType {
|
|
734
|
+
export declare enum GIFType {
|
|
734
735
|
NORMAL = "NORMAL",
|
|
735
736
|
STICKER = "STICKER"
|
|
736
737
|
}
|
|
737
|
-
interface HeadingData {
|
|
738
|
+
export interface HeadingData {
|
|
738
739
|
/** Heading level from 1-6. */
|
|
739
740
|
level?: number;
|
|
740
741
|
/** Styling for the heading text. */
|
|
@@ -742,7 +743,7 @@ interface HeadingData {
|
|
|
742
743
|
/** Indentation level from 1-4. */
|
|
743
744
|
indentation?: number | null;
|
|
744
745
|
}
|
|
745
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
746
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
746
747
|
/** The URL for the HTML code for the node. */
|
|
747
748
|
url?: string;
|
|
748
749
|
/** The HTML code for the node. */
|
|
@@ -760,7 +761,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
760
761
|
autoHeight?: boolean | null;
|
|
761
762
|
}
|
|
762
763
|
/** @oneof */
|
|
763
|
-
interface HTMLDataDataOneOf {
|
|
764
|
+
export interface HTMLDataDataOneOf {
|
|
764
765
|
/** The URL for the HTML code for the node. */
|
|
765
766
|
url?: string;
|
|
766
767
|
/** The HTML code for the node. */
|
|
@@ -771,11 +772,11 @@ interface HTMLDataDataOneOf {
|
|
|
771
772
|
*/
|
|
772
773
|
isAdsense?: boolean | null;
|
|
773
774
|
}
|
|
774
|
-
declare enum Source {
|
|
775
|
+
export declare enum Source {
|
|
775
776
|
HTML = "HTML",
|
|
776
777
|
ADSENSE = "ADSENSE"
|
|
777
778
|
}
|
|
778
|
-
interface ImageData {
|
|
779
|
+
export interface ImageData {
|
|
779
780
|
/** Styling for the image's container. */
|
|
780
781
|
containerData?: PluginContainerData;
|
|
781
782
|
/** Image file details. */
|
|
@@ -798,7 +799,7 @@ interface ImageData {
|
|
|
798
799
|
/** Styling for the image. */
|
|
799
800
|
styles?: ImageDataStyles;
|
|
800
801
|
}
|
|
801
|
-
interface StylesBorder {
|
|
802
|
+
export interface StylesBorder {
|
|
802
803
|
/** Border width in pixels. */
|
|
803
804
|
width?: number | null;
|
|
804
805
|
/**
|
|
@@ -809,11 +810,11 @@ interface StylesBorder {
|
|
|
809
810
|
/** Border radius in pixels. */
|
|
810
811
|
radius?: number | null;
|
|
811
812
|
}
|
|
812
|
-
interface ImageDataStyles {
|
|
813
|
+
export interface ImageDataStyles {
|
|
813
814
|
/** Border attributes. */
|
|
814
815
|
border?: StylesBorder;
|
|
815
816
|
}
|
|
816
|
-
interface LinkPreviewData {
|
|
817
|
+
export interface LinkPreviewData {
|
|
817
818
|
/** Styling for the link preview's container. */
|
|
818
819
|
containerData?: PluginContainerData;
|
|
819
820
|
/** Link details. */
|
|
@@ -829,7 +830,7 @@ interface LinkPreviewData {
|
|
|
829
830
|
/** Styling for the link preview. */
|
|
830
831
|
styles?: LinkPreviewDataStyles;
|
|
831
832
|
}
|
|
832
|
-
declare enum Position {
|
|
833
|
+
export declare enum Position {
|
|
833
834
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
834
835
|
START = "START",
|
|
835
836
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -839,7 +840,7 @@ declare enum Position {
|
|
|
839
840
|
/** Thumbnail hidden and not displayed */
|
|
840
841
|
HIDDEN = "HIDDEN"
|
|
841
842
|
}
|
|
842
|
-
interface LinkPreviewDataStyles {
|
|
843
|
+
export interface LinkPreviewDataStyles {
|
|
843
844
|
/**
|
|
844
845
|
* Background color as a hexadecimal value.
|
|
845
846
|
* @format COLOR_HEX
|
|
@@ -872,13 +873,13 @@ interface LinkPreviewDataStyles {
|
|
|
872
873
|
/** Position of thumbnail. Defaults to `START`. */
|
|
873
874
|
thumbnailPosition?: Position;
|
|
874
875
|
}
|
|
875
|
-
interface MapData {
|
|
876
|
+
export interface MapData {
|
|
876
877
|
/** Styling for the map's container. */
|
|
877
878
|
containerData?: PluginContainerData;
|
|
878
879
|
/** Map settings. */
|
|
879
880
|
mapSettings?: MapSettings;
|
|
880
881
|
}
|
|
881
|
-
interface MapSettings {
|
|
882
|
+
export interface MapSettings {
|
|
882
883
|
/** The address to display on the map. */
|
|
883
884
|
address?: string | null;
|
|
884
885
|
/** Sets whether the map is draggable. */
|
|
@@ -902,7 +903,7 @@ interface MapSettings {
|
|
|
902
903
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
903
904
|
mapType?: MapType;
|
|
904
905
|
}
|
|
905
|
-
declare enum MapType {
|
|
906
|
+
export declare enum MapType {
|
|
906
907
|
/** Roadmap map type */
|
|
907
908
|
ROADMAP = "ROADMAP",
|
|
908
909
|
/** Satellite map type */
|
|
@@ -912,7 +913,7 @@ declare enum MapType {
|
|
|
912
913
|
/** Terrain map type */
|
|
913
914
|
TERRAIN = "TERRAIN"
|
|
914
915
|
}
|
|
915
|
-
interface ParagraphData {
|
|
916
|
+
export interface ParagraphData {
|
|
916
917
|
/** Styling for the paragraph text. */
|
|
917
918
|
textStyle?: TextStyle;
|
|
918
919
|
/** Indentation level from 1-4. */
|
|
@@ -920,7 +921,7 @@ interface ParagraphData {
|
|
|
920
921
|
/** Paragraph level */
|
|
921
922
|
level?: number | null;
|
|
922
923
|
}
|
|
923
|
-
interface PollData {
|
|
924
|
+
export interface PollData {
|
|
924
925
|
/** Styling for the poll's container. */
|
|
925
926
|
containerData?: PluginContainerData;
|
|
926
927
|
/** Poll data. */
|
|
@@ -930,7 +931,7 @@ interface PollData {
|
|
|
930
931
|
/** Styling for the poll and voting options. */
|
|
931
932
|
design?: Design;
|
|
932
933
|
}
|
|
933
|
-
declare enum ViewRole {
|
|
934
|
+
export declare enum ViewRole {
|
|
934
935
|
/** Only Poll creator can view the results */
|
|
935
936
|
CREATOR = "CREATOR",
|
|
936
937
|
/** Anyone who voted can see the results */
|
|
@@ -938,13 +939,13 @@ declare enum ViewRole {
|
|
|
938
939
|
/** Anyone can see the results, even if one didn't vote */
|
|
939
940
|
EVERYONE = "EVERYONE"
|
|
940
941
|
}
|
|
941
|
-
declare enum VoteRole {
|
|
942
|
+
export declare enum VoteRole {
|
|
942
943
|
/** Logged in member */
|
|
943
944
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
944
945
|
/** Anyone */
|
|
945
946
|
ALL = "ALL"
|
|
946
947
|
}
|
|
947
|
-
interface Permissions {
|
|
948
|
+
export interface Permissions {
|
|
948
949
|
/** Sets who can view the poll results. */
|
|
949
950
|
view?: ViewRole;
|
|
950
951
|
/** Sets who can vote. */
|
|
@@ -952,7 +953,7 @@ interface Permissions {
|
|
|
952
953
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
953
954
|
allowMultipleVotes?: boolean | null;
|
|
954
955
|
}
|
|
955
|
-
interface Option {
|
|
956
|
+
export interface Option {
|
|
956
957
|
/** Option ID. */
|
|
957
958
|
_id?: string | null;
|
|
958
959
|
/** Option title. */
|
|
@@ -960,7 +961,7 @@ interface Option {
|
|
|
960
961
|
/** The image displayed with the option. */
|
|
961
962
|
image?: Media;
|
|
962
963
|
}
|
|
963
|
-
interface Settings {
|
|
964
|
+
export interface Settings {
|
|
964
965
|
/** Permissions settings for voting. */
|
|
965
966
|
permissions?: Permissions;
|
|
966
967
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -968,19 +969,19 @@ interface Settings {
|
|
|
968
969
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
969
970
|
showVotesCount?: boolean | null;
|
|
970
971
|
}
|
|
971
|
-
declare enum PollLayoutType {
|
|
972
|
+
export declare enum PollLayoutType {
|
|
972
973
|
/** List */
|
|
973
974
|
LIST = "LIST",
|
|
974
975
|
/** Grid */
|
|
975
976
|
GRID = "GRID"
|
|
976
977
|
}
|
|
977
|
-
declare enum PollLayoutDirection {
|
|
978
|
+
export declare enum PollLayoutDirection {
|
|
978
979
|
/** Left-to-right */
|
|
979
980
|
LTR = "LTR",
|
|
980
981
|
/** Right-to-left */
|
|
981
982
|
RTL = "RTL"
|
|
982
983
|
}
|
|
983
|
-
interface PollLayout {
|
|
984
|
+
export interface PollLayout {
|
|
984
985
|
/** The layout for displaying the voting options. */
|
|
985
986
|
type?: PollLayoutType;
|
|
986
987
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -988,11 +989,11 @@ interface PollLayout {
|
|
|
988
989
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
989
990
|
enableImage?: boolean | null;
|
|
990
991
|
}
|
|
991
|
-
interface OptionLayout {
|
|
992
|
+
export interface OptionLayout {
|
|
992
993
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
993
994
|
enableImage?: boolean | null;
|
|
994
995
|
}
|
|
995
|
-
declare enum BackgroundType {
|
|
996
|
+
export declare enum BackgroundType {
|
|
996
997
|
/** Color background type */
|
|
997
998
|
COLOR = "COLOR",
|
|
998
999
|
/** Image background type */
|
|
@@ -1000,7 +1001,7 @@ declare enum BackgroundType {
|
|
|
1000
1001
|
/** Gradiant background type */
|
|
1001
1002
|
GRADIENT = "GRADIENT"
|
|
1002
1003
|
}
|
|
1003
|
-
interface Gradient {
|
|
1004
|
+
export interface Gradient {
|
|
1004
1005
|
/** The gradient angle in degrees. */
|
|
1005
1006
|
angle?: number | null;
|
|
1006
1007
|
/**
|
|
@@ -1014,7 +1015,7 @@ interface Gradient {
|
|
|
1014
1015
|
*/
|
|
1015
1016
|
lastColor?: string | null;
|
|
1016
1017
|
}
|
|
1017
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1018
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1018
1019
|
/**
|
|
1019
1020
|
* The background color as a hexademical value.
|
|
1020
1021
|
* @format COLOR_HEX
|
|
@@ -1028,7 +1029,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1028
1029
|
type?: BackgroundType;
|
|
1029
1030
|
}
|
|
1030
1031
|
/** @oneof */
|
|
1031
|
-
interface BackgroundBackgroundOneOf {
|
|
1032
|
+
export interface BackgroundBackgroundOneOf {
|
|
1032
1033
|
/**
|
|
1033
1034
|
* The background color as a hexademical value.
|
|
1034
1035
|
* @format COLOR_HEX
|
|
@@ -1039,17 +1040,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
1039
1040
|
/** Details for a gradient background. */
|
|
1040
1041
|
gradient?: Gradient;
|
|
1041
1042
|
}
|
|
1042
|
-
interface PollDesign {
|
|
1043
|
+
export interface PollDesign {
|
|
1043
1044
|
/** Background styling. */
|
|
1044
1045
|
background?: Background;
|
|
1045
1046
|
/** Border radius in pixels. */
|
|
1046
1047
|
borderRadius?: number | null;
|
|
1047
1048
|
}
|
|
1048
|
-
interface OptionDesign {
|
|
1049
|
+
export interface OptionDesign {
|
|
1049
1050
|
/** Border radius in pixels. */
|
|
1050
1051
|
borderRadius?: number | null;
|
|
1051
1052
|
}
|
|
1052
|
-
interface Poll {
|
|
1053
|
+
export interface Poll {
|
|
1053
1054
|
/** Poll ID. */
|
|
1054
1055
|
_id?: string | null;
|
|
1055
1056
|
/** Poll title. */
|
|
@@ -1063,26 +1064,26 @@ interface Poll {
|
|
|
1063
1064
|
/** The poll's permissions and display settings. */
|
|
1064
1065
|
settings?: Settings;
|
|
1065
1066
|
}
|
|
1066
|
-
interface PollDataLayout {
|
|
1067
|
+
export interface PollDataLayout {
|
|
1067
1068
|
/** Poll layout settings. */
|
|
1068
1069
|
poll?: PollLayout;
|
|
1069
1070
|
/** Voting otpions layout settings. */
|
|
1070
1071
|
options?: OptionLayout;
|
|
1071
1072
|
}
|
|
1072
|
-
interface Design {
|
|
1073
|
+
export interface Design {
|
|
1073
1074
|
/** Styling for the poll. */
|
|
1074
1075
|
poll?: PollDesign;
|
|
1075
1076
|
/** Styling for voting options. */
|
|
1076
1077
|
options?: OptionDesign;
|
|
1077
1078
|
}
|
|
1078
|
-
interface TextData {
|
|
1079
|
+
export interface TextData {
|
|
1079
1080
|
/** The text to apply decorations to. */
|
|
1080
1081
|
text?: string;
|
|
1081
1082
|
/** The decorations to apply. */
|
|
1082
1083
|
decorations?: Decoration[];
|
|
1083
1084
|
}
|
|
1084
1085
|
/** Adds appearence changes to text */
|
|
1085
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1086
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1086
1087
|
/** Data for an anchor link decoration. */
|
|
1087
1088
|
anchorData?: AnchorData;
|
|
1088
1089
|
/** Data for a color decoration. */
|
|
@@ -1101,11 +1102,13 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1101
1102
|
underlineData?: boolean | null;
|
|
1102
1103
|
/** Data for a spoiler decoration. */
|
|
1103
1104
|
spoilerData?: SpoilerData;
|
|
1105
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1106
|
+
strikethroughData?: boolean | null;
|
|
1104
1107
|
/** The type of decoration to apply. */
|
|
1105
1108
|
type?: DecorationType;
|
|
1106
1109
|
}
|
|
1107
1110
|
/** @oneof */
|
|
1108
|
-
interface DecorationDataOneOf {
|
|
1111
|
+
export interface DecorationDataOneOf {
|
|
1109
1112
|
/** Data for an anchor link decoration. */
|
|
1110
1113
|
anchorData?: AnchorData;
|
|
1111
1114
|
/** Data for a color decoration. */
|
|
@@ -1124,8 +1127,10 @@ interface DecorationDataOneOf {
|
|
|
1124
1127
|
underlineData?: boolean | null;
|
|
1125
1128
|
/** Data for a spoiler decoration. */
|
|
1126
1129
|
spoilerData?: SpoilerData;
|
|
1130
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1131
|
+
strikethroughData?: boolean | null;
|
|
1127
1132
|
}
|
|
1128
|
-
declare enum DecorationType {
|
|
1133
|
+
export declare enum DecorationType {
|
|
1129
1134
|
BOLD = "BOLD",
|
|
1130
1135
|
ITALIC = "ITALIC",
|
|
1131
1136
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1135,23 +1140,24 @@ declare enum DecorationType {
|
|
|
1135
1140
|
LINK = "LINK",
|
|
1136
1141
|
COLOR = "COLOR",
|
|
1137
1142
|
FONT_SIZE = "FONT_SIZE",
|
|
1138
|
-
EXTERNAL = "EXTERNAL"
|
|
1143
|
+
EXTERNAL = "EXTERNAL",
|
|
1144
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1139
1145
|
}
|
|
1140
|
-
interface AnchorData {
|
|
1146
|
+
export interface AnchorData {
|
|
1141
1147
|
/** The target node's ID. */
|
|
1142
1148
|
anchor?: string;
|
|
1143
1149
|
}
|
|
1144
|
-
interface ColorData {
|
|
1150
|
+
export interface ColorData {
|
|
1145
1151
|
/** The text's background color as a hexadecimal value. */
|
|
1146
1152
|
background?: string | null;
|
|
1147
1153
|
/** The text's foreground color as a hexadecimal value. */
|
|
1148
1154
|
foreground?: string | null;
|
|
1149
1155
|
}
|
|
1150
|
-
interface LinkData {
|
|
1156
|
+
export interface LinkData {
|
|
1151
1157
|
/** Link details. */
|
|
1152
1158
|
link?: Link;
|
|
1153
1159
|
}
|
|
1154
|
-
interface MentionData {
|
|
1160
|
+
export interface MentionData {
|
|
1155
1161
|
/** The mentioned user's name. */
|
|
1156
1162
|
name?: string;
|
|
1157
1163
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1159,21 +1165,21 @@ interface MentionData {
|
|
|
1159
1165
|
/** Mentioned user's ID. */
|
|
1160
1166
|
_id?: string | null;
|
|
1161
1167
|
}
|
|
1162
|
-
interface FontSizeData {
|
|
1168
|
+
export interface FontSizeData {
|
|
1163
1169
|
/** The units used for the font size. */
|
|
1164
1170
|
unit?: FontType;
|
|
1165
1171
|
/** Font size value. */
|
|
1166
1172
|
value?: number | null;
|
|
1167
1173
|
}
|
|
1168
|
-
declare enum FontType {
|
|
1174
|
+
export declare enum FontType {
|
|
1169
1175
|
PX = "PX",
|
|
1170
1176
|
EM = "EM"
|
|
1171
1177
|
}
|
|
1172
|
-
interface SpoilerData {
|
|
1178
|
+
export interface SpoilerData {
|
|
1173
1179
|
/** Spoiler ID. */
|
|
1174
1180
|
_id?: string | null;
|
|
1175
1181
|
}
|
|
1176
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1182
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1177
1183
|
/** Data for embedded Wix Bookings content. */
|
|
1178
1184
|
bookingData?: BookingData;
|
|
1179
1185
|
/** Data for embedded Wix Events content. */
|
|
@@ -1195,28 +1201,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1195
1201
|
image?: Media;
|
|
1196
1202
|
}
|
|
1197
1203
|
/** @oneof */
|
|
1198
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1204
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1199
1205
|
/** Data for embedded Wix Bookings content. */
|
|
1200
1206
|
bookingData?: BookingData;
|
|
1201
1207
|
/** Data for embedded Wix Events content. */
|
|
1202
1208
|
eventData?: EventData;
|
|
1203
1209
|
}
|
|
1204
|
-
declare enum AppType {
|
|
1210
|
+
export declare enum AppType {
|
|
1205
1211
|
PRODUCT = "PRODUCT",
|
|
1206
1212
|
EVENT = "EVENT",
|
|
1207
1213
|
BOOKING = "BOOKING"
|
|
1208
1214
|
}
|
|
1209
|
-
interface BookingData {
|
|
1215
|
+
export interface BookingData {
|
|
1210
1216
|
/** Booking duration in minutes. */
|
|
1211
1217
|
durations?: string | null;
|
|
1212
1218
|
}
|
|
1213
|
-
interface EventData {
|
|
1219
|
+
export interface EventData {
|
|
1214
1220
|
/** Event schedule. */
|
|
1215
1221
|
scheduling?: string | null;
|
|
1216
1222
|
/** Event location. */
|
|
1217
1223
|
location?: string | null;
|
|
1218
1224
|
}
|
|
1219
|
-
interface VideoData {
|
|
1225
|
+
export interface VideoData {
|
|
1220
1226
|
/** Styling for the video's container. */
|
|
1221
1227
|
containerData?: PluginContainerData;
|
|
1222
1228
|
/** Video details. */
|
|
@@ -1230,7 +1236,7 @@ interface VideoData {
|
|
|
1230
1236
|
/** Video options. */
|
|
1231
1237
|
options?: PlaybackOptions;
|
|
1232
1238
|
}
|
|
1233
|
-
interface PlaybackOptions {
|
|
1239
|
+
export interface PlaybackOptions {
|
|
1234
1240
|
/** Sets whether the media will automatically start playing. */
|
|
1235
1241
|
autoPlay?: boolean | null;
|
|
1236
1242
|
/** Sets whether media's will be looped. */
|
|
@@ -1238,7 +1244,7 @@ interface PlaybackOptions {
|
|
|
1238
1244
|
/** Sets whether media's controls will be shown. */
|
|
1239
1245
|
showControls?: boolean | null;
|
|
1240
1246
|
}
|
|
1241
|
-
interface EmbedData {
|
|
1247
|
+
export interface EmbedData {
|
|
1242
1248
|
/** Styling for the oEmbed node's container. */
|
|
1243
1249
|
containerData?: PluginContainerData;
|
|
1244
1250
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1246,7 +1252,7 @@ interface EmbedData {
|
|
|
1246
1252
|
/** Origin asset source. */
|
|
1247
1253
|
src?: string | null;
|
|
1248
1254
|
}
|
|
1249
|
-
interface Oembed {
|
|
1255
|
+
export interface Oembed {
|
|
1250
1256
|
/** The resource type. */
|
|
1251
1257
|
type?: string | null;
|
|
1252
1258
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1278,7 +1284,7 @@ interface Oembed {
|
|
|
1278
1284
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1279
1285
|
version?: string | null;
|
|
1280
1286
|
}
|
|
1281
|
-
interface CollapsibleListData {
|
|
1287
|
+
export interface CollapsibleListData {
|
|
1282
1288
|
/** Styling for the collapsible list's container. */
|
|
1283
1289
|
containerData?: PluginContainerData;
|
|
1284
1290
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1290,7 +1296,7 @@ interface CollapsibleListData {
|
|
|
1290
1296
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1291
1297
|
isQapageData?: boolean | null;
|
|
1292
1298
|
}
|
|
1293
|
-
declare enum InitialExpandedItems {
|
|
1299
|
+
export declare enum InitialExpandedItems {
|
|
1294
1300
|
/** First item will be expended initally */
|
|
1295
1301
|
FIRST = "FIRST",
|
|
1296
1302
|
/** All items will expended initally */
|
|
@@ -1298,13 +1304,13 @@ declare enum InitialExpandedItems {
|
|
|
1298
1304
|
/** All items collapsed initally */
|
|
1299
1305
|
NONE = "NONE"
|
|
1300
1306
|
}
|
|
1301
|
-
declare enum Direction {
|
|
1307
|
+
export declare enum Direction {
|
|
1302
1308
|
/** Left-to-right */
|
|
1303
1309
|
LTR = "LTR",
|
|
1304
1310
|
/** Right-to-left */
|
|
1305
1311
|
RTL = "RTL"
|
|
1306
1312
|
}
|
|
1307
|
-
interface TableData {
|
|
1313
|
+
export interface TableData {
|
|
1308
1314
|
/** Styling for the table's container. */
|
|
1309
1315
|
containerData?: PluginContainerData;
|
|
1310
1316
|
/** The table's dimensions. */
|
|
@@ -1319,7 +1325,7 @@ interface TableData {
|
|
|
1319
1325
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1320
1326
|
columnHeader?: boolean | null;
|
|
1321
1327
|
}
|
|
1322
|
-
interface Dimensions {
|
|
1328
|
+
export interface Dimensions {
|
|
1323
1329
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1324
1330
|
colsWidthRatio?: number[];
|
|
1325
1331
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1327,13 +1333,13 @@ interface Dimensions {
|
|
|
1327
1333
|
/** An array representing the minimum width of each column in pixels. */
|
|
1328
1334
|
colsMinWidth?: number[];
|
|
1329
1335
|
}
|
|
1330
|
-
interface TableCellData {
|
|
1336
|
+
export interface TableCellData {
|
|
1331
1337
|
/** Styling for the cell's background color and text alignment. */
|
|
1332
1338
|
cellStyle?: CellStyle;
|
|
1333
1339
|
/** The cell's border colors. */
|
|
1334
1340
|
borderColors?: BorderColors;
|
|
1335
1341
|
}
|
|
1336
|
-
declare enum VerticalAlignment {
|
|
1342
|
+
export declare enum VerticalAlignment {
|
|
1337
1343
|
/** Top alignment */
|
|
1338
1344
|
TOP = "TOP",
|
|
1339
1345
|
/** Middle alignment */
|
|
@@ -1341,7 +1347,7 @@ declare enum VerticalAlignment {
|
|
|
1341
1347
|
/** Bottom alignment */
|
|
1342
1348
|
BOTTOM = "BOTTOM"
|
|
1343
1349
|
}
|
|
1344
|
-
interface CellStyle {
|
|
1350
|
+
export interface CellStyle {
|
|
1345
1351
|
/** Vertical alignment for the cell's text. */
|
|
1346
1352
|
verticalAlignment?: VerticalAlignment;
|
|
1347
1353
|
/**
|
|
@@ -1350,7 +1356,7 @@ interface CellStyle {
|
|
|
1350
1356
|
*/
|
|
1351
1357
|
backgroundColor?: string | null;
|
|
1352
1358
|
}
|
|
1353
|
-
interface BorderColors {
|
|
1359
|
+
export interface BorderColors {
|
|
1354
1360
|
/**
|
|
1355
1361
|
* Left border color as a hexadecimal value.
|
|
1356
1362
|
* @format COLOR_HEX
|
|
@@ -1378,7 +1384,7 @@ interface BorderColors {
|
|
|
1378
1384
|
*
|
|
1379
1385
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1380
1386
|
*/
|
|
1381
|
-
declare enum NullValue {
|
|
1387
|
+
export declare enum NullValue {
|
|
1382
1388
|
/** Null value. */
|
|
1383
1389
|
NULL_VALUE = "NULL_VALUE"
|
|
1384
1390
|
}
|
|
@@ -1387,11 +1393,11 @@ declare enum NullValue {
|
|
|
1387
1393
|
*
|
|
1388
1394
|
* The JSON representation for `ListValue` is JSON array.
|
|
1389
1395
|
*/
|
|
1390
|
-
interface ListValue {
|
|
1396
|
+
export interface ListValue {
|
|
1391
1397
|
/** Repeated field of dynamically typed values. */
|
|
1392
1398
|
values?: any[];
|
|
1393
1399
|
}
|
|
1394
|
-
interface AudioData {
|
|
1400
|
+
export interface AudioData {
|
|
1395
1401
|
/** Styling for the audio node's container. */
|
|
1396
1402
|
containerData?: PluginContainerData;
|
|
1397
1403
|
/** Audio file details. */
|
|
@@ -1407,7 +1413,7 @@ interface AudioData {
|
|
|
1407
1413
|
/** An HTML version of the audio node. */
|
|
1408
1414
|
html?: string | null;
|
|
1409
1415
|
}
|
|
1410
|
-
interface OrderedListData {
|
|
1416
|
+
export interface OrderedListData {
|
|
1411
1417
|
/** Indentation level from 0-4. */
|
|
1412
1418
|
indentation?: number;
|
|
1413
1419
|
/** Offset level from 0-4. */
|
|
@@ -1415,24 +1421,24 @@ interface OrderedListData {
|
|
|
1415
1421
|
/** List start number. */
|
|
1416
1422
|
start?: number | null;
|
|
1417
1423
|
}
|
|
1418
|
-
interface BulletedListData {
|
|
1424
|
+
export interface BulletedListData {
|
|
1419
1425
|
/** Indentation level from 0-4. */
|
|
1420
1426
|
indentation?: number;
|
|
1421
1427
|
/** Offset level from 0-4. */
|
|
1422
1428
|
offset?: number | null;
|
|
1423
1429
|
}
|
|
1424
|
-
interface BlockquoteData {
|
|
1430
|
+
export interface BlockquoteData {
|
|
1425
1431
|
/** Indentation level from 1-4. */
|
|
1426
1432
|
indentation?: number;
|
|
1427
1433
|
}
|
|
1428
|
-
interface CaptionData {
|
|
1434
|
+
export interface CaptionData {
|
|
1429
1435
|
textStyle?: TextStyle;
|
|
1430
1436
|
}
|
|
1431
|
-
interface LayoutCellData {
|
|
1437
|
+
export interface LayoutCellData {
|
|
1432
1438
|
/** Size of the cell in 12 columns grid. */
|
|
1433
1439
|
colSpan?: number | null;
|
|
1434
1440
|
}
|
|
1435
|
-
interface Metadata {
|
|
1441
|
+
export interface Metadata {
|
|
1436
1442
|
/** Schema version. */
|
|
1437
1443
|
version?: number;
|
|
1438
1444
|
/**
|
|
@@ -1449,7 +1455,7 @@ interface Metadata {
|
|
|
1449
1455
|
/** Object ID. */
|
|
1450
1456
|
_id?: string | null;
|
|
1451
1457
|
}
|
|
1452
|
-
interface DocumentStyle {
|
|
1458
|
+
export interface DocumentStyle {
|
|
1453
1459
|
/** Styling for H1 nodes. */
|
|
1454
1460
|
headerOne?: TextNodeStyle;
|
|
1455
1461
|
/** Styling for H2 nodes. */
|
|
@@ -1469,7 +1475,7 @@ interface DocumentStyle {
|
|
|
1469
1475
|
/** Styling for code block nodes. */
|
|
1470
1476
|
codeBlock?: TextNodeStyle;
|
|
1471
1477
|
}
|
|
1472
|
-
interface TextNodeStyle {
|
|
1478
|
+
export interface TextNodeStyle {
|
|
1473
1479
|
/** The decorations to apply to the node. */
|
|
1474
1480
|
decorations?: Decoration[];
|
|
1475
1481
|
/** Padding and background color for the node. */
|
|
@@ -1477,7 +1483,7 @@ interface TextNodeStyle {
|
|
|
1477
1483
|
/** Line height for text in the node. */
|
|
1478
1484
|
lineHeight?: string | null;
|
|
1479
1485
|
}
|
|
1480
|
-
interface MachineTranslateRequest {
|
|
1486
|
+
export interface MachineTranslateRequest {
|
|
1481
1487
|
/** Language of the source text to translate. */
|
|
1482
1488
|
sourceLanguage: SupportedLanguage;
|
|
1483
1489
|
/** Language to translate text into. */
|
|
@@ -1485,7 +1491,7 @@ interface MachineTranslateRequest {
|
|
|
1485
1491
|
/** The content to translate. */
|
|
1486
1492
|
contentToTranslate: TranslatableContent;
|
|
1487
1493
|
}
|
|
1488
|
-
declare enum SupportedLanguage {
|
|
1494
|
+
export declare enum SupportedLanguage {
|
|
1489
1495
|
/** Undefined Language */
|
|
1490
1496
|
UNDEFINED_SUPPORTED_LANGUAGE = "UNDEFINED_SUPPORTED_LANGUAGE",
|
|
1491
1497
|
/** Afrikaans */
|
|
@@ -1759,30 +1765,30 @@ declare enum SupportedLanguage {
|
|
|
1759
1765
|
/** Zulu */
|
|
1760
1766
|
ZU = "ZU"
|
|
1761
1767
|
}
|
|
1762
|
-
interface MachineTranslateResponse {
|
|
1768
|
+
export interface MachineTranslateResponse {
|
|
1763
1769
|
/** The translated content. */
|
|
1764
1770
|
translatedContent?: TranslatableContent;
|
|
1765
1771
|
}
|
|
1766
|
-
interface NotEnoughCreditsError {
|
|
1772
|
+
export interface NotEnoughCreditsError {
|
|
1767
1773
|
/** The number of credits required to translate the content in the request. */
|
|
1768
1774
|
creditsRequired?: number;
|
|
1769
1775
|
}
|
|
1770
|
-
interface TextTooLongError {
|
|
1776
|
+
export interface TextTooLongError {
|
|
1771
1777
|
/** The maximum length of text that can be translated. */
|
|
1772
1778
|
maxLength?: number;
|
|
1773
1779
|
/** The actual length of the text that was sent for translation. */
|
|
1774
1780
|
actualLength?: number;
|
|
1775
1781
|
}
|
|
1776
|
-
interface UnknownFormatError {
|
|
1782
|
+
export interface UnknownFormatError {
|
|
1777
1783
|
}
|
|
1778
|
-
interface SameLanguageArgumentsError {
|
|
1784
|
+
export interface SameLanguageArgumentsError {
|
|
1779
1785
|
/**
|
|
1780
1786
|
* The language supplied as both the source and the target languages
|
|
1781
1787
|
* @maxLength 16
|
|
1782
1788
|
*/
|
|
1783
1789
|
language?: string;
|
|
1784
1790
|
}
|
|
1785
|
-
interface BulkMachineTranslateRequest {
|
|
1791
|
+
export interface BulkMachineTranslateRequest {
|
|
1786
1792
|
/** Language of the source text to translate. */
|
|
1787
1793
|
sourceLanguage: SupportedLanguage;
|
|
1788
1794
|
/** Language to translate text into. */
|
|
@@ -1794,7 +1800,7 @@ interface BulkMachineTranslateRequest {
|
|
|
1794
1800
|
*/
|
|
1795
1801
|
contentToTranslate?: TranslatableContent[];
|
|
1796
1802
|
}
|
|
1797
|
-
interface BulkMachineTranslateResponse {
|
|
1803
|
+
export interface BulkMachineTranslateResponse {
|
|
1798
1804
|
/**
|
|
1799
1805
|
* List of results for each item in the bulk request.
|
|
1800
1806
|
* @minSize 1
|
|
@@ -1804,13 +1810,13 @@ interface BulkMachineTranslateResponse {
|
|
|
1804
1810
|
/** Metadata for the overall bulk action, including success and failure counts. */
|
|
1805
1811
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1806
1812
|
}
|
|
1807
|
-
interface BulkTranslateResult {
|
|
1813
|
+
export interface BulkTranslateResult {
|
|
1808
1814
|
/** Metadata for the individual item in the request. */
|
|
1809
1815
|
itemMetadata?: ItemMetadata;
|
|
1810
1816
|
/** The translated content. */
|
|
1811
1817
|
item?: TranslatableContent;
|
|
1812
1818
|
}
|
|
1813
|
-
interface ItemMetadata {
|
|
1819
|
+
export interface ItemMetadata {
|
|
1814
1820
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1815
1821
|
_id?: string | null;
|
|
1816
1822
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -1820,7 +1826,7 @@ interface ItemMetadata {
|
|
|
1820
1826
|
/** Details about the error in case of failure. */
|
|
1821
1827
|
error?: ApplicationError;
|
|
1822
1828
|
}
|
|
1823
|
-
interface ApplicationError {
|
|
1829
|
+
export interface ApplicationError {
|
|
1824
1830
|
/** Error code. */
|
|
1825
1831
|
code?: string;
|
|
1826
1832
|
/** Description of the error. */
|
|
@@ -1828,7 +1834,7 @@ interface ApplicationError {
|
|
|
1828
1834
|
/** Data related to the error. */
|
|
1829
1835
|
data?: Record<string, any> | null;
|
|
1830
1836
|
}
|
|
1831
|
-
interface BulkActionMetadata {
|
|
1837
|
+
export interface BulkActionMetadata {
|
|
1832
1838
|
/** Number of items that were successfully processed. */
|
|
1833
1839
|
totalSuccesses?: number;
|
|
1834
1840
|
/** Number of items that couldn't be processed. */
|
|
@@ -1836,13 +1842,86 @@ interface BulkActionMetadata {
|
|
|
1836
1842
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1837
1843
|
undetailedFailures?: number;
|
|
1838
1844
|
}
|
|
1839
|
-
|
|
1845
|
+
type TranslatableContentNonNullablePaths = `plainTextContent` | `htmlContent` | `format`;
|
|
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 {
|
|
1840
1883
|
/** Language to translate text into. */
|
|
1841
1884
|
targetLanguage: SupportedLanguage;
|
|
1842
1885
|
/** The content to translate. */
|
|
1843
1886
|
contentToTranslate: TranslatableContent;
|
|
1844
1887
|
}
|
|
1845
|
-
|
|
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 {
|
|
1846
1925
|
/** Language to translate text into. */
|
|
1847
1926
|
targetLanguage: SupportedLanguage;
|
|
1848
1927
|
/**
|
|
@@ -1852,5 +1931,4 @@ interface BulkMachineTranslateOptions {
|
|
|
1852
1931
|
*/
|
|
1853
1932
|
contentToTranslate?: TranslatableContent[];
|
|
1854
1933
|
}
|
|
1855
|
-
|
|
1856
|
-
export { type Rel as $, Alignment as A, type BulkMachineTranslateOptions as B, Crop as C, DecorationType as D, type Border as E, Format as F, GIFType as G, type Colors as H, InitialExpandedItems as I, type PluginContainerData as J, type PluginContainerDataWidth as K, LineStyle as L, type MachineTranslateOptions as M, NodeType as N, Orientation as O, PluginContainerDataAlignment as P, type PluginContainerDataWidthDataOneOf as Q, type RichContent as R, SupportedLanguage as S, Type as T, type Spoiler as U, ViewMode as V, WidthType as W, type Height as X, type Styles as Y, type Link as Z, type LinkDataOneOf as _, type MachineTranslateResponse as a, type Dimensions as a$, type CodeBlockData as a0, type TextStyle as a1, type DividerData as a2, type FileData as a3, type FileSource as a4, type FileSourceDataOneOf as a5, type PDFSettings as a6, type GalleryData as a7, type Media as a8, type Image as a9, type Gradient as aA, type Background as aB, type BackgroundBackgroundOneOf as aC, type PollDesign as aD, type OptionDesign as aE, type Poll as aF, type PollDataLayout as aG, type Design as aH, type TextData as aI, type Decoration as aJ, type DecorationDataOneOf as aK, type AnchorData as aL, type ColorData as aM, type LinkData as aN, type MentionData as aO, type FontSizeData as aP, type SpoilerData as aQ, type AppEmbedData as aR, type AppEmbedDataAppDataOneOf as aS, type BookingData as aT, type EventData as aU, type VideoData as aV, type PlaybackOptions as aW, type EmbedData as aX, type Oembed as aY, type CollapsibleListData as aZ, type TableData as a_, type Video as aa, type Item as ab, type ItemDataOneOf as ac, type GalleryOptions as ad, type Layout as ae, type ItemStyle as af, type Thumbnails as ag, type GIFData as ah, type GIF as ai, type HeadingData as aj, type HTMLData as ak, type HTMLDataDataOneOf as al, type ImageData as am, type StylesBorder as an, type ImageDataStyles as ao, type LinkPreviewData as ap, type LinkPreviewDataStyles as aq, type MapData as ar, type MapSettings as as, type ParagraphData as at, type PollData as au, type Permissions as av, type Option as aw, type Settings as ax, type PollLayout as ay, type OptionLayout as az, type BulkMachineTranslateResponse as b, type TableCellData as b0, type CellStyle as b1, type BorderColors as b2, type ListValue as b3, type AudioData as b4, type OrderedListData as b5, type BulletedListData as b6, type BlockquoteData as b7, type CaptionData as b8, type LayoutCellData as b9, type Metadata as ba, type DocumentStyle as bb, type TextNodeStyle as bc, type MachineTranslateRequest as bd, type NotEnoughCreditsError as be, type TextTooLongError as bf, type UnknownFormatError as bg, type SameLanguageArgumentsError as bh, type BulkMachineTranslateRequest as bi, type BulkTranslateResult as bj, type ItemMetadata as bk, type ApplicationError as bl, type BulkActionMetadata as bm, 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, type TranslatableContent as u, type TranslatableContentContentOneOf as v, type Node as w, type NodeDataOneOf as x, type NodeStyle as y, type ButtonData as z };
|
|
1934
|
+
export {};
|