@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.
Files changed (130) hide show
  1. package/build/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.mts} +11 -8
  2. package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.ts} +11 -8
  3. package/build/index.js +907 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +850 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → index.d.mts} +11 -8
  8. package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.public.d.ts → internal/index.d.ts} +11 -8
  9. package/build/internal/index.js +907 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +850 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → internal/meta.d.mts} +181 -204
  14. package/build/{es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → internal/meta.d.ts} +181 -204
  15. package/build/internal/meta.js +412 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +384 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. package/build/internal/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.mts +1923 -0
  20. package/build/internal/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.ts +1923 -0
  21. package/build/{internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.mts} +181 -204
  22. package/build/{internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.d.ts → meta.d.ts} +181 -204
  23. package/build/meta.js +412 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +384 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/build/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.mts +1923 -0
  28. package/build/multilingual-machine-v3-translatable-content-machine-translation.universal-BCyWU9nd.d.ts +1923 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
  40. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -41
  41. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
  42. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
  43. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -388
  44. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
  45. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
  46. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -66
  47. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
  48. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -51
  49. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
  50. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -598
  51. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
  52. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts +0 -1998
  53. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -754
  54. package/build/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
  66. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -6
  67. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
  68. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
  69. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -383
  70. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
  71. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
  72. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -38
  73. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
  74. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -14
  75. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
  76. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -595
  77. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
  78. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts +0 -1998
  79. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -726
  80. package/build/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
  91. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -41
  92. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
  93. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
  94. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -388
  95. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
  96. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
  97. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -66
  98. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
  99. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -51
  100. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
  101. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -598
  102. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
  103. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts +0 -1998
  104. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -754
  105. package/build/internal/cjs/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.d.ts +0 -6
  116. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js +0 -6
  117. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.context.js.map +0 -1
  118. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.d.ts +0 -49
  119. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js +0 -383
  120. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.http.js.map +0 -1
  121. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.d.ts +0 -14
  122. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js +0 -38
  123. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.meta.js.map +0 -1
  124. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js +0 -14
  125. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.public.js.map +0 -1
  126. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js +0 -595
  127. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.types.js.map +0 -1
  128. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.d.ts +0 -1998
  129. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js +0 -726
  130. package/build/internal/es/src/multilingual-machine-v3-translatable-content-machine-translation.universal.js.map +0 -1
@@ -1,1998 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /**
3
- * A translatable content is a unit of content to translate.
4
- *
5
- * Use [Machine Translate](/machine-translation/machine-translate) to translate a single unit of translatable content, or [Bulk Machine Translate](/machine-translation/bulk-machine-translate)
6
- * to translate many.
7
- */
8
- export interface TranslatableContent extends TranslatableContentContentOneOf {
9
- /**
10
- * Plain text.
11
- * @minLength 1
12
- * @maxLength 10000
13
- */
14
- plainTextContent?: string;
15
- /**
16
- * HTML-encoded.
17
- * @minLength 1
18
- * @maxLength 10000
19
- */
20
- htmlContent?: string;
21
- /** Rich content. */
22
- richContent?: RichContent;
23
- /**
24
- * Translatable content ID. The ID should be unique to this content and doesn't need to match the ID used by any other service.
25
- * @maxLength 512
26
- */
27
- _id?: string | null;
28
- /** Format of the translatable content. */
29
- format?: FormatWithLiterals;
30
- }
31
- /** @oneof */
32
- export interface TranslatableContentContentOneOf {
33
- /**
34
- * Plain text.
35
- * @minLength 1
36
- * @maxLength 10000
37
- */
38
- plainTextContent?: string;
39
- /**
40
- * HTML-encoded.
41
- * @minLength 1
42
- * @maxLength 10000
43
- */
44
- htmlContent?: string;
45
- /** Rich content. */
46
- richContent?: RichContent;
47
- }
48
- export declare enum Format {
49
- /** Unspecified format. */
50
- UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
51
- /** Plain text content. */
52
- PLAIN_TEXT = "PLAIN_TEXT",
53
- /** HTML content. */
54
- HTML = "HTML",
55
- /** Rich Content. */
56
- RICH = "RICH"
57
- }
58
- /** @enumType */
59
- export type FormatWithLiterals = Format | 'UNKNOWN_FORMAT' | 'PLAIN_TEXT' | 'HTML' | 'RICH';
60
- export interface RichContent {
61
- /** Node objects representing a rich content document. */
62
- nodes?: Node[];
63
- /** Object metadata. */
64
- metadata?: Metadata;
65
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
66
- documentStyle?: DocumentStyle;
67
- }
68
- export interface Node extends NodeDataOneOf {
69
- /** Data for a button node. */
70
- buttonData?: ButtonData;
71
- /** Data for a code block node. */
72
- codeBlockData?: CodeBlockData;
73
- /** Data for a divider node. */
74
- dividerData?: DividerData;
75
- /** Data for a file node. */
76
- fileData?: FileData;
77
- /** Data for a gallery node. */
78
- galleryData?: GalleryData;
79
- /** Data for a GIF node. */
80
- gifData?: GIFData;
81
- /** Data for a heading node. */
82
- headingData?: HeadingData;
83
- /** Data for an embedded HTML node. */
84
- htmlData?: HTMLData;
85
- /** Data for an image node. */
86
- imageData?: ImageData;
87
- /** Data for a link preview node. */
88
- linkPreviewData?: LinkPreviewData;
89
- /** @deprecated */
90
- mapData?: MapData;
91
- /** Data for a paragraph node. */
92
- paragraphData?: ParagraphData;
93
- /** Data for a poll node. */
94
- pollData?: PollData;
95
- /** Data for a text node. Used to apply decorations to text. */
96
- textData?: TextData;
97
- /** Data for an app embed node. */
98
- appEmbedData?: AppEmbedData;
99
- /** Data for a video node. */
100
- videoData?: VideoData;
101
- /** Data for an oEmbed node. */
102
- embedData?: EmbedData;
103
- /** Data for a collapsible list node. */
104
- collapsibleListData?: CollapsibleListData;
105
- /** Data for a table node. */
106
- tableData?: TableData;
107
- /** Data for a table cell node. */
108
- tableCellData?: TableCellData;
109
- /** Data for a custom external node. */
110
- externalData?: Record<string, any> | null;
111
- /** Data for an audio node. */
112
- audioData?: AudioData;
113
- /** Data for an ordered list node. */
114
- orderedListData?: OrderedListData;
115
- /** Data for a bulleted list node. */
116
- bulletedListData?: BulletedListData;
117
- /** Data for a block quote node. */
118
- blockquoteData?: BlockquoteData;
119
- /** Data for a caption node. */
120
- captionData?: CaptionData;
121
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
122
- layoutCellData?: LayoutCellData;
123
- /** 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. */
124
- type?: NodeTypeWithLiterals;
125
- /** Node ID. */
126
- id?: string;
127
- /** A list of child nodes. */
128
- nodes?: Node[];
129
- /** Padding and background color styling for the node. */
130
- style?: NodeStyle;
131
- }
132
- /** @oneof */
133
- export interface NodeDataOneOf {
134
- /** Data for a button node. */
135
- buttonData?: ButtonData;
136
- /** Data for a code block node. */
137
- codeBlockData?: CodeBlockData;
138
- /** Data for a divider node. */
139
- dividerData?: DividerData;
140
- /** Data for a file node. */
141
- fileData?: FileData;
142
- /** Data for a gallery node. */
143
- galleryData?: GalleryData;
144
- /** Data for a GIF node. */
145
- gifData?: GIFData;
146
- /** Data for a heading node. */
147
- headingData?: HeadingData;
148
- /** Data for an embedded HTML node. */
149
- htmlData?: HTMLData;
150
- /** Data for an image node. */
151
- imageData?: ImageData;
152
- /** Data for a link preview node. */
153
- linkPreviewData?: LinkPreviewData;
154
- /** @deprecated */
155
- mapData?: MapData;
156
- /** Data for a paragraph node. */
157
- paragraphData?: ParagraphData;
158
- /** Data for a poll node. */
159
- pollData?: PollData;
160
- /** Data for a text node. Used to apply decorations to text. */
161
- textData?: TextData;
162
- /** Data for an app embed node. */
163
- appEmbedData?: AppEmbedData;
164
- /** Data for a video node. */
165
- videoData?: VideoData;
166
- /** Data for an oEmbed node. */
167
- embedData?: EmbedData;
168
- /** Data for a collapsible list node. */
169
- collapsibleListData?: CollapsibleListData;
170
- /** Data for a table node. */
171
- tableData?: TableData;
172
- /** Data for a table cell node. */
173
- tableCellData?: TableCellData;
174
- /** Data for a custom external node. */
175
- externalData?: Record<string, any> | null;
176
- /** Data for an audio node. */
177
- audioData?: AudioData;
178
- /** Data for an ordered list node. */
179
- orderedListData?: OrderedListData;
180
- /** Data for a bulleted list node. */
181
- bulletedListData?: BulletedListData;
182
- /** Data for a block quote node. */
183
- blockquoteData?: BlockquoteData;
184
- /** Data for a caption node. */
185
- captionData?: CaptionData;
186
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
187
- layoutCellData?: LayoutCellData;
188
- }
189
- export declare enum NodeType {
190
- PARAGRAPH = "PARAGRAPH",
191
- TEXT = "TEXT",
192
- HEADING = "HEADING",
193
- BULLETED_LIST = "BULLETED_LIST",
194
- ORDERED_LIST = "ORDERED_LIST",
195
- LIST_ITEM = "LIST_ITEM",
196
- BLOCKQUOTE = "BLOCKQUOTE",
197
- CODE_BLOCK = "CODE_BLOCK",
198
- VIDEO = "VIDEO",
199
- DIVIDER = "DIVIDER",
200
- FILE = "FILE",
201
- GALLERY = "GALLERY",
202
- GIF = "GIF",
203
- HTML = "HTML",
204
- IMAGE = "IMAGE",
205
- LINK_PREVIEW = "LINK_PREVIEW",
206
- /** @deprecated */
207
- MAP = "MAP",
208
- POLL = "POLL",
209
- APP_EMBED = "APP_EMBED",
210
- BUTTON = "BUTTON",
211
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
212
- TABLE = "TABLE",
213
- EMBED = "EMBED",
214
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
215
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
216
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
217
- TABLE_CELL = "TABLE_CELL",
218
- TABLE_ROW = "TABLE_ROW",
219
- EXTERNAL = "EXTERNAL",
220
- AUDIO = "AUDIO",
221
- CAPTION = "CAPTION",
222
- LAYOUT = "LAYOUT",
223
- LAYOUT_CELL = "LAYOUT_CELL"
224
- }
225
- /** @enumType */
226
- export 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';
227
- export interface NodeStyle {
228
- /** The top padding value in pixels. */
229
- paddingTop?: string | null;
230
- /** The bottom padding value in pixels. */
231
- paddingBottom?: string | null;
232
- /** The background color as a hexadecimal value. */
233
- backgroundColor?: string | null;
234
- }
235
- export interface ButtonData {
236
- /** Styling for the button's container. */
237
- containerData?: PluginContainerData;
238
- /** The button type. */
239
- type?: TypeWithLiterals;
240
- /** Styling for the button. */
241
- styles?: Styles;
242
- /** The text to display on the button. */
243
- text?: string | null;
244
- /** Button link details. */
245
- link?: Link;
246
- }
247
- export interface Border {
248
- /**
249
- * Deprecated: Use `borderWidth` in `styles` instead.
250
- * @deprecated
251
- */
252
- width?: number | null;
253
- /**
254
- * Deprecated: Use `borderRadius` in `styles` instead.
255
- * @deprecated
256
- */
257
- radius?: number | null;
258
- }
259
- export interface Colors {
260
- /**
261
- * Deprecated: Use `textColor` in `styles` instead.
262
- * @deprecated
263
- */
264
- text?: string | null;
265
- /**
266
- * Deprecated: Use `borderColor` in `styles` instead.
267
- * @deprecated
268
- */
269
- border?: string | null;
270
- /**
271
- * Deprecated: Use `backgroundColor` in `styles` instead.
272
- * @deprecated
273
- */
274
- background?: string | null;
275
- }
276
- export interface PluginContainerData {
277
- /** The width of the node when it's displayed. */
278
- width?: PluginContainerDataWidth;
279
- /** The node's alignment within its container. */
280
- alignment?: PluginContainerDataAlignmentWithLiterals;
281
- /** Spoiler cover settings for the node. */
282
- spoiler?: Spoiler;
283
- /** The height of the node when it's displayed. */
284
- height?: Height;
285
- /** 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`. */
286
- textWrap?: boolean | null;
287
- }
288
- export declare enum WidthType {
289
- /** Width matches the content width */
290
- CONTENT = "CONTENT",
291
- /** Small Width */
292
- SMALL = "SMALL",
293
- /** Width will match the original asset width */
294
- ORIGINAL = "ORIGINAL",
295
- /** coast-to-coast display */
296
- FULL_WIDTH = "FULL_WIDTH"
297
- }
298
- /** @enumType */
299
- export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
300
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
301
- /**
302
- * One of the following predefined width options:
303
- * `CONTENT`: The width of the container matches the content width.
304
- * `SMALL`: A small width.
305
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
306
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
307
- */
308
- size?: WidthTypeWithLiterals;
309
- /** A custom width value in pixels. */
310
- custom?: string | null;
311
- }
312
- /** @oneof */
313
- export interface PluginContainerDataWidthDataOneOf {
314
- /**
315
- * One of the following predefined width options:
316
- * `CONTENT`: The width of the container matches the content width.
317
- * `SMALL`: A small width.
318
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
319
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
320
- */
321
- size?: WidthTypeWithLiterals;
322
- /** A custom width value in pixels. */
323
- custom?: string | null;
324
- }
325
- export declare enum PluginContainerDataAlignment {
326
- /** Center Alignment */
327
- CENTER = "CENTER",
328
- /** Left Alignment */
329
- LEFT = "LEFT",
330
- /** Right Alignment */
331
- RIGHT = "RIGHT"
332
- }
333
- /** @enumType */
334
- export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
335
- export interface Spoiler {
336
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
337
- enabled?: boolean | null;
338
- /** The description displayed on top of the spoiler cover. */
339
- description?: string | null;
340
- /** The text for the button used to remove the spoiler cover. */
341
- buttonText?: string | null;
342
- }
343
- export interface Height {
344
- /** A custom height value in pixels. */
345
- custom?: string | null;
346
- }
347
- export declare enum Type {
348
- /** Regular link button */
349
- LINK = "LINK",
350
- /** Triggers custom action that is defined in plugin configuration by the consumer */
351
- ACTION = "ACTION"
352
- }
353
- /** @enumType */
354
- export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
355
- export interface Styles {
356
- /**
357
- * Deprecated: Use `borderWidth` and `borderRadius` instead.
358
- * @deprecated
359
- */
360
- border?: Border;
361
- /**
362
- * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
363
- * @deprecated
364
- */
365
- colors?: Colors;
366
- /** Border width in pixels. */
367
- borderWidth?: number | null;
368
- /**
369
- * Deprecated: Use `borderWidth` for normal/hover states instead.
370
- * @deprecated
371
- */
372
- borderWidthHover?: number | null;
373
- /** Border radius in pixels. */
374
- borderRadius?: number | null;
375
- /**
376
- * Border color as a hexadecimal value.
377
- * @format COLOR_HEX
378
- */
379
- borderColor?: string | null;
380
- /**
381
- * Border color as a hexadecimal value (hover state).
382
- * @format COLOR_HEX
383
- */
384
- borderColorHover?: string | null;
385
- /**
386
- * Text color as a hexadecimal value.
387
- * @format COLOR_HEX
388
- */
389
- textColor?: string | null;
390
- /**
391
- * Text color as a hexadecimal value (hover state).
392
- * @format COLOR_HEX
393
- */
394
- textColorHover?: string | null;
395
- /**
396
- * Background color as a hexadecimal value.
397
- * @format COLOR_HEX
398
- */
399
- backgroundColor?: string | null;
400
- /**
401
- * Background color as a hexadecimal value (hover state).
402
- * @format COLOR_HEX
403
- */
404
- backgroundColorHover?: string | null;
405
- /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
406
- buttonSize?: string | null;
407
- }
408
- export interface Link extends LinkDataOneOf {
409
- /** The absolute URL for the linked document. */
410
- url?: string;
411
- /** The target node's ID. Used for linking to another node in this object. */
412
- anchor?: string;
413
- /**
414
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
415
- * `SELF` - Default. Opens the linked document in the same frame as the link.
416
- * `BLANK` - Opens the linked document in a new browser tab or window.
417
- * `PARENT` - Opens the linked document in the link's parent frame.
418
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
419
- */
420
- target?: TargetWithLiterals;
421
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
422
- rel?: Rel;
423
- /** A serialized object used for a custom or external link panel. */
424
- customData?: string | null;
425
- }
426
- /** @oneof */
427
- export interface LinkDataOneOf {
428
- /** The absolute URL for the linked document. */
429
- url?: string;
430
- /** The target node's ID. Used for linking to another node in this object. */
431
- anchor?: string;
432
- }
433
- export declare enum Target {
434
- /** Opens the linked document in the same frame as it was clicked (this is default) */
435
- SELF = "SELF",
436
- /** Opens the linked document in a new window or tab */
437
- BLANK = "BLANK",
438
- /** Opens the linked document in the parent frame */
439
- PARENT = "PARENT",
440
- /** Opens the linked document in the full body of the window */
441
- TOP = "TOP"
442
- }
443
- /** @enumType */
444
- export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
445
- export interface Rel {
446
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
447
- nofollow?: boolean | null;
448
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
449
- sponsored?: boolean | null;
450
- /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
451
- ugc?: boolean | null;
452
- /** Indicates that this link protect referral information from being passed to the target website. */
453
- noreferrer?: boolean | null;
454
- }
455
- export interface CodeBlockData {
456
- /** Styling for the code block's text. */
457
- textStyle?: TextStyle;
458
- }
459
- export interface TextStyle {
460
- /** Text alignment. Defaults to `AUTO`. */
461
- textAlignment?: TextAlignmentWithLiterals;
462
- /** 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. */
463
- lineHeight?: string | null;
464
- }
465
- export declare enum TextAlignment {
466
- /** browser default, eqivalent to `initial` */
467
- AUTO = "AUTO",
468
- /** Left align */
469
- LEFT = "LEFT",
470
- /** Right align */
471
- RIGHT = "RIGHT",
472
- /** Center align */
473
- CENTER = "CENTER",
474
- /** 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 */
475
- JUSTIFY = "JUSTIFY"
476
- }
477
- /** @enumType */
478
- export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
479
- export interface DividerData {
480
- /** Styling for the divider's container. */
481
- containerData?: PluginContainerData;
482
- /** Divider line style. */
483
- lineStyle?: LineStyleWithLiterals;
484
- /** Divider width. */
485
- width?: WidthWithLiterals;
486
- /** Divider alignment. */
487
- alignment?: AlignmentWithLiterals;
488
- }
489
- export declare enum LineStyle {
490
- /** Single Line */
491
- SINGLE = "SINGLE",
492
- /** Double Line */
493
- DOUBLE = "DOUBLE",
494
- /** Dashed Line */
495
- DASHED = "DASHED",
496
- /** Dotted Line */
497
- DOTTED = "DOTTED"
498
- }
499
- /** @enumType */
500
- export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
501
- export declare enum Width {
502
- /** Large line */
503
- LARGE = "LARGE",
504
- /** Medium line */
505
- MEDIUM = "MEDIUM",
506
- /** Small line */
507
- SMALL = "SMALL"
508
- }
509
- /** @enumType */
510
- export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
511
- export declare enum Alignment {
512
- /** Center alignment */
513
- CENTER = "CENTER",
514
- /** Left alignment */
515
- LEFT = "LEFT",
516
- /** Right alignment */
517
- RIGHT = "RIGHT"
518
- }
519
- /** @enumType */
520
- export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
521
- export interface FileData {
522
- /** Styling for the file's container. */
523
- containerData?: PluginContainerData;
524
- /** The source for the file's data. */
525
- src?: FileSource;
526
- /** File name. */
527
- name?: string | null;
528
- /** File type. */
529
- type?: string | null;
530
- /**
531
- * Use `sizeInKb` instead.
532
- * @deprecated
533
- */
534
- size?: number | null;
535
- /** Settings for PDF files. */
536
- pdfSettings?: PDFSettings;
537
- /** File MIME type. */
538
- mimeType?: string | null;
539
- /** File path. */
540
- path?: string | null;
541
- /** File size in KB. */
542
- sizeInKb?: string | null;
543
- }
544
- export declare enum ViewMode {
545
- /** No PDF view */
546
- NONE = "NONE",
547
- /** Full PDF view */
548
- FULL = "FULL",
549
- /** Mini PDF view */
550
- MINI = "MINI"
551
- }
552
- /** @enumType */
553
- export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
554
- export interface FileSource extends FileSourceDataOneOf {
555
- /** The absolute URL for the file's source. */
556
- url?: string | null;
557
- /**
558
- * Custom ID. Use `id` instead.
559
- * @deprecated
560
- */
561
- custom?: string | null;
562
- /** An ID that's resolved to a URL by a resolver function. */
563
- id?: string | null;
564
- /** Indicates whether the file's source is private. Defaults to `false`. */
565
- private?: boolean | null;
566
- }
567
- /** @oneof */
568
- export interface FileSourceDataOneOf {
569
- /** The absolute URL for the file's source. */
570
- url?: string | null;
571
- /**
572
- * Custom ID. Use `id` instead.
573
- * @deprecated
574
- */
575
- custom?: string | null;
576
- /** An ID that's resolved to a URL by a resolver function. */
577
- id?: string | null;
578
- }
579
- export interface PDFSettings {
580
- /**
581
- * PDF view mode. One of the following:
582
- * `NONE` : The PDF isn't displayed.
583
- * `FULL` : A full page view of the PDF is displayed.
584
- * `MINI` : A mini view of the PDF is displayed.
585
- */
586
- viewMode?: ViewModeWithLiterals;
587
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
588
- disableDownload?: boolean | null;
589
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
590
- disablePrint?: boolean | null;
591
- }
592
- export interface GalleryData {
593
- /** Styling for the gallery's container. */
594
- containerData?: PluginContainerData;
595
- /** The items in the gallery. */
596
- items?: Item[];
597
- /** Options for defining the gallery's appearance. */
598
- options?: GalleryOptions;
599
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
600
- disableExpand?: boolean | null;
601
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
602
- disableDownload?: boolean | null;
603
- }
604
- export interface Media {
605
- /** The source for the media's data. */
606
- src?: FileSource;
607
- /** Media width in pixels. */
608
- width?: number | null;
609
- /** Media height in pixels. */
610
- height?: number | null;
611
- /** Media duration in seconds. Only relevant for audio and video files. */
612
- duration?: number | null;
613
- }
614
- export interface Image {
615
- /** Image file details. */
616
- media?: Media;
617
- /** Link details for images that are links. */
618
- link?: Link;
619
- }
620
- export interface Video {
621
- /** Video file details. */
622
- media?: Media;
623
- /** Video thumbnail file details. */
624
- thumbnail?: Media;
625
- }
626
- export interface Item extends ItemDataOneOf {
627
- /** An image item. */
628
- image?: Image;
629
- /** A video item. */
630
- video?: Video;
631
- /** Item title. */
632
- title?: string | null;
633
- /** Item's alternative text. */
634
- altText?: string | null;
635
- }
636
- /** @oneof */
637
- export interface ItemDataOneOf {
638
- /** An image item. */
639
- image?: Image;
640
- /** A video item. */
641
- video?: Video;
642
- }
643
- export interface GalleryOptions {
644
- /** Gallery layout. */
645
- layout?: Layout;
646
- /** Styling for gallery items. */
647
- item?: ItemStyle;
648
- /** Styling for gallery thumbnail images. */
649
- thumbnails?: Thumbnails;
650
- }
651
- export declare enum LayoutType {
652
- /** Collage type */
653
- COLLAGE = "COLLAGE",
654
- /** Masonry type */
655
- MASONRY = "MASONRY",
656
- /** Grid type */
657
- GRID = "GRID",
658
- /** Thumbnail type */
659
- THUMBNAIL = "THUMBNAIL",
660
- /** Slider type */
661
- SLIDER = "SLIDER",
662
- /** Slideshow type */
663
- SLIDESHOW = "SLIDESHOW",
664
- /** Panorama type */
665
- PANORAMA = "PANORAMA",
666
- /** Column type */
667
- COLUMN = "COLUMN",
668
- /** Magic type */
669
- MAGIC = "MAGIC",
670
- /** Fullsize images type */
671
- FULLSIZE = "FULLSIZE"
672
- }
673
- /** @enumType */
674
- export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
675
- export declare enum Orientation {
676
- /** Rows Orientation */
677
- ROWS = "ROWS",
678
- /** Columns Orientation */
679
- COLUMNS = "COLUMNS"
680
- }
681
- /** @enumType */
682
- export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
683
- export declare enum Crop {
684
- /** Crop to fill */
685
- FILL = "FILL",
686
- /** Crop to fit */
687
- FIT = "FIT"
688
- }
689
- /** @enumType */
690
- export type CropWithLiterals = Crop | 'FILL' | 'FIT';
691
- export declare enum ThumbnailsAlignment {
692
- /** Top alignment */
693
- TOP = "TOP",
694
- /** Right alignment */
695
- RIGHT = "RIGHT",
696
- /** Bottom alignment */
697
- BOTTOM = "BOTTOM",
698
- /** Left alignment */
699
- LEFT = "LEFT",
700
- /** No thumbnail */
701
- NONE = "NONE"
702
- }
703
- /** @enumType */
704
- export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
705
- export interface Layout {
706
- /** Gallery layout type. */
707
- type?: LayoutTypeWithLiterals;
708
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
709
- horizontalScroll?: boolean | null;
710
- /** Gallery orientation. */
711
- orientation?: OrientationWithLiterals;
712
- /** The number of columns to display on full size screens. */
713
- numberOfColumns?: number | null;
714
- /** The number of columns to display on mobile screens. */
715
- mobileNumberOfColumns?: number | null;
716
- }
717
- export interface ItemStyle {
718
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
719
- targetSize?: number | null;
720
- /** Item ratio */
721
- ratio?: number | null;
722
- /** Sets how item images are cropped. */
723
- crop?: CropWithLiterals;
724
- /** The spacing between items in pixels. */
725
- spacing?: number | null;
726
- }
727
- export interface Thumbnails {
728
- /** Thumbnail alignment. */
729
- placement?: ThumbnailsAlignmentWithLiterals;
730
- /** Spacing between thumbnails in pixels. */
731
- spacing?: number | null;
732
- }
733
- export interface GIFData {
734
- /** Styling for the GIF's container. */
735
- containerData?: PluginContainerData;
736
- /** The source of the full size GIF. */
737
- original?: GIF;
738
- /** The source of the downsized GIF. */
739
- downsized?: GIF;
740
- /** Height in pixels. */
741
- height?: number;
742
- /** Width in pixels. */
743
- width?: number;
744
- /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
745
- gifType?: GIFTypeWithLiterals;
746
- }
747
- export interface GIF {
748
- /**
749
- * GIF format URL.
750
- * @format WEB_URL
751
- */
752
- gif?: string | null;
753
- /**
754
- * MP4 format URL.
755
- * @format WEB_URL
756
- */
757
- mp4?: string | null;
758
- /**
759
- * Thumbnail URL.
760
- * @format WEB_URL
761
- */
762
- still?: string | null;
763
- }
764
- export declare enum GIFType {
765
- NORMAL = "NORMAL",
766
- STICKER = "STICKER"
767
- }
768
- /** @enumType */
769
- export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
770
- export interface HeadingData {
771
- /** Heading level from 1-6. */
772
- level?: number;
773
- /** Styling for the heading text. */
774
- textStyle?: TextStyle;
775
- /** Indentation level from 1-4. */
776
- indentation?: number | null;
777
- }
778
- export interface HTMLData extends HTMLDataDataOneOf {
779
- /** The URL for the HTML code for the node. */
780
- url?: string;
781
- /** The HTML code for the node. */
782
- html?: string;
783
- /**
784
- * Whether this is an AdSense element. Use `source` instead.
785
- * @deprecated
786
- */
787
- isAdsense?: boolean | null;
788
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
789
- containerData?: PluginContainerData;
790
- /** The type of HTML code. */
791
- source?: SourceWithLiterals;
792
- /** If container height is aligned with its content height. Defaults to `true`. */
793
- autoHeight?: boolean | null;
794
- }
795
- /** @oneof */
796
- export interface HTMLDataDataOneOf {
797
- /** The URL for the HTML code for the node. */
798
- url?: string;
799
- /** The HTML code for the node. */
800
- html?: string;
801
- /**
802
- * Whether this is an AdSense element. Use `source` instead.
803
- * @deprecated
804
- */
805
- isAdsense?: boolean | null;
806
- }
807
- export declare enum Source {
808
- HTML = "HTML",
809
- ADSENSE = "ADSENSE"
810
- }
811
- /** @enumType */
812
- export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
813
- export interface ImageData {
814
- /** Styling for the image's container. */
815
- containerData?: PluginContainerData;
816
- /** Image file details. */
817
- image?: Media;
818
- /** Link details for images that are links. */
819
- link?: Link;
820
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
821
- disableExpand?: boolean | null;
822
- /** Image's alternative text. */
823
- altText?: string | null;
824
- /**
825
- * Deprecated: use Caption node instead.
826
- * @deprecated
827
- */
828
- caption?: string | null;
829
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
830
- disableDownload?: boolean | null;
831
- /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
832
- decorative?: boolean | null;
833
- /** Styling for the image. */
834
- styles?: ImageDataStyles;
835
- }
836
- export interface StylesBorder {
837
- /** Border width in pixels. */
838
- width?: number | null;
839
- /**
840
- * Border color as a hexadecimal value.
841
- * @format COLOR_HEX
842
- */
843
- color?: string | null;
844
- /** Border radius in pixels. */
845
- radius?: number | null;
846
- }
847
- export interface ImageDataStyles {
848
- /** Border attributes. */
849
- border?: StylesBorder;
850
- }
851
- export interface LinkPreviewData {
852
- /** Styling for the link preview's container. */
853
- containerData?: PluginContainerData;
854
- /** Link details. */
855
- link?: Link;
856
- /** Preview title. */
857
- title?: string | null;
858
- /** Preview thumbnail URL. */
859
- thumbnailUrl?: string | null;
860
- /** Preview description. */
861
- description?: string | null;
862
- /** The preview content as HTML. */
863
- html?: string | null;
864
- /** Styling for the link preview. */
865
- styles?: LinkPreviewDataStyles;
866
- }
867
- export declare enum Position {
868
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
869
- START = "START",
870
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
871
- END = "END",
872
- /** Thumbnail positioned at the top */
873
- TOP = "TOP",
874
- /** Thumbnail hidden and not displayed */
875
- HIDDEN = "HIDDEN"
876
- }
877
- /** @enumType */
878
- export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
879
- export interface LinkPreviewDataStyles {
880
- /**
881
- * Background color as a hexadecimal value.
882
- * @format COLOR_HEX
883
- */
884
- backgroundColor?: string | null;
885
- /**
886
- * Title color as a hexadecimal value.
887
- * @format COLOR_HEX
888
- */
889
- titleColor?: string | null;
890
- /**
891
- * Subtitle color as a hexadecimal value.
892
- * @format COLOR_HEX
893
- */
894
- subtitleColor?: string | null;
895
- /**
896
- * Link color as a hexadecimal value.
897
- * @format COLOR_HEX
898
- */
899
- linkColor?: string | null;
900
- /** Border width in pixels. */
901
- borderWidth?: number | null;
902
- /** Border radius in pixels. */
903
- borderRadius?: number | null;
904
- /**
905
- * Border color as a hexadecimal value.
906
- * @format COLOR_HEX
907
- */
908
- borderColor?: string | null;
909
- /** Position of thumbnail. Defaults to `START`. */
910
- thumbnailPosition?: PositionWithLiterals;
911
- }
912
- export interface MapData {
913
- /** Styling for the map's container. */
914
- containerData?: PluginContainerData;
915
- /** Map settings. */
916
- mapSettings?: MapSettings;
917
- }
918
- export interface MapSettings {
919
- /** The address to display on the map. */
920
- address?: string | null;
921
- /** Sets whether the map is draggable. */
922
- draggable?: boolean | null;
923
- /** Sets whether the location marker is visible. */
924
- marker?: boolean | null;
925
- /** Sets whether street view control is enabled. */
926
- streetViewControl?: boolean | null;
927
- /** Sets whether zoom control is enabled. */
928
- zoomControl?: boolean | null;
929
- /** Location latitude. */
930
- lat?: number | null;
931
- /** Location longitude. */
932
- lng?: number | null;
933
- /** Location name. */
934
- locationName?: string | null;
935
- /** Sets whether view mode control is enabled. */
936
- viewModeControl?: boolean | null;
937
- /** Initial zoom value. */
938
- initialZoom?: number | null;
939
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
940
- mapType?: MapTypeWithLiterals;
941
- }
942
- export declare enum MapType {
943
- /** Roadmap map type */
944
- ROADMAP = "ROADMAP",
945
- /** Satellite map type */
946
- SATELITE = "SATELITE",
947
- /** Hybrid map type */
948
- HYBRID = "HYBRID",
949
- /** Terrain map type */
950
- TERRAIN = "TERRAIN"
951
- }
952
- /** @enumType */
953
- export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
954
- export interface ParagraphData {
955
- /** Styling for the paragraph text. */
956
- textStyle?: TextStyle;
957
- /** Indentation level from 1-4. */
958
- indentation?: number | null;
959
- /** Paragraph level */
960
- level?: number | null;
961
- }
962
- export interface PollData {
963
- /** Styling for the poll's container. */
964
- containerData?: PluginContainerData;
965
- /** Poll data. */
966
- poll?: Poll;
967
- /** Layout settings for the poll and voting options. */
968
- layout?: PollDataLayout;
969
- /** Styling for the poll and voting options. */
970
- design?: Design;
971
- }
972
- export declare enum ViewRole {
973
- /** Only Poll creator can view the results */
974
- CREATOR = "CREATOR",
975
- /** Anyone who voted can see the results */
976
- VOTERS = "VOTERS",
977
- /** Anyone can see the results, even if one didn't vote */
978
- EVERYONE = "EVERYONE"
979
- }
980
- /** @enumType */
981
- export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
982
- export declare enum VoteRole {
983
- /** Logged in member */
984
- SITE_MEMBERS = "SITE_MEMBERS",
985
- /** Anyone */
986
- ALL = "ALL"
987
- }
988
- /** @enumType */
989
- export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
990
- export interface Permissions {
991
- /** Sets who can view the poll results. */
992
- view?: ViewRoleWithLiterals;
993
- /** Sets who can vote. */
994
- vote?: VoteRoleWithLiterals;
995
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
996
- allowMultipleVotes?: boolean | null;
997
- }
998
- export interface Option {
999
- /** Option ID. */
1000
- id?: string | null;
1001
- /** Option title. */
1002
- title?: string | null;
1003
- /** The image displayed with the option. */
1004
- image?: Media;
1005
- }
1006
- export interface Settings {
1007
- /** Permissions settings for voting. */
1008
- permissions?: Permissions;
1009
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1010
- showVoters?: boolean | null;
1011
- /** Sets whether the vote count is displayed. Defaults to `true`. */
1012
- showVotesCount?: boolean | null;
1013
- }
1014
- export declare enum PollLayoutType {
1015
- /** List */
1016
- LIST = "LIST",
1017
- /** Grid */
1018
- GRID = "GRID"
1019
- }
1020
- /** @enumType */
1021
- export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1022
- export declare enum PollLayoutDirection {
1023
- /** Left-to-right */
1024
- LTR = "LTR",
1025
- /** Right-to-left */
1026
- RTL = "RTL"
1027
- }
1028
- /** @enumType */
1029
- export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1030
- export interface PollLayout {
1031
- /** The layout for displaying the voting options. */
1032
- type?: PollLayoutTypeWithLiterals;
1033
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1034
- direction?: PollLayoutDirectionWithLiterals;
1035
- /** Sets whether to display the main poll image. Defaults to `false`. */
1036
- enableImage?: boolean | null;
1037
- }
1038
- export interface OptionLayout {
1039
- /** Sets whether to display option images. Defaults to `false`. */
1040
- enableImage?: boolean | null;
1041
- }
1042
- export declare enum BackgroundType {
1043
- /** Color background type */
1044
- COLOR = "COLOR",
1045
- /** Image background type */
1046
- IMAGE = "IMAGE",
1047
- /** Gradiant background type */
1048
- GRADIENT = "GRADIENT"
1049
- }
1050
- /** @enumType */
1051
- export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1052
- export interface Gradient {
1053
- /** The gradient angle in degrees. */
1054
- angle?: number | null;
1055
- /**
1056
- * The start color as a hexademical value.
1057
- * @format COLOR_HEX
1058
- */
1059
- startColor?: string | null;
1060
- /**
1061
- * The end color as a hexademical value.
1062
- * @format COLOR_HEX
1063
- */
1064
- lastColor?: string | null;
1065
- }
1066
- export interface Background extends BackgroundBackgroundOneOf {
1067
- /**
1068
- * The background color as a hexademical value.
1069
- * @format COLOR_HEX
1070
- */
1071
- color?: string | null;
1072
- /** An image to use for the background. */
1073
- image?: Media;
1074
- /** Details for a gradient background. */
1075
- gradient?: Gradient;
1076
- /** Background type. For each option, include the relevant details. */
1077
- type?: BackgroundTypeWithLiterals;
1078
- }
1079
- /** @oneof */
1080
- export interface BackgroundBackgroundOneOf {
1081
- /**
1082
- * The background color as a hexademical value.
1083
- * @format COLOR_HEX
1084
- */
1085
- color?: string | null;
1086
- /** An image to use for the background. */
1087
- image?: Media;
1088
- /** Details for a gradient background. */
1089
- gradient?: Gradient;
1090
- }
1091
- export interface PollDesign {
1092
- /** Background styling. */
1093
- background?: Background;
1094
- /** Border radius in pixels. */
1095
- borderRadius?: number | null;
1096
- }
1097
- export interface OptionDesign {
1098
- /** Border radius in pixels. */
1099
- borderRadius?: number | null;
1100
- }
1101
- export interface Poll {
1102
- /** Poll ID. */
1103
- id?: string | null;
1104
- /** Poll title. */
1105
- title?: string | null;
1106
- /** Poll creator ID. */
1107
- creatorId?: string | null;
1108
- /** Main poll image. */
1109
- image?: Media;
1110
- /** Voting options. */
1111
- options?: Option[];
1112
- /** The poll's permissions and display settings. */
1113
- settings?: Settings;
1114
- }
1115
- export interface PollDataLayout {
1116
- /** Poll layout settings. */
1117
- poll?: PollLayout;
1118
- /** Voting otpions layout settings. */
1119
- options?: OptionLayout;
1120
- }
1121
- export interface Design {
1122
- /** Styling for the poll. */
1123
- poll?: PollDesign;
1124
- /** Styling for voting options. */
1125
- options?: OptionDesign;
1126
- }
1127
- export interface TextData {
1128
- /** The text to apply decorations to. */
1129
- text?: string;
1130
- /** The decorations to apply. */
1131
- decorations?: Decoration[];
1132
- }
1133
- /** Adds appearence changes to text */
1134
- export interface Decoration extends DecorationDataOneOf {
1135
- /** Data for an anchor link decoration. */
1136
- anchorData?: AnchorData;
1137
- /** Data for a color decoration. */
1138
- colorData?: ColorData;
1139
- /** Data for an external link decoration. */
1140
- linkData?: LinkData;
1141
- /** Data for a mention decoration. */
1142
- mentionData?: MentionData;
1143
- /** Data for a font size decoration. */
1144
- fontSizeData?: FontSizeData;
1145
- /** Font weight for a bold decoration. */
1146
- fontWeightValue?: number | null;
1147
- /** Data for an italic decoration. Defaults to `true`. */
1148
- italicData?: boolean | null;
1149
- /** Data for an underline decoration. Defaults to `true`. */
1150
- underlineData?: boolean | null;
1151
- /** Data for a spoiler decoration. */
1152
- spoilerData?: SpoilerData;
1153
- /** Data for a strikethrough decoration. Defaults to `true`. */
1154
- strikethroughData?: boolean | null;
1155
- /** The type of decoration to apply. */
1156
- type?: DecorationTypeWithLiterals;
1157
- }
1158
- /** @oneof */
1159
- export interface DecorationDataOneOf {
1160
- /** Data for an anchor link decoration. */
1161
- anchorData?: AnchorData;
1162
- /** Data for a color decoration. */
1163
- colorData?: ColorData;
1164
- /** Data for an external link decoration. */
1165
- linkData?: LinkData;
1166
- /** Data for a mention decoration. */
1167
- mentionData?: MentionData;
1168
- /** Data for a font size decoration. */
1169
- fontSizeData?: FontSizeData;
1170
- /** Font weight for a bold decoration. */
1171
- fontWeightValue?: number | null;
1172
- /** Data for an italic decoration. Defaults to `true`. */
1173
- italicData?: boolean | null;
1174
- /** Data for an underline decoration. Defaults to `true`. */
1175
- underlineData?: boolean | null;
1176
- /** Data for a spoiler decoration. */
1177
- spoilerData?: SpoilerData;
1178
- /** Data for a strikethrough decoration. Defaults to `true`. */
1179
- strikethroughData?: boolean | null;
1180
- }
1181
- export declare enum DecorationType {
1182
- BOLD = "BOLD",
1183
- ITALIC = "ITALIC",
1184
- UNDERLINE = "UNDERLINE",
1185
- SPOILER = "SPOILER",
1186
- ANCHOR = "ANCHOR",
1187
- MENTION = "MENTION",
1188
- LINK = "LINK",
1189
- COLOR = "COLOR",
1190
- FONT_SIZE = "FONT_SIZE",
1191
- EXTERNAL = "EXTERNAL",
1192
- STRIKETHROUGH = "STRIKETHROUGH"
1193
- }
1194
- /** @enumType */
1195
- export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
1196
- export interface AnchorData {
1197
- /** The target node's ID. */
1198
- anchor?: string;
1199
- }
1200
- export interface ColorData {
1201
- /** The text's background color as a hexadecimal value. */
1202
- background?: string | null;
1203
- /** The text's foreground color as a hexadecimal value. */
1204
- foreground?: string | null;
1205
- }
1206
- export interface LinkData {
1207
- /** Link details. */
1208
- link?: Link;
1209
- }
1210
- export interface MentionData {
1211
- /** The mentioned user's name. */
1212
- name?: string;
1213
- /** The version of the user's name that appears after the `@` character in the mention. */
1214
- slug?: string;
1215
- /** Mentioned user's ID. */
1216
- id?: string | null;
1217
- }
1218
- export interface FontSizeData {
1219
- /** The units used for the font size. */
1220
- unit?: FontTypeWithLiterals;
1221
- /** Font size value. */
1222
- value?: number | null;
1223
- }
1224
- export declare enum FontType {
1225
- PX = "PX",
1226
- EM = "EM"
1227
- }
1228
- /** @enumType */
1229
- export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1230
- export interface SpoilerData {
1231
- /** Spoiler ID. */
1232
- id?: string | null;
1233
- }
1234
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1235
- /** Data for embedded Wix Bookings content. */
1236
- bookingData?: BookingData;
1237
- /** Data for embedded Wix Events content. */
1238
- eventData?: EventData;
1239
- /** The type of Wix App content being embedded. */
1240
- type?: AppTypeWithLiterals;
1241
- /** The ID of the embedded content. */
1242
- itemId?: string | null;
1243
- /** The name of the embedded content. */
1244
- name?: string | null;
1245
- /**
1246
- * Deprecated: Use `image` instead.
1247
- * @deprecated
1248
- */
1249
- imageSrc?: string | null;
1250
- /** The URL for the embedded content. */
1251
- url?: string | null;
1252
- /** An image for the embedded content. */
1253
- image?: Media;
1254
- }
1255
- /** @oneof */
1256
- export interface AppEmbedDataAppDataOneOf {
1257
- /** Data for embedded Wix Bookings content. */
1258
- bookingData?: BookingData;
1259
- /** Data for embedded Wix Events content. */
1260
- eventData?: EventData;
1261
- }
1262
- export declare enum AppType {
1263
- PRODUCT = "PRODUCT",
1264
- EVENT = "EVENT",
1265
- BOOKING = "BOOKING"
1266
- }
1267
- /** @enumType */
1268
- export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1269
- export interface BookingData {
1270
- /** Booking duration in minutes. */
1271
- durations?: string | null;
1272
- }
1273
- export interface EventData {
1274
- /** Event schedule. */
1275
- scheduling?: string | null;
1276
- /** Event location. */
1277
- location?: string | null;
1278
- }
1279
- export interface VideoData {
1280
- /** Styling for the video's container. */
1281
- containerData?: PluginContainerData;
1282
- /** Video details. */
1283
- video?: Media;
1284
- /** Video thumbnail details. */
1285
- thumbnail?: Media;
1286
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
1287
- disableDownload?: boolean | null;
1288
- /** Video title. */
1289
- title?: string | null;
1290
- /** Video options. */
1291
- options?: PlaybackOptions;
1292
- }
1293
- export interface PlaybackOptions {
1294
- /** Sets whether the media will automatically start playing. */
1295
- autoPlay?: boolean | null;
1296
- /** Sets whether media's will be looped. */
1297
- playInLoop?: boolean | null;
1298
- /** Sets whether media's controls will be shown. */
1299
- showControls?: boolean | null;
1300
- }
1301
- export interface EmbedData {
1302
- /** Styling for the oEmbed node's container. */
1303
- containerData?: PluginContainerData;
1304
- /** An [oEmbed](https://www.oembed.com) object. */
1305
- oembed?: Oembed;
1306
- /** Origin asset source. */
1307
- src?: string | null;
1308
- }
1309
- export interface Oembed {
1310
- /** The resource type. */
1311
- type?: string | null;
1312
- /** The width of the resource specified in the `url` property in pixels. */
1313
- width?: number | null;
1314
- /** The height of the resource specified in the `url` property in pixels. */
1315
- height?: number | null;
1316
- /** Resource title. */
1317
- title?: string | null;
1318
- /** The source URL for the resource. */
1319
- url?: string | null;
1320
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1321
- html?: string | null;
1322
- /** The name of the author or owner of the resource. */
1323
- authorName?: string | null;
1324
- /** The URL for the author or owner of the resource. */
1325
- authorUrl?: string | null;
1326
- /** The name of the resource provider. */
1327
- providerName?: string | null;
1328
- /** The URL for the resource provider. */
1329
- providerUrl?: string | null;
1330
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1331
- thumbnailUrl?: string | null;
1332
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1333
- thumbnailWidth?: string | null;
1334
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1335
- thumbnailHeight?: string | null;
1336
- /** The URL for an embedded viedo. */
1337
- videoUrl?: string | null;
1338
- /** The oEmbed version number. This value must be `1.0`. */
1339
- version?: string | null;
1340
- }
1341
- export interface CollapsibleListData {
1342
- /** Styling for the collapsible list's container. */
1343
- containerData?: PluginContainerData;
1344
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1345
- expandOnlyOne?: boolean | null;
1346
- /** Sets which items are expanded when the page loads. */
1347
- initialExpandedItems?: InitialExpandedItemsWithLiterals;
1348
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1349
- direction?: DirectionWithLiterals;
1350
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1351
- isQapageData?: boolean | null;
1352
- }
1353
- export declare enum InitialExpandedItems {
1354
- /** First item will be expended initally */
1355
- FIRST = "FIRST",
1356
- /** All items will expended initally */
1357
- ALL = "ALL",
1358
- /** All items collapsed initally */
1359
- NONE = "NONE"
1360
- }
1361
- /** @enumType */
1362
- export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1363
- export declare enum Direction {
1364
- /** Left-to-right */
1365
- LTR = "LTR",
1366
- /** Right-to-left */
1367
- RTL = "RTL"
1368
- }
1369
- /** @enumType */
1370
- export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1371
- export interface TableData {
1372
- /** Styling for the table's container. */
1373
- containerData?: PluginContainerData;
1374
- /** The table's dimensions. */
1375
- dimensions?: Dimensions;
1376
- /**
1377
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
1378
- * @deprecated
1379
- */
1380
- header?: boolean | null;
1381
- /** Sets whether the table's first row is a header. Defaults to `false`. */
1382
- rowHeader?: boolean | null;
1383
- /** Sets whether the table's first column is a header. Defaults to `false`. */
1384
- columnHeader?: boolean | null;
1385
- }
1386
- export interface Dimensions {
1387
- /** An array representing relative width of each column in relation to the other columns. */
1388
- colsWidthRatio?: number[];
1389
- /** An array representing the height of each row in pixels. */
1390
- rowsHeight?: number[];
1391
- /** An array representing the minimum width of each column in pixels. */
1392
- colsMinWidth?: number[];
1393
- }
1394
- export interface TableCellData {
1395
- /** Styling for the cell's background color and text alignment. */
1396
- cellStyle?: CellStyle;
1397
- /** The cell's border colors. */
1398
- borderColors?: BorderColors;
1399
- }
1400
- export declare enum VerticalAlignment {
1401
- /** Top alignment */
1402
- TOP = "TOP",
1403
- /** Middle alignment */
1404
- MIDDLE = "MIDDLE",
1405
- /** Bottom alignment */
1406
- BOTTOM = "BOTTOM"
1407
- }
1408
- /** @enumType */
1409
- export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1410
- export interface CellStyle {
1411
- /** Vertical alignment for the cell's text. */
1412
- verticalAlignment?: VerticalAlignmentWithLiterals;
1413
- /**
1414
- * Cell background color as a hexadecimal value.
1415
- * @format COLOR_HEX
1416
- */
1417
- backgroundColor?: string | null;
1418
- }
1419
- export interface BorderColors {
1420
- /**
1421
- * Left border color as a hexadecimal value.
1422
- * @format COLOR_HEX
1423
- */
1424
- left?: string | null;
1425
- /**
1426
- * Right border color as a hexadecimal value.
1427
- * @format COLOR_HEX
1428
- */
1429
- right?: string | null;
1430
- /**
1431
- * Top border color as a hexadecimal value.
1432
- * @format COLOR_HEX
1433
- */
1434
- top?: string | null;
1435
- /**
1436
- * Bottom border color as a hexadecimal value.
1437
- * @format COLOR_HEX
1438
- */
1439
- bottom?: string | null;
1440
- }
1441
- /**
1442
- * `NullValue` is a singleton enumeration to represent the null value for the
1443
- * `Value` type union.
1444
- *
1445
- * The JSON representation for `NullValue` is JSON `null`.
1446
- */
1447
- export declare enum NullValue {
1448
- /** Null value. */
1449
- NULL_VALUE = "NULL_VALUE"
1450
- }
1451
- /** @enumType */
1452
- export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1453
- /**
1454
- * `ListValue` is a wrapper around a repeated field of values.
1455
- *
1456
- * The JSON representation for `ListValue` is JSON array.
1457
- */
1458
- export interface ListValue {
1459
- /** Repeated field of dynamically typed values. */
1460
- values?: any[];
1461
- }
1462
- export interface AudioData {
1463
- /** Styling for the audio node's container. */
1464
- containerData?: PluginContainerData;
1465
- /** Audio file details. */
1466
- audio?: Media;
1467
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1468
- disableDownload?: boolean | null;
1469
- /** Cover image. */
1470
- coverImage?: Media;
1471
- /** Track name. */
1472
- name?: string | null;
1473
- /** Author name. */
1474
- authorName?: string | null;
1475
- /** An HTML version of the audio node. */
1476
- html?: string | null;
1477
- }
1478
- export interface OrderedListData {
1479
- /** Indentation level from 0-4. */
1480
- indentation?: number;
1481
- /** Offset level from 0-4. */
1482
- offset?: number | null;
1483
- /** List start number. */
1484
- start?: number | null;
1485
- }
1486
- export interface BulletedListData {
1487
- /** Indentation level from 0-4. */
1488
- indentation?: number;
1489
- /** Offset level from 0-4. */
1490
- offset?: number | null;
1491
- }
1492
- export interface BlockquoteData {
1493
- /** Indentation level from 1-4. */
1494
- indentation?: number;
1495
- }
1496
- export interface CaptionData {
1497
- textStyle?: TextStyle;
1498
- }
1499
- export interface LayoutCellData {
1500
- /** Size of the cell in 12 columns grid. */
1501
- colSpan?: number | null;
1502
- }
1503
- export interface Metadata {
1504
- /** Schema version. */
1505
- version?: number;
1506
- /**
1507
- * When the object was created.
1508
- * @readonly
1509
- * @deprecated
1510
- */
1511
- createdTimestamp?: Date | null;
1512
- /**
1513
- * When the object was most recently updated.
1514
- * @deprecated
1515
- */
1516
- updatedTimestamp?: Date | null;
1517
- /** Object ID. */
1518
- _id?: string | null;
1519
- }
1520
- export interface DocumentStyle {
1521
- /** Styling for H1 nodes. */
1522
- headerOne?: TextNodeStyle;
1523
- /** Styling for H2 nodes. */
1524
- headerTwo?: TextNodeStyle;
1525
- /** Styling for H3 nodes. */
1526
- headerThree?: TextNodeStyle;
1527
- /** Styling for H4 nodes. */
1528
- headerFour?: TextNodeStyle;
1529
- /** Styling for H5 nodes. */
1530
- headerFive?: TextNodeStyle;
1531
- /** Styling for H6 nodes. */
1532
- headerSix?: TextNodeStyle;
1533
- /** Styling for paragraph nodes. */
1534
- paragraph?: TextNodeStyle;
1535
- /** Styling for block quote nodes. */
1536
- blockquote?: TextNodeStyle;
1537
- /** Styling for code block nodes. */
1538
- codeBlock?: TextNodeStyle;
1539
- }
1540
- export interface TextNodeStyle {
1541
- /** The decorations to apply to the node. */
1542
- decorations?: Decoration[];
1543
- /** Padding and background color for the node. */
1544
- nodeStyle?: NodeStyle;
1545
- /** Line height for text in the node. */
1546
- lineHeight?: string | null;
1547
- }
1548
- export interface MachineTranslateRequest {
1549
- /** Language of the source text to translate. */
1550
- sourceLanguage: SupportedLanguageWithLiterals;
1551
- /** Language to translate text into. */
1552
- targetLanguage: SupportedLanguageWithLiterals;
1553
- /** The content to translate. */
1554
- contentToTranslate: TranslatableContent;
1555
- }
1556
- export declare enum SupportedLanguage {
1557
- /** Undefined Language */
1558
- UNDEFINED_SUPPORTED_LANGUAGE = "UNDEFINED_SUPPORTED_LANGUAGE",
1559
- /** Afrikaans */
1560
- AF = "AF",
1561
- /** Albanian */
1562
- SQ = "SQ",
1563
- /** Amharic */
1564
- AM = "AM",
1565
- /** Arabic */
1566
- AR = "AR",
1567
- /** Armenian */
1568
- HY = "HY",
1569
- /** Assamese */
1570
- AS = "AS",
1571
- /** Aymara */
1572
- AY = "AY",
1573
- /** Azerbaijani */
1574
- AZ = "AZ",
1575
- /** Bambara */
1576
- BM = "BM",
1577
- /** Basque */
1578
- EU = "EU",
1579
- /** Belarusian */
1580
- BE = "BE",
1581
- /** Bengali */
1582
- BN = "BN",
1583
- /** Bhojpuri */
1584
- BHO = "BHO",
1585
- /** Bosnian */
1586
- BS = "BS",
1587
- /** Bulgarian */
1588
- BG = "BG",
1589
- /** Catalan */
1590
- CA = "CA",
1591
- /** Cebuano */
1592
- CEB = "CEB",
1593
- /** Chinese (Simplified) */
1594
- ZH_CN = "ZH_CN",
1595
- /** Chinese (Traditional) */
1596
- ZH_TW = "ZH_TW",
1597
- /** Chinese (Simplified) */
1598
- ZH = "ZH",
1599
- /** Corsican */
1600
- CO = "CO",
1601
- /** Croatian */
1602
- HR = "HR",
1603
- /** Czech */
1604
- CS = "CS",
1605
- /** Danish */
1606
- DA = "DA",
1607
- /** Dhivehi */
1608
- DV = "DV",
1609
- /** Dogri */
1610
- DOI = "DOI",
1611
- /** Dutch */
1612
- NL = "NL",
1613
- /** English */
1614
- EN = "EN",
1615
- /** Esperanto */
1616
- EO = "EO",
1617
- /** Estonian */
1618
- ET = "ET",
1619
- /** Ewe */
1620
- EE = "EE",
1621
- /** Filipino (Tagalog) */
1622
- FIL = "FIL",
1623
- /** Finnish */
1624
- FI = "FI",
1625
- /** French */
1626
- FR = "FR",
1627
- /** Frisian */
1628
- FY = "FY",
1629
- /** Galician */
1630
- GL = "GL",
1631
- /** Georgian */
1632
- KA = "KA",
1633
- /** German */
1634
- DE = "DE",
1635
- /** Greek */
1636
- EL = "EL",
1637
- /** Guarani */
1638
- GN = "GN",
1639
- /** Gujarati */
1640
- GU = "GU",
1641
- /** Haitian Creole */
1642
- HT = "HT",
1643
- /** Hausa */
1644
- HA = "HA",
1645
- /** Hawaiian */
1646
- HAW = "HAW",
1647
- /** Hebrew */
1648
- HE = "HE",
1649
- /** Hindi */
1650
- HI = "HI",
1651
- /** Hmong */
1652
- HMN = "HMN",
1653
- /** Hungarian */
1654
- HU = "HU",
1655
- /** Icelandic */
1656
- IS = "IS",
1657
- /** Igbo */
1658
- IG = "IG",
1659
- /** Ilocano */
1660
- ILO = "ILO",
1661
- /** Indonesian */
1662
- ID = "ID",
1663
- /** Irish */
1664
- GA = "GA",
1665
- /** Italian */
1666
- IT = "IT",
1667
- /** Japanese */
1668
- JA = "JA",
1669
- /** Javanese */
1670
- JW = "JW",
1671
- /** Kannada */
1672
- KN = "KN",
1673
- /** Kazakh */
1674
- KK = "KK",
1675
- /** Khmer */
1676
- KM = "KM",
1677
- /** Kinyarwanda */
1678
- RW = "RW",
1679
- /** Konkani */
1680
- GOM = "GOM",
1681
- /** Korean */
1682
- KO = "KO",
1683
- /** Krio */
1684
- KRI = "KRI",
1685
- /** Kurdish */
1686
- KU = "KU",
1687
- /** Kurdish (Sorani) */
1688
- CKB = "CKB",
1689
- /** Kyrgyz */
1690
- KY = "KY",
1691
- /** Lao */
1692
- LO = "LO",
1693
- /** Latin */
1694
- LA = "LA",
1695
- /** Latvian */
1696
- LV = "LV",
1697
- /** Lingala */
1698
- LN = "LN",
1699
- /** Lithuanian */
1700
- LT = "LT",
1701
- /** Luganda */
1702
- LG = "LG",
1703
- /** Luxembourgish */
1704
- LB = "LB",
1705
- /** Macedonian */
1706
- MK = "MK",
1707
- /** Maithili */
1708
- MAI = "MAI",
1709
- /** Malagasy */
1710
- MG = "MG",
1711
- /** Malay */
1712
- MS = "MS",
1713
- /** Malayalam */
1714
- ML = "ML",
1715
- /** Maltese */
1716
- MT = "MT",
1717
- /** Maori */
1718
- MI = "MI",
1719
- /** Marathi */
1720
- MR = "MR",
1721
- /** Meiteilon (Manipuri) */
1722
- MNI_MTEI = "MNI_MTEI",
1723
- /** Mizo */
1724
- LUS = "LUS",
1725
- /** Mongolian */
1726
- MN = "MN",
1727
- /** Myanmar (Burmese) */
1728
- MY = "MY",
1729
- /** Nepali */
1730
- NE = "NE",
1731
- /** Norwegian */
1732
- NO = "NO",
1733
- /** Nyanja (Chichewa) */
1734
- NY = "NY",
1735
- /** Odia (Oriya) */
1736
- OR = "OR",
1737
- /** Oromo */
1738
- OM = "OM",
1739
- /** Pashto */
1740
- PS = "PS",
1741
- /** Persian */
1742
- FA = "FA",
1743
- /** Polish */
1744
- PL = "PL",
1745
- /** Portuguese (Portugal, Brazil) */
1746
- PT = "PT",
1747
- /** Punjabi */
1748
- PA = "PA",
1749
- /** Quechua */
1750
- QU = "QU",
1751
- /** Romanian */
1752
- RO = "RO",
1753
- /** Russian */
1754
- RU = "RU",
1755
- /** Samoan */
1756
- SM = "SM",
1757
- /** Sanskrit */
1758
- SA = "SA",
1759
- /** Scots Gaelic */
1760
- GD = "GD",
1761
- /** Sepedi */
1762
- NSO = "NSO",
1763
- /** Serbian */
1764
- SR = "SR",
1765
- /** Sesotho */
1766
- ST = "ST",
1767
- /** Shona */
1768
- SN = "SN",
1769
- /** Sindhi */
1770
- SD = "SD",
1771
- /** Sinhala (Sinhalese) */
1772
- SI = "SI",
1773
- /** Slovak */
1774
- SK = "SK",
1775
- /** Slovenian */
1776
- SL = "SL",
1777
- /** Somali */
1778
- SO = "SO",
1779
- /** Spanish */
1780
- ES = "ES",
1781
- /** Sundanese */
1782
- SU = "SU",
1783
- /** Swahili */
1784
- SW = "SW",
1785
- /** Swedish */
1786
- SV = "SV",
1787
- /** Tagalog (Filipino) */
1788
- TL = "TL",
1789
- /** Tajik */
1790
- TG = "TG",
1791
- /** Tamil */
1792
- TA = "TA",
1793
- /** Tatar */
1794
- TT = "TT",
1795
- /** Telugu */
1796
- TE = "TE",
1797
- /** Thai */
1798
- TH = "TH",
1799
- /** Tigrinya */
1800
- TI = "TI",
1801
- /** Tsonga */
1802
- TS = "TS",
1803
- /** Turkish */
1804
- TR = "TR",
1805
- /** Turkmen */
1806
- TK = "TK",
1807
- /** Twi (Akan) */
1808
- AK = "AK",
1809
- /** Ukrainian */
1810
- UK = "UK",
1811
- /** Urdu */
1812
- UR = "UR",
1813
- /** Uyghur */
1814
- UG = "UG",
1815
- /** Uzbek */
1816
- UZ = "UZ",
1817
- /** Vietnamese */
1818
- VI = "VI",
1819
- /** Welsh */
1820
- CY = "CY",
1821
- /** Xhosa */
1822
- XH = "XH",
1823
- /** Yiddish */
1824
- YI = "YI",
1825
- /** Yoruba */
1826
- YO = "YO",
1827
- /** Zulu */
1828
- ZU = "ZU"
1829
- }
1830
- /** @enumType */
1831
- export 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';
1832
- export interface MachineTranslateResponse {
1833
- /** The translated content. */
1834
- translatedContent?: TranslatableContent;
1835
- }
1836
- export interface NotEnoughCreditsError {
1837
- /** The number of credits required to translate the content in the request. */
1838
- creditsRequired?: number;
1839
- }
1840
- export interface TextTooLongError {
1841
- /** The maximum length of text that can be translated. */
1842
- maxLength?: number;
1843
- /** The actual length of the text that was sent for translation. */
1844
- actualLength?: number;
1845
- }
1846
- export interface UnknownFormatError {
1847
- }
1848
- export interface SameLanguageArgumentsError {
1849
- /**
1850
- * The language supplied as both the source and the target languages
1851
- * @maxLength 16
1852
- */
1853
- language?: string;
1854
- }
1855
- export interface BulkMachineTranslateRequest {
1856
- /** Language of the source text to translate. */
1857
- sourceLanguage: SupportedLanguageWithLiterals;
1858
- /** Language to translate text into. */
1859
- targetLanguage: SupportedLanguageWithLiterals;
1860
- /**
1861
- * The content to translate.
1862
- * @minSize 1
1863
- * @maxSize 1000
1864
- */
1865
- contentToTranslate?: TranslatableContent[];
1866
- }
1867
- export interface BulkMachineTranslateResponse {
1868
- /**
1869
- * List of results for each item in the bulk request.
1870
- * @minSize 1
1871
- * @maxSize 1000
1872
- */
1873
- results?: BulkTranslateResult[];
1874
- /** Metadata for the overall bulk action, including success and failure counts. */
1875
- bulkActionMetadata?: BulkActionMetadata;
1876
- }
1877
- export interface BulkTranslateResult {
1878
- /** Metadata for the individual item in the request. */
1879
- itemMetadata?: ItemMetadata;
1880
- /** The translated content. */
1881
- item?: TranslatableContent;
1882
- }
1883
- export interface ItemMetadata {
1884
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1885
- _id?: string | null;
1886
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1887
- originalIndex?: number;
1888
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1889
- success?: boolean;
1890
- /** Details about the error in case of failure. */
1891
- error?: ApplicationError;
1892
- }
1893
- export interface ApplicationError {
1894
- /** Error code. */
1895
- code?: string;
1896
- /** Description of the error. */
1897
- description?: string;
1898
- /** Data related to the error. */
1899
- data?: Record<string, any> | null;
1900
- }
1901
- export interface BulkActionMetadata {
1902
- /** Number of items that were successfully processed. */
1903
- totalSuccesses?: number;
1904
- /** Number of items that couldn't be processed. */
1905
- totalFailures?: number;
1906
- /** Number of failures without details because detailed failure threshold was exceeded. */
1907
- undetailedFailures?: number;
1908
- }
1909
- type TranslatableContentNonNullablePaths = `plainTextContent` | `htmlContent` | `format`;
1910
- /**
1911
- * Translates the text of a translatable unit of content from one supported language to another.
1912
- *
1913
- * The `translatedContent` object returns with the same `id` used for `contentToTranslate.id` but the text within the
1914
- * content fields is replaced with the translated text. Note that Wix does not overwrite the original content object.
1915
- * To retrieve the translated content later, make sure to store it separately.
1916
- *
1917
- * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
1918
- * cannot be translated using this method.
1919
- *
1920
- * The translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
1921
- * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
1922
- * The total translatable content may be more than 5,000 characters as long as no individual node surpasses this limit.
1923
- * If any node exceeds 5,000 characters, the entire request fails.
1924
- *
1925
- * Each site has a word credit balance indicating the number of words available for translation. Successful translation requests reduce the word credits by the number of words in `contentToTranslate`.
1926
- * If the site does not have sufficient word credits to translate all of the text in the request, the request fails
1927
- * with a `NOT_ENOUGH_CREDITS` error. You can also call the [Credit Data API](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/introduction)'s [Check Sufficient Credits](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/check-sufficient-credits) method at any time to check whether the site has enough credits to translate the specified number of words.
1928
- * Wix users can receive additional word credits by [purchasing a translation package](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site#purchasing-translation-packages) in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager) at any time.
1929
- *
1930
- * To translate up to 1,000 `translatableContent` units at once, use [Bulk Machine Translate](/machine-translation/bulk-machine-translate).
1931
- * @param sourceLanguage - Language of the source text to translate.
1932
- * @public
1933
- * @requiredField options
1934
- * @requiredField options.contentToTranslate
1935
- * @requiredField options.targetLanguage
1936
- * @requiredField sourceLanguage
1937
- * @permissionId WIX_MULTILINGUAL.MACHINE_TRANSLATE
1938
- * @permissionScope Wix Multilingual - Translation API
1939
- * @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
1940
- * @applicableIdentity APP
1941
- * @fqn wix.multilingual.machine.v3.MachineTranslation.MachineTranslate
1942
- */
1943
- export declare function machineTranslate(sourceLanguage: SupportedLanguageWithLiterals, options: NonNullablePaths<MachineTranslateOptions, `contentToTranslate` | `targetLanguage`>): Promise<NonNullablePaths<MachineTranslateResponse, {
1944
- [P in TranslatableContentNonNullablePaths]: `translatedContent.${P}`;
1945
- }[TranslatableContentNonNullablePaths]>>;
1946
- export interface MachineTranslateOptions {
1947
- /** Language to translate text into. */
1948
- targetLanguage: SupportedLanguageWithLiterals;
1949
- /** The content to translate. */
1950
- contentToTranslate: TranslatableContent;
1951
- }
1952
- /**
1953
- * Translates the text of multiple units of translatable content from one supported language to another.
1954
- *
1955
- * Each translated content item in the `results` array returns with the same `id` as the corresponding `contentToTranslate.id`, but with the text in the
1956
- * content fields replaced with the translated text. Note that Wix does not overwrite the original content source,
1957
- * to retrieve the translated content later, make sure to store it separately.
1958
- *
1959
- * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
1960
- * cannot be translated using this method.
1961
- *
1962
- * Each unit of translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
1963
- * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
1964
- * The total request may exceed 5,000 characters as long as no individual node surpasses this limit.
1965
- * If any node exceeds 5,000 characters, then the request fails for that specific `contentToTranslate` item and the error details for that
1966
- * error are returned in `itemMetadata`. Even if some translations fail due to the character limit,
1967
- * the machine translation for other items will succeed if they are under the character limit.
1968
- *
1969
- * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
1970
- * Each successful translation request reduces the word credits by the number of words included in `contentToTranslate`.
1971
- * If the site does not have sufficient word credits to complete the translation, then the entire request fails
1972
- * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
1973
- *
1974
- * To translate a single unit of `translatableContent`, use [Machine Translate](/machine-translation/machine-translate).
1975
- * @param sourceLanguage - Language of the source text to translate.
1976
- * @public
1977
- * @requiredField options.targetLanguage
1978
- * @requiredField sourceLanguage
1979
- * @permissionId WIX_MULTILINGUAL.MACHINE_TRANSLATE
1980
- * @permissionScope Wix Multilingual - Translation API
1981
- * @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
1982
- * @applicableIdentity APP
1983
- * @fqn wix.multilingual.machine.v3.MachineTranslation.BulkMachineTranslate
1984
- */
1985
- export declare function bulkMachineTranslate(sourceLanguage: SupportedLanguageWithLiterals, options?: NonNullablePaths<BulkMachineTranslateOptions, `targetLanguage`>): Promise<NonNullablePaths<BulkMachineTranslateResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
1986
- [P in TranslatableContentNonNullablePaths]: `results.${number}.item.${P}`;
1987
- }[TranslatableContentNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
1988
- export interface BulkMachineTranslateOptions {
1989
- /** Language to translate text into. */
1990
- targetLanguage: SupportedLanguageWithLiterals;
1991
- /**
1992
- * The content to translate.
1993
- * @minSize 1
1994
- * @maxSize 1000
1995
- */
1996
- contentToTranslate?: TranslatableContent[];
1997
- }
1998
- export {};