@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,10 +1,12 @@
|
|
|
1
|
+
import { be as MachineTranslateRequest$1, a as MachineTranslateResponse$1, bj as BulkMachineTranslateRequest$1, b as BulkMachineTranslateResponse$1 } from './multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.mjs';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* A translatable content is a unit of content to translate.
|
|
3
5
|
*
|
|
4
6
|
* 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
7
|
* to translate many.
|
|
6
8
|
*/
|
|
7
|
-
|
|
9
|
+
interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
8
10
|
/**
|
|
9
11
|
* Plain text.
|
|
10
12
|
* @minLength 1
|
|
@@ -25,10 +27,10 @@ export interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
|
25
27
|
*/
|
|
26
28
|
id?: string | null;
|
|
27
29
|
/** Format of the translatable content. */
|
|
28
|
-
format?:
|
|
30
|
+
format?: FormatWithLiterals;
|
|
29
31
|
}
|
|
30
32
|
/** @oneof */
|
|
31
|
-
|
|
33
|
+
interface TranslatableContentContentOneOf {
|
|
32
34
|
/**
|
|
33
35
|
* Plain text.
|
|
34
36
|
* @minLength 1
|
|
@@ -44,7 +46,7 @@ export interface TranslatableContentContentOneOf {
|
|
|
44
46
|
/** Rich content. */
|
|
45
47
|
richContent?: RichContent;
|
|
46
48
|
}
|
|
47
|
-
|
|
49
|
+
declare enum Format {
|
|
48
50
|
/** Unspecified format. */
|
|
49
51
|
UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
|
|
50
52
|
/** Plain text content. */
|
|
@@ -54,7 +56,9 @@ export declare enum Format {
|
|
|
54
56
|
/** Rich Content. */
|
|
55
57
|
RICH = "RICH"
|
|
56
58
|
}
|
|
57
|
-
|
|
59
|
+
/** @enumType */
|
|
60
|
+
type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'PLAIN_TEXT' | 'HTML' | 'RICH';
|
|
61
|
+
interface RichContent {
|
|
58
62
|
/** Node objects representing a rich content document. */
|
|
59
63
|
nodes?: Node[];
|
|
60
64
|
/** Object metadata. */
|
|
@@ -62,7 +66,7 @@ export interface RichContent {
|
|
|
62
66
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
63
67
|
documentStyle?: DocumentStyle;
|
|
64
68
|
}
|
|
65
|
-
|
|
69
|
+
interface Node extends NodeDataOneOf {
|
|
66
70
|
/** Data for a button node. */
|
|
67
71
|
buttonData?: ButtonData;
|
|
68
72
|
/** Data for a code block node. */
|
|
@@ -118,7 +122,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
118
122
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
119
123
|
layoutCellData?: LayoutCellData;
|
|
120
124
|
/** 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. */
|
|
121
|
-
type?:
|
|
125
|
+
type?: NodeTypeWithLiterals;
|
|
122
126
|
/** Node ID. */
|
|
123
127
|
id?: string;
|
|
124
128
|
/** A list of child nodes. */
|
|
@@ -127,7 +131,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
127
131
|
style?: NodeStyle;
|
|
128
132
|
}
|
|
129
133
|
/** @oneof */
|
|
130
|
-
|
|
134
|
+
interface NodeDataOneOf {
|
|
131
135
|
/** Data for a button node. */
|
|
132
136
|
buttonData?: ButtonData;
|
|
133
137
|
/** Data for a code block node. */
|
|
@@ -183,7 +187,7 @@ export interface NodeDataOneOf {
|
|
|
183
187
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
184
188
|
layoutCellData?: LayoutCellData;
|
|
185
189
|
}
|
|
186
|
-
|
|
190
|
+
declare enum NodeType {
|
|
187
191
|
PARAGRAPH = "PARAGRAPH",
|
|
188
192
|
TEXT = "TEXT",
|
|
189
193
|
HEADING = "HEADING",
|
|
@@ -219,7 +223,9 @@ export declare enum NodeType {
|
|
|
219
223
|
LAYOUT = "LAYOUT",
|
|
220
224
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
221
225
|
}
|
|
222
|
-
|
|
226
|
+
/** @enumType */
|
|
227
|
+
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';
|
|
228
|
+
interface NodeStyle {
|
|
223
229
|
/** The top padding value in pixels. */
|
|
224
230
|
paddingTop?: string | null;
|
|
225
231
|
/** The bottom padding value in pixels. */
|
|
@@ -227,11 +233,11 @@ export interface NodeStyle {
|
|
|
227
233
|
/** The background color as a hexadecimal value. */
|
|
228
234
|
backgroundColor?: string | null;
|
|
229
235
|
}
|
|
230
|
-
|
|
236
|
+
interface ButtonData {
|
|
231
237
|
/** Styling for the button's container. */
|
|
232
238
|
containerData?: PluginContainerData;
|
|
233
239
|
/** The button type. */
|
|
234
|
-
type?:
|
|
240
|
+
type?: TypeWithLiterals;
|
|
235
241
|
/** Styling for the button. */
|
|
236
242
|
styles?: Styles;
|
|
237
243
|
/** The text to display on the button. */
|
|
@@ -239,7 +245,7 @@ export interface ButtonData {
|
|
|
239
245
|
/** Button link details. */
|
|
240
246
|
link?: Link;
|
|
241
247
|
}
|
|
242
|
-
|
|
248
|
+
interface Border {
|
|
243
249
|
/**
|
|
244
250
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
245
251
|
* @deprecated
|
|
@@ -251,7 +257,7 @@ export interface Border {
|
|
|
251
257
|
*/
|
|
252
258
|
radius?: number | null;
|
|
253
259
|
}
|
|
254
|
-
|
|
260
|
+
interface Colors {
|
|
255
261
|
/**
|
|
256
262
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
257
263
|
* @deprecated
|
|
@@ -268,11 +274,11 @@ export interface Colors {
|
|
|
268
274
|
*/
|
|
269
275
|
background?: string | null;
|
|
270
276
|
}
|
|
271
|
-
|
|
277
|
+
interface PluginContainerData {
|
|
272
278
|
/** The width of the node when it's displayed. */
|
|
273
279
|
width?: PluginContainerDataWidth;
|
|
274
280
|
/** The node's alignment within its container. */
|
|
275
|
-
alignment?:
|
|
281
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
276
282
|
/** Spoiler cover settings for the node. */
|
|
277
283
|
spoiler?: Spoiler;
|
|
278
284
|
/** The height of the node when it's displayed. */
|
|
@@ -280,7 +286,7 @@ export interface PluginContainerData {
|
|
|
280
286
|
/** 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
287
|
textWrap?: boolean | null;
|
|
282
288
|
}
|
|
283
|
-
|
|
289
|
+
declare enum WidthType {
|
|
284
290
|
/** Width matches the content width */
|
|
285
291
|
CONTENT = "CONTENT",
|
|
286
292
|
/** Small Width */
|
|
@@ -290,7 +296,9 @@ export declare enum WidthType {
|
|
|
290
296
|
/** coast-to-coast display */
|
|
291
297
|
FULL_WIDTH = "FULL_WIDTH"
|
|
292
298
|
}
|
|
293
|
-
|
|
299
|
+
/** @enumType */
|
|
300
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
301
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
294
302
|
/**
|
|
295
303
|
* One of the following predefined width options:
|
|
296
304
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -298,12 +306,12 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
298
306
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
299
307
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
300
308
|
*/
|
|
301
|
-
size?:
|
|
309
|
+
size?: WidthTypeWithLiterals;
|
|
302
310
|
/** A custom width value in pixels. */
|
|
303
311
|
custom?: string | null;
|
|
304
312
|
}
|
|
305
313
|
/** @oneof */
|
|
306
|
-
|
|
314
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
307
315
|
/**
|
|
308
316
|
* One of the following predefined width options:
|
|
309
317
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -311,11 +319,11 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
311
319
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
312
320
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
313
321
|
*/
|
|
314
|
-
size?:
|
|
322
|
+
size?: WidthTypeWithLiterals;
|
|
315
323
|
/** A custom width value in pixels. */
|
|
316
324
|
custom?: string | null;
|
|
317
325
|
}
|
|
318
|
-
|
|
326
|
+
declare enum PluginContainerDataAlignment {
|
|
319
327
|
/** Center Alignment */
|
|
320
328
|
CENTER = "CENTER",
|
|
321
329
|
/** Left Alignment */
|
|
@@ -323,7 +331,9 @@ export declare enum PluginContainerDataAlignment {
|
|
|
323
331
|
/** Right Alignment */
|
|
324
332
|
RIGHT = "RIGHT"
|
|
325
333
|
}
|
|
326
|
-
|
|
334
|
+
/** @enumType */
|
|
335
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
336
|
+
interface Spoiler {
|
|
327
337
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
328
338
|
enabled?: boolean | null;
|
|
329
339
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -331,17 +341,19 @@ export interface Spoiler {
|
|
|
331
341
|
/** The text for the button used to remove the spoiler cover. */
|
|
332
342
|
buttonText?: string | null;
|
|
333
343
|
}
|
|
334
|
-
|
|
344
|
+
interface Height {
|
|
335
345
|
/** A custom height value in pixels. */
|
|
336
346
|
custom?: string | null;
|
|
337
347
|
}
|
|
338
|
-
|
|
348
|
+
declare enum Type {
|
|
339
349
|
/** Regular link button */
|
|
340
350
|
LINK = "LINK",
|
|
341
351
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
342
352
|
ACTION = "ACTION"
|
|
343
353
|
}
|
|
344
|
-
|
|
354
|
+
/** @enumType */
|
|
355
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
356
|
+
interface Styles {
|
|
345
357
|
/**
|
|
346
358
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
347
359
|
* @deprecated
|
|
@@ -394,7 +406,7 @@ export interface Styles {
|
|
|
394
406
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
395
407
|
buttonSize?: string | null;
|
|
396
408
|
}
|
|
397
|
-
|
|
409
|
+
interface Link extends LinkDataOneOf {
|
|
398
410
|
/** The absolute URL for the linked document. */
|
|
399
411
|
url?: string;
|
|
400
412
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -406,20 +418,20 @@ export interface Link extends LinkDataOneOf {
|
|
|
406
418
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
407
419
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
408
420
|
*/
|
|
409
|
-
target?:
|
|
421
|
+
target?: TargetWithLiterals;
|
|
410
422
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
411
423
|
rel?: Rel;
|
|
412
424
|
/** A serialized object used for a custom or external link panel. */
|
|
413
425
|
customData?: string | null;
|
|
414
426
|
}
|
|
415
427
|
/** @oneof */
|
|
416
|
-
|
|
428
|
+
interface LinkDataOneOf {
|
|
417
429
|
/** The absolute URL for the linked document. */
|
|
418
430
|
url?: string;
|
|
419
431
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
420
432
|
anchor?: string;
|
|
421
433
|
}
|
|
422
|
-
|
|
434
|
+
declare enum Target {
|
|
423
435
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
424
436
|
SELF = "SELF",
|
|
425
437
|
/** Opens the linked document in a new window or tab */
|
|
@@ -429,7 +441,9 @@ export declare enum Target {
|
|
|
429
441
|
/** Opens the linked document in the full body of the window */
|
|
430
442
|
TOP = "TOP"
|
|
431
443
|
}
|
|
432
|
-
|
|
444
|
+
/** @enumType */
|
|
445
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
446
|
+
interface Rel {
|
|
433
447
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
434
448
|
nofollow?: boolean | null;
|
|
435
449
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -439,17 +453,17 @@ export interface Rel {
|
|
|
439
453
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
440
454
|
noreferrer?: boolean | null;
|
|
441
455
|
}
|
|
442
|
-
|
|
456
|
+
interface CodeBlockData {
|
|
443
457
|
/** Styling for the code block's text. */
|
|
444
458
|
textStyle?: TextStyle;
|
|
445
459
|
}
|
|
446
|
-
|
|
460
|
+
interface TextStyle {
|
|
447
461
|
/** Text alignment. Defaults to `AUTO`. */
|
|
448
|
-
textAlignment?:
|
|
462
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
449
463
|
/** 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
464
|
lineHeight?: string | null;
|
|
451
465
|
}
|
|
452
|
-
|
|
466
|
+
declare enum TextAlignment {
|
|
453
467
|
/** browser default, eqivalent to `initial` */
|
|
454
468
|
AUTO = "AUTO",
|
|
455
469
|
/** Left align */
|
|
@@ -461,17 +475,19 @@ export declare enum TextAlignment {
|
|
|
461
475
|
/** 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
476
|
JUSTIFY = "JUSTIFY"
|
|
463
477
|
}
|
|
464
|
-
|
|
478
|
+
/** @enumType */
|
|
479
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
480
|
+
interface DividerData {
|
|
465
481
|
/** Styling for the divider's container. */
|
|
466
482
|
containerData?: PluginContainerData;
|
|
467
483
|
/** Divider line style. */
|
|
468
|
-
lineStyle?:
|
|
484
|
+
lineStyle?: LineStyleWithLiterals;
|
|
469
485
|
/** Divider width. */
|
|
470
|
-
width?:
|
|
486
|
+
width?: WidthWithLiterals;
|
|
471
487
|
/** Divider alignment. */
|
|
472
|
-
alignment?:
|
|
488
|
+
alignment?: AlignmentWithLiterals;
|
|
473
489
|
}
|
|
474
|
-
|
|
490
|
+
declare enum LineStyle {
|
|
475
491
|
/** Single Line */
|
|
476
492
|
SINGLE = "SINGLE",
|
|
477
493
|
/** Double Line */
|
|
@@ -481,7 +497,9 @@ export declare enum LineStyle {
|
|
|
481
497
|
/** Dotted Line */
|
|
482
498
|
DOTTED = "DOTTED"
|
|
483
499
|
}
|
|
484
|
-
|
|
500
|
+
/** @enumType */
|
|
501
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
502
|
+
declare enum Width {
|
|
485
503
|
/** Large line */
|
|
486
504
|
LARGE = "LARGE",
|
|
487
505
|
/** Medium line */
|
|
@@ -489,7 +507,9 @@ export declare enum Width {
|
|
|
489
507
|
/** Small line */
|
|
490
508
|
SMALL = "SMALL"
|
|
491
509
|
}
|
|
492
|
-
|
|
510
|
+
/** @enumType */
|
|
511
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
512
|
+
declare enum Alignment {
|
|
493
513
|
/** Center alignment */
|
|
494
514
|
CENTER = "CENTER",
|
|
495
515
|
/** Left alignment */
|
|
@@ -497,7 +517,9 @@ export declare enum Alignment {
|
|
|
497
517
|
/** Right alignment */
|
|
498
518
|
RIGHT = "RIGHT"
|
|
499
519
|
}
|
|
500
|
-
|
|
520
|
+
/** @enumType */
|
|
521
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
522
|
+
interface FileData {
|
|
501
523
|
/** Styling for the file's container. */
|
|
502
524
|
containerData?: PluginContainerData;
|
|
503
525
|
/** The source for the file's data. */
|
|
@@ -520,7 +542,7 @@ export interface FileData {
|
|
|
520
542
|
/** File size in KB. */
|
|
521
543
|
sizeInKb?: string | null;
|
|
522
544
|
}
|
|
523
|
-
|
|
545
|
+
declare enum ViewMode {
|
|
524
546
|
/** No PDF view */
|
|
525
547
|
NONE = "NONE",
|
|
526
548
|
/** Full PDF view */
|
|
@@ -528,7 +550,9 @@ export declare enum ViewMode {
|
|
|
528
550
|
/** Mini PDF view */
|
|
529
551
|
MINI = "MINI"
|
|
530
552
|
}
|
|
531
|
-
|
|
553
|
+
/** @enumType */
|
|
554
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
555
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
532
556
|
/** The absolute URL for the file's source. */
|
|
533
557
|
url?: string | null;
|
|
534
558
|
/**
|
|
@@ -542,7 +566,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
542
566
|
private?: boolean | null;
|
|
543
567
|
}
|
|
544
568
|
/** @oneof */
|
|
545
|
-
|
|
569
|
+
interface FileSourceDataOneOf {
|
|
546
570
|
/** The absolute URL for the file's source. */
|
|
547
571
|
url?: string | null;
|
|
548
572
|
/**
|
|
@@ -553,20 +577,20 @@ export interface FileSourceDataOneOf {
|
|
|
553
577
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
554
578
|
id?: string | null;
|
|
555
579
|
}
|
|
556
|
-
|
|
580
|
+
interface PDFSettings {
|
|
557
581
|
/**
|
|
558
582
|
* PDF view mode. One of the following:
|
|
559
583
|
* `NONE` : The PDF isn't displayed.
|
|
560
584
|
* `FULL` : A full page view of the PDF is displayed.
|
|
561
585
|
* `MINI` : A mini view of the PDF is displayed.
|
|
562
586
|
*/
|
|
563
|
-
viewMode?:
|
|
587
|
+
viewMode?: ViewModeWithLiterals;
|
|
564
588
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
565
589
|
disableDownload?: boolean | null;
|
|
566
590
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
567
591
|
disablePrint?: boolean | null;
|
|
568
592
|
}
|
|
569
|
-
|
|
593
|
+
interface GalleryData {
|
|
570
594
|
/** Styling for the gallery's container. */
|
|
571
595
|
containerData?: PluginContainerData;
|
|
572
596
|
/** The items in the gallery. */
|
|
@@ -578,7 +602,7 @@ export interface GalleryData {
|
|
|
578
602
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
579
603
|
disableDownload?: boolean | null;
|
|
580
604
|
}
|
|
581
|
-
|
|
605
|
+
interface Media {
|
|
582
606
|
/** The source for the media's data. */
|
|
583
607
|
src?: FileSource;
|
|
584
608
|
/** Media width in pixels. */
|
|
@@ -588,19 +612,19 @@ export interface Media {
|
|
|
588
612
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
589
613
|
duration?: number | null;
|
|
590
614
|
}
|
|
591
|
-
|
|
615
|
+
interface Image {
|
|
592
616
|
/** Image file details. */
|
|
593
617
|
media?: Media;
|
|
594
618
|
/** Link details for images that are links. */
|
|
595
619
|
link?: Link;
|
|
596
620
|
}
|
|
597
|
-
|
|
621
|
+
interface Video {
|
|
598
622
|
/** Video file details. */
|
|
599
623
|
media?: Media;
|
|
600
624
|
/** Video thumbnail file details. */
|
|
601
625
|
thumbnail?: Media;
|
|
602
626
|
}
|
|
603
|
-
|
|
627
|
+
interface Item extends ItemDataOneOf {
|
|
604
628
|
/** An image item. */
|
|
605
629
|
image?: Image;
|
|
606
630
|
/** A video item. */
|
|
@@ -611,13 +635,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
611
635
|
altText?: string | null;
|
|
612
636
|
}
|
|
613
637
|
/** @oneof */
|
|
614
|
-
|
|
638
|
+
interface ItemDataOneOf {
|
|
615
639
|
/** An image item. */
|
|
616
640
|
image?: Image;
|
|
617
641
|
/** A video item. */
|
|
618
642
|
video?: Video;
|
|
619
643
|
}
|
|
620
|
-
|
|
644
|
+
interface GalleryOptions {
|
|
621
645
|
/** Gallery layout. */
|
|
622
646
|
layout?: Layout;
|
|
623
647
|
/** Styling for gallery items. */
|
|
@@ -625,7 +649,7 @@ export interface GalleryOptions {
|
|
|
625
649
|
/** Styling for gallery thumbnail images. */
|
|
626
650
|
thumbnails?: Thumbnails;
|
|
627
651
|
}
|
|
628
|
-
|
|
652
|
+
declare enum LayoutType {
|
|
629
653
|
/** Collage type */
|
|
630
654
|
COLLAGE = "COLLAGE",
|
|
631
655
|
/** Masonry type */
|
|
@@ -647,19 +671,25 @@ export declare enum LayoutType {
|
|
|
647
671
|
/** Fullsize images type */
|
|
648
672
|
FULLSIZE = "FULLSIZE"
|
|
649
673
|
}
|
|
650
|
-
|
|
674
|
+
/** @enumType */
|
|
675
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
676
|
+
declare enum Orientation {
|
|
651
677
|
/** Rows Orientation */
|
|
652
678
|
ROWS = "ROWS",
|
|
653
679
|
/** Columns Orientation */
|
|
654
680
|
COLUMNS = "COLUMNS"
|
|
655
681
|
}
|
|
656
|
-
|
|
682
|
+
/** @enumType */
|
|
683
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
684
|
+
declare enum Crop {
|
|
657
685
|
/** Crop to fill */
|
|
658
686
|
FILL = "FILL",
|
|
659
687
|
/** Crop to fit */
|
|
660
688
|
FIT = "FIT"
|
|
661
689
|
}
|
|
662
|
-
|
|
690
|
+
/** @enumType */
|
|
691
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
692
|
+
declare enum ThumbnailsAlignment {
|
|
663
693
|
/** Top alignment */
|
|
664
694
|
TOP = "TOP",
|
|
665
695
|
/** Right alignment */
|
|
@@ -671,35 +701,37 @@ export declare enum ThumbnailsAlignment {
|
|
|
671
701
|
/** No thumbnail */
|
|
672
702
|
NONE = "NONE"
|
|
673
703
|
}
|
|
674
|
-
|
|
704
|
+
/** @enumType */
|
|
705
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
706
|
+
interface Layout {
|
|
675
707
|
/** Gallery layout type. */
|
|
676
|
-
type?:
|
|
708
|
+
type?: LayoutTypeWithLiterals;
|
|
677
709
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
678
710
|
horizontalScroll?: boolean | null;
|
|
679
711
|
/** Gallery orientation. */
|
|
680
|
-
orientation?:
|
|
712
|
+
orientation?: OrientationWithLiterals;
|
|
681
713
|
/** The number of columns to display on full size screens. */
|
|
682
714
|
numberOfColumns?: number | null;
|
|
683
715
|
/** The number of columns to display on mobile screens. */
|
|
684
716
|
mobileNumberOfColumns?: number | null;
|
|
685
717
|
}
|
|
686
|
-
|
|
718
|
+
interface ItemStyle {
|
|
687
719
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
688
720
|
targetSize?: number | null;
|
|
689
721
|
/** Item ratio */
|
|
690
722
|
ratio?: number | null;
|
|
691
723
|
/** Sets how item images are cropped. */
|
|
692
|
-
crop?:
|
|
724
|
+
crop?: CropWithLiterals;
|
|
693
725
|
/** The spacing between items in pixels. */
|
|
694
726
|
spacing?: number | null;
|
|
695
727
|
}
|
|
696
|
-
|
|
728
|
+
interface Thumbnails {
|
|
697
729
|
/** Thumbnail alignment. */
|
|
698
|
-
placement?:
|
|
730
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
699
731
|
/** Spacing between thumbnails in pixels. */
|
|
700
732
|
spacing?: number | null;
|
|
701
733
|
}
|
|
702
|
-
|
|
734
|
+
interface GIFData {
|
|
703
735
|
/** Styling for the GIF's container. */
|
|
704
736
|
containerData?: PluginContainerData;
|
|
705
737
|
/** The source of the full size GIF. */
|
|
@@ -711,9 +743,9 @@ export interface GIFData {
|
|
|
711
743
|
/** Width in pixels. */
|
|
712
744
|
width?: number;
|
|
713
745
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
714
|
-
gifType?:
|
|
746
|
+
gifType?: GIFTypeWithLiterals;
|
|
715
747
|
}
|
|
716
|
-
|
|
748
|
+
interface GIF {
|
|
717
749
|
/**
|
|
718
750
|
* GIF format URL.
|
|
719
751
|
* @format WEB_URL
|
|
@@ -730,11 +762,13 @@ export interface GIF {
|
|
|
730
762
|
*/
|
|
731
763
|
still?: string | null;
|
|
732
764
|
}
|
|
733
|
-
|
|
765
|
+
declare enum GIFType {
|
|
734
766
|
NORMAL = "NORMAL",
|
|
735
767
|
STICKER = "STICKER"
|
|
736
768
|
}
|
|
737
|
-
|
|
769
|
+
/** @enumType */
|
|
770
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
771
|
+
interface HeadingData {
|
|
738
772
|
/** Heading level from 1-6. */
|
|
739
773
|
level?: number;
|
|
740
774
|
/** Styling for the heading text. */
|
|
@@ -742,7 +776,7 @@ export interface HeadingData {
|
|
|
742
776
|
/** Indentation level from 1-4. */
|
|
743
777
|
indentation?: number | null;
|
|
744
778
|
}
|
|
745
|
-
|
|
779
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
746
780
|
/** The URL for the HTML code for the node. */
|
|
747
781
|
url?: string;
|
|
748
782
|
/** The HTML code for the node. */
|
|
@@ -755,12 +789,12 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
755
789
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
756
790
|
containerData?: PluginContainerData;
|
|
757
791
|
/** The type of HTML code. */
|
|
758
|
-
source?:
|
|
792
|
+
source?: SourceWithLiterals;
|
|
759
793
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
760
794
|
autoHeight?: boolean | null;
|
|
761
795
|
}
|
|
762
796
|
/** @oneof */
|
|
763
|
-
|
|
797
|
+
interface HTMLDataDataOneOf {
|
|
764
798
|
/** The URL for the HTML code for the node. */
|
|
765
799
|
url?: string;
|
|
766
800
|
/** The HTML code for the node. */
|
|
@@ -771,11 +805,13 @@ export interface HTMLDataDataOneOf {
|
|
|
771
805
|
*/
|
|
772
806
|
isAdsense?: boolean | null;
|
|
773
807
|
}
|
|
774
|
-
|
|
808
|
+
declare enum Source {
|
|
775
809
|
HTML = "HTML",
|
|
776
810
|
ADSENSE = "ADSENSE"
|
|
777
811
|
}
|
|
778
|
-
|
|
812
|
+
/** @enumType */
|
|
813
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
814
|
+
interface ImageData {
|
|
779
815
|
/** Styling for the image's container. */
|
|
780
816
|
containerData?: PluginContainerData;
|
|
781
817
|
/** Image file details. */
|
|
@@ -798,7 +834,7 @@ export interface ImageData {
|
|
|
798
834
|
/** Styling for the image. */
|
|
799
835
|
styles?: ImageDataStyles;
|
|
800
836
|
}
|
|
801
|
-
|
|
837
|
+
interface StylesBorder {
|
|
802
838
|
/** Border width in pixels. */
|
|
803
839
|
width?: number | null;
|
|
804
840
|
/**
|
|
@@ -809,11 +845,11 @@ export interface StylesBorder {
|
|
|
809
845
|
/** Border radius in pixels. */
|
|
810
846
|
radius?: number | null;
|
|
811
847
|
}
|
|
812
|
-
|
|
848
|
+
interface ImageDataStyles {
|
|
813
849
|
/** Border attributes. */
|
|
814
850
|
border?: StylesBorder;
|
|
815
851
|
}
|
|
816
|
-
|
|
852
|
+
interface LinkPreviewData {
|
|
817
853
|
/** Styling for the link preview's container. */
|
|
818
854
|
containerData?: PluginContainerData;
|
|
819
855
|
/** Link details. */
|
|
@@ -829,7 +865,7 @@ export interface LinkPreviewData {
|
|
|
829
865
|
/** Styling for the link preview. */
|
|
830
866
|
styles?: LinkPreviewDataStyles;
|
|
831
867
|
}
|
|
832
|
-
|
|
868
|
+
declare enum Position {
|
|
833
869
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
834
870
|
START = "START",
|
|
835
871
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -839,7 +875,9 @@ export declare enum Position {
|
|
|
839
875
|
/** Thumbnail hidden and not displayed */
|
|
840
876
|
HIDDEN = "HIDDEN"
|
|
841
877
|
}
|
|
842
|
-
|
|
878
|
+
/** @enumType */
|
|
879
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
880
|
+
interface LinkPreviewDataStyles {
|
|
843
881
|
/**
|
|
844
882
|
* Background color as a hexadecimal value.
|
|
845
883
|
* @format COLOR_HEX
|
|
@@ -870,15 +908,15 @@ export interface LinkPreviewDataStyles {
|
|
|
870
908
|
*/
|
|
871
909
|
borderColor?: string | null;
|
|
872
910
|
/** Position of thumbnail. Defaults to `START`. */
|
|
873
|
-
thumbnailPosition?:
|
|
911
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
874
912
|
}
|
|
875
|
-
|
|
913
|
+
interface MapData {
|
|
876
914
|
/** Styling for the map's container. */
|
|
877
915
|
containerData?: PluginContainerData;
|
|
878
916
|
/** Map settings. */
|
|
879
917
|
mapSettings?: MapSettings;
|
|
880
918
|
}
|
|
881
|
-
|
|
919
|
+
interface MapSettings {
|
|
882
920
|
/** The address to display on the map. */
|
|
883
921
|
address?: string | null;
|
|
884
922
|
/** Sets whether the map is draggable. */
|
|
@@ -900,9 +938,9 @@ export interface MapSettings {
|
|
|
900
938
|
/** Initial zoom value. */
|
|
901
939
|
initialZoom?: number | null;
|
|
902
940
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
903
|
-
mapType?:
|
|
941
|
+
mapType?: MapTypeWithLiterals;
|
|
904
942
|
}
|
|
905
|
-
|
|
943
|
+
declare enum MapType {
|
|
906
944
|
/** Roadmap map type */
|
|
907
945
|
ROADMAP = "ROADMAP",
|
|
908
946
|
/** Satellite map type */
|
|
@@ -912,7 +950,9 @@ export declare enum MapType {
|
|
|
912
950
|
/** Terrain map type */
|
|
913
951
|
TERRAIN = "TERRAIN"
|
|
914
952
|
}
|
|
915
|
-
|
|
953
|
+
/** @enumType */
|
|
954
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
955
|
+
interface ParagraphData {
|
|
916
956
|
/** Styling for the paragraph text. */
|
|
917
957
|
textStyle?: TextStyle;
|
|
918
958
|
/** Indentation level from 1-4. */
|
|
@@ -920,7 +960,7 @@ export interface ParagraphData {
|
|
|
920
960
|
/** Paragraph level */
|
|
921
961
|
level?: number | null;
|
|
922
962
|
}
|
|
923
|
-
|
|
963
|
+
interface PollData {
|
|
924
964
|
/** Styling for the poll's container. */
|
|
925
965
|
containerData?: PluginContainerData;
|
|
926
966
|
/** Poll data. */
|
|
@@ -930,7 +970,7 @@ export interface PollData {
|
|
|
930
970
|
/** Styling for the poll and voting options. */
|
|
931
971
|
design?: Design;
|
|
932
972
|
}
|
|
933
|
-
|
|
973
|
+
declare enum ViewRole {
|
|
934
974
|
/** Only Poll creator can view the results */
|
|
935
975
|
CREATOR = "CREATOR",
|
|
936
976
|
/** Anyone who voted can see the results */
|
|
@@ -938,21 +978,25 @@ export declare enum ViewRole {
|
|
|
938
978
|
/** Anyone can see the results, even if one didn't vote */
|
|
939
979
|
EVERYONE = "EVERYONE"
|
|
940
980
|
}
|
|
941
|
-
|
|
981
|
+
/** @enumType */
|
|
982
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
983
|
+
declare enum VoteRole {
|
|
942
984
|
/** Logged in member */
|
|
943
985
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
944
986
|
/** Anyone */
|
|
945
987
|
ALL = "ALL"
|
|
946
988
|
}
|
|
947
|
-
|
|
989
|
+
/** @enumType */
|
|
990
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
991
|
+
interface Permissions {
|
|
948
992
|
/** Sets who can view the poll results. */
|
|
949
|
-
view?:
|
|
993
|
+
view?: ViewRoleWithLiterals;
|
|
950
994
|
/** Sets who can vote. */
|
|
951
|
-
vote?:
|
|
995
|
+
vote?: VoteRoleWithLiterals;
|
|
952
996
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
953
997
|
allowMultipleVotes?: boolean | null;
|
|
954
998
|
}
|
|
955
|
-
|
|
999
|
+
interface Option {
|
|
956
1000
|
/** Option ID. */
|
|
957
1001
|
id?: string | null;
|
|
958
1002
|
/** Option title. */
|
|
@@ -960,7 +1004,7 @@ export interface Option {
|
|
|
960
1004
|
/** The image displayed with the option. */
|
|
961
1005
|
image?: Media;
|
|
962
1006
|
}
|
|
963
|
-
|
|
1007
|
+
interface Settings {
|
|
964
1008
|
/** Permissions settings for voting. */
|
|
965
1009
|
permissions?: Permissions;
|
|
966
1010
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -968,31 +1012,35 @@ export interface Settings {
|
|
|
968
1012
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
969
1013
|
showVotesCount?: boolean | null;
|
|
970
1014
|
}
|
|
971
|
-
|
|
1015
|
+
declare enum PollLayoutType {
|
|
972
1016
|
/** List */
|
|
973
1017
|
LIST = "LIST",
|
|
974
1018
|
/** Grid */
|
|
975
1019
|
GRID = "GRID"
|
|
976
1020
|
}
|
|
977
|
-
|
|
1021
|
+
/** @enumType */
|
|
1022
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1023
|
+
declare enum PollLayoutDirection {
|
|
978
1024
|
/** Left-to-right */
|
|
979
1025
|
LTR = "LTR",
|
|
980
1026
|
/** Right-to-left */
|
|
981
1027
|
RTL = "RTL"
|
|
982
1028
|
}
|
|
983
|
-
|
|
1029
|
+
/** @enumType */
|
|
1030
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1031
|
+
interface PollLayout {
|
|
984
1032
|
/** The layout for displaying the voting options. */
|
|
985
|
-
type?:
|
|
1033
|
+
type?: PollLayoutTypeWithLiterals;
|
|
986
1034
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
987
|
-
direction?:
|
|
1035
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
988
1036
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
989
1037
|
enableImage?: boolean | null;
|
|
990
1038
|
}
|
|
991
|
-
|
|
1039
|
+
interface OptionLayout {
|
|
992
1040
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
993
1041
|
enableImage?: boolean | null;
|
|
994
1042
|
}
|
|
995
|
-
|
|
1043
|
+
declare enum BackgroundType {
|
|
996
1044
|
/** Color background type */
|
|
997
1045
|
COLOR = "COLOR",
|
|
998
1046
|
/** Image background type */
|
|
@@ -1000,7 +1048,9 @@ export declare enum BackgroundType {
|
|
|
1000
1048
|
/** Gradiant background type */
|
|
1001
1049
|
GRADIENT = "GRADIENT"
|
|
1002
1050
|
}
|
|
1003
|
-
|
|
1051
|
+
/** @enumType */
|
|
1052
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1053
|
+
interface Gradient {
|
|
1004
1054
|
/** The gradient angle in degrees. */
|
|
1005
1055
|
angle?: number | null;
|
|
1006
1056
|
/**
|
|
@@ -1014,7 +1064,7 @@ export interface Gradient {
|
|
|
1014
1064
|
*/
|
|
1015
1065
|
lastColor?: string | null;
|
|
1016
1066
|
}
|
|
1017
|
-
|
|
1067
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1018
1068
|
/**
|
|
1019
1069
|
* The background color as a hexademical value.
|
|
1020
1070
|
* @format COLOR_HEX
|
|
@@ -1025,10 +1075,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1025
1075
|
/** Details for a gradient background. */
|
|
1026
1076
|
gradient?: Gradient;
|
|
1027
1077
|
/** Background type. For each option, include the relevant details. */
|
|
1028
|
-
type?:
|
|
1078
|
+
type?: BackgroundTypeWithLiterals;
|
|
1029
1079
|
}
|
|
1030
1080
|
/** @oneof */
|
|
1031
|
-
|
|
1081
|
+
interface BackgroundBackgroundOneOf {
|
|
1032
1082
|
/**
|
|
1033
1083
|
* The background color as a hexademical value.
|
|
1034
1084
|
* @format COLOR_HEX
|
|
@@ -1039,17 +1089,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1039
1089
|
/** Details for a gradient background. */
|
|
1040
1090
|
gradient?: Gradient;
|
|
1041
1091
|
}
|
|
1042
|
-
|
|
1092
|
+
interface PollDesign {
|
|
1043
1093
|
/** Background styling. */
|
|
1044
1094
|
background?: Background;
|
|
1045
1095
|
/** Border radius in pixels. */
|
|
1046
1096
|
borderRadius?: number | null;
|
|
1047
1097
|
}
|
|
1048
|
-
|
|
1098
|
+
interface OptionDesign {
|
|
1049
1099
|
/** Border radius in pixels. */
|
|
1050
1100
|
borderRadius?: number | null;
|
|
1051
1101
|
}
|
|
1052
|
-
|
|
1102
|
+
interface Poll {
|
|
1053
1103
|
/** Poll ID. */
|
|
1054
1104
|
id?: string | null;
|
|
1055
1105
|
/** Poll title. */
|
|
@@ -1063,26 +1113,26 @@ export interface Poll {
|
|
|
1063
1113
|
/** The poll's permissions and display settings. */
|
|
1064
1114
|
settings?: Settings;
|
|
1065
1115
|
}
|
|
1066
|
-
|
|
1116
|
+
interface PollDataLayout {
|
|
1067
1117
|
/** Poll layout settings. */
|
|
1068
1118
|
poll?: PollLayout;
|
|
1069
1119
|
/** Voting otpions layout settings. */
|
|
1070
1120
|
options?: OptionLayout;
|
|
1071
1121
|
}
|
|
1072
|
-
|
|
1122
|
+
interface Design {
|
|
1073
1123
|
/** Styling for the poll. */
|
|
1074
1124
|
poll?: PollDesign;
|
|
1075
1125
|
/** Styling for voting options. */
|
|
1076
1126
|
options?: OptionDesign;
|
|
1077
1127
|
}
|
|
1078
|
-
|
|
1128
|
+
interface TextData {
|
|
1079
1129
|
/** The text to apply decorations to. */
|
|
1080
1130
|
text?: string;
|
|
1081
1131
|
/** The decorations to apply. */
|
|
1082
1132
|
decorations?: Decoration[];
|
|
1083
1133
|
}
|
|
1084
1134
|
/** Adds appearence changes to text */
|
|
1085
|
-
|
|
1135
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1086
1136
|
/** Data for an anchor link decoration. */
|
|
1087
1137
|
anchorData?: AnchorData;
|
|
1088
1138
|
/** Data for a color decoration. */
|
|
@@ -1104,10 +1154,10 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1104
1154
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1105
1155
|
strikethroughData?: boolean | null;
|
|
1106
1156
|
/** The type of decoration to apply. */
|
|
1107
|
-
type?:
|
|
1157
|
+
type?: DecorationTypeWithLiterals;
|
|
1108
1158
|
}
|
|
1109
1159
|
/** @oneof */
|
|
1110
|
-
|
|
1160
|
+
interface DecorationDataOneOf {
|
|
1111
1161
|
/** Data for an anchor link decoration. */
|
|
1112
1162
|
anchorData?: AnchorData;
|
|
1113
1163
|
/** Data for a color decoration. */
|
|
@@ -1129,7 +1179,7 @@ export interface DecorationDataOneOf {
|
|
|
1129
1179
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1130
1180
|
strikethroughData?: boolean | null;
|
|
1131
1181
|
}
|
|
1132
|
-
|
|
1182
|
+
declare enum DecorationType {
|
|
1133
1183
|
BOLD = "BOLD",
|
|
1134
1184
|
ITALIC = "ITALIC",
|
|
1135
1185
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1142,21 +1192,23 @@ export declare enum DecorationType {
|
|
|
1142
1192
|
EXTERNAL = "EXTERNAL",
|
|
1143
1193
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1144
1194
|
}
|
|
1145
|
-
|
|
1195
|
+
/** @enumType */
|
|
1196
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1197
|
+
interface AnchorData {
|
|
1146
1198
|
/** The target node's ID. */
|
|
1147
1199
|
anchor?: string;
|
|
1148
1200
|
}
|
|
1149
|
-
|
|
1201
|
+
interface ColorData {
|
|
1150
1202
|
/** The text's background color as a hexadecimal value. */
|
|
1151
1203
|
background?: string | null;
|
|
1152
1204
|
/** The text's foreground color as a hexadecimal value. */
|
|
1153
1205
|
foreground?: string | null;
|
|
1154
1206
|
}
|
|
1155
|
-
|
|
1207
|
+
interface LinkData {
|
|
1156
1208
|
/** Link details. */
|
|
1157
1209
|
link?: Link;
|
|
1158
1210
|
}
|
|
1159
|
-
|
|
1211
|
+
interface MentionData {
|
|
1160
1212
|
/** The mentioned user's name. */
|
|
1161
1213
|
name?: string;
|
|
1162
1214
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1164,27 +1216,29 @@ export interface MentionData {
|
|
|
1164
1216
|
/** Mentioned user's ID. */
|
|
1165
1217
|
id?: string | null;
|
|
1166
1218
|
}
|
|
1167
|
-
|
|
1219
|
+
interface FontSizeData {
|
|
1168
1220
|
/** The units used for the font size. */
|
|
1169
|
-
unit?:
|
|
1221
|
+
unit?: FontTypeWithLiterals;
|
|
1170
1222
|
/** Font size value. */
|
|
1171
1223
|
value?: number | null;
|
|
1172
1224
|
}
|
|
1173
|
-
|
|
1225
|
+
declare enum FontType {
|
|
1174
1226
|
PX = "PX",
|
|
1175
1227
|
EM = "EM"
|
|
1176
1228
|
}
|
|
1177
|
-
|
|
1229
|
+
/** @enumType */
|
|
1230
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1231
|
+
interface SpoilerData {
|
|
1178
1232
|
/** Spoiler ID. */
|
|
1179
1233
|
id?: string | null;
|
|
1180
1234
|
}
|
|
1181
|
-
|
|
1235
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1182
1236
|
/** Data for embedded Wix Bookings content. */
|
|
1183
1237
|
bookingData?: BookingData;
|
|
1184
1238
|
/** Data for embedded Wix Events content. */
|
|
1185
1239
|
eventData?: EventData;
|
|
1186
1240
|
/** The type of Wix App content being embedded. */
|
|
1187
|
-
type?:
|
|
1241
|
+
type?: AppTypeWithLiterals;
|
|
1188
1242
|
/** The ID of the embedded content. */
|
|
1189
1243
|
itemId?: string | null;
|
|
1190
1244
|
/** The name of the embedded content. */
|
|
@@ -1200,28 +1254,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1200
1254
|
image?: Media;
|
|
1201
1255
|
}
|
|
1202
1256
|
/** @oneof */
|
|
1203
|
-
|
|
1257
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1204
1258
|
/** Data for embedded Wix Bookings content. */
|
|
1205
1259
|
bookingData?: BookingData;
|
|
1206
1260
|
/** Data for embedded Wix Events content. */
|
|
1207
1261
|
eventData?: EventData;
|
|
1208
1262
|
}
|
|
1209
|
-
|
|
1263
|
+
declare enum AppType {
|
|
1210
1264
|
PRODUCT = "PRODUCT",
|
|
1211
1265
|
EVENT = "EVENT",
|
|
1212
1266
|
BOOKING = "BOOKING"
|
|
1213
1267
|
}
|
|
1214
|
-
|
|
1268
|
+
/** @enumType */
|
|
1269
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1270
|
+
interface BookingData {
|
|
1215
1271
|
/** Booking duration in minutes. */
|
|
1216
1272
|
durations?: string | null;
|
|
1217
1273
|
}
|
|
1218
|
-
|
|
1274
|
+
interface EventData {
|
|
1219
1275
|
/** Event schedule. */
|
|
1220
1276
|
scheduling?: string | null;
|
|
1221
1277
|
/** Event location. */
|
|
1222
1278
|
location?: string | null;
|
|
1223
1279
|
}
|
|
1224
|
-
|
|
1280
|
+
interface VideoData {
|
|
1225
1281
|
/** Styling for the video's container. */
|
|
1226
1282
|
containerData?: PluginContainerData;
|
|
1227
1283
|
/** Video details. */
|
|
@@ -1235,7 +1291,7 @@ export interface VideoData {
|
|
|
1235
1291
|
/** Video options. */
|
|
1236
1292
|
options?: PlaybackOptions;
|
|
1237
1293
|
}
|
|
1238
|
-
|
|
1294
|
+
interface PlaybackOptions {
|
|
1239
1295
|
/** Sets whether the media will automatically start playing. */
|
|
1240
1296
|
autoPlay?: boolean | null;
|
|
1241
1297
|
/** Sets whether media's will be looped. */
|
|
@@ -1243,7 +1299,7 @@ export interface PlaybackOptions {
|
|
|
1243
1299
|
/** Sets whether media's controls will be shown. */
|
|
1244
1300
|
showControls?: boolean | null;
|
|
1245
1301
|
}
|
|
1246
|
-
|
|
1302
|
+
interface EmbedData {
|
|
1247
1303
|
/** Styling for the oEmbed node's container. */
|
|
1248
1304
|
containerData?: PluginContainerData;
|
|
1249
1305
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1251,7 +1307,7 @@ export interface EmbedData {
|
|
|
1251
1307
|
/** Origin asset source. */
|
|
1252
1308
|
src?: string | null;
|
|
1253
1309
|
}
|
|
1254
|
-
|
|
1310
|
+
interface Oembed {
|
|
1255
1311
|
/** The resource type. */
|
|
1256
1312
|
type?: string | null;
|
|
1257
1313
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1283,19 +1339,19 @@ export interface Oembed {
|
|
|
1283
1339
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1284
1340
|
version?: string | null;
|
|
1285
1341
|
}
|
|
1286
|
-
|
|
1342
|
+
interface CollapsibleListData {
|
|
1287
1343
|
/** Styling for the collapsible list's container. */
|
|
1288
1344
|
containerData?: PluginContainerData;
|
|
1289
1345
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1290
1346
|
expandOnlyOne?: boolean | null;
|
|
1291
1347
|
/** Sets which items are expanded when the page loads. */
|
|
1292
|
-
initialExpandedItems?:
|
|
1348
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
1293
1349
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1294
|
-
direction?:
|
|
1350
|
+
direction?: DirectionWithLiterals;
|
|
1295
1351
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1296
1352
|
isQapageData?: boolean | null;
|
|
1297
1353
|
}
|
|
1298
|
-
|
|
1354
|
+
declare enum InitialExpandedItems {
|
|
1299
1355
|
/** First item will be expended initally */
|
|
1300
1356
|
FIRST = "FIRST",
|
|
1301
1357
|
/** All items will expended initally */
|
|
@@ -1303,13 +1359,17 @@ export declare enum InitialExpandedItems {
|
|
|
1303
1359
|
/** All items collapsed initally */
|
|
1304
1360
|
NONE = "NONE"
|
|
1305
1361
|
}
|
|
1306
|
-
|
|
1362
|
+
/** @enumType */
|
|
1363
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1364
|
+
declare enum Direction {
|
|
1307
1365
|
/** Left-to-right */
|
|
1308
1366
|
LTR = "LTR",
|
|
1309
1367
|
/** Right-to-left */
|
|
1310
1368
|
RTL = "RTL"
|
|
1311
1369
|
}
|
|
1312
|
-
|
|
1370
|
+
/** @enumType */
|
|
1371
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1372
|
+
interface TableData {
|
|
1313
1373
|
/** Styling for the table's container. */
|
|
1314
1374
|
containerData?: PluginContainerData;
|
|
1315
1375
|
/** The table's dimensions. */
|
|
@@ -1324,7 +1384,7 @@ export interface TableData {
|
|
|
1324
1384
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1325
1385
|
columnHeader?: boolean | null;
|
|
1326
1386
|
}
|
|
1327
|
-
|
|
1387
|
+
interface Dimensions {
|
|
1328
1388
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1329
1389
|
colsWidthRatio?: number[];
|
|
1330
1390
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1332,13 +1392,13 @@ export interface Dimensions {
|
|
|
1332
1392
|
/** An array representing the minimum width of each column in pixels. */
|
|
1333
1393
|
colsMinWidth?: number[];
|
|
1334
1394
|
}
|
|
1335
|
-
|
|
1395
|
+
interface TableCellData {
|
|
1336
1396
|
/** Styling for the cell's background color and text alignment. */
|
|
1337
1397
|
cellStyle?: CellStyle;
|
|
1338
1398
|
/** The cell's border colors. */
|
|
1339
1399
|
borderColors?: BorderColors;
|
|
1340
1400
|
}
|
|
1341
|
-
|
|
1401
|
+
declare enum VerticalAlignment {
|
|
1342
1402
|
/** Top alignment */
|
|
1343
1403
|
TOP = "TOP",
|
|
1344
1404
|
/** Middle alignment */
|
|
@@ -1346,16 +1406,18 @@ export declare enum VerticalAlignment {
|
|
|
1346
1406
|
/** Bottom alignment */
|
|
1347
1407
|
BOTTOM = "BOTTOM"
|
|
1348
1408
|
}
|
|
1349
|
-
|
|
1409
|
+
/** @enumType */
|
|
1410
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1411
|
+
interface CellStyle {
|
|
1350
1412
|
/** Vertical alignment for the cell's text. */
|
|
1351
|
-
verticalAlignment?:
|
|
1413
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1352
1414
|
/**
|
|
1353
1415
|
* Cell background color as a hexadecimal value.
|
|
1354
1416
|
* @format COLOR_HEX
|
|
1355
1417
|
*/
|
|
1356
1418
|
backgroundColor?: string | null;
|
|
1357
1419
|
}
|
|
1358
|
-
|
|
1420
|
+
interface BorderColors {
|
|
1359
1421
|
/**
|
|
1360
1422
|
* Left border color as a hexadecimal value.
|
|
1361
1423
|
* @format COLOR_HEX
|
|
@@ -1377,26 +1439,7 @@ export interface BorderColors {
|
|
|
1377
1439
|
*/
|
|
1378
1440
|
bottom?: string | null;
|
|
1379
1441
|
}
|
|
1380
|
-
|
|
1381
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1382
|
-
* `Value` type union.
|
|
1383
|
-
*
|
|
1384
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
1385
|
-
*/
|
|
1386
|
-
export declare enum NullValue {
|
|
1387
|
-
/** Null value. */
|
|
1388
|
-
NULL_VALUE = "NULL_VALUE"
|
|
1389
|
-
}
|
|
1390
|
-
/**
|
|
1391
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
1392
|
-
*
|
|
1393
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
1394
|
-
*/
|
|
1395
|
-
export interface ListValue {
|
|
1396
|
-
/** Repeated field of dynamically typed values. */
|
|
1397
|
-
values?: any[];
|
|
1398
|
-
}
|
|
1399
|
-
export interface AudioData {
|
|
1442
|
+
interface AudioData {
|
|
1400
1443
|
/** Styling for the audio node's container. */
|
|
1401
1444
|
containerData?: PluginContainerData;
|
|
1402
1445
|
/** Audio file details. */
|
|
@@ -1412,7 +1455,7 @@ export interface AudioData {
|
|
|
1412
1455
|
/** An HTML version of the audio node. */
|
|
1413
1456
|
html?: string | null;
|
|
1414
1457
|
}
|
|
1415
|
-
|
|
1458
|
+
interface OrderedListData {
|
|
1416
1459
|
/** Indentation level from 0-4. */
|
|
1417
1460
|
indentation?: number;
|
|
1418
1461
|
/** Offset level from 0-4. */
|
|
@@ -1420,24 +1463,24 @@ export interface OrderedListData {
|
|
|
1420
1463
|
/** List start number. */
|
|
1421
1464
|
start?: number | null;
|
|
1422
1465
|
}
|
|
1423
|
-
|
|
1466
|
+
interface BulletedListData {
|
|
1424
1467
|
/** Indentation level from 0-4. */
|
|
1425
1468
|
indentation?: number;
|
|
1426
1469
|
/** Offset level from 0-4. */
|
|
1427
1470
|
offset?: number | null;
|
|
1428
1471
|
}
|
|
1429
|
-
|
|
1472
|
+
interface BlockquoteData {
|
|
1430
1473
|
/** Indentation level from 1-4. */
|
|
1431
1474
|
indentation?: number;
|
|
1432
1475
|
}
|
|
1433
|
-
|
|
1476
|
+
interface CaptionData {
|
|
1434
1477
|
textStyle?: TextStyle;
|
|
1435
1478
|
}
|
|
1436
|
-
|
|
1479
|
+
interface LayoutCellData {
|
|
1437
1480
|
/** Size of the cell in 12 columns grid. */
|
|
1438
1481
|
colSpan?: number | null;
|
|
1439
1482
|
}
|
|
1440
|
-
|
|
1483
|
+
interface Metadata {
|
|
1441
1484
|
/** Schema version. */
|
|
1442
1485
|
version?: number;
|
|
1443
1486
|
/**
|
|
@@ -1454,7 +1497,7 @@ export interface Metadata {
|
|
|
1454
1497
|
/** Object ID. */
|
|
1455
1498
|
id?: string | null;
|
|
1456
1499
|
}
|
|
1457
|
-
|
|
1500
|
+
interface DocumentStyle {
|
|
1458
1501
|
/** Styling for H1 nodes. */
|
|
1459
1502
|
headerOne?: TextNodeStyle;
|
|
1460
1503
|
/** Styling for H2 nodes. */
|
|
@@ -1474,7 +1517,7 @@ export interface DocumentStyle {
|
|
|
1474
1517
|
/** Styling for code block nodes. */
|
|
1475
1518
|
codeBlock?: TextNodeStyle;
|
|
1476
1519
|
}
|
|
1477
|
-
|
|
1520
|
+
interface TextNodeStyle {
|
|
1478
1521
|
/** The decorations to apply to the node. */
|
|
1479
1522
|
decorations?: Decoration[];
|
|
1480
1523
|
/** Padding and background color for the node. */
|
|
@@ -1482,15 +1525,15 @@ export interface TextNodeStyle {
|
|
|
1482
1525
|
/** Line height for text in the node. */
|
|
1483
1526
|
lineHeight?: string | null;
|
|
1484
1527
|
}
|
|
1485
|
-
|
|
1528
|
+
interface MachineTranslateRequest {
|
|
1486
1529
|
/** Language of the source text to translate. */
|
|
1487
|
-
sourceLanguage:
|
|
1530
|
+
sourceLanguage: SupportedLanguageWithLiterals;
|
|
1488
1531
|
/** Language to translate text into. */
|
|
1489
|
-
targetLanguage:
|
|
1532
|
+
targetLanguage: SupportedLanguageWithLiterals;
|
|
1490
1533
|
/** The content to translate. */
|
|
1491
1534
|
contentToTranslate: TranslatableContent;
|
|
1492
1535
|
}
|
|
1493
|
-
|
|
1536
|
+
declare enum SupportedLanguage {
|
|
1494
1537
|
/** Undefined Language */
|
|
1495
1538
|
UNDEFINED_SUPPORTED_LANGUAGE = "UNDEFINED_SUPPORTED_LANGUAGE",
|
|
1496
1539
|
/** Afrikaans */
|
|
@@ -1764,34 +1807,17 @@ export declare enum SupportedLanguage {
|
|
|
1764
1807
|
/** Zulu */
|
|
1765
1808
|
ZU = "ZU"
|
|
1766
1809
|
}
|
|
1767
|
-
|
|
1810
|
+
/** @enumType */
|
|
1811
|
+
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';
|
|
1812
|
+
interface MachineTranslateResponse {
|
|
1768
1813
|
/** The translated content. */
|
|
1769
1814
|
translatedContent?: TranslatableContent;
|
|
1770
1815
|
}
|
|
1771
|
-
|
|
1772
|
-
/** The number of credits required to translate the content in the request. */
|
|
1773
|
-
creditsRequired?: number;
|
|
1774
|
-
}
|
|
1775
|
-
export interface TextTooLongError {
|
|
1776
|
-
/** The maximum length of text that can be translated. */
|
|
1777
|
-
maxLength?: number;
|
|
1778
|
-
/** The actual length of the text that was sent for translation. */
|
|
1779
|
-
actualLength?: number;
|
|
1780
|
-
}
|
|
1781
|
-
export interface UnknownFormatError {
|
|
1782
|
-
}
|
|
1783
|
-
export interface SameLanguageArgumentsError {
|
|
1784
|
-
/**
|
|
1785
|
-
* The language supplied as both the source and the target languages
|
|
1786
|
-
* @maxLength 16
|
|
1787
|
-
*/
|
|
1788
|
-
language?: string;
|
|
1789
|
-
}
|
|
1790
|
-
export interface BulkMachineTranslateRequest {
|
|
1816
|
+
interface BulkMachineTranslateRequest {
|
|
1791
1817
|
/** Language of the source text to translate. */
|
|
1792
|
-
sourceLanguage:
|
|
1818
|
+
sourceLanguage: SupportedLanguageWithLiterals;
|
|
1793
1819
|
/** Language to translate text into. */
|
|
1794
|
-
targetLanguage:
|
|
1820
|
+
targetLanguage: SupportedLanguageWithLiterals;
|
|
1795
1821
|
/**
|
|
1796
1822
|
* The content to translate.
|
|
1797
1823
|
* @minSize 1
|
|
@@ -1799,7 +1825,7 @@ export interface BulkMachineTranslateRequest {
|
|
|
1799
1825
|
*/
|
|
1800
1826
|
contentToTranslate?: TranslatableContent[];
|
|
1801
1827
|
}
|
|
1802
|
-
|
|
1828
|
+
interface BulkMachineTranslateResponse {
|
|
1803
1829
|
/**
|
|
1804
1830
|
* List of results for each item in the bulk request.
|
|
1805
1831
|
* @minSize 1
|
|
@@ -1809,13 +1835,13 @@ export interface BulkMachineTranslateResponse {
|
|
|
1809
1835
|
/** Metadata for the overall bulk action, including success and failure counts. */
|
|
1810
1836
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1811
1837
|
}
|
|
1812
|
-
|
|
1838
|
+
interface BulkTranslateResult {
|
|
1813
1839
|
/** Metadata for the individual item in the request. */
|
|
1814
1840
|
itemMetadata?: ItemMetadata;
|
|
1815
1841
|
/** The translated content. */
|
|
1816
1842
|
item?: TranslatableContent;
|
|
1817
1843
|
}
|
|
1818
|
-
|
|
1844
|
+
interface ItemMetadata {
|
|
1819
1845
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1820
1846
|
id?: string | null;
|
|
1821
1847
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -1825,7 +1851,7 @@ export interface ItemMetadata {
|
|
|
1825
1851
|
/** Details about the error in case of failure. */
|
|
1826
1852
|
error?: ApplicationError;
|
|
1827
1853
|
}
|
|
1828
|
-
|
|
1854
|
+
interface ApplicationError {
|
|
1829
1855
|
/** Error code. */
|
|
1830
1856
|
code?: string;
|
|
1831
1857
|
/** Description of the error. */
|
|
@@ -1833,7 +1859,7 @@ export interface ApplicationError {
|
|
|
1833
1859
|
/** Data related to the error. */
|
|
1834
1860
|
data?: Record<string, any> | null;
|
|
1835
1861
|
}
|
|
1836
|
-
|
|
1862
|
+
interface BulkActionMetadata {
|
|
1837
1863
|
/** Number of items that were successfully processed. */
|
|
1838
1864
|
totalSuccesses?: number;
|
|
1839
1865
|
/** Number of items that couldn't be processed. */
|
|
@@ -1841,3 +1867,18 @@ export interface BulkActionMetadata {
|
|
|
1841
1867
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1842
1868
|
undetailedFailures?: number;
|
|
1843
1869
|
}
|
|
1870
|
+
|
|
1871
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1872
|
+
getUrl: (context: any) => string;
|
|
1873
|
+
httpMethod: K;
|
|
1874
|
+
path: string;
|
|
1875
|
+
pathParams: M;
|
|
1876
|
+
__requestType: T;
|
|
1877
|
+
__originalRequestType: S;
|
|
1878
|
+
__responseType: Q;
|
|
1879
|
+
__originalResponseType: R;
|
|
1880
|
+
};
|
|
1881
|
+
declare function machineTranslate(): __PublicMethodMetaInfo<'POST', {}, MachineTranslateRequest$1, MachineTranslateRequest, MachineTranslateResponse$1, MachineTranslateResponse>;
|
|
1882
|
+
declare function bulkMachineTranslate(): __PublicMethodMetaInfo<'POST', {}, BulkMachineTranslateRequest$1, BulkMachineTranslateRequest, BulkMachineTranslateResponse$1, BulkMachineTranslateResponse>;
|
|
1883
|
+
|
|
1884
|
+
export { type __PublicMethodMetaInfo, bulkMachineTranslate, machineTranslate };
|