@wix/auto_sdk_multilingual_translation-published-contents 1.0.21 → 1.0.23
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/index.d.mts +49 -0
- package/build/index.d.ts +49 -0
- package/build/index.js +850 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +790 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +49 -0
- package/build/internal/index.d.ts +49 -0
- package/build/internal/index.js +850 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +790 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → internal/meta.d.mts} +187 -360
- package/build/{es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → internal/meta.d.ts} +187 -360
- package/build/internal/meta.js +239 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +212 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/internal/{cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.mts} +197 -266
- package/build/{cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → internal/multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.ts} +197 -266
- package/build/{internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → meta.d.mts} +187 -360
- package/build/{internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → meta.d.ts} +187 -360
- package/build/meta.js +239 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +212 -0
- package/build/meta.mjs.map +1 -0
- package/build/{internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.mts} +197 -266
- package/build/{es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.ts} +197 -266
- 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-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -57
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -208
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -47
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -258
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -333
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -450
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.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-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -21
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -204
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -20
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -221
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -330
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -423
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.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-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -57
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -208
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -47
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -258
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -333
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -450
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.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-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -21
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -204
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -20
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -221
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -330
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -423
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface PublishedContent {
|
|
2
2
|
/**
|
|
3
3
|
* Published content ID.
|
|
4
4
|
* @readonly
|
|
@@ -33,7 +33,7 @@ export interface PublishedContent {
|
|
|
33
33
|
/** Custom field data for the published content object. */
|
|
34
34
|
extendedFields?: ExtendedFields;
|
|
35
35
|
}
|
|
36
|
-
|
|
36
|
+
interface SchemaKey {
|
|
37
37
|
/**
|
|
38
38
|
* ID of the app that created the schema.
|
|
39
39
|
* @format GUID
|
|
@@ -56,7 +56,7 @@ export interface SchemaKey {
|
|
|
56
56
|
*/
|
|
57
57
|
scope?: SchemaScopeWithLiterals;
|
|
58
58
|
}
|
|
59
|
-
|
|
59
|
+
declare enum SchemaScope {
|
|
60
60
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
61
61
|
/** Global schema for all sites. */
|
|
62
62
|
GLOBAL = "GLOBAL",
|
|
@@ -64,8 +64,8 @@ export declare enum SchemaScope {
|
|
|
64
64
|
SITE = "SITE"
|
|
65
65
|
}
|
|
66
66
|
/** @enumType */
|
|
67
|
-
|
|
68
|
-
|
|
67
|
+
type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
|
|
68
|
+
interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
69
69
|
/**
|
|
70
70
|
* Plain text.
|
|
71
71
|
* @maxLength 100000
|
|
@@ -93,7 +93,7 @@ export interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
|
93
93
|
sequenceIds?: string[];
|
|
94
94
|
}
|
|
95
95
|
/** @oneof */
|
|
96
|
-
|
|
96
|
+
interface PublishedContentFieldValueOneOf {
|
|
97
97
|
/**
|
|
98
98
|
* Plain text.
|
|
99
99
|
* @maxLength 100000
|
|
@@ -108,7 +108,7 @@ export interface PublishedContentFieldValueOneOf {
|
|
|
108
108
|
/** Wix Media Manager document. */
|
|
109
109
|
document?: string;
|
|
110
110
|
}
|
|
111
|
-
|
|
111
|
+
interface RichContent {
|
|
112
112
|
/** Node objects representing a rich content document. */
|
|
113
113
|
nodes?: Node[];
|
|
114
114
|
/** Object metadata. */
|
|
@@ -116,7 +116,7 @@ export interface RichContent {
|
|
|
116
116
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
117
117
|
documentStyle?: DocumentStyle;
|
|
118
118
|
}
|
|
119
|
-
|
|
119
|
+
interface Node extends NodeDataOneOf {
|
|
120
120
|
/** Data for a button node. */
|
|
121
121
|
buttonData?: ButtonData;
|
|
122
122
|
/** Data for a code block node. */
|
|
@@ -181,7 +181,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
181
181
|
style?: NodeStyle;
|
|
182
182
|
}
|
|
183
183
|
/** @oneof */
|
|
184
|
-
|
|
184
|
+
interface NodeDataOneOf {
|
|
185
185
|
/** Data for a button node. */
|
|
186
186
|
buttonData?: ButtonData;
|
|
187
187
|
/** Data for a code block node. */
|
|
@@ -237,7 +237,7 @@ export interface NodeDataOneOf {
|
|
|
237
237
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
238
238
|
layoutCellData?: LayoutCellData;
|
|
239
239
|
}
|
|
240
|
-
|
|
240
|
+
declare enum NodeType {
|
|
241
241
|
PARAGRAPH = "PARAGRAPH",
|
|
242
242
|
TEXT = "TEXT",
|
|
243
243
|
HEADING = "HEADING",
|
|
@@ -274,8 +274,8 @@ export declare enum NodeType {
|
|
|
274
274
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
275
275
|
}
|
|
276
276
|
/** @enumType */
|
|
277
|
-
|
|
278
|
-
|
|
277
|
+
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';
|
|
278
|
+
interface NodeStyle {
|
|
279
279
|
/** The top padding value in pixels. */
|
|
280
280
|
paddingTop?: string | null;
|
|
281
281
|
/** The bottom padding value in pixels. */
|
|
@@ -283,7 +283,7 @@ export interface NodeStyle {
|
|
|
283
283
|
/** The background color as a hexadecimal value. */
|
|
284
284
|
backgroundColor?: string | null;
|
|
285
285
|
}
|
|
286
|
-
|
|
286
|
+
interface ButtonData {
|
|
287
287
|
/** Styling for the button's container. */
|
|
288
288
|
containerData?: PluginContainerData;
|
|
289
289
|
/** The button type. */
|
|
@@ -295,7 +295,7 @@ export interface ButtonData {
|
|
|
295
295
|
/** Button link details. */
|
|
296
296
|
link?: Link;
|
|
297
297
|
}
|
|
298
|
-
|
|
298
|
+
interface Border {
|
|
299
299
|
/**
|
|
300
300
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
301
301
|
* @deprecated
|
|
@@ -307,7 +307,7 @@ export interface Border {
|
|
|
307
307
|
*/
|
|
308
308
|
radius?: number | null;
|
|
309
309
|
}
|
|
310
|
-
|
|
310
|
+
interface Colors {
|
|
311
311
|
/**
|
|
312
312
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
313
313
|
* @deprecated
|
|
@@ -324,7 +324,7 @@ export interface Colors {
|
|
|
324
324
|
*/
|
|
325
325
|
background?: string | null;
|
|
326
326
|
}
|
|
327
|
-
|
|
327
|
+
interface PluginContainerData {
|
|
328
328
|
/** The width of the node when it's displayed. */
|
|
329
329
|
width?: PluginContainerDataWidth;
|
|
330
330
|
/** The node's alignment within its container. */
|
|
@@ -336,7 +336,7 @@ export interface PluginContainerData {
|
|
|
336
336
|
/** 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`. */
|
|
337
337
|
textWrap?: boolean | null;
|
|
338
338
|
}
|
|
339
|
-
|
|
339
|
+
declare enum WidthType {
|
|
340
340
|
/** Width matches the content width */
|
|
341
341
|
CONTENT = "CONTENT",
|
|
342
342
|
/** Small Width */
|
|
@@ -347,8 +347,8 @@ export declare enum WidthType {
|
|
|
347
347
|
FULL_WIDTH = "FULL_WIDTH"
|
|
348
348
|
}
|
|
349
349
|
/** @enumType */
|
|
350
|
-
|
|
351
|
-
|
|
350
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
351
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
352
352
|
/**
|
|
353
353
|
* One of the following predefined width options:
|
|
354
354
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -361,7 +361,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
361
361
|
custom?: string | null;
|
|
362
362
|
}
|
|
363
363
|
/** @oneof */
|
|
364
|
-
|
|
364
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
365
365
|
/**
|
|
366
366
|
* One of the following predefined width options:
|
|
367
367
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -373,7 +373,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
373
373
|
/** A custom width value in pixels. */
|
|
374
374
|
custom?: string | null;
|
|
375
375
|
}
|
|
376
|
-
|
|
376
|
+
declare enum PluginContainerDataAlignment {
|
|
377
377
|
/** Center Alignment */
|
|
378
378
|
CENTER = "CENTER",
|
|
379
379
|
/** Left Alignment */
|
|
@@ -382,8 +382,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
382
382
|
RIGHT = "RIGHT"
|
|
383
383
|
}
|
|
384
384
|
/** @enumType */
|
|
385
|
-
|
|
386
|
-
|
|
385
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
386
|
+
interface Spoiler {
|
|
387
387
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
388
388
|
enabled?: boolean | null;
|
|
389
389
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -391,19 +391,19 @@ export interface Spoiler {
|
|
|
391
391
|
/** The text for the button used to remove the spoiler cover. */
|
|
392
392
|
buttonText?: string | null;
|
|
393
393
|
}
|
|
394
|
-
|
|
394
|
+
interface Height {
|
|
395
395
|
/** A custom height value in pixels. */
|
|
396
396
|
custom?: string | null;
|
|
397
397
|
}
|
|
398
|
-
|
|
398
|
+
declare enum Type {
|
|
399
399
|
/** Regular link button */
|
|
400
400
|
LINK = "LINK",
|
|
401
401
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
402
402
|
ACTION = "ACTION"
|
|
403
403
|
}
|
|
404
404
|
/** @enumType */
|
|
405
|
-
|
|
406
|
-
|
|
405
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
406
|
+
interface Styles {
|
|
407
407
|
/**
|
|
408
408
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
409
409
|
* @deprecated
|
|
@@ -456,7 +456,7 @@ export interface Styles {
|
|
|
456
456
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
457
457
|
buttonSize?: string | null;
|
|
458
458
|
}
|
|
459
|
-
|
|
459
|
+
interface Link extends LinkDataOneOf {
|
|
460
460
|
/** The absolute URL for the linked document. */
|
|
461
461
|
url?: string;
|
|
462
462
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -475,13 +475,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
475
475
|
customData?: string | null;
|
|
476
476
|
}
|
|
477
477
|
/** @oneof */
|
|
478
|
-
|
|
478
|
+
interface LinkDataOneOf {
|
|
479
479
|
/** The absolute URL for the linked document. */
|
|
480
480
|
url?: string;
|
|
481
481
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
482
482
|
anchor?: string;
|
|
483
483
|
}
|
|
484
|
-
|
|
484
|
+
declare enum Target {
|
|
485
485
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
486
486
|
SELF = "SELF",
|
|
487
487
|
/** Opens the linked document in a new window or tab */
|
|
@@ -492,8 +492,8 @@ export declare enum Target {
|
|
|
492
492
|
TOP = "TOP"
|
|
493
493
|
}
|
|
494
494
|
/** @enumType */
|
|
495
|
-
|
|
496
|
-
|
|
495
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
496
|
+
interface Rel {
|
|
497
497
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
498
498
|
nofollow?: boolean | null;
|
|
499
499
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -503,17 +503,17 @@ export interface Rel {
|
|
|
503
503
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
504
504
|
noreferrer?: boolean | null;
|
|
505
505
|
}
|
|
506
|
-
|
|
506
|
+
interface CodeBlockData {
|
|
507
507
|
/** Styling for the code block's text. */
|
|
508
508
|
textStyle?: TextStyle;
|
|
509
509
|
}
|
|
510
|
-
|
|
510
|
+
interface TextStyle {
|
|
511
511
|
/** Text alignment. Defaults to `AUTO`. */
|
|
512
512
|
textAlignment?: TextAlignmentWithLiterals;
|
|
513
513
|
/** 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. */
|
|
514
514
|
lineHeight?: string | null;
|
|
515
515
|
}
|
|
516
|
-
|
|
516
|
+
declare enum TextAlignment {
|
|
517
517
|
/** browser default, eqivalent to `initial` */
|
|
518
518
|
AUTO = "AUTO",
|
|
519
519
|
/** Left align */
|
|
@@ -526,8 +526,8 @@ export declare enum TextAlignment {
|
|
|
526
526
|
JUSTIFY = "JUSTIFY"
|
|
527
527
|
}
|
|
528
528
|
/** @enumType */
|
|
529
|
-
|
|
530
|
-
|
|
529
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
530
|
+
interface DividerData {
|
|
531
531
|
/** Styling for the divider's container. */
|
|
532
532
|
containerData?: PluginContainerData;
|
|
533
533
|
/** Divider line style. */
|
|
@@ -537,7 +537,7 @@ export interface DividerData {
|
|
|
537
537
|
/** Divider alignment. */
|
|
538
538
|
alignment?: AlignmentWithLiterals;
|
|
539
539
|
}
|
|
540
|
-
|
|
540
|
+
declare enum LineStyle {
|
|
541
541
|
/** Single Line */
|
|
542
542
|
SINGLE = "SINGLE",
|
|
543
543
|
/** Double Line */
|
|
@@ -548,8 +548,8 @@ export declare enum LineStyle {
|
|
|
548
548
|
DOTTED = "DOTTED"
|
|
549
549
|
}
|
|
550
550
|
/** @enumType */
|
|
551
|
-
|
|
552
|
-
|
|
551
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
552
|
+
declare enum Width {
|
|
553
553
|
/** Large line */
|
|
554
554
|
LARGE = "LARGE",
|
|
555
555
|
/** Medium line */
|
|
@@ -558,8 +558,8 @@ export declare enum Width {
|
|
|
558
558
|
SMALL = "SMALL"
|
|
559
559
|
}
|
|
560
560
|
/** @enumType */
|
|
561
|
-
|
|
562
|
-
|
|
561
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
562
|
+
declare enum Alignment {
|
|
563
563
|
/** Center alignment */
|
|
564
564
|
CENTER = "CENTER",
|
|
565
565
|
/** Left alignment */
|
|
@@ -568,8 +568,8 @@ export declare enum Alignment {
|
|
|
568
568
|
RIGHT = "RIGHT"
|
|
569
569
|
}
|
|
570
570
|
/** @enumType */
|
|
571
|
-
|
|
572
|
-
|
|
571
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
572
|
+
interface FileData {
|
|
573
573
|
/** Styling for the file's container. */
|
|
574
574
|
containerData?: PluginContainerData;
|
|
575
575
|
/** The source for the file's data. */
|
|
@@ -592,7 +592,7 @@ export interface FileData {
|
|
|
592
592
|
/** File size in KB. */
|
|
593
593
|
sizeInKb?: string | null;
|
|
594
594
|
}
|
|
595
|
-
|
|
595
|
+
declare enum ViewMode {
|
|
596
596
|
/** No PDF view */
|
|
597
597
|
NONE = "NONE",
|
|
598
598
|
/** Full PDF view */
|
|
@@ -601,8 +601,8 @@ export declare enum ViewMode {
|
|
|
601
601
|
MINI = "MINI"
|
|
602
602
|
}
|
|
603
603
|
/** @enumType */
|
|
604
|
-
|
|
605
|
-
|
|
604
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
605
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
606
606
|
/** The absolute URL for the file's source. */
|
|
607
607
|
url?: string | null;
|
|
608
608
|
/**
|
|
@@ -616,7 +616,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
616
616
|
private?: boolean | null;
|
|
617
617
|
}
|
|
618
618
|
/** @oneof */
|
|
619
|
-
|
|
619
|
+
interface FileSourceDataOneOf {
|
|
620
620
|
/** The absolute URL for the file's source. */
|
|
621
621
|
url?: string | null;
|
|
622
622
|
/**
|
|
@@ -627,7 +627,7 @@ export interface FileSourceDataOneOf {
|
|
|
627
627
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
628
628
|
id?: string | null;
|
|
629
629
|
}
|
|
630
|
-
|
|
630
|
+
interface PDFSettings {
|
|
631
631
|
/**
|
|
632
632
|
* PDF view mode. One of the following:
|
|
633
633
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -640,7 +640,7 @@ export interface PDFSettings {
|
|
|
640
640
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
641
641
|
disablePrint?: boolean | null;
|
|
642
642
|
}
|
|
643
|
-
|
|
643
|
+
interface GalleryData {
|
|
644
644
|
/** Styling for the gallery's container. */
|
|
645
645
|
containerData?: PluginContainerData;
|
|
646
646
|
/** The items in the gallery. */
|
|
@@ -652,7 +652,7 @@ export interface GalleryData {
|
|
|
652
652
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
653
653
|
disableDownload?: boolean | null;
|
|
654
654
|
}
|
|
655
|
-
|
|
655
|
+
interface Media {
|
|
656
656
|
/** The source for the media's data. */
|
|
657
657
|
src?: FileSource;
|
|
658
658
|
/** Media width in pixels. */
|
|
@@ -662,19 +662,19 @@ export interface Media {
|
|
|
662
662
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
663
663
|
duration?: number | null;
|
|
664
664
|
}
|
|
665
|
-
|
|
665
|
+
interface Image {
|
|
666
666
|
/** Image file details. */
|
|
667
667
|
media?: Media;
|
|
668
668
|
/** Link details for images that are links. */
|
|
669
669
|
link?: Link;
|
|
670
670
|
}
|
|
671
|
-
|
|
671
|
+
interface Video {
|
|
672
672
|
/** Video file details. */
|
|
673
673
|
media?: Media;
|
|
674
674
|
/** Video thumbnail file details. */
|
|
675
675
|
thumbnail?: Media;
|
|
676
676
|
}
|
|
677
|
-
|
|
677
|
+
interface Item extends ItemDataOneOf {
|
|
678
678
|
/** An image item. */
|
|
679
679
|
image?: Image;
|
|
680
680
|
/** A video item. */
|
|
@@ -685,13 +685,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
685
685
|
altText?: string | null;
|
|
686
686
|
}
|
|
687
687
|
/** @oneof */
|
|
688
|
-
|
|
688
|
+
interface ItemDataOneOf {
|
|
689
689
|
/** An image item. */
|
|
690
690
|
image?: Image;
|
|
691
691
|
/** A video item. */
|
|
692
692
|
video?: Video;
|
|
693
693
|
}
|
|
694
|
-
|
|
694
|
+
interface GalleryOptions {
|
|
695
695
|
/** Gallery layout. */
|
|
696
696
|
layout?: Layout;
|
|
697
697
|
/** Styling for gallery items. */
|
|
@@ -699,7 +699,7 @@ export interface GalleryOptions {
|
|
|
699
699
|
/** Styling for gallery thumbnail images. */
|
|
700
700
|
thumbnails?: Thumbnails;
|
|
701
701
|
}
|
|
702
|
-
|
|
702
|
+
declare enum LayoutType {
|
|
703
703
|
/** Collage type */
|
|
704
704
|
COLLAGE = "COLLAGE",
|
|
705
705
|
/** Masonry type */
|
|
@@ -722,24 +722,24 @@ export declare enum LayoutType {
|
|
|
722
722
|
FULLSIZE = "FULLSIZE"
|
|
723
723
|
}
|
|
724
724
|
/** @enumType */
|
|
725
|
-
|
|
726
|
-
|
|
725
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
726
|
+
declare enum Orientation {
|
|
727
727
|
/** Rows Orientation */
|
|
728
728
|
ROWS = "ROWS",
|
|
729
729
|
/** Columns Orientation */
|
|
730
730
|
COLUMNS = "COLUMNS"
|
|
731
731
|
}
|
|
732
732
|
/** @enumType */
|
|
733
|
-
|
|
734
|
-
|
|
733
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
734
|
+
declare enum Crop {
|
|
735
735
|
/** Crop to fill */
|
|
736
736
|
FILL = "FILL",
|
|
737
737
|
/** Crop to fit */
|
|
738
738
|
FIT = "FIT"
|
|
739
739
|
}
|
|
740
740
|
/** @enumType */
|
|
741
|
-
|
|
742
|
-
|
|
741
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
742
|
+
declare enum ThumbnailsAlignment {
|
|
743
743
|
/** Top alignment */
|
|
744
744
|
TOP = "TOP",
|
|
745
745
|
/** Right alignment */
|
|
@@ -752,8 +752,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
752
752
|
NONE = "NONE"
|
|
753
753
|
}
|
|
754
754
|
/** @enumType */
|
|
755
|
-
|
|
756
|
-
|
|
755
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
756
|
+
interface Layout {
|
|
757
757
|
/** Gallery layout type. */
|
|
758
758
|
type?: LayoutTypeWithLiterals;
|
|
759
759
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -765,7 +765,7 @@ export interface Layout {
|
|
|
765
765
|
/** The number of columns to display on mobile screens. */
|
|
766
766
|
mobileNumberOfColumns?: number | null;
|
|
767
767
|
}
|
|
768
|
-
|
|
768
|
+
interface ItemStyle {
|
|
769
769
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
770
770
|
targetSize?: number | null;
|
|
771
771
|
/** Item ratio */
|
|
@@ -775,13 +775,13 @@ export interface ItemStyle {
|
|
|
775
775
|
/** The spacing between items in pixels. */
|
|
776
776
|
spacing?: number | null;
|
|
777
777
|
}
|
|
778
|
-
|
|
778
|
+
interface Thumbnails {
|
|
779
779
|
/** Thumbnail alignment. */
|
|
780
780
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
781
781
|
/** Spacing between thumbnails in pixels. */
|
|
782
782
|
spacing?: number | null;
|
|
783
783
|
}
|
|
784
|
-
|
|
784
|
+
interface GIFData {
|
|
785
785
|
/** Styling for the GIF's container. */
|
|
786
786
|
containerData?: PluginContainerData;
|
|
787
787
|
/** The source of the full size GIF. */
|
|
@@ -795,7 +795,7 @@ export interface GIFData {
|
|
|
795
795
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
796
796
|
gifType?: GIFTypeWithLiterals;
|
|
797
797
|
}
|
|
798
|
-
|
|
798
|
+
interface GIF {
|
|
799
799
|
/**
|
|
800
800
|
* GIF format URL.
|
|
801
801
|
* @format WEB_URL
|
|
@@ -812,13 +812,13 @@ export interface GIF {
|
|
|
812
812
|
*/
|
|
813
813
|
still?: string | null;
|
|
814
814
|
}
|
|
815
|
-
|
|
815
|
+
declare enum GIFType {
|
|
816
816
|
NORMAL = "NORMAL",
|
|
817
817
|
STICKER = "STICKER"
|
|
818
818
|
}
|
|
819
819
|
/** @enumType */
|
|
820
|
-
|
|
821
|
-
|
|
820
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
821
|
+
interface HeadingData {
|
|
822
822
|
/** Heading level from 1-6. */
|
|
823
823
|
level?: number;
|
|
824
824
|
/** Styling for the heading text. */
|
|
@@ -826,7 +826,7 @@ export interface HeadingData {
|
|
|
826
826
|
/** Indentation level from 1-4. */
|
|
827
827
|
indentation?: number | null;
|
|
828
828
|
}
|
|
829
|
-
|
|
829
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
830
830
|
/** The URL for the HTML code for the node. */
|
|
831
831
|
url?: string;
|
|
832
832
|
/** The HTML code for the node. */
|
|
@@ -844,7 +844,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
844
844
|
autoHeight?: boolean | null;
|
|
845
845
|
}
|
|
846
846
|
/** @oneof */
|
|
847
|
-
|
|
847
|
+
interface HTMLDataDataOneOf {
|
|
848
848
|
/** The URL for the HTML code for the node. */
|
|
849
849
|
url?: string;
|
|
850
850
|
/** The HTML code for the node. */
|
|
@@ -855,13 +855,13 @@ export interface HTMLDataDataOneOf {
|
|
|
855
855
|
*/
|
|
856
856
|
isAdsense?: boolean | null;
|
|
857
857
|
}
|
|
858
|
-
|
|
858
|
+
declare enum Source {
|
|
859
859
|
HTML = "HTML",
|
|
860
860
|
ADSENSE = "ADSENSE"
|
|
861
861
|
}
|
|
862
862
|
/** @enumType */
|
|
863
|
-
|
|
864
|
-
|
|
863
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
864
|
+
interface ImageData {
|
|
865
865
|
/** Styling for the image's container. */
|
|
866
866
|
containerData?: PluginContainerData;
|
|
867
867
|
/** Image file details. */
|
|
@@ -884,7 +884,7 @@ export interface ImageData {
|
|
|
884
884
|
/** Styling for the image. */
|
|
885
885
|
styles?: ImageDataStyles;
|
|
886
886
|
}
|
|
887
|
-
|
|
887
|
+
interface StylesBorder {
|
|
888
888
|
/** Border width in pixels. */
|
|
889
889
|
width?: number | null;
|
|
890
890
|
/**
|
|
@@ -895,11 +895,11 @@ export interface StylesBorder {
|
|
|
895
895
|
/** Border radius in pixels. */
|
|
896
896
|
radius?: number | null;
|
|
897
897
|
}
|
|
898
|
-
|
|
898
|
+
interface ImageDataStyles {
|
|
899
899
|
/** Border attributes. */
|
|
900
900
|
border?: StylesBorder;
|
|
901
901
|
}
|
|
902
|
-
|
|
902
|
+
interface LinkPreviewData {
|
|
903
903
|
/** Styling for the link preview's container. */
|
|
904
904
|
containerData?: PluginContainerData;
|
|
905
905
|
/** Link details. */
|
|
@@ -915,7 +915,7 @@ export interface LinkPreviewData {
|
|
|
915
915
|
/** Styling for the link preview. */
|
|
916
916
|
styles?: LinkPreviewDataStyles;
|
|
917
917
|
}
|
|
918
|
-
|
|
918
|
+
declare enum Position {
|
|
919
919
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
920
920
|
START = "START",
|
|
921
921
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -926,8 +926,8 @@ export declare enum Position {
|
|
|
926
926
|
HIDDEN = "HIDDEN"
|
|
927
927
|
}
|
|
928
928
|
/** @enumType */
|
|
929
|
-
|
|
930
|
-
|
|
929
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
930
|
+
interface LinkPreviewDataStyles {
|
|
931
931
|
/**
|
|
932
932
|
* Background color as a hexadecimal value.
|
|
933
933
|
* @format COLOR_HEX
|
|
@@ -960,13 +960,13 @@ export interface LinkPreviewDataStyles {
|
|
|
960
960
|
/** Position of thumbnail. Defaults to `START`. */
|
|
961
961
|
thumbnailPosition?: PositionWithLiterals;
|
|
962
962
|
}
|
|
963
|
-
|
|
963
|
+
interface MapData {
|
|
964
964
|
/** Styling for the map's container. */
|
|
965
965
|
containerData?: PluginContainerData;
|
|
966
966
|
/** Map settings. */
|
|
967
967
|
mapSettings?: MapSettings;
|
|
968
968
|
}
|
|
969
|
-
|
|
969
|
+
interface MapSettings {
|
|
970
970
|
/** The address to display on the map. */
|
|
971
971
|
address?: string | null;
|
|
972
972
|
/** Sets whether the map is draggable. */
|
|
@@ -990,7 +990,7 @@ export interface MapSettings {
|
|
|
990
990
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
991
991
|
mapType?: MapTypeWithLiterals;
|
|
992
992
|
}
|
|
993
|
-
|
|
993
|
+
declare enum MapType {
|
|
994
994
|
/** Roadmap map type */
|
|
995
995
|
ROADMAP = "ROADMAP",
|
|
996
996
|
/** Satellite map type */
|
|
@@ -1001,8 +1001,8 @@ export declare enum MapType {
|
|
|
1001
1001
|
TERRAIN = "TERRAIN"
|
|
1002
1002
|
}
|
|
1003
1003
|
/** @enumType */
|
|
1004
|
-
|
|
1005
|
-
|
|
1004
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1005
|
+
interface ParagraphData {
|
|
1006
1006
|
/** Styling for the paragraph text. */
|
|
1007
1007
|
textStyle?: TextStyle;
|
|
1008
1008
|
/** Indentation level from 1-4. */
|
|
@@ -1010,7 +1010,7 @@ export interface ParagraphData {
|
|
|
1010
1010
|
/** Paragraph level */
|
|
1011
1011
|
level?: number | null;
|
|
1012
1012
|
}
|
|
1013
|
-
|
|
1013
|
+
interface PollData {
|
|
1014
1014
|
/** Styling for the poll's container. */
|
|
1015
1015
|
containerData?: PluginContainerData;
|
|
1016
1016
|
/** Poll data. */
|
|
@@ -1020,7 +1020,7 @@ export interface PollData {
|
|
|
1020
1020
|
/** Styling for the poll and voting options. */
|
|
1021
1021
|
design?: Design;
|
|
1022
1022
|
}
|
|
1023
|
-
|
|
1023
|
+
declare enum ViewRole {
|
|
1024
1024
|
/** Only Poll creator can view the results */
|
|
1025
1025
|
CREATOR = "CREATOR",
|
|
1026
1026
|
/** Anyone who voted can see the results */
|
|
@@ -1029,16 +1029,16 @@ export declare enum ViewRole {
|
|
|
1029
1029
|
EVERYONE = "EVERYONE"
|
|
1030
1030
|
}
|
|
1031
1031
|
/** @enumType */
|
|
1032
|
-
|
|
1033
|
-
|
|
1032
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1033
|
+
declare enum VoteRole {
|
|
1034
1034
|
/** Logged in member */
|
|
1035
1035
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1036
1036
|
/** Anyone */
|
|
1037
1037
|
ALL = "ALL"
|
|
1038
1038
|
}
|
|
1039
1039
|
/** @enumType */
|
|
1040
|
-
|
|
1041
|
-
|
|
1040
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1041
|
+
interface Permissions {
|
|
1042
1042
|
/** Sets who can view the poll results. */
|
|
1043
1043
|
view?: ViewRoleWithLiterals;
|
|
1044
1044
|
/** Sets who can vote. */
|
|
@@ -1046,7 +1046,7 @@ export interface Permissions {
|
|
|
1046
1046
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1047
1047
|
allowMultipleVotes?: boolean | null;
|
|
1048
1048
|
}
|
|
1049
|
-
|
|
1049
|
+
interface Option {
|
|
1050
1050
|
/** Option ID. */
|
|
1051
1051
|
id?: string | null;
|
|
1052
1052
|
/** Option title. */
|
|
@@ -1054,7 +1054,7 @@ export interface Option {
|
|
|
1054
1054
|
/** The image displayed with the option. */
|
|
1055
1055
|
image?: Media;
|
|
1056
1056
|
}
|
|
1057
|
-
|
|
1057
|
+
interface Settings {
|
|
1058
1058
|
/** Permissions settings for voting. */
|
|
1059
1059
|
permissions?: Permissions;
|
|
1060
1060
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1062,23 +1062,23 @@ export interface Settings {
|
|
|
1062
1062
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1063
1063
|
showVotesCount?: boolean | null;
|
|
1064
1064
|
}
|
|
1065
|
-
|
|
1065
|
+
declare enum PollLayoutType {
|
|
1066
1066
|
/** List */
|
|
1067
1067
|
LIST = "LIST",
|
|
1068
1068
|
/** Grid */
|
|
1069
1069
|
GRID = "GRID"
|
|
1070
1070
|
}
|
|
1071
1071
|
/** @enumType */
|
|
1072
|
-
|
|
1073
|
-
|
|
1072
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1073
|
+
declare enum PollLayoutDirection {
|
|
1074
1074
|
/** Left-to-right */
|
|
1075
1075
|
LTR = "LTR",
|
|
1076
1076
|
/** Right-to-left */
|
|
1077
1077
|
RTL = "RTL"
|
|
1078
1078
|
}
|
|
1079
1079
|
/** @enumType */
|
|
1080
|
-
|
|
1081
|
-
|
|
1080
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1081
|
+
interface PollLayout {
|
|
1082
1082
|
/** The layout for displaying the voting options. */
|
|
1083
1083
|
type?: PollLayoutTypeWithLiterals;
|
|
1084
1084
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1086,11 +1086,11 @@ export interface PollLayout {
|
|
|
1086
1086
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1087
1087
|
enableImage?: boolean | null;
|
|
1088
1088
|
}
|
|
1089
|
-
|
|
1089
|
+
interface OptionLayout {
|
|
1090
1090
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1091
1091
|
enableImage?: boolean | null;
|
|
1092
1092
|
}
|
|
1093
|
-
|
|
1093
|
+
declare enum BackgroundType {
|
|
1094
1094
|
/** Color background type */
|
|
1095
1095
|
COLOR = "COLOR",
|
|
1096
1096
|
/** Image background type */
|
|
@@ -1099,8 +1099,8 @@ export declare enum BackgroundType {
|
|
|
1099
1099
|
GRADIENT = "GRADIENT"
|
|
1100
1100
|
}
|
|
1101
1101
|
/** @enumType */
|
|
1102
|
-
|
|
1103
|
-
|
|
1102
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1103
|
+
interface Gradient {
|
|
1104
1104
|
/** The gradient angle in degrees. */
|
|
1105
1105
|
angle?: number | null;
|
|
1106
1106
|
/**
|
|
@@ -1114,7 +1114,7 @@ export interface Gradient {
|
|
|
1114
1114
|
*/
|
|
1115
1115
|
lastColor?: string | null;
|
|
1116
1116
|
}
|
|
1117
|
-
|
|
1117
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1118
1118
|
/**
|
|
1119
1119
|
* The background color as a hexademical value.
|
|
1120
1120
|
* @format COLOR_HEX
|
|
@@ -1128,7 +1128,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1128
1128
|
type?: BackgroundTypeWithLiterals;
|
|
1129
1129
|
}
|
|
1130
1130
|
/** @oneof */
|
|
1131
|
-
|
|
1131
|
+
interface BackgroundBackgroundOneOf {
|
|
1132
1132
|
/**
|
|
1133
1133
|
* The background color as a hexademical value.
|
|
1134
1134
|
* @format COLOR_HEX
|
|
@@ -1139,17 +1139,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1139
1139
|
/** Details for a gradient background. */
|
|
1140
1140
|
gradient?: Gradient;
|
|
1141
1141
|
}
|
|
1142
|
-
|
|
1142
|
+
interface PollDesign {
|
|
1143
1143
|
/** Background styling. */
|
|
1144
1144
|
background?: Background;
|
|
1145
1145
|
/** Border radius in pixels. */
|
|
1146
1146
|
borderRadius?: number | null;
|
|
1147
1147
|
}
|
|
1148
|
-
|
|
1148
|
+
interface OptionDesign {
|
|
1149
1149
|
/** Border radius in pixels. */
|
|
1150
1150
|
borderRadius?: number | null;
|
|
1151
1151
|
}
|
|
1152
|
-
|
|
1152
|
+
interface Poll {
|
|
1153
1153
|
/** Poll ID. */
|
|
1154
1154
|
id?: string | null;
|
|
1155
1155
|
/** Poll title. */
|
|
@@ -1163,26 +1163,26 @@ export interface Poll {
|
|
|
1163
1163
|
/** The poll's permissions and display settings. */
|
|
1164
1164
|
settings?: Settings;
|
|
1165
1165
|
}
|
|
1166
|
-
|
|
1166
|
+
interface PollDataLayout {
|
|
1167
1167
|
/** Poll layout settings. */
|
|
1168
1168
|
poll?: PollLayout;
|
|
1169
1169
|
/** Voting otpions layout settings. */
|
|
1170
1170
|
options?: OptionLayout;
|
|
1171
1171
|
}
|
|
1172
|
-
|
|
1172
|
+
interface Design {
|
|
1173
1173
|
/** Styling for the poll. */
|
|
1174
1174
|
poll?: PollDesign;
|
|
1175
1175
|
/** Styling for voting options. */
|
|
1176
1176
|
options?: OptionDesign;
|
|
1177
1177
|
}
|
|
1178
|
-
|
|
1178
|
+
interface TextData {
|
|
1179
1179
|
/** The text to apply decorations to. */
|
|
1180
1180
|
text?: string;
|
|
1181
1181
|
/** The decorations to apply. */
|
|
1182
1182
|
decorations?: Decoration[];
|
|
1183
1183
|
}
|
|
1184
1184
|
/** Adds appearence changes to text */
|
|
1185
|
-
|
|
1185
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1186
1186
|
/** Data for an anchor link decoration. */
|
|
1187
1187
|
anchorData?: AnchorData;
|
|
1188
1188
|
/** Data for a color decoration. */
|
|
@@ -1207,7 +1207,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1207
1207
|
type?: DecorationTypeWithLiterals;
|
|
1208
1208
|
}
|
|
1209
1209
|
/** @oneof */
|
|
1210
|
-
|
|
1210
|
+
interface DecorationDataOneOf {
|
|
1211
1211
|
/** Data for an anchor link decoration. */
|
|
1212
1212
|
anchorData?: AnchorData;
|
|
1213
1213
|
/** Data for a color decoration. */
|
|
@@ -1229,7 +1229,7 @@ export interface DecorationDataOneOf {
|
|
|
1229
1229
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1230
1230
|
strikethroughData?: boolean | null;
|
|
1231
1231
|
}
|
|
1232
|
-
|
|
1232
|
+
declare enum DecorationType {
|
|
1233
1233
|
BOLD = "BOLD",
|
|
1234
1234
|
ITALIC = "ITALIC",
|
|
1235
1235
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1243,22 +1243,22 @@ export declare enum DecorationType {
|
|
|
1243
1243
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1244
1244
|
}
|
|
1245
1245
|
/** @enumType */
|
|
1246
|
-
|
|
1247
|
-
|
|
1246
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1247
|
+
interface AnchorData {
|
|
1248
1248
|
/** The target node's ID. */
|
|
1249
1249
|
anchor?: string;
|
|
1250
1250
|
}
|
|
1251
|
-
|
|
1251
|
+
interface ColorData {
|
|
1252
1252
|
/** The text's background color as a hexadecimal value. */
|
|
1253
1253
|
background?: string | null;
|
|
1254
1254
|
/** The text's foreground color as a hexadecimal value. */
|
|
1255
1255
|
foreground?: string | null;
|
|
1256
1256
|
}
|
|
1257
|
-
|
|
1257
|
+
interface LinkData {
|
|
1258
1258
|
/** Link details. */
|
|
1259
1259
|
link?: Link;
|
|
1260
1260
|
}
|
|
1261
|
-
|
|
1261
|
+
interface MentionData {
|
|
1262
1262
|
/** The mentioned user's name. */
|
|
1263
1263
|
name?: string;
|
|
1264
1264
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1266,23 +1266,23 @@ export interface MentionData {
|
|
|
1266
1266
|
/** Mentioned user's ID. */
|
|
1267
1267
|
id?: string | null;
|
|
1268
1268
|
}
|
|
1269
|
-
|
|
1269
|
+
interface FontSizeData {
|
|
1270
1270
|
/** The units used for the font size. */
|
|
1271
1271
|
unit?: FontTypeWithLiterals;
|
|
1272
1272
|
/** Font size value. */
|
|
1273
1273
|
value?: number | null;
|
|
1274
1274
|
}
|
|
1275
|
-
|
|
1275
|
+
declare enum FontType {
|
|
1276
1276
|
PX = "PX",
|
|
1277
1277
|
EM = "EM"
|
|
1278
1278
|
}
|
|
1279
1279
|
/** @enumType */
|
|
1280
|
-
|
|
1281
|
-
|
|
1280
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1281
|
+
interface SpoilerData {
|
|
1282
1282
|
/** Spoiler ID. */
|
|
1283
1283
|
id?: string | null;
|
|
1284
1284
|
}
|
|
1285
|
-
|
|
1285
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1286
1286
|
/** Data for embedded Wix Bookings content. */
|
|
1287
1287
|
bookingData?: BookingData;
|
|
1288
1288
|
/** Data for embedded Wix Events content. */
|
|
@@ -1304,30 +1304,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1304
1304
|
image?: Media;
|
|
1305
1305
|
}
|
|
1306
1306
|
/** @oneof */
|
|
1307
|
-
|
|
1307
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1308
1308
|
/** Data for embedded Wix Bookings content. */
|
|
1309
1309
|
bookingData?: BookingData;
|
|
1310
1310
|
/** Data for embedded Wix Events content. */
|
|
1311
1311
|
eventData?: EventData;
|
|
1312
1312
|
}
|
|
1313
|
-
|
|
1313
|
+
declare enum AppType {
|
|
1314
1314
|
PRODUCT = "PRODUCT",
|
|
1315
1315
|
EVENT = "EVENT",
|
|
1316
1316
|
BOOKING = "BOOKING"
|
|
1317
1317
|
}
|
|
1318
1318
|
/** @enumType */
|
|
1319
|
-
|
|
1320
|
-
|
|
1319
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1320
|
+
interface BookingData {
|
|
1321
1321
|
/** Booking duration in minutes. */
|
|
1322
1322
|
durations?: string | null;
|
|
1323
1323
|
}
|
|
1324
|
-
|
|
1324
|
+
interface EventData {
|
|
1325
1325
|
/** Event schedule. */
|
|
1326
1326
|
scheduling?: string | null;
|
|
1327
1327
|
/** Event location. */
|
|
1328
1328
|
location?: string | null;
|
|
1329
1329
|
}
|
|
1330
|
-
|
|
1330
|
+
interface VideoData {
|
|
1331
1331
|
/** Styling for the video's container. */
|
|
1332
1332
|
containerData?: PluginContainerData;
|
|
1333
1333
|
/** Video details. */
|
|
@@ -1341,7 +1341,7 @@ export interface VideoData {
|
|
|
1341
1341
|
/** Video options. */
|
|
1342
1342
|
options?: PlaybackOptions;
|
|
1343
1343
|
}
|
|
1344
|
-
|
|
1344
|
+
interface PlaybackOptions {
|
|
1345
1345
|
/** Sets whether the media will automatically start playing. */
|
|
1346
1346
|
autoPlay?: boolean | null;
|
|
1347
1347
|
/** Sets whether media's will be looped. */
|
|
@@ -1349,7 +1349,7 @@ export interface PlaybackOptions {
|
|
|
1349
1349
|
/** Sets whether media's controls will be shown. */
|
|
1350
1350
|
showControls?: boolean | null;
|
|
1351
1351
|
}
|
|
1352
|
-
|
|
1352
|
+
interface EmbedData {
|
|
1353
1353
|
/** Styling for the oEmbed node's container. */
|
|
1354
1354
|
containerData?: PluginContainerData;
|
|
1355
1355
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1357,7 +1357,7 @@ export interface EmbedData {
|
|
|
1357
1357
|
/** Origin asset source. */
|
|
1358
1358
|
src?: string | null;
|
|
1359
1359
|
}
|
|
1360
|
-
|
|
1360
|
+
interface Oembed {
|
|
1361
1361
|
/** The resource type. */
|
|
1362
1362
|
type?: string | null;
|
|
1363
1363
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1389,7 +1389,7 @@ export interface Oembed {
|
|
|
1389
1389
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1390
1390
|
version?: string | null;
|
|
1391
1391
|
}
|
|
1392
|
-
|
|
1392
|
+
interface CollapsibleListData {
|
|
1393
1393
|
/** Styling for the collapsible list's container. */
|
|
1394
1394
|
containerData?: PluginContainerData;
|
|
1395
1395
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1401,7 +1401,7 @@ export interface CollapsibleListData {
|
|
|
1401
1401
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1402
1402
|
isQapageData?: boolean | null;
|
|
1403
1403
|
}
|
|
1404
|
-
|
|
1404
|
+
declare enum InitialExpandedItems {
|
|
1405
1405
|
/** First item will be expended initally */
|
|
1406
1406
|
FIRST = "FIRST",
|
|
1407
1407
|
/** All items will expended initally */
|
|
@@ -1410,16 +1410,16 @@ export declare enum InitialExpandedItems {
|
|
|
1410
1410
|
NONE = "NONE"
|
|
1411
1411
|
}
|
|
1412
1412
|
/** @enumType */
|
|
1413
|
-
|
|
1414
|
-
|
|
1413
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1414
|
+
declare enum Direction {
|
|
1415
1415
|
/** Left-to-right */
|
|
1416
1416
|
LTR = "LTR",
|
|
1417
1417
|
/** Right-to-left */
|
|
1418
1418
|
RTL = "RTL"
|
|
1419
1419
|
}
|
|
1420
1420
|
/** @enumType */
|
|
1421
|
-
|
|
1422
|
-
|
|
1421
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1422
|
+
interface TableData {
|
|
1423
1423
|
/** Styling for the table's container. */
|
|
1424
1424
|
containerData?: PluginContainerData;
|
|
1425
1425
|
/** The table's dimensions. */
|
|
@@ -1434,7 +1434,7 @@ export interface TableData {
|
|
|
1434
1434
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1435
1435
|
columnHeader?: boolean | null;
|
|
1436
1436
|
}
|
|
1437
|
-
|
|
1437
|
+
interface Dimensions {
|
|
1438
1438
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1439
1439
|
colsWidthRatio?: number[];
|
|
1440
1440
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1442,13 +1442,13 @@ export interface Dimensions {
|
|
|
1442
1442
|
/** An array representing the minimum width of each column in pixels. */
|
|
1443
1443
|
colsMinWidth?: number[];
|
|
1444
1444
|
}
|
|
1445
|
-
|
|
1445
|
+
interface TableCellData {
|
|
1446
1446
|
/** Styling for the cell's background color and text alignment. */
|
|
1447
1447
|
cellStyle?: CellStyle;
|
|
1448
1448
|
/** The cell's border colors. */
|
|
1449
1449
|
borderColors?: BorderColors;
|
|
1450
1450
|
}
|
|
1451
|
-
|
|
1451
|
+
declare enum VerticalAlignment {
|
|
1452
1452
|
/** Top alignment */
|
|
1453
1453
|
TOP = "TOP",
|
|
1454
1454
|
/** Middle alignment */
|
|
@@ -1457,8 +1457,8 @@ export declare enum VerticalAlignment {
|
|
|
1457
1457
|
BOTTOM = "BOTTOM"
|
|
1458
1458
|
}
|
|
1459
1459
|
/** @enumType */
|
|
1460
|
-
|
|
1461
|
-
|
|
1460
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1461
|
+
interface CellStyle {
|
|
1462
1462
|
/** Vertical alignment for the cell's text. */
|
|
1463
1463
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1464
1464
|
/**
|
|
@@ -1467,7 +1467,7 @@ export interface CellStyle {
|
|
|
1467
1467
|
*/
|
|
1468
1468
|
backgroundColor?: string | null;
|
|
1469
1469
|
}
|
|
1470
|
-
|
|
1470
|
+
interface BorderColors {
|
|
1471
1471
|
/**
|
|
1472
1472
|
* Left border color as a hexadecimal value.
|
|
1473
1473
|
* @format COLOR_HEX
|
|
@@ -1495,22 +1495,20 @@ export interface BorderColors {
|
|
|
1495
1495
|
*
|
|
1496
1496
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1497
1497
|
*/
|
|
1498
|
-
|
|
1498
|
+
declare enum NullValue {
|
|
1499
1499
|
/** Null value. */
|
|
1500
1500
|
NULL_VALUE = "NULL_VALUE"
|
|
1501
1501
|
}
|
|
1502
|
-
/** @enumType */
|
|
1503
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1504
1502
|
/**
|
|
1505
1503
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1506
1504
|
*
|
|
1507
1505
|
* The JSON representation for `ListValue` is JSON array.
|
|
1508
1506
|
*/
|
|
1509
|
-
|
|
1507
|
+
interface ListValue {
|
|
1510
1508
|
/** Repeated field of dynamically typed values. */
|
|
1511
1509
|
values?: any[];
|
|
1512
1510
|
}
|
|
1513
|
-
|
|
1511
|
+
interface AudioData {
|
|
1514
1512
|
/** Styling for the audio node's container. */
|
|
1515
1513
|
containerData?: PluginContainerData;
|
|
1516
1514
|
/** Audio file details. */
|
|
@@ -1526,7 +1524,7 @@ export interface AudioData {
|
|
|
1526
1524
|
/** An HTML version of the audio node. */
|
|
1527
1525
|
html?: string | null;
|
|
1528
1526
|
}
|
|
1529
|
-
|
|
1527
|
+
interface OrderedListData {
|
|
1530
1528
|
/** Indentation level from 0-4. */
|
|
1531
1529
|
indentation?: number;
|
|
1532
1530
|
/** Offset level from 0-4. */
|
|
@@ -1534,24 +1532,24 @@ export interface OrderedListData {
|
|
|
1534
1532
|
/** List start number. */
|
|
1535
1533
|
start?: number | null;
|
|
1536
1534
|
}
|
|
1537
|
-
|
|
1535
|
+
interface BulletedListData {
|
|
1538
1536
|
/** Indentation level from 0-4. */
|
|
1539
1537
|
indentation?: number;
|
|
1540
1538
|
/** Offset level from 0-4. */
|
|
1541
1539
|
offset?: number | null;
|
|
1542
1540
|
}
|
|
1543
|
-
|
|
1541
|
+
interface BlockquoteData {
|
|
1544
1542
|
/** Indentation level from 1-4. */
|
|
1545
1543
|
indentation?: number;
|
|
1546
1544
|
}
|
|
1547
|
-
|
|
1545
|
+
interface CaptionData {
|
|
1548
1546
|
textStyle?: TextStyle;
|
|
1549
1547
|
}
|
|
1550
|
-
|
|
1548
|
+
interface LayoutCellData {
|
|
1551
1549
|
/** Size of the cell in 12 columns grid. */
|
|
1552
1550
|
colSpan?: number | null;
|
|
1553
1551
|
}
|
|
1554
|
-
|
|
1552
|
+
interface Metadata {
|
|
1555
1553
|
/** Schema version. */
|
|
1556
1554
|
version?: number;
|
|
1557
1555
|
/**
|
|
@@ -1568,7 +1566,7 @@ export interface Metadata {
|
|
|
1568
1566
|
/** Object ID. */
|
|
1569
1567
|
_id?: string | null;
|
|
1570
1568
|
}
|
|
1571
|
-
|
|
1569
|
+
interface DocumentStyle {
|
|
1572
1570
|
/** Styling for H1 nodes. */
|
|
1573
1571
|
headerOne?: TextNodeStyle;
|
|
1574
1572
|
/** Styling for H2 nodes. */
|
|
@@ -1588,7 +1586,7 @@ export interface DocumentStyle {
|
|
|
1588
1586
|
/** Styling for code block nodes. */
|
|
1589
1587
|
codeBlock?: TextNodeStyle;
|
|
1590
1588
|
}
|
|
1591
|
-
|
|
1589
|
+
interface TextNodeStyle {
|
|
1592
1590
|
/** The decorations to apply to the node. */
|
|
1593
1591
|
decorations?: Decoration[];
|
|
1594
1592
|
/** Padding and background color for the node. */
|
|
@@ -1596,7 +1594,7 @@ export interface TextNodeStyle {
|
|
|
1596
1594
|
/** Line height for text in the node. */
|
|
1597
1595
|
lineHeight?: string | null;
|
|
1598
1596
|
}
|
|
1599
|
-
|
|
1597
|
+
interface FocalPoint {
|
|
1600
1598
|
/** X-coordinate of the focal point. */
|
|
1601
1599
|
x?: number;
|
|
1602
1600
|
/** Y-coordinate of the focal point. */
|
|
@@ -1606,7 +1604,7 @@ export interface FocalPoint {
|
|
|
1606
1604
|
/** crop by width */
|
|
1607
1605
|
width?: number | null;
|
|
1608
1606
|
}
|
|
1609
|
-
|
|
1607
|
+
interface VideoResolution {
|
|
1610
1608
|
/** Video URL. */
|
|
1611
1609
|
url?: string;
|
|
1612
1610
|
/** Video height. */
|
|
@@ -1616,7 +1614,7 @@ export interface VideoResolution {
|
|
|
1616
1614
|
/** Video format for example, mp4, hls. */
|
|
1617
1615
|
format?: string;
|
|
1618
1616
|
}
|
|
1619
|
-
|
|
1617
|
+
interface ExtendedFields {
|
|
1620
1618
|
/**
|
|
1621
1619
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1622
1620
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -1627,22 +1625,22 @@ export interface ExtendedFields {
|
|
|
1627
1625
|
*/
|
|
1628
1626
|
namespaces?: Record<string, Record<string, any>>;
|
|
1629
1627
|
}
|
|
1630
|
-
|
|
1628
|
+
interface GetPublishedContentRequest {
|
|
1631
1629
|
/**
|
|
1632
1630
|
* The ID of the published content
|
|
1633
1631
|
* @format GUID
|
|
1634
1632
|
*/
|
|
1635
1633
|
contentId?: string;
|
|
1636
1634
|
}
|
|
1637
|
-
|
|
1635
|
+
interface GetPublishedContentResponse {
|
|
1638
1636
|
/** The published content */
|
|
1639
1637
|
publishedContent?: PublishedContent;
|
|
1640
1638
|
}
|
|
1641
|
-
|
|
1639
|
+
interface QueryPublishedContentRequest {
|
|
1642
1640
|
/** Query options. Note that some query filters are required. See the API description for a list of required filters. */
|
|
1643
1641
|
query: CursorQuery;
|
|
1644
1642
|
}
|
|
1645
|
-
|
|
1643
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1646
1644
|
/**
|
|
1647
1645
|
* Cursor paging options.
|
|
1648
1646
|
*
|
|
@@ -1664,7 +1662,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1664
1662
|
sort?: Sorting[];
|
|
1665
1663
|
}
|
|
1666
1664
|
/** @oneof */
|
|
1667
|
-
|
|
1665
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1668
1666
|
/**
|
|
1669
1667
|
* Cursor paging options.
|
|
1670
1668
|
*
|
|
@@ -1672,7 +1670,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
1672
1670
|
*/
|
|
1673
1671
|
cursorPaging?: CursorPaging;
|
|
1674
1672
|
}
|
|
1675
|
-
|
|
1673
|
+
interface Sorting {
|
|
1676
1674
|
/**
|
|
1677
1675
|
* Name of the field to sort by.
|
|
1678
1676
|
* @maxLength 512
|
|
@@ -1681,13 +1679,13 @@ export interface Sorting {
|
|
|
1681
1679
|
/** Sort order. */
|
|
1682
1680
|
order?: SortOrderWithLiterals;
|
|
1683
1681
|
}
|
|
1684
|
-
|
|
1682
|
+
declare enum SortOrder {
|
|
1685
1683
|
ASC = "ASC",
|
|
1686
1684
|
DESC = "DESC"
|
|
1687
1685
|
}
|
|
1688
1686
|
/** @enumType */
|
|
1689
|
-
|
|
1690
|
-
|
|
1687
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1688
|
+
interface CursorPaging {
|
|
1691
1689
|
/**
|
|
1692
1690
|
* Maximum number of items to return in the results.
|
|
1693
1691
|
* @max 100
|
|
@@ -1702,13 +1700,13 @@ export interface CursorPaging {
|
|
|
1702
1700
|
*/
|
|
1703
1701
|
cursor?: string | null;
|
|
1704
1702
|
}
|
|
1705
|
-
|
|
1703
|
+
interface QueryPublishedContentResponse {
|
|
1706
1704
|
/** The published translation content. */
|
|
1707
1705
|
publishedContent?: PublishedContent[];
|
|
1708
1706
|
/** Details on the paged set of results returned. */
|
|
1709
1707
|
pagingMetadata?: CursorPagingMetadata;
|
|
1710
1708
|
}
|
|
1711
|
-
|
|
1709
|
+
interface CursorPagingMetadata {
|
|
1712
1710
|
/** Number of items returned in current page. */
|
|
1713
1711
|
count?: number | null;
|
|
1714
1712
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1721,7 +1719,7 @@ export interface CursorPagingMetadata {
|
|
|
1721
1719
|
*/
|
|
1722
1720
|
hasNext?: boolean | null;
|
|
1723
1721
|
}
|
|
1724
|
-
|
|
1722
|
+
interface Cursors {
|
|
1725
1723
|
/**
|
|
1726
1724
|
* Cursor string pointing to the next page in the list of results.
|
|
1727
1725
|
* @maxLength 16000
|
|
@@ -1733,7 +1731,7 @@ export interface Cursors {
|
|
|
1733
1731
|
*/
|
|
1734
1732
|
prev?: string | null;
|
|
1735
1733
|
}
|
|
1736
|
-
|
|
1734
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1737
1735
|
createdEvent?: EntityCreatedEvent;
|
|
1738
1736
|
updatedEvent?: EntityUpdatedEvent;
|
|
1739
1737
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1768,19 +1766,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1768
1766
|
entityEventSequence?: string | null;
|
|
1769
1767
|
}
|
|
1770
1768
|
/** @oneof */
|
|
1771
|
-
|
|
1769
|
+
interface DomainEventBodyOneOf {
|
|
1772
1770
|
createdEvent?: EntityCreatedEvent;
|
|
1773
1771
|
updatedEvent?: EntityUpdatedEvent;
|
|
1774
1772
|
deletedEvent?: EntityDeletedEvent;
|
|
1775
1773
|
actionEvent?: ActionEvent;
|
|
1776
1774
|
}
|
|
1777
|
-
|
|
1775
|
+
interface EntityCreatedEvent {
|
|
1778
1776
|
entity?: string;
|
|
1779
1777
|
}
|
|
1780
|
-
|
|
1778
|
+
interface RestoreInfo {
|
|
1781
1779
|
deletedDate?: Date | null;
|
|
1782
1780
|
}
|
|
1783
|
-
|
|
1781
|
+
interface EntityUpdatedEvent {
|
|
1784
1782
|
/**
|
|
1785
1783
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1786
1784
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1788,25 +1786,25 @@ export interface EntityUpdatedEvent {
|
|
|
1788
1786
|
*/
|
|
1789
1787
|
currentEntity?: string;
|
|
1790
1788
|
}
|
|
1791
|
-
|
|
1789
|
+
interface EntityDeletedEvent {
|
|
1792
1790
|
/** Entity that was deleted. */
|
|
1793
1791
|
deletedEntity?: string | null;
|
|
1794
1792
|
}
|
|
1795
|
-
|
|
1793
|
+
interface ActionEvent {
|
|
1796
1794
|
body?: string;
|
|
1797
1795
|
}
|
|
1798
|
-
|
|
1796
|
+
interface Empty {
|
|
1799
1797
|
}
|
|
1800
|
-
|
|
1798
|
+
interface DeletePublishedContentRequest {
|
|
1801
1799
|
/**
|
|
1802
1800
|
* The ID of the published content to delete
|
|
1803
1801
|
* @format GUID
|
|
1804
1802
|
*/
|
|
1805
1803
|
contentId?: string;
|
|
1806
1804
|
}
|
|
1807
|
-
|
|
1805
|
+
interface DeletePublishedContentResponse {
|
|
1808
1806
|
}
|
|
1809
|
-
|
|
1807
|
+
interface MessageEnvelope {
|
|
1810
1808
|
/**
|
|
1811
1809
|
* App instance ID.
|
|
1812
1810
|
* @format GUID
|
|
@@ -1822,7 +1820,7 @@ export interface MessageEnvelope {
|
|
|
1822
1820
|
/** Stringify payload. */
|
|
1823
1821
|
data?: string;
|
|
1824
1822
|
}
|
|
1825
|
-
|
|
1823
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1826
1824
|
/**
|
|
1827
1825
|
* ID of a site visitor that has not logged in to the site.
|
|
1828
1826
|
* @format GUID
|
|
@@ -1847,7 +1845,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1847
1845
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1848
1846
|
}
|
|
1849
1847
|
/** @oneof */
|
|
1850
|
-
|
|
1848
|
+
interface IdentificationDataIdOneOf {
|
|
1851
1849
|
/**
|
|
1852
1850
|
* ID of a site visitor that has not logged in to the site.
|
|
1853
1851
|
* @format GUID
|
|
@@ -1869,7 +1867,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1869
1867
|
*/
|
|
1870
1868
|
appId?: string;
|
|
1871
1869
|
}
|
|
1872
|
-
|
|
1870
|
+
declare enum WebhookIdentityType {
|
|
1873
1871
|
UNKNOWN = "UNKNOWN",
|
|
1874
1872
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1875
1873
|
MEMBER = "MEMBER",
|
|
@@ -1877,8 +1875,8 @@ export declare enum WebhookIdentityType {
|
|
|
1877
1875
|
APP = "APP"
|
|
1878
1876
|
}
|
|
1879
1877
|
/** @enumType */
|
|
1880
|
-
|
|
1881
|
-
|
|
1878
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1879
|
+
interface BaseEventMetadata {
|
|
1882
1880
|
/**
|
|
1883
1881
|
* App instance ID.
|
|
1884
1882
|
* @format GUID
|
|
@@ -1892,7 +1890,7 @@ export interface BaseEventMetadata {
|
|
|
1892
1890
|
/** The identification type and identity data. */
|
|
1893
1891
|
identity?: IdentificationData;
|
|
1894
1892
|
}
|
|
1895
|
-
|
|
1893
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1896
1894
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1897
1895
|
_id?: string;
|
|
1898
1896
|
/**
|
|
@@ -1922,86 +1920,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1922
1920
|
*/
|
|
1923
1921
|
entityEventSequence?: string | null;
|
|
1924
1922
|
}
|
|
1925
|
-
|
|
1923
|
+
interface PublishedContentCreatedEnvelope {
|
|
1926
1924
|
entity: PublishedContent;
|
|
1927
1925
|
metadata: EventMetadata;
|
|
1928
1926
|
}
|
|
1929
|
-
|
|
1930
|
-
* Triggered when published content is created.
|
|
1931
|
-
* @permissionScope Wix Multilingual - Translation API
|
|
1932
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1933
|
-
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1934
|
-
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1935
|
-
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1936
|
-
* @webhook
|
|
1937
|
-
* @eventType wix.multilingual.localization_public.v3.published_content_created
|
|
1938
|
-
* @slug created
|
|
1939
|
-
*/
|
|
1940
|
-
export declare function onPublishedContentCreated(handler: (event: PublishedContentCreatedEnvelope) => void | Promise<void>): void;
|
|
1941
|
-
export interface PublishedContentDeletedEnvelope {
|
|
1927
|
+
interface PublishedContentDeletedEnvelope {
|
|
1942
1928
|
entity: PublishedContent;
|
|
1943
1929
|
metadata: EventMetadata;
|
|
1944
1930
|
}
|
|
1945
|
-
|
|
1946
|
-
* Triggered when published content is deleted.
|
|
1947
|
-
* @permissionScope Wix Multilingual - Translation API
|
|
1948
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1949
|
-
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1950
|
-
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1951
|
-
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1952
|
-
* @webhook
|
|
1953
|
-
* @eventType wix.multilingual.localization_public.v3.published_content_deleted
|
|
1954
|
-
* @slug deleted
|
|
1955
|
-
*/
|
|
1956
|
-
export declare function onPublishedContentDeleted(handler: (event: PublishedContentDeletedEnvelope) => void | Promise<void>): void;
|
|
1957
|
-
export interface PublishedContentUpdatedEnvelope {
|
|
1931
|
+
interface PublishedContentUpdatedEnvelope {
|
|
1958
1932
|
entity: PublishedContent;
|
|
1959
1933
|
metadata: EventMetadata;
|
|
1960
1934
|
}
|
|
1961
|
-
/**
|
|
1962
|
-
* Triggered when published content is updated.
|
|
1963
|
-
* @permissionScope Wix Multilingual - Translation API
|
|
1964
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1965
|
-
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1966
|
-
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1967
|
-
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1968
|
-
* @webhook
|
|
1969
|
-
* @eventType wix.multilingual.localization_public.v3.published_content_updated
|
|
1970
|
-
* @slug updated
|
|
1971
|
-
*/
|
|
1972
|
-
export declare function onPublishedContentUpdated(handler: (event: PublishedContentUpdatedEnvelope) => void | Promise<void>): void;
|
|
1973
|
-
/**
|
|
1974
|
-
* Creates a query to retrieve a list of translation content items.
|
|
1975
|
-
*
|
|
1976
|
-
* The `queryPublishedContent()` function builds a query to retrieve a list of translation content items and returns a `PublishedContentQueryBuilder` object.
|
|
1977
|
-
*
|
|
1978
|
-
* The returned object contains the query definition, which is used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/find) function.
|
|
1979
|
-
*
|
|
1980
|
-
* You can refine the query by chaining `PublishedContentQueryBuilder` functions onto the query. `PublishedContentQueryBuilder` functions enable you to filter, sort, and control the results that `queryPublishedContent()` returns.
|
|
1981
|
-
*
|
|
1982
|
-
* `queryPublishedContent()` runs with the following `PublishedContentQueryBuilder` defaults which you can override:
|
|
1983
|
-
*
|
|
1984
|
-
* + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/limit)
|
|
1985
|
-
* + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/ascending)
|
|
1986
|
-
*
|
|
1987
|
-
* The following query filter fields are required:
|
|
1988
|
-
*
|
|
1989
|
-
* + `schemaKey.appId`
|
|
1990
|
-
* + `schemaKey.entityType`
|
|
1991
|
-
* + `schemaKey.scope`
|
|
1992
|
-
*
|
|
1993
|
-
* The following `PublishedContentQueryBuilder` functions are supported for `queryPublishedContent()`. For a full description of the operations object, see the object returned for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-result/items) property in `PublishedContentQueryResult`.
|
|
1994
|
-
* @public
|
|
1995
|
-
* @permissionScope Wix Multilingual - Translation API
|
|
1996
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1997
|
-
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1998
|
-
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1999
|
-
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
2000
|
-
* @applicableIdentity APP
|
|
2001
|
-
* @applicableIdentity VISITOR
|
|
2002
|
-
* @fqn com.wixpress.localizationpublic.v3.TranslationPublishedContent.QueryPublishedContent
|
|
2003
|
-
*/
|
|
2004
|
-
export declare function queryPublishedContent(): PublishedContentQueryBuilder;
|
|
2005
1935
|
interface QueryCursorResult {
|
|
2006
1936
|
cursors: Cursors;
|
|
2007
1937
|
hasNext: () => boolean;
|
|
@@ -2009,13 +1939,13 @@ interface QueryCursorResult {
|
|
|
2009
1939
|
length: number;
|
|
2010
1940
|
pageSize: number;
|
|
2011
1941
|
}
|
|
2012
|
-
|
|
1942
|
+
interface PublishedContentQueryResult extends QueryCursorResult {
|
|
2013
1943
|
items: PublishedContent[];
|
|
2014
1944
|
query: PublishedContentQueryBuilder;
|
|
2015
1945
|
next: () => Promise<PublishedContentQueryResult>;
|
|
2016
1946
|
prev: () => Promise<PublishedContentQueryResult>;
|
|
2017
1947
|
}
|
|
2018
|
-
|
|
1948
|
+
interface PublishedContentQueryBuilder {
|
|
2019
1949
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2020
1950
|
* @param value - Value to compare against.
|
|
2021
1951
|
*/
|
|
@@ -2060,4 +1990,5 @@ export interface PublishedContentQueryBuilder {
|
|
|
2060
1990
|
skipTo: (cursor: string) => PublishedContentQueryBuilder;
|
|
2061
1991
|
find: () => Promise<PublishedContentQueryResult>;
|
|
2062
1992
|
}
|
|
2063
|
-
|
|
1993
|
+
|
|
1994
|
+
export { type Styles as $, Alignment as A, BackgroundType as B, Crop as C, DecorationType as D, type NodeDataOneOf as E, FontType as F, GIFType as G, type NodeStyle as H, InitialExpandedItems as I, type ButtonData as J, type Border as K, LineStyle as L, MapType as M, NodeType as N, Orientation as O, type PublishedContentQueryBuilder as P, type Colors as Q, type RichContent as R, SchemaScope as S, Type as T, type PluginContainerData as U, ViewMode as V, WidthType as W, type PluginContainerDataWidth as X, type PluginContainerDataWidthDataOneOf as Y, type Spoiler as Z, type Height as _, type PublishedContentCreatedEnvelope as a, type Oembed as a$, type Link as a0, type LinkDataOneOf as a1, type Rel as a2, type CodeBlockData as a3, type TextStyle as a4, type DividerData as a5, type FileData as a6, type FileSource as a7, type FileSourceDataOneOf as a8, type PDFSettings as a9, type Settings as aA, type PollLayout as aB, type OptionLayout as aC, type Gradient as aD, type Background as aE, type BackgroundBackgroundOneOf as aF, type PollDesign as aG, type OptionDesign as aH, type Poll as aI, type PollDataLayout as aJ, type Design as aK, type TextData as aL, type Decoration as aM, type DecorationDataOneOf as aN, type AnchorData as aO, type ColorData as aP, type LinkData as aQ, type MentionData as aR, type FontSizeData as aS, type SpoilerData as aT, type AppEmbedData as aU, type AppEmbedDataAppDataOneOf as aV, type BookingData as aW, type EventData as aX, type VideoData as aY, type PlaybackOptions as aZ, type EmbedData as a_, type GalleryData as aa, type Media as ab, type Image as ac, type Video as ad, type Item as ae, type ItemDataOneOf as af, type GalleryOptions as ag, type Layout as ah, type ItemStyle as ai, type Thumbnails as aj, type GIFData as ak, type GIF as al, type HeadingData as am, type HTMLData as an, type HTMLDataDataOneOf as ao, type ImageData as ap, type StylesBorder as aq, type ImageDataStyles as ar, type LinkPreviewData as as, type LinkPreviewDataStyles as at, type MapData as au, type MapSettings as av, type ParagraphData as aw, type PollData as ax, type Permissions as ay, type Option as az, type PublishedContentDeletedEnvelope as b, type CollapsibleListData as b0, type TableData as b1, type Dimensions as b2, type TableCellData as b3, type CellStyle as b4, type BorderColors as b5, type ListValue as b6, type AudioData as b7, type OrderedListData as b8, type BulletedListData as b9, type Empty as bA, type DeletePublishedContentRequest as bB, type DeletePublishedContentResponse as bC, type MessageEnvelope as bD, type IdentificationData as bE, type IdentificationDataIdOneOf as bF, type BaseEventMetadata as bG, type EventMetadata as bH, type PublishedContentQueryResult as bI, type BlockquoteData as ba, type CaptionData as bb, type LayoutCellData as bc, type Metadata as bd, type DocumentStyle as be, type TextNodeStyle as bf, type FocalPoint as bg, type VideoResolution as bh, type ExtendedFields as bi, type GetPublishedContentRequest as bj, type GetPublishedContentResponse as bk, type QueryPublishedContentRequest as bl, type CursorQuery as bm, type CursorQueryPagingMethodOneOf as bn, type Sorting as bo, type CursorPaging as bp, type QueryPublishedContentResponse as bq, type CursorPagingMetadata as br, type Cursors as bs, type DomainEvent as bt, type DomainEventBodyOneOf as bu, type EntityCreatedEvent as bv, type RestoreInfo as bw, type EntityUpdatedEvent as bx, type EntityDeletedEvent as by, type ActionEvent as bz, type PublishedContentUpdatedEnvelope as c, PluginContainerDataAlignment as d, Target as e, TextAlignment as f, Width as g, LayoutType as h, ThumbnailsAlignment as i, Source as j, Position as k, ViewRole as l, VoteRole as m, PollLayoutType as n, PollLayoutDirection as o, AppType as p, Direction as q, VerticalAlignment as r, NullValue as s, SortOrder as t, WebhookIdentityType as u, type PublishedContent as v, type SchemaKey as w, type PublishedContentField as x, type PublishedContentFieldValueOneOf as y, type Node as z };
|