@wix/auto_sdk_multilingual_machine-translation 1.0.14 → 1.0.16
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} +11 -8
- package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.ts} +11 -8
- 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} +11 -8
- package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → internal/index.d.ts} +11 -8
- 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/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → internal/meta.d.mts} +181 -204
- package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → internal/meta.d.ts} +181 -204
- 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/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.mts +1923 -0
- package/build/internal/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.ts +1923 -0
- package/build/{internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.mts} +181 -204
- package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.ts} +181 -204
- 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/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.mts +1923 -0
- package/build/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.ts +1923 -0
- package/package.json +12 -11
- 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.d.ts +0 -1998
- 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.d.ts +0 -1998
- 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.d.ts +0 -1998
- 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.d.ts +0 -1998
- 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
|
|
@@ -28,7 +30,7 @@ export interface TranslatableContent extends TranslatableContentContentOneOf {
|
|
|
28
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. */
|
|
@@ -55,8 +57,8 @@ export declare enum Format {
|
|
|
55
57
|
RICH = "RICH"
|
|
56
58
|
}
|
|
57
59
|
/** @enumType */
|
|
58
|
-
|
|
59
|
-
|
|
60
|
+
type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'PLAIN_TEXT' | 'HTML' | 'RICH';
|
|
61
|
+
interface RichContent {
|
|
60
62
|
/** Node objects representing a rich content document. */
|
|
61
63
|
nodes?: Node[];
|
|
62
64
|
/** Object metadata. */
|
|
@@ -64,7 +66,7 @@ export interface RichContent {
|
|
|
64
66
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
65
67
|
documentStyle?: DocumentStyle;
|
|
66
68
|
}
|
|
67
|
-
|
|
69
|
+
interface Node extends NodeDataOneOf {
|
|
68
70
|
/** Data for a button node. */
|
|
69
71
|
buttonData?: ButtonData;
|
|
70
72
|
/** Data for a code block node. */
|
|
@@ -129,7 +131,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
129
131
|
style?: NodeStyle;
|
|
130
132
|
}
|
|
131
133
|
/** @oneof */
|
|
132
|
-
|
|
134
|
+
interface NodeDataOneOf {
|
|
133
135
|
/** Data for a button node. */
|
|
134
136
|
buttonData?: ButtonData;
|
|
135
137
|
/** Data for a code block node. */
|
|
@@ -185,7 +187,7 @@ export interface NodeDataOneOf {
|
|
|
185
187
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
186
188
|
layoutCellData?: LayoutCellData;
|
|
187
189
|
}
|
|
188
|
-
|
|
190
|
+
declare enum NodeType {
|
|
189
191
|
PARAGRAPH = "PARAGRAPH",
|
|
190
192
|
TEXT = "TEXT",
|
|
191
193
|
HEADING = "HEADING",
|
|
@@ -222,8 +224,8 @@ export declare enum NodeType {
|
|
|
222
224
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
223
225
|
}
|
|
224
226
|
/** @enumType */
|
|
225
|
-
|
|
226
|
-
|
|
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 {
|
|
227
229
|
/** The top padding value in pixels. */
|
|
228
230
|
paddingTop?: string | null;
|
|
229
231
|
/** The bottom padding value in pixels. */
|
|
@@ -231,7 +233,7 @@ export interface NodeStyle {
|
|
|
231
233
|
/** The background color as a hexadecimal value. */
|
|
232
234
|
backgroundColor?: string | null;
|
|
233
235
|
}
|
|
234
|
-
|
|
236
|
+
interface ButtonData {
|
|
235
237
|
/** Styling for the button's container. */
|
|
236
238
|
containerData?: PluginContainerData;
|
|
237
239
|
/** The button type. */
|
|
@@ -243,7 +245,7 @@ export interface ButtonData {
|
|
|
243
245
|
/** Button link details. */
|
|
244
246
|
link?: Link;
|
|
245
247
|
}
|
|
246
|
-
|
|
248
|
+
interface Border {
|
|
247
249
|
/**
|
|
248
250
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
249
251
|
* @deprecated
|
|
@@ -255,7 +257,7 @@ export interface Border {
|
|
|
255
257
|
*/
|
|
256
258
|
radius?: number | null;
|
|
257
259
|
}
|
|
258
|
-
|
|
260
|
+
interface Colors {
|
|
259
261
|
/**
|
|
260
262
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
261
263
|
* @deprecated
|
|
@@ -272,7 +274,7 @@ export interface Colors {
|
|
|
272
274
|
*/
|
|
273
275
|
background?: string | null;
|
|
274
276
|
}
|
|
275
|
-
|
|
277
|
+
interface PluginContainerData {
|
|
276
278
|
/** The width of the node when it's displayed. */
|
|
277
279
|
width?: PluginContainerDataWidth;
|
|
278
280
|
/** The node's alignment within its container. */
|
|
@@ -284,7 +286,7 @@ export interface PluginContainerData {
|
|
|
284
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`. */
|
|
285
287
|
textWrap?: boolean | null;
|
|
286
288
|
}
|
|
287
|
-
|
|
289
|
+
declare enum WidthType {
|
|
288
290
|
/** Width matches the content width */
|
|
289
291
|
CONTENT = "CONTENT",
|
|
290
292
|
/** Small Width */
|
|
@@ -295,8 +297,8 @@ export declare enum WidthType {
|
|
|
295
297
|
FULL_WIDTH = "FULL_WIDTH"
|
|
296
298
|
}
|
|
297
299
|
/** @enumType */
|
|
298
|
-
|
|
299
|
-
|
|
300
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
301
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
300
302
|
/**
|
|
301
303
|
* One of the following predefined width options:
|
|
302
304
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -309,7 +311,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
309
311
|
custom?: string | null;
|
|
310
312
|
}
|
|
311
313
|
/** @oneof */
|
|
312
|
-
|
|
314
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
313
315
|
/**
|
|
314
316
|
* One of the following predefined width options:
|
|
315
317
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -321,7 +323,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
321
323
|
/** A custom width value in pixels. */
|
|
322
324
|
custom?: string | null;
|
|
323
325
|
}
|
|
324
|
-
|
|
326
|
+
declare enum PluginContainerDataAlignment {
|
|
325
327
|
/** Center Alignment */
|
|
326
328
|
CENTER = "CENTER",
|
|
327
329
|
/** Left Alignment */
|
|
@@ -330,8 +332,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
330
332
|
RIGHT = "RIGHT"
|
|
331
333
|
}
|
|
332
334
|
/** @enumType */
|
|
333
|
-
|
|
334
|
-
|
|
335
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
336
|
+
interface Spoiler {
|
|
335
337
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
336
338
|
enabled?: boolean | null;
|
|
337
339
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -339,19 +341,19 @@ export interface Spoiler {
|
|
|
339
341
|
/** The text for the button used to remove the spoiler cover. */
|
|
340
342
|
buttonText?: string | null;
|
|
341
343
|
}
|
|
342
|
-
|
|
344
|
+
interface Height {
|
|
343
345
|
/** A custom height value in pixels. */
|
|
344
346
|
custom?: string | null;
|
|
345
347
|
}
|
|
346
|
-
|
|
348
|
+
declare enum Type {
|
|
347
349
|
/** Regular link button */
|
|
348
350
|
LINK = "LINK",
|
|
349
351
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
350
352
|
ACTION = "ACTION"
|
|
351
353
|
}
|
|
352
354
|
/** @enumType */
|
|
353
|
-
|
|
354
|
-
|
|
355
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
356
|
+
interface Styles {
|
|
355
357
|
/**
|
|
356
358
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
357
359
|
* @deprecated
|
|
@@ -404,7 +406,7 @@ export interface Styles {
|
|
|
404
406
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
405
407
|
buttonSize?: string | null;
|
|
406
408
|
}
|
|
407
|
-
|
|
409
|
+
interface Link extends LinkDataOneOf {
|
|
408
410
|
/** The absolute URL for the linked document. */
|
|
409
411
|
url?: string;
|
|
410
412
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -423,13 +425,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
423
425
|
customData?: string | null;
|
|
424
426
|
}
|
|
425
427
|
/** @oneof */
|
|
426
|
-
|
|
428
|
+
interface LinkDataOneOf {
|
|
427
429
|
/** The absolute URL for the linked document. */
|
|
428
430
|
url?: string;
|
|
429
431
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
430
432
|
anchor?: string;
|
|
431
433
|
}
|
|
432
|
-
|
|
434
|
+
declare enum Target {
|
|
433
435
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
434
436
|
SELF = "SELF",
|
|
435
437
|
/** Opens the linked document in a new window or tab */
|
|
@@ -440,8 +442,8 @@ export declare enum Target {
|
|
|
440
442
|
TOP = "TOP"
|
|
441
443
|
}
|
|
442
444
|
/** @enumType */
|
|
443
|
-
|
|
444
|
-
|
|
445
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
446
|
+
interface Rel {
|
|
445
447
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
446
448
|
nofollow?: boolean | null;
|
|
447
449
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -451,17 +453,17 @@ export interface Rel {
|
|
|
451
453
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
452
454
|
noreferrer?: boolean | null;
|
|
453
455
|
}
|
|
454
|
-
|
|
456
|
+
interface CodeBlockData {
|
|
455
457
|
/** Styling for the code block's text. */
|
|
456
458
|
textStyle?: TextStyle;
|
|
457
459
|
}
|
|
458
|
-
|
|
460
|
+
interface TextStyle {
|
|
459
461
|
/** Text alignment. Defaults to `AUTO`. */
|
|
460
462
|
textAlignment?: TextAlignmentWithLiterals;
|
|
461
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. */
|
|
462
464
|
lineHeight?: string | null;
|
|
463
465
|
}
|
|
464
|
-
|
|
466
|
+
declare enum TextAlignment {
|
|
465
467
|
/** browser default, eqivalent to `initial` */
|
|
466
468
|
AUTO = "AUTO",
|
|
467
469
|
/** Left align */
|
|
@@ -474,8 +476,8 @@ export declare enum TextAlignment {
|
|
|
474
476
|
JUSTIFY = "JUSTIFY"
|
|
475
477
|
}
|
|
476
478
|
/** @enumType */
|
|
477
|
-
|
|
478
|
-
|
|
479
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
480
|
+
interface DividerData {
|
|
479
481
|
/** Styling for the divider's container. */
|
|
480
482
|
containerData?: PluginContainerData;
|
|
481
483
|
/** Divider line style. */
|
|
@@ -485,7 +487,7 @@ export interface DividerData {
|
|
|
485
487
|
/** Divider alignment. */
|
|
486
488
|
alignment?: AlignmentWithLiterals;
|
|
487
489
|
}
|
|
488
|
-
|
|
490
|
+
declare enum LineStyle {
|
|
489
491
|
/** Single Line */
|
|
490
492
|
SINGLE = "SINGLE",
|
|
491
493
|
/** Double Line */
|
|
@@ -496,8 +498,8 @@ export declare enum LineStyle {
|
|
|
496
498
|
DOTTED = "DOTTED"
|
|
497
499
|
}
|
|
498
500
|
/** @enumType */
|
|
499
|
-
|
|
500
|
-
|
|
501
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
502
|
+
declare enum Width {
|
|
501
503
|
/** Large line */
|
|
502
504
|
LARGE = "LARGE",
|
|
503
505
|
/** Medium line */
|
|
@@ -506,8 +508,8 @@ export declare enum Width {
|
|
|
506
508
|
SMALL = "SMALL"
|
|
507
509
|
}
|
|
508
510
|
/** @enumType */
|
|
509
|
-
|
|
510
|
-
|
|
511
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
512
|
+
declare enum Alignment {
|
|
511
513
|
/** Center alignment */
|
|
512
514
|
CENTER = "CENTER",
|
|
513
515
|
/** Left alignment */
|
|
@@ -516,8 +518,8 @@ export declare enum Alignment {
|
|
|
516
518
|
RIGHT = "RIGHT"
|
|
517
519
|
}
|
|
518
520
|
/** @enumType */
|
|
519
|
-
|
|
520
|
-
|
|
521
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
522
|
+
interface FileData {
|
|
521
523
|
/** Styling for the file's container. */
|
|
522
524
|
containerData?: PluginContainerData;
|
|
523
525
|
/** The source for the file's data. */
|
|
@@ -540,7 +542,7 @@ export interface FileData {
|
|
|
540
542
|
/** File size in KB. */
|
|
541
543
|
sizeInKb?: string | null;
|
|
542
544
|
}
|
|
543
|
-
|
|
545
|
+
declare enum ViewMode {
|
|
544
546
|
/** No PDF view */
|
|
545
547
|
NONE = "NONE",
|
|
546
548
|
/** Full PDF view */
|
|
@@ -549,8 +551,8 @@ export declare enum ViewMode {
|
|
|
549
551
|
MINI = "MINI"
|
|
550
552
|
}
|
|
551
553
|
/** @enumType */
|
|
552
|
-
|
|
553
|
-
|
|
554
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
555
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
554
556
|
/** The absolute URL for the file's source. */
|
|
555
557
|
url?: string | null;
|
|
556
558
|
/**
|
|
@@ -564,7 +566,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
564
566
|
private?: boolean | null;
|
|
565
567
|
}
|
|
566
568
|
/** @oneof */
|
|
567
|
-
|
|
569
|
+
interface FileSourceDataOneOf {
|
|
568
570
|
/** The absolute URL for the file's source. */
|
|
569
571
|
url?: string | null;
|
|
570
572
|
/**
|
|
@@ -575,7 +577,7 @@ export interface FileSourceDataOneOf {
|
|
|
575
577
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
576
578
|
id?: string | null;
|
|
577
579
|
}
|
|
578
|
-
|
|
580
|
+
interface PDFSettings {
|
|
579
581
|
/**
|
|
580
582
|
* PDF view mode. One of the following:
|
|
581
583
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -588,7 +590,7 @@ export interface PDFSettings {
|
|
|
588
590
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
589
591
|
disablePrint?: boolean | null;
|
|
590
592
|
}
|
|
591
|
-
|
|
593
|
+
interface GalleryData {
|
|
592
594
|
/** Styling for the gallery's container. */
|
|
593
595
|
containerData?: PluginContainerData;
|
|
594
596
|
/** The items in the gallery. */
|
|
@@ -600,7 +602,7 @@ export interface GalleryData {
|
|
|
600
602
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
601
603
|
disableDownload?: boolean | null;
|
|
602
604
|
}
|
|
603
|
-
|
|
605
|
+
interface Media {
|
|
604
606
|
/** The source for the media's data. */
|
|
605
607
|
src?: FileSource;
|
|
606
608
|
/** Media width in pixels. */
|
|
@@ -610,19 +612,19 @@ export interface Media {
|
|
|
610
612
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
611
613
|
duration?: number | null;
|
|
612
614
|
}
|
|
613
|
-
|
|
615
|
+
interface Image {
|
|
614
616
|
/** Image file details. */
|
|
615
617
|
media?: Media;
|
|
616
618
|
/** Link details for images that are links. */
|
|
617
619
|
link?: Link;
|
|
618
620
|
}
|
|
619
|
-
|
|
621
|
+
interface Video {
|
|
620
622
|
/** Video file details. */
|
|
621
623
|
media?: Media;
|
|
622
624
|
/** Video thumbnail file details. */
|
|
623
625
|
thumbnail?: Media;
|
|
624
626
|
}
|
|
625
|
-
|
|
627
|
+
interface Item extends ItemDataOneOf {
|
|
626
628
|
/** An image item. */
|
|
627
629
|
image?: Image;
|
|
628
630
|
/** A video item. */
|
|
@@ -633,13 +635,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
633
635
|
altText?: string | null;
|
|
634
636
|
}
|
|
635
637
|
/** @oneof */
|
|
636
|
-
|
|
638
|
+
interface ItemDataOneOf {
|
|
637
639
|
/** An image item. */
|
|
638
640
|
image?: Image;
|
|
639
641
|
/** A video item. */
|
|
640
642
|
video?: Video;
|
|
641
643
|
}
|
|
642
|
-
|
|
644
|
+
interface GalleryOptions {
|
|
643
645
|
/** Gallery layout. */
|
|
644
646
|
layout?: Layout;
|
|
645
647
|
/** Styling for gallery items. */
|
|
@@ -647,7 +649,7 @@ export interface GalleryOptions {
|
|
|
647
649
|
/** Styling for gallery thumbnail images. */
|
|
648
650
|
thumbnails?: Thumbnails;
|
|
649
651
|
}
|
|
650
|
-
|
|
652
|
+
declare enum LayoutType {
|
|
651
653
|
/** Collage type */
|
|
652
654
|
COLLAGE = "COLLAGE",
|
|
653
655
|
/** Masonry type */
|
|
@@ -670,24 +672,24 @@ export declare enum LayoutType {
|
|
|
670
672
|
FULLSIZE = "FULLSIZE"
|
|
671
673
|
}
|
|
672
674
|
/** @enumType */
|
|
673
|
-
|
|
674
|
-
|
|
675
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
676
|
+
declare enum Orientation {
|
|
675
677
|
/** Rows Orientation */
|
|
676
678
|
ROWS = "ROWS",
|
|
677
679
|
/** Columns Orientation */
|
|
678
680
|
COLUMNS = "COLUMNS"
|
|
679
681
|
}
|
|
680
682
|
/** @enumType */
|
|
681
|
-
|
|
682
|
-
|
|
683
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
684
|
+
declare enum Crop {
|
|
683
685
|
/** Crop to fill */
|
|
684
686
|
FILL = "FILL",
|
|
685
687
|
/** Crop to fit */
|
|
686
688
|
FIT = "FIT"
|
|
687
689
|
}
|
|
688
690
|
/** @enumType */
|
|
689
|
-
|
|
690
|
-
|
|
691
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
692
|
+
declare enum ThumbnailsAlignment {
|
|
691
693
|
/** Top alignment */
|
|
692
694
|
TOP = "TOP",
|
|
693
695
|
/** Right alignment */
|
|
@@ -700,8 +702,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
700
702
|
NONE = "NONE"
|
|
701
703
|
}
|
|
702
704
|
/** @enumType */
|
|
703
|
-
|
|
704
|
-
|
|
705
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
706
|
+
interface Layout {
|
|
705
707
|
/** Gallery layout type. */
|
|
706
708
|
type?: LayoutTypeWithLiterals;
|
|
707
709
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -713,7 +715,7 @@ export interface Layout {
|
|
|
713
715
|
/** The number of columns to display on mobile screens. */
|
|
714
716
|
mobileNumberOfColumns?: number | null;
|
|
715
717
|
}
|
|
716
|
-
|
|
718
|
+
interface ItemStyle {
|
|
717
719
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
718
720
|
targetSize?: number | null;
|
|
719
721
|
/** Item ratio */
|
|
@@ -723,13 +725,13 @@ export interface ItemStyle {
|
|
|
723
725
|
/** The spacing between items in pixels. */
|
|
724
726
|
spacing?: number | null;
|
|
725
727
|
}
|
|
726
|
-
|
|
728
|
+
interface Thumbnails {
|
|
727
729
|
/** Thumbnail alignment. */
|
|
728
730
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
729
731
|
/** Spacing between thumbnails in pixels. */
|
|
730
732
|
spacing?: number | null;
|
|
731
733
|
}
|
|
732
|
-
|
|
734
|
+
interface GIFData {
|
|
733
735
|
/** Styling for the GIF's container. */
|
|
734
736
|
containerData?: PluginContainerData;
|
|
735
737
|
/** The source of the full size GIF. */
|
|
@@ -743,7 +745,7 @@ export interface GIFData {
|
|
|
743
745
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
744
746
|
gifType?: GIFTypeWithLiterals;
|
|
745
747
|
}
|
|
746
|
-
|
|
748
|
+
interface GIF {
|
|
747
749
|
/**
|
|
748
750
|
* GIF format URL.
|
|
749
751
|
* @format WEB_URL
|
|
@@ -760,13 +762,13 @@ export interface GIF {
|
|
|
760
762
|
*/
|
|
761
763
|
still?: string | null;
|
|
762
764
|
}
|
|
763
|
-
|
|
765
|
+
declare enum GIFType {
|
|
764
766
|
NORMAL = "NORMAL",
|
|
765
767
|
STICKER = "STICKER"
|
|
766
768
|
}
|
|
767
769
|
/** @enumType */
|
|
768
|
-
|
|
769
|
-
|
|
770
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
771
|
+
interface HeadingData {
|
|
770
772
|
/** Heading level from 1-6. */
|
|
771
773
|
level?: number;
|
|
772
774
|
/** Styling for the heading text. */
|
|
@@ -774,7 +776,7 @@ export interface HeadingData {
|
|
|
774
776
|
/** Indentation level from 1-4. */
|
|
775
777
|
indentation?: number | null;
|
|
776
778
|
}
|
|
777
|
-
|
|
779
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
778
780
|
/** The URL for the HTML code for the node. */
|
|
779
781
|
url?: string;
|
|
780
782
|
/** The HTML code for the node. */
|
|
@@ -792,7 +794,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
792
794
|
autoHeight?: boolean | null;
|
|
793
795
|
}
|
|
794
796
|
/** @oneof */
|
|
795
|
-
|
|
797
|
+
interface HTMLDataDataOneOf {
|
|
796
798
|
/** The URL for the HTML code for the node. */
|
|
797
799
|
url?: string;
|
|
798
800
|
/** The HTML code for the node. */
|
|
@@ -803,13 +805,13 @@ export interface HTMLDataDataOneOf {
|
|
|
803
805
|
*/
|
|
804
806
|
isAdsense?: boolean | null;
|
|
805
807
|
}
|
|
806
|
-
|
|
808
|
+
declare enum Source {
|
|
807
809
|
HTML = "HTML",
|
|
808
810
|
ADSENSE = "ADSENSE"
|
|
809
811
|
}
|
|
810
812
|
/** @enumType */
|
|
811
|
-
|
|
812
|
-
|
|
813
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
814
|
+
interface ImageData {
|
|
813
815
|
/** Styling for the image's container. */
|
|
814
816
|
containerData?: PluginContainerData;
|
|
815
817
|
/** Image file details. */
|
|
@@ -832,7 +834,7 @@ export interface ImageData {
|
|
|
832
834
|
/** Styling for the image. */
|
|
833
835
|
styles?: ImageDataStyles;
|
|
834
836
|
}
|
|
835
|
-
|
|
837
|
+
interface StylesBorder {
|
|
836
838
|
/** Border width in pixels. */
|
|
837
839
|
width?: number | null;
|
|
838
840
|
/**
|
|
@@ -843,11 +845,11 @@ export interface StylesBorder {
|
|
|
843
845
|
/** Border radius in pixels. */
|
|
844
846
|
radius?: number | null;
|
|
845
847
|
}
|
|
846
|
-
|
|
848
|
+
interface ImageDataStyles {
|
|
847
849
|
/** Border attributes. */
|
|
848
850
|
border?: StylesBorder;
|
|
849
851
|
}
|
|
850
|
-
|
|
852
|
+
interface LinkPreviewData {
|
|
851
853
|
/** Styling for the link preview's container. */
|
|
852
854
|
containerData?: PluginContainerData;
|
|
853
855
|
/** Link details. */
|
|
@@ -863,7 +865,7 @@ export interface LinkPreviewData {
|
|
|
863
865
|
/** Styling for the link preview. */
|
|
864
866
|
styles?: LinkPreviewDataStyles;
|
|
865
867
|
}
|
|
866
|
-
|
|
868
|
+
declare enum Position {
|
|
867
869
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
868
870
|
START = "START",
|
|
869
871
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -874,8 +876,8 @@ export declare enum Position {
|
|
|
874
876
|
HIDDEN = "HIDDEN"
|
|
875
877
|
}
|
|
876
878
|
/** @enumType */
|
|
877
|
-
|
|
878
|
-
|
|
879
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
880
|
+
interface LinkPreviewDataStyles {
|
|
879
881
|
/**
|
|
880
882
|
* Background color as a hexadecimal value.
|
|
881
883
|
* @format COLOR_HEX
|
|
@@ -908,13 +910,13 @@ export interface LinkPreviewDataStyles {
|
|
|
908
910
|
/** Position of thumbnail. Defaults to `START`. */
|
|
909
911
|
thumbnailPosition?: PositionWithLiterals;
|
|
910
912
|
}
|
|
911
|
-
|
|
913
|
+
interface MapData {
|
|
912
914
|
/** Styling for the map's container. */
|
|
913
915
|
containerData?: PluginContainerData;
|
|
914
916
|
/** Map settings. */
|
|
915
917
|
mapSettings?: MapSettings;
|
|
916
918
|
}
|
|
917
|
-
|
|
919
|
+
interface MapSettings {
|
|
918
920
|
/** The address to display on the map. */
|
|
919
921
|
address?: string | null;
|
|
920
922
|
/** Sets whether the map is draggable. */
|
|
@@ -938,7 +940,7 @@ export interface MapSettings {
|
|
|
938
940
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
939
941
|
mapType?: MapTypeWithLiterals;
|
|
940
942
|
}
|
|
941
|
-
|
|
943
|
+
declare enum MapType {
|
|
942
944
|
/** Roadmap map type */
|
|
943
945
|
ROADMAP = "ROADMAP",
|
|
944
946
|
/** Satellite map type */
|
|
@@ -949,8 +951,8 @@ export declare enum MapType {
|
|
|
949
951
|
TERRAIN = "TERRAIN"
|
|
950
952
|
}
|
|
951
953
|
/** @enumType */
|
|
952
|
-
|
|
953
|
-
|
|
954
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
955
|
+
interface ParagraphData {
|
|
954
956
|
/** Styling for the paragraph text. */
|
|
955
957
|
textStyle?: TextStyle;
|
|
956
958
|
/** Indentation level from 1-4. */
|
|
@@ -958,7 +960,7 @@ export interface ParagraphData {
|
|
|
958
960
|
/** Paragraph level */
|
|
959
961
|
level?: number | null;
|
|
960
962
|
}
|
|
961
|
-
|
|
963
|
+
interface PollData {
|
|
962
964
|
/** Styling for the poll's container. */
|
|
963
965
|
containerData?: PluginContainerData;
|
|
964
966
|
/** Poll data. */
|
|
@@ -968,7 +970,7 @@ export interface PollData {
|
|
|
968
970
|
/** Styling for the poll and voting options. */
|
|
969
971
|
design?: Design;
|
|
970
972
|
}
|
|
971
|
-
|
|
973
|
+
declare enum ViewRole {
|
|
972
974
|
/** Only Poll creator can view the results */
|
|
973
975
|
CREATOR = "CREATOR",
|
|
974
976
|
/** Anyone who voted can see the results */
|
|
@@ -977,16 +979,16 @@ export declare enum ViewRole {
|
|
|
977
979
|
EVERYONE = "EVERYONE"
|
|
978
980
|
}
|
|
979
981
|
/** @enumType */
|
|
980
|
-
|
|
981
|
-
|
|
982
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
983
|
+
declare enum VoteRole {
|
|
982
984
|
/** Logged in member */
|
|
983
985
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
984
986
|
/** Anyone */
|
|
985
987
|
ALL = "ALL"
|
|
986
988
|
}
|
|
987
989
|
/** @enumType */
|
|
988
|
-
|
|
989
|
-
|
|
990
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
991
|
+
interface Permissions {
|
|
990
992
|
/** Sets who can view the poll results. */
|
|
991
993
|
view?: ViewRoleWithLiterals;
|
|
992
994
|
/** Sets who can vote. */
|
|
@@ -994,7 +996,7 @@ export interface Permissions {
|
|
|
994
996
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
995
997
|
allowMultipleVotes?: boolean | null;
|
|
996
998
|
}
|
|
997
|
-
|
|
999
|
+
interface Option {
|
|
998
1000
|
/** Option ID. */
|
|
999
1001
|
id?: string | null;
|
|
1000
1002
|
/** Option title. */
|
|
@@ -1002,7 +1004,7 @@ export interface Option {
|
|
|
1002
1004
|
/** The image displayed with the option. */
|
|
1003
1005
|
image?: Media;
|
|
1004
1006
|
}
|
|
1005
|
-
|
|
1007
|
+
interface Settings {
|
|
1006
1008
|
/** Permissions settings for voting. */
|
|
1007
1009
|
permissions?: Permissions;
|
|
1008
1010
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1010,23 +1012,23 @@ export interface Settings {
|
|
|
1010
1012
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1011
1013
|
showVotesCount?: boolean | null;
|
|
1012
1014
|
}
|
|
1013
|
-
|
|
1015
|
+
declare enum PollLayoutType {
|
|
1014
1016
|
/** List */
|
|
1015
1017
|
LIST = "LIST",
|
|
1016
1018
|
/** Grid */
|
|
1017
1019
|
GRID = "GRID"
|
|
1018
1020
|
}
|
|
1019
1021
|
/** @enumType */
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1023
|
+
declare enum PollLayoutDirection {
|
|
1022
1024
|
/** Left-to-right */
|
|
1023
1025
|
LTR = "LTR",
|
|
1024
1026
|
/** Right-to-left */
|
|
1025
1027
|
RTL = "RTL"
|
|
1026
1028
|
}
|
|
1027
1029
|
/** @enumType */
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1031
|
+
interface PollLayout {
|
|
1030
1032
|
/** The layout for displaying the voting options. */
|
|
1031
1033
|
type?: PollLayoutTypeWithLiterals;
|
|
1032
1034
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1034,11 +1036,11 @@ export interface PollLayout {
|
|
|
1034
1036
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1035
1037
|
enableImage?: boolean | null;
|
|
1036
1038
|
}
|
|
1037
|
-
|
|
1039
|
+
interface OptionLayout {
|
|
1038
1040
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1039
1041
|
enableImage?: boolean | null;
|
|
1040
1042
|
}
|
|
1041
|
-
|
|
1043
|
+
declare enum BackgroundType {
|
|
1042
1044
|
/** Color background type */
|
|
1043
1045
|
COLOR = "COLOR",
|
|
1044
1046
|
/** Image background type */
|
|
@@ -1047,8 +1049,8 @@ export declare enum BackgroundType {
|
|
|
1047
1049
|
GRADIENT = "GRADIENT"
|
|
1048
1050
|
}
|
|
1049
1051
|
/** @enumType */
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1053
|
+
interface Gradient {
|
|
1052
1054
|
/** The gradient angle in degrees. */
|
|
1053
1055
|
angle?: number | null;
|
|
1054
1056
|
/**
|
|
@@ -1062,7 +1064,7 @@ export interface Gradient {
|
|
|
1062
1064
|
*/
|
|
1063
1065
|
lastColor?: string | null;
|
|
1064
1066
|
}
|
|
1065
|
-
|
|
1067
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1066
1068
|
/**
|
|
1067
1069
|
* The background color as a hexademical value.
|
|
1068
1070
|
* @format COLOR_HEX
|
|
@@ -1076,7 +1078,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1076
1078
|
type?: BackgroundTypeWithLiterals;
|
|
1077
1079
|
}
|
|
1078
1080
|
/** @oneof */
|
|
1079
|
-
|
|
1081
|
+
interface BackgroundBackgroundOneOf {
|
|
1080
1082
|
/**
|
|
1081
1083
|
* The background color as a hexademical value.
|
|
1082
1084
|
* @format COLOR_HEX
|
|
@@ -1087,17 +1089,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1087
1089
|
/** Details for a gradient background. */
|
|
1088
1090
|
gradient?: Gradient;
|
|
1089
1091
|
}
|
|
1090
|
-
|
|
1092
|
+
interface PollDesign {
|
|
1091
1093
|
/** Background styling. */
|
|
1092
1094
|
background?: Background;
|
|
1093
1095
|
/** Border radius in pixels. */
|
|
1094
1096
|
borderRadius?: number | null;
|
|
1095
1097
|
}
|
|
1096
|
-
|
|
1098
|
+
interface OptionDesign {
|
|
1097
1099
|
/** Border radius in pixels. */
|
|
1098
1100
|
borderRadius?: number | null;
|
|
1099
1101
|
}
|
|
1100
|
-
|
|
1102
|
+
interface Poll {
|
|
1101
1103
|
/** Poll ID. */
|
|
1102
1104
|
id?: string | null;
|
|
1103
1105
|
/** Poll title. */
|
|
@@ -1111,26 +1113,26 @@ export interface Poll {
|
|
|
1111
1113
|
/** The poll's permissions and display settings. */
|
|
1112
1114
|
settings?: Settings;
|
|
1113
1115
|
}
|
|
1114
|
-
|
|
1116
|
+
interface PollDataLayout {
|
|
1115
1117
|
/** Poll layout settings. */
|
|
1116
1118
|
poll?: PollLayout;
|
|
1117
1119
|
/** Voting otpions layout settings. */
|
|
1118
1120
|
options?: OptionLayout;
|
|
1119
1121
|
}
|
|
1120
|
-
|
|
1122
|
+
interface Design {
|
|
1121
1123
|
/** Styling for the poll. */
|
|
1122
1124
|
poll?: PollDesign;
|
|
1123
1125
|
/** Styling for voting options. */
|
|
1124
1126
|
options?: OptionDesign;
|
|
1125
1127
|
}
|
|
1126
|
-
|
|
1128
|
+
interface TextData {
|
|
1127
1129
|
/** The text to apply decorations to. */
|
|
1128
1130
|
text?: string;
|
|
1129
1131
|
/** The decorations to apply. */
|
|
1130
1132
|
decorations?: Decoration[];
|
|
1131
1133
|
}
|
|
1132
1134
|
/** Adds appearence changes to text */
|
|
1133
|
-
|
|
1135
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1134
1136
|
/** Data for an anchor link decoration. */
|
|
1135
1137
|
anchorData?: AnchorData;
|
|
1136
1138
|
/** Data for a color decoration. */
|
|
@@ -1155,7 +1157,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1155
1157
|
type?: DecorationTypeWithLiterals;
|
|
1156
1158
|
}
|
|
1157
1159
|
/** @oneof */
|
|
1158
|
-
|
|
1160
|
+
interface DecorationDataOneOf {
|
|
1159
1161
|
/** Data for an anchor link decoration. */
|
|
1160
1162
|
anchorData?: AnchorData;
|
|
1161
1163
|
/** Data for a color decoration. */
|
|
@@ -1177,7 +1179,7 @@ export interface DecorationDataOneOf {
|
|
|
1177
1179
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1178
1180
|
strikethroughData?: boolean | null;
|
|
1179
1181
|
}
|
|
1180
|
-
|
|
1182
|
+
declare enum DecorationType {
|
|
1181
1183
|
BOLD = "BOLD",
|
|
1182
1184
|
ITALIC = "ITALIC",
|
|
1183
1185
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1191,22 +1193,22 @@ export declare enum DecorationType {
|
|
|
1191
1193
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1192
1194
|
}
|
|
1193
1195
|
/** @enumType */
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1197
|
+
interface AnchorData {
|
|
1196
1198
|
/** The target node's ID. */
|
|
1197
1199
|
anchor?: string;
|
|
1198
1200
|
}
|
|
1199
|
-
|
|
1201
|
+
interface ColorData {
|
|
1200
1202
|
/** The text's background color as a hexadecimal value. */
|
|
1201
1203
|
background?: string | null;
|
|
1202
1204
|
/** The text's foreground color as a hexadecimal value. */
|
|
1203
1205
|
foreground?: string | null;
|
|
1204
1206
|
}
|
|
1205
|
-
|
|
1207
|
+
interface LinkData {
|
|
1206
1208
|
/** Link details. */
|
|
1207
1209
|
link?: Link;
|
|
1208
1210
|
}
|
|
1209
|
-
|
|
1211
|
+
interface MentionData {
|
|
1210
1212
|
/** The mentioned user's name. */
|
|
1211
1213
|
name?: string;
|
|
1212
1214
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1214,23 +1216,23 @@ export interface MentionData {
|
|
|
1214
1216
|
/** Mentioned user's ID. */
|
|
1215
1217
|
id?: string | null;
|
|
1216
1218
|
}
|
|
1217
|
-
|
|
1219
|
+
interface FontSizeData {
|
|
1218
1220
|
/** The units used for the font size. */
|
|
1219
1221
|
unit?: FontTypeWithLiterals;
|
|
1220
1222
|
/** Font size value. */
|
|
1221
1223
|
value?: number | null;
|
|
1222
1224
|
}
|
|
1223
|
-
|
|
1225
|
+
declare enum FontType {
|
|
1224
1226
|
PX = "PX",
|
|
1225
1227
|
EM = "EM"
|
|
1226
1228
|
}
|
|
1227
1229
|
/** @enumType */
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1231
|
+
interface SpoilerData {
|
|
1230
1232
|
/** Spoiler ID. */
|
|
1231
1233
|
id?: string | null;
|
|
1232
1234
|
}
|
|
1233
|
-
|
|
1235
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1234
1236
|
/** Data for embedded Wix Bookings content. */
|
|
1235
1237
|
bookingData?: BookingData;
|
|
1236
1238
|
/** Data for embedded Wix Events content. */
|
|
@@ -1252,30 +1254,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1252
1254
|
image?: Media;
|
|
1253
1255
|
}
|
|
1254
1256
|
/** @oneof */
|
|
1255
|
-
|
|
1257
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1256
1258
|
/** Data for embedded Wix Bookings content. */
|
|
1257
1259
|
bookingData?: BookingData;
|
|
1258
1260
|
/** Data for embedded Wix Events content. */
|
|
1259
1261
|
eventData?: EventData;
|
|
1260
1262
|
}
|
|
1261
|
-
|
|
1263
|
+
declare enum AppType {
|
|
1262
1264
|
PRODUCT = "PRODUCT",
|
|
1263
1265
|
EVENT = "EVENT",
|
|
1264
1266
|
BOOKING = "BOOKING"
|
|
1265
1267
|
}
|
|
1266
1268
|
/** @enumType */
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1270
|
+
interface BookingData {
|
|
1269
1271
|
/** Booking duration in minutes. */
|
|
1270
1272
|
durations?: string | null;
|
|
1271
1273
|
}
|
|
1272
|
-
|
|
1274
|
+
interface EventData {
|
|
1273
1275
|
/** Event schedule. */
|
|
1274
1276
|
scheduling?: string | null;
|
|
1275
1277
|
/** Event location. */
|
|
1276
1278
|
location?: string | null;
|
|
1277
1279
|
}
|
|
1278
|
-
|
|
1280
|
+
interface VideoData {
|
|
1279
1281
|
/** Styling for the video's container. */
|
|
1280
1282
|
containerData?: PluginContainerData;
|
|
1281
1283
|
/** Video details. */
|
|
@@ -1289,7 +1291,7 @@ export interface VideoData {
|
|
|
1289
1291
|
/** Video options. */
|
|
1290
1292
|
options?: PlaybackOptions;
|
|
1291
1293
|
}
|
|
1292
|
-
|
|
1294
|
+
interface PlaybackOptions {
|
|
1293
1295
|
/** Sets whether the media will automatically start playing. */
|
|
1294
1296
|
autoPlay?: boolean | null;
|
|
1295
1297
|
/** Sets whether media's will be looped. */
|
|
@@ -1297,7 +1299,7 @@ export interface PlaybackOptions {
|
|
|
1297
1299
|
/** Sets whether media's controls will be shown. */
|
|
1298
1300
|
showControls?: boolean | null;
|
|
1299
1301
|
}
|
|
1300
|
-
|
|
1302
|
+
interface EmbedData {
|
|
1301
1303
|
/** Styling for the oEmbed node's container. */
|
|
1302
1304
|
containerData?: PluginContainerData;
|
|
1303
1305
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1305,7 +1307,7 @@ export interface EmbedData {
|
|
|
1305
1307
|
/** Origin asset source. */
|
|
1306
1308
|
src?: string | null;
|
|
1307
1309
|
}
|
|
1308
|
-
|
|
1310
|
+
interface Oembed {
|
|
1309
1311
|
/** The resource type. */
|
|
1310
1312
|
type?: string | null;
|
|
1311
1313
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1337,7 +1339,7 @@ export interface Oembed {
|
|
|
1337
1339
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1338
1340
|
version?: string | null;
|
|
1339
1341
|
}
|
|
1340
|
-
|
|
1342
|
+
interface CollapsibleListData {
|
|
1341
1343
|
/** Styling for the collapsible list's container. */
|
|
1342
1344
|
containerData?: PluginContainerData;
|
|
1343
1345
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1349,7 +1351,7 @@ export interface CollapsibleListData {
|
|
|
1349
1351
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1350
1352
|
isQapageData?: boolean | null;
|
|
1351
1353
|
}
|
|
1352
|
-
|
|
1354
|
+
declare enum InitialExpandedItems {
|
|
1353
1355
|
/** First item will be expended initally */
|
|
1354
1356
|
FIRST = "FIRST",
|
|
1355
1357
|
/** All items will expended initally */
|
|
@@ -1358,16 +1360,16 @@ export declare enum InitialExpandedItems {
|
|
|
1358
1360
|
NONE = "NONE"
|
|
1359
1361
|
}
|
|
1360
1362
|
/** @enumType */
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1364
|
+
declare enum Direction {
|
|
1363
1365
|
/** Left-to-right */
|
|
1364
1366
|
LTR = "LTR",
|
|
1365
1367
|
/** Right-to-left */
|
|
1366
1368
|
RTL = "RTL"
|
|
1367
1369
|
}
|
|
1368
1370
|
/** @enumType */
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1372
|
+
interface TableData {
|
|
1371
1373
|
/** Styling for the table's container. */
|
|
1372
1374
|
containerData?: PluginContainerData;
|
|
1373
1375
|
/** The table's dimensions. */
|
|
@@ -1382,7 +1384,7 @@ export interface TableData {
|
|
|
1382
1384
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1383
1385
|
columnHeader?: boolean | null;
|
|
1384
1386
|
}
|
|
1385
|
-
|
|
1387
|
+
interface Dimensions {
|
|
1386
1388
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1387
1389
|
colsWidthRatio?: number[];
|
|
1388
1390
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1390,13 +1392,13 @@ export interface Dimensions {
|
|
|
1390
1392
|
/** An array representing the minimum width of each column in pixels. */
|
|
1391
1393
|
colsMinWidth?: number[];
|
|
1392
1394
|
}
|
|
1393
|
-
|
|
1395
|
+
interface TableCellData {
|
|
1394
1396
|
/** Styling for the cell's background color and text alignment. */
|
|
1395
1397
|
cellStyle?: CellStyle;
|
|
1396
1398
|
/** The cell's border colors. */
|
|
1397
1399
|
borderColors?: BorderColors;
|
|
1398
1400
|
}
|
|
1399
|
-
|
|
1401
|
+
declare enum VerticalAlignment {
|
|
1400
1402
|
/** Top alignment */
|
|
1401
1403
|
TOP = "TOP",
|
|
1402
1404
|
/** Middle alignment */
|
|
@@ -1405,8 +1407,8 @@ export declare enum VerticalAlignment {
|
|
|
1405
1407
|
BOTTOM = "BOTTOM"
|
|
1406
1408
|
}
|
|
1407
1409
|
/** @enumType */
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1411
|
+
interface CellStyle {
|
|
1410
1412
|
/** Vertical alignment for the cell's text. */
|
|
1411
1413
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1412
1414
|
/**
|
|
@@ -1415,7 +1417,7 @@ export interface CellStyle {
|
|
|
1415
1417
|
*/
|
|
1416
1418
|
backgroundColor?: string | null;
|
|
1417
1419
|
}
|
|
1418
|
-
|
|
1420
|
+
interface BorderColors {
|
|
1419
1421
|
/**
|
|
1420
1422
|
* Left border color as a hexadecimal value.
|
|
1421
1423
|
* @format COLOR_HEX
|
|
@@ -1437,28 +1439,7 @@ export interface BorderColors {
|
|
|
1437
1439
|
*/
|
|
1438
1440
|
bottom?: string | null;
|
|
1439
1441
|
}
|
|
1440
|
-
|
|
1441
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1442
|
-
* `Value` type union.
|
|
1443
|
-
*
|
|
1444
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
1445
|
-
*/
|
|
1446
|
-
export declare enum NullValue {
|
|
1447
|
-
/** Null value. */
|
|
1448
|
-
NULL_VALUE = "NULL_VALUE"
|
|
1449
|
-
}
|
|
1450
|
-
/** @enumType */
|
|
1451
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1452
|
-
/**
|
|
1453
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
1454
|
-
*
|
|
1455
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
1456
|
-
*/
|
|
1457
|
-
export interface ListValue {
|
|
1458
|
-
/** Repeated field of dynamically typed values. */
|
|
1459
|
-
values?: any[];
|
|
1460
|
-
}
|
|
1461
|
-
export interface AudioData {
|
|
1442
|
+
interface AudioData {
|
|
1462
1443
|
/** Styling for the audio node's container. */
|
|
1463
1444
|
containerData?: PluginContainerData;
|
|
1464
1445
|
/** Audio file details. */
|
|
@@ -1474,7 +1455,7 @@ export interface AudioData {
|
|
|
1474
1455
|
/** An HTML version of the audio node. */
|
|
1475
1456
|
html?: string | null;
|
|
1476
1457
|
}
|
|
1477
|
-
|
|
1458
|
+
interface OrderedListData {
|
|
1478
1459
|
/** Indentation level from 0-4. */
|
|
1479
1460
|
indentation?: number;
|
|
1480
1461
|
/** Offset level from 0-4. */
|
|
@@ -1482,24 +1463,24 @@ export interface OrderedListData {
|
|
|
1482
1463
|
/** List start number. */
|
|
1483
1464
|
start?: number | null;
|
|
1484
1465
|
}
|
|
1485
|
-
|
|
1466
|
+
interface BulletedListData {
|
|
1486
1467
|
/** Indentation level from 0-4. */
|
|
1487
1468
|
indentation?: number;
|
|
1488
1469
|
/** Offset level from 0-4. */
|
|
1489
1470
|
offset?: number | null;
|
|
1490
1471
|
}
|
|
1491
|
-
|
|
1472
|
+
interface BlockquoteData {
|
|
1492
1473
|
/** Indentation level from 1-4. */
|
|
1493
1474
|
indentation?: number;
|
|
1494
1475
|
}
|
|
1495
|
-
|
|
1476
|
+
interface CaptionData {
|
|
1496
1477
|
textStyle?: TextStyle;
|
|
1497
1478
|
}
|
|
1498
|
-
|
|
1479
|
+
interface LayoutCellData {
|
|
1499
1480
|
/** Size of the cell in 12 columns grid. */
|
|
1500
1481
|
colSpan?: number | null;
|
|
1501
1482
|
}
|
|
1502
|
-
|
|
1483
|
+
interface Metadata {
|
|
1503
1484
|
/** Schema version. */
|
|
1504
1485
|
version?: number;
|
|
1505
1486
|
/**
|
|
@@ -1516,7 +1497,7 @@ export interface Metadata {
|
|
|
1516
1497
|
/** Object ID. */
|
|
1517
1498
|
id?: string | null;
|
|
1518
1499
|
}
|
|
1519
|
-
|
|
1500
|
+
interface DocumentStyle {
|
|
1520
1501
|
/** Styling for H1 nodes. */
|
|
1521
1502
|
headerOne?: TextNodeStyle;
|
|
1522
1503
|
/** Styling for H2 nodes. */
|
|
@@ -1536,7 +1517,7 @@ export interface DocumentStyle {
|
|
|
1536
1517
|
/** Styling for code block nodes. */
|
|
1537
1518
|
codeBlock?: TextNodeStyle;
|
|
1538
1519
|
}
|
|
1539
|
-
|
|
1520
|
+
interface TextNodeStyle {
|
|
1540
1521
|
/** The decorations to apply to the node. */
|
|
1541
1522
|
decorations?: Decoration[];
|
|
1542
1523
|
/** Padding and background color for the node. */
|
|
@@ -1544,7 +1525,7 @@ export interface TextNodeStyle {
|
|
|
1544
1525
|
/** Line height for text in the node. */
|
|
1545
1526
|
lineHeight?: string | null;
|
|
1546
1527
|
}
|
|
1547
|
-
|
|
1528
|
+
interface MachineTranslateRequest {
|
|
1548
1529
|
/** Language of the source text to translate. */
|
|
1549
1530
|
sourceLanguage: SupportedLanguageWithLiterals;
|
|
1550
1531
|
/** Language to translate text into. */
|
|
@@ -1552,7 +1533,7 @@ export interface MachineTranslateRequest {
|
|
|
1552
1533
|
/** The content to translate. */
|
|
1553
1534
|
contentToTranslate: TranslatableContent;
|
|
1554
1535
|
}
|
|
1555
|
-
|
|
1536
|
+
declare enum SupportedLanguage {
|
|
1556
1537
|
/** Undefined Language */
|
|
1557
1538
|
UNDEFINED_SUPPORTED_LANGUAGE = "UNDEFINED_SUPPORTED_LANGUAGE",
|
|
1558
1539
|
/** Afrikaans */
|
|
@@ -1827,31 +1808,12 @@ export declare enum SupportedLanguage {
|
|
|
1827
1808
|
ZU = "ZU"
|
|
1828
1809
|
}
|
|
1829
1810
|
/** @enumType */
|
|
1830
|
-
|
|
1831
|
-
|
|
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 {
|
|
1832
1813
|
/** The translated content. */
|
|
1833
1814
|
translatedContent?: TranslatableContent;
|
|
1834
1815
|
}
|
|
1835
|
-
|
|
1836
|
-
/** The number of credits required to translate the content in the request. */
|
|
1837
|
-
creditsRequired?: number;
|
|
1838
|
-
}
|
|
1839
|
-
export interface TextTooLongError {
|
|
1840
|
-
/** The maximum length of text that can be translated. */
|
|
1841
|
-
maxLength?: number;
|
|
1842
|
-
/** The actual length of the text that was sent for translation. */
|
|
1843
|
-
actualLength?: number;
|
|
1844
|
-
}
|
|
1845
|
-
export interface UnknownFormatError {
|
|
1846
|
-
}
|
|
1847
|
-
export interface SameLanguageArgumentsError {
|
|
1848
|
-
/**
|
|
1849
|
-
* The language supplied as both the source and the target languages
|
|
1850
|
-
* @maxLength 16
|
|
1851
|
-
*/
|
|
1852
|
-
language?: string;
|
|
1853
|
-
}
|
|
1854
|
-
export interface BulkMachineTranslateRequest {
|
|
1816
|
+
interface BulkMachineTranslateRequest {
|
|
1855
1817
|
/** Language of the source text to translate. */
|
|
1856
1818
|
sourceLanguage: SupportedLanguageWithLiterals;
|
|
1857
1819
|
/** Language to translate text into. */
|
|
@@ -1863,7 +1825,7 @@ export interface BulkMachineTranslateRequest {
|
|
|
1863
1825
|
*/
|
|
1864
1826
|
contentToTranslate?: TranslatableContent[];
|
|
1865
1827
|
}
|
|
1866
|
-
|
|
1828
|
+
interface BulkMachineTranslateResponse {
|
|
1867
1829
|
/**
|
|
1868
1830
|
* List of results for each item in the bulk request.
|
|
1869
1831
|
* @minSize 1
|
|
@@ -1873,13 +1835,13 @@ export interface BulkMachineTranslateResponse {
|
|
|
1873
1835
|
/** Metadata for the overall bulk action, including success and failure counts. */
|
|
1874
1836
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1875
1837
|
}
|
|
1876
|
-
|
|
1838
|
+
interface BulkTranslateResult {
|
|
1877
1839
|
/** Metadata for the individual item in the request. */
|
|
1878
1840
|
itemMetadata?: ItemMetadata;
|
|
1879
1841
|
/** The translated content. */
|
|
1880
1842
|
item?: TranslatableContent;
|
|
1881
1843
|
}
|
|
1882
|
-
|
|
1844
|
+
interface ItemMetadata {
|
|
1883
1845
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1884
1846
|
id?: string | null;
|
|
1885
1847
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -1889,7 +1851,7 @@ export interface ItemMetadata {
|
|
|
1889
1851
|
/** Details about the error in case of failure. */
|
|
1890
1852
|
error?: ApplicationError;
|
|
1891
1853
|
}
|
|
1892
|
-
|
|
1854
|
+
interface ApplicationError {
|
|
1893
1855
|
/** Error code. */
|
|
1894
1856
|
code?: string;
|
|
1895
1857
|
/** Description of the error. */
|
|
@@ -1897,7 +1859,7 @@ export interface ApplicationError {
|
|
|
1897
1859
|
/** Data related to the error. */
|
|
1898
1860
|
data?: Record<string, any> | null;
|
|
1899
1861
|
}
|
|
1900
|
-
|
|
1862
|
+
interface BulkActionMetadata {
|
|
1901
1863
|
/** Number of items that were successfully processed. */
|
|
1902
1864
|
totalSuccesses?: number;
|
|
1903
1865
|
/** Number of items that couldn't be processed. */
|
|
@@ -1905,3 +1867,18 @@ export interface BulkActionMetadata {
|
|
|
1905
1867
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1906
1868
|
undetailedFailures?: number;
|
|
1907
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 };
|