@wix/auto_sdk_multilingual_translation-published-contents 1.0.16 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +21 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +57 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +1 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +24 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +208 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +1 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +13 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +47 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +1 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +35 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +258 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +1 -0
- package/build/{internal/meta.d.ts → cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts} +339 -157
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +333 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +1 -0
- package/build/{multilingual-localization-public-v3-published-content-translation-published-contents.universal-DngHLA-S.d.mts → cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts} +238 -166
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +453 -0
- package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +21 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +21 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +1 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +24 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +204 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +1 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +13 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +20 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +1 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +35 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +221 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +1 -0
- package/build/{meta.d.mts → es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts} +339 -157
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +330 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +1 -0
- package/build/{internal/multilingual-localization-public-v3-published-content-translation-published-contents.universal-DngHLA-S.d.ts → es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts} +238 -166
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +426 -0
- package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +21 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +57 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +1 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +24 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +208 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +1 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +13 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +47 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +1 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +35 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +258 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +1 -0
- package/build/internal/{meta.d.mts → cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts} +339 -157
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +333 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +1 -0
- package/build/{multilingual-localization-public-v3-published-content-translation-published-contents.universal-DngHLA-S.d.ts → internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts} +238 -166
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +453 -0
- package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +21 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +21 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +1 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +24 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +204 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +1 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +13 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +20 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +1 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +35 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +221 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +1 -0
- package/build/{meta.d.ts → internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts} +339 -157
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +330 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +1 -0
- package/build/internal/{multilingual-localization-public-v3-published-content-translation-published-contents.universal-DngHLA-S.d.mts → es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts} +238 -166
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +426 -0
- package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -47
- package/build/index.d.ts +0 -47
- package/build/index.js +0 -848
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -788
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -47
- package/build/internal/index.d.ts +0 -47
- package/build/internal/index.js +0 -848
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -788
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js +0 -239
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -212
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js +0 -239
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -212
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
interface PublishedContent {
|
|
1
|
+
export interface PublishedContent {
|
|
2
2
|
/**
|
|
3
3
|
* Published content ID.
|
|
4
4
|
* @readonly
|
|
@@ -33,7 +33,7 @@ interface PublishedContent {
|
|
|
33
33
|
/** Custom field data for the published content object. */
|
|
34
34
|
extendedFields?: ExtendedFields;
|
|
35
35
|
}
|
|
36
|
-
interface SchemaKey {
|
|
36
|
+
export interface SchemaKey {
|
|
37
37
|
/**
|
|
38
38
|
* ID of the app that created the schema.
|
|
39
39
|
* @format GUID
|
|
@@ -56,14 +56,14 @@ interface SchemaKey {
|
|
|
56
56
|
*/
|
|
57
57
|
scope?: SchemaScope;
|
|
58
58
|
}
|
|
59
|
-
declare enum SchemaScope {
|
|
59
|
+
export declare enum SchemaScope {
|
|
60
60
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
61
61
|
/** Global schema for all sites. */
|
|
62
62
|
GLOBAL = "GLOBAL",
|
|
63
63
|
/** Custom schema for a specific site. */
|
|
64
64
|
SITE = "SITE"
|
|
65
65
|
}
|
|
66
|
-
interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
66
|
+
export interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
67
67
|
/**
|
|
68
68
|
* Plain text.
|
|
69
69
|
* @maxLength 100000
|
|
@@ -91,7 +91,7 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
|
91
91
|
sequenceIds?: string[];
|
|
92
92
|
}
|
|
93
93
|
/** @oneof */
|
|
94
|
-
interface PublishedContentFieldValueOneOf {
|
|
94
|
+
export interface PublishedContentFieldValueOneOf {
|
|
95
95
|
/**
|
|
96
96
|
* Plain text.
|
|
97
97
|
* @maxLength 100000
|
|
@@ -106,7 +106,7 @@ interface PublishedContentFieldValueOneOf {
|
|
|
106
106
|
/** Wix Media Manager document. */
|
|
107
107
|
document?: string;
|
|
108
108
|
}
|
|
109
|
-
interface RichContent {
|
|
109
|
+
export interface RichContent {
|
|
110
110
|
/** Node objects representing a rich content document. */
|
|
111
111
|
nodes?: Node[];
|
|
112
112
|
/** Object metadata. */
|
|
@@ -114,7 +114,7 @@ interface RichContent {
|
|
|
114
114
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
115
115
|
documentStyle?: DocumentStyle;
|
|
116
116
|
}
|
|
117
|
-
interface Node extends NodeDataOneOf {
|
|
117
|
+
export interface Node extends NodeDataOneOf {
|
|
118
118
|
/** Data for a button node. */
|
|
119
119
|
buttonData?: ButtonData;
|
|
120
120
|
/** Data for a code block node. */
|
|
@@ -179,7 +179,7 @@ interface Node extends NodeDataOneOf {
|
|
|
179
179
|
style?: NodeStyle;
|
|
180
180
|
}
|
|
181
181
|
/** @oneof */
|
|
182
|
-
interface NodeDataOneOf {
|
|
182
|
+
export interface NodeDataOneOf {
|
|
183
183
|
/** Data for a button node. */
|
|
184
184
|
buttonData?: ButtonData;
|
|
185
185
|
/** Data for a code block node. */
|
|
@@ -235,7 +235,7 @@ interface NodeDataOneOf {
|
|
|
235
235
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
236
236
|
layoutCellData?: LayoutCellData;
|
|
237
237
|
}
|
|
238
|
-
declare enum NodeType {
|
|
238
|
+
export declare enum NodeType {
|
|
239
239
|
PARAGRAPH = "PARAGRAPH",
|
|
240
240
|
TEXT = "TEXT",
|
|
241
241
|
HEADING = "HEADING",
|
|
@@ -271,7 +271,7 @@ declare enum NodeType {
|
|
|
271
271
|
LAYOUT = "LAYOUT",
|
|
272
272
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
273
273
|
}
|
|
274
|
-
interface NodeStyle {
|
|
274
|
+
export interface NodeStyle {
|
|
275
275
|
/** The top padding value in pixels. */
|
|
276
276
|
paddingTop?: string | null;
|
|
277
277
|
/** The bottom padding value in pixels. */
|
|
@@ -279,7 +279,7 @@ interface NodeStyle {
|
|
|
279
279
|
/** The background color as a hexadecimal value. */
|
|
280
280
|
backgroundColor?: string | null;
|
|
281
281
|
}
|
|
282
|
-
interface ButtonData {
|
|
282
|
+
export interface ButtonData {
|
|
283
283
|
/** Styling for the button's container. */
|
|
284
284
|
containerData?: PluginContainerData;
|
|
285
285
|
/** The button type. */
|
|
@@ -291,7 +291,7 @@ interface ButtonData {
|
|
|
291
291
|
/** Button link details. */
|
|
292
292
|
link?: Link;
|
|
293
293
|
}
|
|
294
|
-
interface Border {
|
|
294
|
+
export interface Border {
|
|
295
295
|
/**
|
|
296
296
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
297
297
|
* @deprecated
|
|
@@ -303,7 +303,7 @@ interface Border {
|
|
|
303
303
|
*/
|
|
304
304
|
radius?: number | null;
|
|
305
305
|
}
|
|
306
|
-
interface Colors {
|
|
306
|
+
export interface Colors {
|
|
307
307
|
/**
|
|
308
308
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
309
309
|
* @deprecated
|
|
@@ -320,7 +320,7 @@ interface Colors {
|
|
|
320
320
|
*/
|
|
321
321
|
background?: string | null;
|
|
322
322
|
}
|
|
323
|
-
interface PluginContainerData {
|
|
323
|
+
export interface PluginContainerData {
|
|
324
324
|
/** The width of the node when it's displayed. */
|
|
325
325
|
width?: PluginContainerDataWidth;
|
|
326
326
|
/** The node's alignment within its container. */
|
|
@@ -332,7 +332,7 @@ interface PluginContainerData {
|
|
|
332
332
|
/** 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`. */
|
|
333
333
|
textWrap?: boolean | null;
|
|
334
334
|
}
|
|
335
|
-
declare enum WidthType {
|
|
335
|
+
export declare enum WidthType {
|
|
336
336
|
/** Width matches the content width */
|
|
337
337
|
CONTENT = "CONTENT",
|
|
338
338
|
/** Small Width */
|
|
@@ -342,7 +342,7 @@ declare enum WidthType {
|
|
|
342
342
|
/** coast-to-coast display */
|
|
343
343
|
FULL_WIDTH = "FULL_WIDTH"
|
|
344
344
|
}
|
|
345
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
345
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
346
346
|
/**
|
|
347
347
|
* One of the following predefined width options:
|
|
348
348
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -355,7 +355,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
355
355
|
custom?: string | null;
|
|
356
356
|
}
|
|
357
357
|
/** @oneof */
|
|
358
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
358
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
359
359
|
/**
|
|
360
360
|
* One of the following predefined width options:
|
|
361
361
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -367,7 +367,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
367
367
|
/** A custom width value in pixels. */
|
|
368
368
|
custom?: string | null;
|
|
369
369
|
}
|
|
370
|
-
declare enum PluginContainerDataAlignment {
|
|
370
|
+
export declare enum PluginContainerDataAlignment {
|
|
371
371
|
/** Center Alignment */
|
|
372
372
|
CENTER = "CENTER",
|
|
373
373
|
/** Left Alignment */
|
|
@@ -375,7 +375,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
375
375
|
/** Right Alignment */
|
|
376
376
|
RIGHT = "RIGHT"
|
|
377
377
|
}
|
|
378
|
-
interface Spoiler {
|
|
378
|
+
export interface Spoiler {
|
|
379
379
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
380
380
|
enabled?: boolean | null;
|
|
381
381
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -383,17 +383,17 @@ interface Spoiler {
|
|
|
383
383
|
/** The text for the button used to remove the spoiler cover. */
|
|
384
384
|
buttonText?: string | null;
|
|
385
385
|
}
|
|
386
|
-
interface Height {
|
|
386
|
+
export interface Height {
|
|
387
387
|
/** A custom height value in pixels. */
|
|
388
388
|
custom?: string | null;
|
|
389
389
|
}
|
|
390
|
-
declare enum Type {
|
|
390
|
+
export declare enum Type {
|
|
391
391
|
/** Regular link button */
|
|
392
392
|
LINK = "LINK",
|
|
393
393
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
394
394
|
ACTION = "ACTION"
|
|
395
395
|
}
|
|
396
|
-
interface Styles {
|
|
396
|
+
export interface Styles {
|
|
397
397
|
/**
|
|
398
398
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
399
399
|
* @deprecated
|
|
@@ -446,7 +446,7 @@ interface Styles {
|
|
|
446
446
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
447
447
|
buttonSize?: string | null;
|
|
448
448
|
}
|
|
449
|
-
interface Link extends LinkDataOneOf {
|
|
449
|
+
export interface Link extends LinkDataOneOf {
|
|
450
450
|
/** The absolute URL for the linked document. */
|
|
451
451
|
url?: string;
|
|
452
452
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -465,13 +465,13 @@ interface Link extends LinkDataOneOf {
|
|
|
465
465
|
customData?: string | null;
|
|
466
466
|
}
|
|
467
467
|
/** @oneof */
|
|
468
|
-
interface LinkDataOneOf {
|
|
468
|
+
export interface LinkDataOneOf {
|
|
469
469
|
/** The absolute URL for the linked document. */
|
|
470
470
|
url?: string;
|
|
471
471
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
472
472
|
anchor?: string;
|
|
473
473
|
}
|
|
474
|
-
declare enum Target {
|
|
474
|
+
export declare enum Target {
|
|
475
475
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
476
476
|
SELF = "SELF",
|
|
477
477
|
/** Opens the linked document in a new window or tab */
|
|
@@ -481,7 +481,7 @@ declare enum Target {
|
|
|
481
481
|
/** Opens the linked document in the full body of the window */
|
|
482
482
|
TOP = "TOP"
|
|
483
483
|
}
|
|
484
|
-
interface Rel {
|
|
484
|
+
export interface Rel {
|
|
485
485
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
486
486
|
nofollow?: boolean | null;
|
|
487
487
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -491,17 +491,17 @@ interface Rel {
|
|
|
491
491
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
492
492
|
noreferrer?: boolean | null;
|
|
493
493
|
}
|
|
494
|
-
interface CodeBlockData {
|
|
494
|
+
export interface CodeBlockData {
|
|
495
495
|
/** Styling for the code block's text. */
|
|
496
496
|
textStyle?: TextStyle;
|
|
497
497
|
}
|
|
498
|
-
interface TextStyle {
|
|
498
|
+
export interface TextStyle {
|
|
499
499
|
/** Text alignment. Defaults to `AUTO`. */
|
|
500
500
|
textAlignment?: TextAlignment;
|
|
501
501
|
/** 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. */
|
|
502
502
|
lineHeight?: string | null;
|
|
503
503
|
}
|
|
504
|
-
declare enum TextAlignment {
|
|
504
|
+
export declare enum TextAlignment {
|
|
505
505
|
/** browser default, eqivalent to `initial` */
|
|
506
506
|
AUTO = "AUTO",
|
|
507
507
|
/** Left align */
|
|
@@ -513,7 +513,7 @@ declare enum TextAlignment {
|
|
|
513
513
|
/** 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 */
|
|
514
514
|
JUSTIFY = "JUSTIFY"
|
|
515
515
|
}
|
|
516
|
-
interface DividerData {
|
|
516
|
+
export interface DividerData {
|
|
517
517
|
/** Styling for the divider's container. */
|
|
518
518
|
containerData?: PluginContainerData;
|
|
519
519
|
/** Divider line style. */
|
|
@@ -523,7 +523,7 @@ interface DividerData {
|
|
|
523
523
|
/** Divider alignment. */
|
|
524
524
|
alignment?: Alignment;
|
|
525
525
|
}
|
|
526
|
-
declare enum LineStyle {
|
|
526
|
+
export declare enum LineStyle {
|
|
527
527
|
/** Single Line */
|
|
528
528
|
SINGLE = "SINGLE",
|
|
529
529
|
/** Double Line */
|
|
@@ -533,7 +533,7 @@ declare enum LineStyle {
|
|
|
533
533
|
/** Dotted Line */
|
|
534
534
|
DOTTED = "DOTTED"
|
|
535
535
|
}
|
|
536
|
-
declare enum Width {
|
|
536
|
+
export declare enum Width {
|
|
537
537
|
/** Large line */
|
|
538
538
|
LARGE = "LARGE",
|
|
539
539
|
/** Medium line */
|
|
@@ -541,7 +541,7 @@ declare enum Width {
|
|
|
541
541
|
/** Small line */
|
|
542
542
|
SMALL = "SMALL"
|
|
543
543
|
}
|
|
544
|
-
declare enum Alignment {
|
|
544
|
+
export declare enum Alignment {
|
|
545
545
|
/** Center alignment */
|
|
546
546
|
CENTER = "CENTER",
|
|
547
547
|
/** Left alignment */
|
|
@@ -549,7 +549,7 @@ declare enum Alignment {
|
|
|
549
549
|
/** Right alignment */
|
|
550
550
|
RIGHT = "RIGHT"
|
|
551
551
|
}
|
|
552
|
-
interface FileData {
|
|
552
|
+
export interface FileData {
|
|
553
553
|
/** Styling for the file's container. */
|
|
554
554
|
containerData?: PluginContainerData;
|
|
555
555
|
/** The source for the file's data. */
|
|
@@ -572,7 +572,7 @@ interface FileData {
|
|
|
572
572
|
/** File size in KB. */
|
|
573
573
|
sizeInKb?: string | null;
|
|
574
574
|
}
|
|
575
|
-
declare enum ViewMode {
|
|
575
|
+
export declare enum ViewMode {
|
|
576
576
|
/** No PDF view */
|
|
577
577
|
NONE = "NONE",
|
|
578
578
|
/** Full PDF view */
|
|
@@ -580,7 +580,7 @@ declare enum ViewMode {
|
|
|
580
580
|
/** Mini PDF view */
|
|
581
581
|
MINI = "MINI"
|
|
582
582
|
}
|
|
583
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
583
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
584
584
|
/** The absolute URL for the file's source. */
|
|
585
585
|
url?: string | null;
|
|
586
586
|
/**
|
|
@@ -594,7 +594,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
594
594
|
private?: boolean | null;
|
|
595
595
|
}
|
|
596
596
|
/** @oneof */
|
|
597
|
-
interface FileSourceDataOneOf {
|
|
597
|
+
export interface FileSourceDataOneOf {
|
|
598
598
|
/** The absolute URL for the file's source. */
|
|
599
599
|
url?: string | null;
|
|
600
600
|
/**
|
|
@@ -605,7 +605,7 @@ interface FileSourceDataOneOf {
|
|
|
605
605
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
606
606
|
_id?: string | null;
|
|
607
607
|
}
|
|
608
|
-
interface PDFSettings {
|
|
608
|
+
export interface PDFSettings {
|
|
609
609
|
/**
|
|
610
610
|
* PDF view mode. One of the following:
|
|
611
611
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -618,7 +618,7 @@ interface PDFSettings {
|
|
|
618
618
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
619
619
|
disablePrint?: boolean | null;
|
|
620
620
|
}
|
|
621
|
-
interface GalleryData {
|
|
621
|
+
export interface GalleryData {
|
|
622
622
|
/** Styling for the gallery's container. */
|
|
623
623
|
containerData?: PluginContainerData;
|
|
624
624
|
/** The items in the gallery. */
|
|
@@ -630,7 +630,7 @@ interface GalleryData {
|
|
|
630
630
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
631
631
|
disableDownload?: boolean | null;
|
|
632
632
|
}
|
|
633
|
-
interface Media {
|
|
633
|
+
export interface Media {
|
|
634
634
|
/** The source for the media's data. */
|
|
635
635
|
src?: FileSource;
|
|
636
636
|
/** Media width in pixels. */
|
|
@@ -640,19 +640,19 @@ interface Media {
|
|
|
640
640
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
641
641
|
duration?: number | null;
|
|
642
642
|
}
|
|
643
|
-
interface Image {
|
|
643
|
+
export interface Image {
|
|
644
644
|
/** Image file details. */
|
|
645
645
|
media?: Media;
|
|
646
646
|
/** Link details for images that are links. */
|
|
647
647
|
link?: Link;
|
|
648
648
|
}
|
|
649
|
-
interface Video {
|
|
649
|
+
export interface Video {
|
|
650
650
|
/** Video file details. */
|
|
651
651
|
media?: Media;
|
|
652
652
|
/** Video thumbnail file details. */
|
|
653
653
|
thumbnail?: Media;
|
|
654
654
|
}
|
|
655
|
-
interface Item extends ItemDataOneOf {
|
|
655
|
+
export interface Item extends ItemDataOneOf {
|
|
656
656
|
/** An image item. */
|
|
657
657
|
image?: Image;
|
|
658
658
|
/** A video item. */
|
|
@@ -663,13 +663,13 @@ interface Item extends ItemDataOneOf {
|
|
|
663
663
|
altText?: string | null;
|
|
664
664
|
}
|
|
665
665
|
/** @oneof */
|
|
666
|
-
interface ItemDataOneOf {
|
|
666
|
+
export interface ItemDataOneOf {
|
|
667
667
|
/** An image item. */
|
|
668
668
|
image?: Image;
|
|
669
669
|
/** A video item. */
|
|
670
670
|
video?: Video;
|
|
671
671
|
}
|
|
672
|
-
interface GalleryOptions {
|
|
672
|
+
export interface GalleryOptions {
|
|
673
673
|
/** Gallery layout. */
|
|
674
674
|
layout?: Layout;
|
|
675
675
|
/** Styling for gallery items. */
|
|
@@ -677,7 +677,7 @@ interface GalleryOptions {
|
|
|
677
677
|
/** Styling for gallery thumbnail images. */
|
|
678
678
|
thumbnails?: Thumbnails;
|
|
679
679
|
}
|
|
680
|
-
declare enum LayoutType {
|
|
680
|
+
export declare enum LayoutType {
|
|
681
681
|
/** Collage type */
|
|
682
682
|
COLLAGE = "COLLAGE",
|
|
683
683
|
/** Masonry type */
|
|
@@ -699,19 +699,19 @@ declare enum LayoutType {
|
|
|
699
699
|
/** Fullsize images type */
|
|
700
700
|
FULLSIZE = "FULLSIZE"
|
|
701
701
|
}
|
|
702
|
-
declare enum Orientation {
|
|
702
|
+
export declare enum Orientation {
|
|
703
703
|
/** Rows Orientation */
|
|
704
704
|
ROWS = "ROWS",
|
|
705
705
|
/** Columns Orientation */
|
|
706
706
|
COLUMNS = "COLUMNS"
|
|
707
707
|
}
|
|
708
|
-
declare enum Crop {
|
|
708
|
+
export declare enum Crop {
|
|
709
709
|
/** Crop to fill */
|
|
710
710
|
FILL = "FILL",
|
|
711
711
|
/** Crop to fit */
|
|
712
712
|
FIT = "FIT"
|
|
713
713
|
}
|
|
714
|
-
declare enum ThumbnailsAlignment {
|
|
714
|
+
export declare enum ThumbnailsAlignment {
|
|
715
715
|
/** Top alignment */
|
|
716
716
|
TOP = "TOP",
|
|
717
717
|
/** Right alignment */
|
|
@@ -723,7 +723,7 @@ declare enum ThumbnailsAlignment {
|
|
|
723
723
|
/** No thumbnail */
|
|
724
724
|
NONE = "NONE"
|
|
725
725
|
}
|
|
726
|
-
interface Layout {
|
|
726
|
+
export interface Layout {
|
|
727
727
|
/** Gallery layout type. */
|
|
728
728
|
type?: LayoutType;
|
|
729
729
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -735,7 +735,7 @@ interface Layout {
|
|
|
735
735
|
/** The number of columns to display on mobile screens. */
|
|
736
736
|
mobileNumberOfColumns?: number | null;
|
|
737
737
|
}
|
|
738
|
-
interface ItemStyle {
|
|
738
|
+
export interface ItemStyle {
|
|
739
739
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
740
740
|
targetSize?: number | null;
|
|
741
741
|
/** Item ratio */
|
|
@@ -745,13 +745,13 @@ interface ItemStyle {
|
|
|
745
745
|
/** The spacing between items in pixels. */
|
|
746
746
|
spacing?: number | null;
|
|
747
747
|
}
|
|
748
|
-
interface Thumbnails {
|
|
748
|
+
export interface Thumbnails {
|
|
749
749
|
/** Thumbnail alignment. */
|
|
750
750
|
placement?: ThumbnailsAlignment;
|
|
751
751
|
/** Spacing between thumbnails in pixels. */
|
|
752
752
|
spacing?: number | null;
|
|
753
753
|
}
|
|
754
|
-
interface GIFData {
|
|
754
|
+
export interface GIFData {
|
|
755
755
|
/** Styling for the GIF's container. */
|
|
756
756
|
containerData?: PluginContainerData;
|
|
757
757
|
/** The source of the full size GIF. */
|
|
@@ -765,7 +765,7 @@ interface GIFData {
|
|
|
765
765
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
766
766
|
gifType?: GIFType;
|
|
767
767
|
}
|
|
768
|
-
interface GIF {
|
|
768
|
+
export interface GIF {
|
|
769
769
|
/**
|
|
770
770
|
* GIF format URL.
|
|
771
771
|
* @format WEB_URL
|
|
@@ -782,11 +782,11 @@ interface GIF {
|
|
|
782
782
|
*/
|
|
783
783
|
still?: string | null;
|
|
784
784
|
}
|
|
785
|
-
declare enum GIFType {
|
|
785
|
+
export declare enum GIFType {
|
|
786
786
|
NORMAL = "NORMAL",
|
|
787
787
|
STICKER = "STICKER"
|
|
788
788
|
}
|
|
789
|
-
interface HeadingData {
|
|
789
|
+
export interface HeadingData {
|
|
790
790
|
/** Heading level from 1-6. */
|
|
791
791
|
level?: number;
|
|
792
792
|
/** Styling for the heading text. */
|
|
@@ -794,7 +794,7 @@ interface HeadingData {
|
|
|
794
794
|
/** Indentation level from 1-4. */
|
|
795
795
|
indentation?: number | null;
|
|
796
796
|
}
|
|
797
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
797
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
798
798
|
/** The URL for the HTML code for the node. */
|
|
799
799
|
url?: string;
|
|
800
800
|
/** The HTML code for the node. */
|
|
@@ -812,7 +812,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
812
812
|
autoHeight?: boolean | null;
|
|
813
813
|
}
|
|
814
814
|
/** @oneof */
|
|
815
|
-
interface HTMLDataDataOneOf {
|
|
815
|
+
export interface HTMLDataDataOneOf {
|
|
816
816
|
/** The URL for the HTML code for the node. */
|
|
817
817
|
url?: string;
|
|
818
818
|
/** The HTML code for the node. */
|
|
@@ -823,11 +823,11 @@ interface HTMLDataDataOneOf {
|
|
|
823
823
|
*/
|
|
824
824
|
isAdsense?: boolean | null;
|
|
825
825
|
}
|
|
826
|
-
declare enum Source {
|
|
826
|
+
export declare enum Source {
|
|
827
827
|
HTML = "HTML",
|
|
828
828
|
ADSENSE = "ADSENSE"
|
|
829
829
|
}
|
|
830
|
-
interface ImageData {
|
|
830
|
+
export interface ImageData {
|
|
831
831
|
/** Styling for the image's container. */
|
|
832
832
|
containerData?: PluginContainerData;
|
|
833
833
|
/** Image file details. */
|
|
@@ -850,7 +850,7 @@ interface ImageData {
|
|
|
850
850
|
/** Styling for the image. */
|
|
851
851
|
styles?: ImageDataStyles;
|
|
852
852
|
}
|
|
853
|
-
interface StylesBorder {
|
|
853
|
+
export interface StylesBorder {
|
|
854
854
|
/** Border width in pixels. */
|
|
855
855
|
width?: number | null;
|
|
856
856
|
/**
|
|
@@ -861,11 +861,11 @@ interface StylesBorder {
|
|
|
861
861
|
/** Border radius in pixels. */
|
|
862
862
|
radius?: number | null;
|
|
863
863
|
}
|
|
864
|
-
interface ImageDataStyles {
|
|
864
|
+
export interface ImageDataStyles {
|
|
865
865
|
/** Border attributes. */
|
|
866
866
|
border?: StylesBorder;
|
|
867
867
|
}
|
|
868
|
-
interface LinkPreviewData {
|
|
868
|
+
export interface LinkPreviewData {
|
|
869
869
|
/** Styling for the link preview's container. */
|
|
870
870
|
containerData?: PluginContainerData;
|
|
871
871
|
/** Link details. */
|
|
@@ -881,7 +881,7 @@ interface LinkPreviewData {
|
|
|
881
881
|
/** Styling for the link preview. */
|
|
882
882
|
styles?: LinkPreviewDataStyles;
|
|
883
883
|
}
|
|
884
|
-
declare enum Position {
|
|
884
|
+
export declare enum Position {
|
|
885
885
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
886
886
|
START = "START",
|
|
887
887
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -891,7 +891,7 @@ declare enum Position {
|
|
|
891
891
|
/** Thumbnail hidden and not displayed */
|
|
892
892
|
HIDDEN = "HIDDEN"
|
|
893
893
|
}
|
|
894
|
-
interface LinkPreviewDataStyles {
|
|
894
|
+
export interface LinkPreviewDataStyles {
|
|
895
895
|
/**
|
|
896
896
|
* Background color as a hexadecimal value.
|
|
897
897
|
* @format COLOR_HEX
|
|
@@ -924,13 +924,13 @@ interface LinkPreviewDataStyles {
|
|
|
924
924
|
/** Position of thumbnail. Defaults to `START`. */
|
|
925
925
|
thumbnailPosition?: Position;
|
|
926
926
|
}
|
|
927
|
-
interface MapData {
|
|
927
|
+
export interface MapData {
|
|
928
928
|
/** Styling for the map's container. */
|
|
929
929
|
containerData?: PluginContainerData;
|
|
930
930
|
/** Map settings. */
|
|
931
931
|
mapSettings?: MapSettings;
|
|
932
932
|
}
|
|
933
|
-
interface MapSettings {
|
|
933
|
+
export interface MapSettings {
|
|
934
934
|
/** The address to display on the map. */
|
|
935
935
|
address?: string | null;
|
|
936
936
|
/** Sets whether the map is draggable. */
|
|
@@ -954,7 +954,7 @@ interface MapSettings {
|
|
|
954
954
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
955
955
|
mapType?: MapType;
|
|
956
956
|
}
|
|
957
|
-
declare enum MapType {
|
|
957
|
+
export declare enum MapType {
|
|
958
958
|
/** Roadmap map type */
|
|
959
959
|
ROADMAP = "ROADMAP",
|
|
960
960
|
/** Satellite map type */
|
|
@@ -964,7 +964,7 @@ declare enum MapType {
|
|
|
964
964
|
/** Terrain map type */
|
|
965
965
|
TERRAIN = "TERRAIN"
|
|
966
966
|
}
|
|
967
|
-
interface ParagraphData {
|
|
967
|
+
export interface ParagraphData {
|
|
968
968
|
/** Styling for the paragraph text. */
|
|
969
969
|
textStyle?: TextStyle;
|
|
970
970
|
/** Indentation level from 1-4. */
|
|
@@ -972,7 +972,7 @@ interface ParagraphData {
|
|
|
972
972
|
/** Paragraph level */
|
|
973
973
|
level?: number | null;
|
|
974
974
|
}
|
|
975
|
-
interface PollData {
|
|
975
|
+
export interface PollData {
|
|
976
976
|
/** Styling for the poll's container. */
|
|
977
977
|
containerData?: PluginContainerData;
|
|
978
978
|
/** Poll data. */
|
|
@@ -982,7 +982,7 @@ interface PollData {
|
|
|
982
982
|
/** Styling for the poll and voting options. */
|
|
983
983
|
design?: Design;
|
|
984
984
|
}
|
|
985
|
-
declare enum ViewRole {
|
|
985
|
+
export declare enum ViewRole {
|
|
986
986
|
/** Only Poll creator can view the results */
|
|
987
987
|
CREATOR = "CREATOR",
|
|
988
988
|
/** Anyone who voted can see the results */
|
|
@@ -990,13 +990,13 @@ declare enum ViewRole {
|
|
|
990
990
|
/** Anyone can see the results, even if one didn't vote */
|
|
991
991
|
EVERYONE = "EVERYONE"
|
|
992
992
|
}
|
|
993
|
-
declare enum VoteRole {
|
|
993
|
+
export declare enum VoteRole {
|
|
994
994
|
/** Logged in member */
|
|
995
995
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
996
996
|
/** Anyone */
|
|
997
997
|
ALL = "ALL"
|
|
998
998
|
}
|
|
999
|
-
interface Permissions {
|
|
999
|
+
export interface Permissions {
|
|
1000
1000
|
/** Sets who can view the poll results. */
|
|
1001
1001
|
view?: ViewRole;
|
|
1002
1002
|
/** Sets who can vote. */
|
|
@@ -1004,7 +1004,7 @@ interface Permissions {
|
|
|
1004
1004
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1005
1005
|
allowMultipleVotes?: boolean | null;
|
|
1006
1006
|
}
|
|
1007
|
-
interface Option {
|
|
1007
|
+
export interface Option {
|
|
1008
1008
|
/** Option ID. */
|
|
1009
1009
|
_id?: string | null;
|
|
1010
1010
|
/** Option title. */
|
|
@@ -1012,7 +1012,7 @@ interface Option {
|
|
|
1012
1012
|
/** The image displayed with the option. */
|
|
1013
1013
|
image?: Media;
|
|
1014
1014
|
}
|
|
1015
|
-
interface Settings {
|
|
1015
|
+
export interface Settings {
|
|
1016
1016
|
/** Permissions settings for voting. */
|
|
1017
1017
|
permissions?: Permissions;
|
|
1018
1018
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1020,19 +1020,19 @@ interface Settings {
|
|
|
1020
1020
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1021
1021
|
showVotesCount?: boolean | null;
|
|
1022
1022
|
}
|
|
1023
|
-
declare enum PollLayoutType {
|
|
1023
|
+
export declare enum PollLayoutType {
|
|
1024
1024
|
/** List */
|
|
1025
1025
|
LIST = "LIST",
|
|
1026
1026
|
/** Grid */
|
|
1027
1027
|
GRID = "GRID"
|
|
1028
1028
|
}
|
|
1029
|
-
declare enum PollLayoutDirection {
|
|
1029
|
+
export declare enum PollLayoutDirection {
|
|
1030
1030
|
/** Left-to-right */
|
|
1031
1031
|
LTR = "LTR",
|
|
1032
1032
|
/** Right-to-left */
|
|
1033
1033
|
RTL = "RTL"
|
|
1034
1034
|
}
|
|
1035
|
-
interface PollLayout {
|
|
1035
|
+
export interface PollLayout {
|
|
1036
1036
|
/** The layout for displaying the voting options. */
|
|
1037
1037
|
type?: PollLayoutType;
|
|
1038
1038
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1040,11 +1040,11 @@ interface PollLayout {
|
|
|
1040
1040
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1041
1041
|
enableImage?: boolean | null;
|
|
1042
1042
|
}
|
|
1043
|
-
interface OptionLayout {
|
|
1043
|
+
export interface OptionLayout {
|
|
1044
1044
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1045
1045
|
enableImage?: boolean | null;
|
|
1046
1046
|
}
|
|
1047
|
-
declare enum BackgroundType {
|
|
1047
|
+
export declare enum BackgroundType {
|
|
1048
1048
|
/** Color background type */
|
|
1049
1049
|
COLOR = "COLOR",
|
|
1050
1050
|
/** Image background type */
|
|
@@ -1052,7 +1052,7 @@ declare enum BackgroundType {
|
|
|
1052
1052
|
/** Gradiant background type */
|
|
1053
1053
|
GRADIENT = "GRADIENT"
|
|
1054
1054
|
}
|
|
1055
|
-
interface Gradient {
|
|
1055
|
+
export interface Gradient {
|
|
1056
1056
|
/** The gradient angle in degrees. */
|
|
1057
1057
|
angle?: number | null;
|
|
1058
1058
|
/**
|
|
@@ -1066,7 +1066,7 @@ interface Gradient {
|
|
|
1066
1066
|
*/
|
|
1067
1067
|
lastColor?: string | null;
|
|
1068
1068
|
}
|
|
1069
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1069
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1070
1070
|
/**
|
|
1071
1071
|
* The background color as a hexademical value.
|
|
1072
1072
|
* @format COLOR_HEX
|
|
@@ -1080,7 +1080,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1080
1080
|
type?: BackgroundType;
|
|
1081
1081
|
}
|
|
1082
1082
|
/** @oneof */
|
|
1083
|
-
interface BackgroundBackgroundOneOf {
|
|
1083
|
+
export interface BackgroundBackgroundOneOf {
|
|
1084
1084
|
/**
|
|
1085
1085
|
* The background color as a hexademical value.
|
|
1086
1086
|
* @format COLOR_HEX
|
|
@@ -1091,17 +1091,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
1091
1091
|
/** Details for a gradient background. */
|
|
1092
1092
|
gradient?: Gradient;
|
|
1093
1093
|
}
|
|
1094
|
-
interface PollDesign {
|
|
1094
|
+
export interface PollDesign {
|
|
1095
1095
|
/** Background styling. */
|
|
1096
1096
|
background?: Background;
|
|
1097
1097
|
/** Border radius in pixels. */
|
|
1098
1098
|
borderRadius?: number | null;
|
|
1099
1099
|
}
|
|
1100
|
-
interface OptionDesign {
|
|
1100
|
+
export interface OptionDesign {
|
|
1101
1101
|
/** Border radius in pixels. */
|
|
1102
1102
|
borderRadius?: number | null;
|
|
1103
1103
|
}
|
|
1104
|
-
interface Poll {
|
|
1104
|
+
export interface Poll {
|
|
1105
1105
|
/** Poll ID. */
|
|
1106
1106
|
_id?: string | null;
|
|
1107
1107
|
/** Poll title. */
|
|
@@ -1115,26 +1115,26 @@ interface Poll {
|
|
|
1115
1115
|
/** The poll's permissions and display settings. */
|
|
1116
1116
|
settings?: Settings;
|
|
1117
1117
|
}
|
|
1118
|
-
interface PollDataLayout {
|
|
1118
|
+
export interface PollDataLayout {
|
|
1119
1119
|
/** Poll layout settings. */
|
|
1120
1120
|
poll?: PollLayout;
|
|
1121
1121
|
/** Voting otpions layout settings. */
|
|
1122
1122
|
options?: OptionLayout;
|
|
1123
1123
|
}
|
|
1124
|
-
interface Design {
|
|
1124
|
+
export interface Design {
|
|
1125
1125
|
/** Styling for the poll. */
|
|
1126
1126
|
poll?: PollDesign;
|
|
1127
1127
|
/** Styling for voting options. */
|
|
1128
1128
|
options?: OptionDesign;
|
|
1129
1129
|
}
|
|
1130
|
-
interface TextData {
|
|
1130
|
+
export interface TextData {
|
|
1131
1131
|
/** The text to apply decorations to. */
|
|
1132
1132
|
text?: string;
|
|
1133
1133
|
/** The decorations to apply. */
|
|
1134
1134
|
decorations?: Decoration[];
|
|
1135
1135
|
}
|
|
1136
1136
|
/** Adds appearence changes to text */
|
|
1137
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1137
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1138
1138
|
/** Data for an anchor link decoration. */
|
|
1139
1139
|
anchorData?: AnchorData;
|
|
1140
1140
|
/** Data for a color decoration. */
|
|
@@ -1153,11 +1153,13 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1153
1153
|
underlineData?: boolean | null;
|
|
1154
1154
|
/** Data for a spoiler decoration. */
|
|
1155
1155
|
spoilerData?: SpoilerData;
|
|
1156
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1157
|
+
strikethroughData?: boolean | null;
|
|
1156
1158
|
/** The type of decoration to apply. */
|
|
1157
1159
|
type?: DecorationType;
|
|
1158
1160
|
}
|
|
1159
1161
|
/** @oneof */
|
|
1160
|
-
interface DecorationDataOneOf {
|
|
1162
|
+
export interface DecorationDataOneOf {
|
|
1161
1163
|
/** Data for an anchor link decoration. */
|
|
1162
1164
|
anchorData?: AnchorData;
|
|
1163
1165
|
/** Data for a color decoration. */
|
|
@@ -1176,8 +1178,10 @@ interface DecorationDataOneOf {
|
|
|
1176
1178
|
underlineData?: boolean | null;
|
|
1177
1179
|
/** Data for a spoiler decoration. */
|
|
1178
1180
|
spoilerData?: SpoilerData;
|
|
1181
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1182
|
+
strikethroughData?: boolean | null;
|
|
1179
1183
|
}
|
|
1180
|
-
declare enum DecorationType {
|
|
1184
|
+
export declare enum DecorationType {
|
|
1181
1185
|
BOLD = "BOLD",
|
|
1182
1186
|
ITALIC = "ITALIC",
|
|
1183
1187
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1187,23 +1191,24 @@ declare enum DecorationType {
|
|
|
1187
1191
|
LINK = "LINK",
|
|
1188
1192
|
COLOR = "COLOR",
|
|
1189
1193
|
FONT_SIZE = "FONT_SIZE",
|
|
1190
|
-
EXTERNAL = "EXTERNAL"
|
|
1194
|
+
EXTERNAL = "EXTERNAL",
|
|
1195
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1191
1196
|
}
|
|
1192
|
-
interface AnchorData {
|
|
1197
|
+
export interface AnchorData {
|
|
1193
1198
|
/** The target node's ID. */
|
|
1194
1199
|
anchor?: string;
|
|
1195
1200
|
}
|
|
1196
|
-
interface ColorData {
|
|
1201
|
+
export interface ColorData {
|
|
1197
1202
|
/** The text's background color as a hexadecimal value. */
|
|
1198
1203
|
background?: string | null;
|
|
1199
1204
|
/** The text's foreground color as a hexadecimal value. */
|
|
1200
1205
|
foreground?: string | null;
|
|
1201
1206
|
}
|
|
1202
|
-
interface LinkData {
|
|
1207
|
+
export interface LinkData {
|
|
1203
1208
|
/** Link details. */
|
|
1204
1209
|
link?: Link;
|
|
1205
1210
|
}
|
|
1206
|
-
interface MentionData {
|
|
1211
|
+
export interface MentionData {
|
|
1207
1212
|
/** The mentioned user's name. */
|
|
1208
1213
|
name?: string;
|
|
1209
1214
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1211,21 +1216,21 @@ interface MentionData {
|
|
|
1211
1216
|
/** Mentioned user's ID. */
|
|
1212
1217
|
_id?: string | null;
|
|
1213
1218
|
}
|
|
1214
|
-
interface FontSizeData {
|
|
1219
|
+
export interface FontSizeData {
|
|
1215
1220
|
/** The units used for the font size. */
|
|
1216
1221
|
unit?: FontType;
|
|
1217
1222
|
/** Font size value. */
|
|
1218
1223
|
value?: number | null;
|
|
1219
1224
|
}
|
|
1220
|
-
declare enum FontType {
|
|
1225
|
+
export declare enum FontType {
|
|
1221
1226
|
PX = "PX",
|
|
1222
1227
|
EM = "EM"
|
|
1223
1228
|
}
|
|
1224
|
-
interface SpoilerData {
|
|
1229
|
+
export interface SpoilerData {
|
|
1225
1230
|
/** Spoiler ID. */
|
|
1226
1231
|
_id?: string | null;
|
|
1227
1232
|
}
|
|
1228
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1233
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1229
1234
|
/** Data for embedded Wix Bookings content. */
|
|
1230
1235
|
bookingData?: BookingData;
|
|
1231
1236
|
/** Data for embedded Wix Events content. */
|
|
@@ -1247,28 +1252,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1247
1252
|
image?: Media;
|
|
1248
1253
|
}
|
|
1249
1254
|
/** @oneof */
|
|
1250
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1255
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1251
1256
|
/** Data for embedded Wix Bookings content. */
|
|
1252
1257
|
bookingData?: BookingData;
|
|
1253
1258
|
/** Data for embedded Wix Events content. */
|
|
1254
1259
|
eventData?: EventData;
|
|
1255
1260
|
}
|
|
1256
|
-
declare enum AppType {
|
|
1261
|
+
export declare enum AppType {
|
|
1257
1262
|
PRODUCT = "PRODUCT",
|
|
1258
1263
|
EVENT = "EVENT",
|
|
1259
1264
|
BOOKING = "BOOKING"
|
|
1260
1265
|
}
|
|
1261
|
-
interface BookingData {
|
|
1266
|
+
export interface BookingData {
|
|
1262
1267
|
/** Booking duration in minutes. */
|
|
1263
1268
|
durations?: string | null;
|
|
1264
1269
|
}
|
|
1265
|
-
interface EventData {
|
|
1270
|
+
export interface EventData {
|
|
1266
1271
|
/** Event schedule. */
|
|
1267
1272
|
scheduling?: string | null;
|
|
1268
1273
|
/** Event location. */
|
|
1269
1274
|
location?: string | null;
|
|
1270
1275
|
}
|
|
1271
|
-
interface VideoData {
|
|
1276
|
+
export interface VideoData {
|
|
1272
1277
|
/** Styling for the video's container. */
|
|
1273
1278
|
containerData?: PluginContainerData;
|
|
1274
1279
|
/** Video details. */
|
|
@@ -1282,7 +1287,7 @@ interface VideoData {
|
|
|
1282
1287
|
/** Video options. */
|
|
1283
1288
|
options?: PlaybackOptions;
|
|
1284
1289
|
}
|
|
1285
|
-
interface PlaybackOptions {
|
|
1290
|
+
export interface PlaybackOptions {
|
|
1286
1291
|
/** Sets whether the media will automatically start playing. */
|
|
1287
1292
|
autoPlay?: boolean | null;
|
|
1288
1293
|
/** Sets whether media's will be looped. */
|
|
@@ -1290,7 +1295,7 @@ interface PlaybackOptions {
|
|
|
1290
1295
|
/** Sets whether media's controls will be shown. */
|
|
1291
1296
|
showControls?: boolean | null;
|
|
1292
1297
|
}
|
|
1293
|
-
interface EmbedData {
|
|
1298
|
+
export interface EmbedData {
|
|
1294
1299
|
/** Styling for the oEmbed node's container. */
|
|
1295
1300
|
containerData?: PluginContainerData;
|
|
1296
1301
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1298,7 +1303,7 @@ interface EmbedData {
|
|
|
1298
1303
|
/** Origin asset source. */
|
|
1299
1304
|
src?: string | null;
|
|
1300
1305
|
}
|
|
1301
|
-
interface Oembed {
|
|
1306
|
+
export interface Oembed {
|
|
1302
1307
|
/** The resource type. */
|
|
1303
1308
|
type?: string | null;
|
|
1304
1309
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1330,7 +1335,7 @@ interface Oembed {
|
|
|
1330
1335
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1331
1336
|
version?: string | null;
|
|
1332
1337
|
}
|
|
1333
|
-
interface CollapsibleListData {
|
|
1338
|
+
export interface CollapsibleListData {
|
|
1334
1339
|
/** Styling for the collapsible list's container. */
|
|
1335
1340
|
containerData?: PluginContainerData;
|
|
1336
1341
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1342,7 +1347,7 @@ interface CollapsibleListData {
|
|
|
1342
1347
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1343
1348
|
isQapageData?: boolean | null;
|
|
1344
1349
|
}
|
|
1345
|
-
declare enum InitialExpandedItems {
|
|
1350
|
+
export declare enum InitialExpandedItems {
|
|
1346
1351
|
/** First item will be expended initally */
|
|
1347
1352
|
FIRST = "FIRST",
|
|
1348
1353
|
/** All items will expended initally */
|
|
@@ -1350,13 +1355,13 @@ declare enum InitialExpandedItems {
|
|
|
1350
1355
|
/** All items collapsed initally */
|
|
1351
1356
|
NONE = "NONE"
|
|
1352
1357
|
}
|
|
1353
|
-
declare enum Direction {
|
|
1358
|
+
export declare enum Direction {
|
|
1354
1359
|
/** Left-to-right */
|
|
1355
1360
|
LTR = "LTR",
|
|
1356
1361
|
/** Right-to-left */
|
|
1357
1362
|
RTL = "RTL"
|
|
1358
1363
|
}
|
|
1359
|
-
interface TableData {
|
|
1364
|
+
export interface TableData {
|
|
1360
1365
|
/** Styling for the table's container. */
|
|
1361
1366
|
containerData?: PluginContainerData;
|
|
1362
1367
|
/** The table's dimensions. */
|
|
@@ -1371,7 +1376,7 @@ interface TableData {
|
|
|
1371
1376
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1372
1377
|
columnHeader?: boolean | null;
|
|
1373
1378
|
}
|
|
1374
|
-
interface Dimensions {
|
|
1379
|
+
export interface Dimensions {
|
|
1375
1380
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1376
1381
|
colsWidthRatio?: number[];
|
|
1377
1382
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1379,13 +1384,13 @@ interface Dimensions {
|
|
|
1379
1384
|
/** An array representing the minimum width of each column in pixels. */
|
|
1380
1385
|
colsMinWidth?: number[];
|
|
1381
1386
|
}
|
|
1382
|
-
interface TableCellData {
|
|
1387
|
+
export interface TableCellData {
|
|
1383
1388
|
/** Styling for the cell's background color and text alignment. */
|
|
1384
1389
|
cellStyle?: CellStyle;
|
|
1385
1390
|
/** The cell's border colors. */
|
|
1386
1391
|
borderColors?: BorderColors;
|
|
1387
1392
|
}
|
|
1388
|
-
declare enum VerticalAlignment {
|
|
1393
|
+
export declare enum VerticalAlignment {
|
|
1389
1394
|
/** Top alignment */
|
|
1390
1395
|
TOP = "TOP",
|
|
1391
1396
|
/** Middle alignment */
|
|
@@ -1393,7 +1398,7 @@ declare enum VerticalAlignment {
|
|
|
1393
1398
|
/** Bottom alignment */
|
|
1394
1399
|
BOTTOM = "BOTTOM"
|
|
1395
1400
|
}
|
|
1396
|
-
interface CellStyle {
|
|
1401
|
+
export interface CellStyle {
|
|
1397
1402
|
/** Vertical alignment for the cell's text. */
|
|
1398
1403
|
verticalAlignment?: VerticalAlignment;
|
|
1399
1404
|
/**
|
|
@@ -1402,7 +1407,7 @@ interface CellStyle {
|
|
|
1402
1407
|
*/
|
|
1403
1408
|
backgroundColor?: string | null;
|
|
1404
1409
|
}
|
|
1405
|
-
interface BorderColors {
|
|
1410
|
+
export interface BorderColors {
|
|
1406
1411
|
/**
|
|
1407
1412
|
* Left border color as a hexadecimal value.
|
|
1408
1413
|
* @format COLOR_HEX
|
|
@@ -1430,7 +1435,7 @@ interface BorderColors {
|
|
|
1430
1435
|
*
|
|
1431
1436
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1432
1437
|
*/
|
|
1433
|
-
declare enum NullValue {
|
|
1438
|
+
export declare enum NullValue {
|
|
1434
1439
|
/** Null value. */
|
|
1435
1440
|
NULL_VALUE = "NULL_VALUE"
|
|
1436
1441
|
}
|
|
@@ -1439,11 +1444,11 @@ declare enum NullValue {
|
|
|
1439
1444
|
*
|
|
1440
1445
|
* The JSON representation for `ListValue` is JSON array.
|
|
1441
1446
|
*/
|
|
1442
|
-
interface ListValue {
|
|
1447
|
+
export interface ListValue {
|
|
1443
1448
|
/** Repeated field of dynamically typed values. */
|
|
1444
1449
|
values?: any[];
|
|
1445
1450
|
}
|
|
1446
|
-
interface AudioData {
|
|
1451
|
+
export interface AudioData {
|
|
1447
1452
|
/** Styling for the audio node's container. */
|
|
1448
1453
|
containerData?: PluginContainerData;
|
|
1449
1454
|
/** Audio file details. */
|
|
@@ -1459,7 +1464,7 @@ interface AudioData {
|
|
|
1459
1464
|
/** An HTML version of the audio node. */
|
|
1460
1465
|
html?: string | null;
|
|
1461
1466
|
}
|
|
1462
|
-
interface OrderedListData {
|
|
1467
|
+
export interface OrderedListData {
|
|
1463
1468
|
/** Indentation level from 0-4. */
|
|
1464
1469
|
indentation?: number;
|
|
1465
1470
|
/** Offset level from 0-4. */
|
|
@@ -1467,24 +1472,24 @@ interface OrderedListData {
|
|
|
1467
1472
|
/** List start number. */
|
|
1468
1473
|
start?: number | null;
|
|
1469
1474
|
}
|
|
1470
|
-
interface BulletedListData {
|
|
1475
|
+
export interface BulletedListData {
|
|
1471
1476
|
/** Indentation level from 0-4. */
|
|
1472
1477
|
indentation?: number;
|
|
1473
1478
|
/** Offset level from 0-4. */
|
|
1474
1479
|
offset?: number | null;
|
|
1475
1480
|
}
|
|
1476
|
-
interface BlockquoteData {
|
|
1481
|
+
export interface BlockquoteData {
|
|
1477
1482
|
/** Indentation level from 1-4. */
|
|
1478
1483
|
indentation?: number;
|
|
1479
1484
|
}
|
|
1480
|
-
interface CaptionData {
|
|
1485
|
+
export interface CaptionData {
|
|
1481
1486
|
textStyle?: TextStyle;
|
|
1482
1487
|
}
|
|
1483
|
-
interface LayoutCellData {
|
|
1488
|
+
export interface LayoutCellData {
|
|
1484
1489
|
/** Size of the cell in 12 columns grid. */
|
|
1485
1490
|
colSpan?: number | null;
|
|
1486
1491
|
}
|
|
1487
|
-
interface Metadata {
|
|
1492
|
+
export interface Metadata {
|
|
1488
1493
|
/** Schema version. */
|
|
1489
1494
|
version?: number;
|
|
1490
1495
|
/**
|
|
@@ -1501,7 +1506,7 @@ interface Metadata {
|
|
|
1501
1506
|
/** Object ID. */
|
|
1502
1507
|
_id?: string | null;
|
|
1503
1508
|
}
|
|
1504
|
-
interface DocumentStyle {
|
|
1509
|
+
export interface DocumentStyle {
|
|
1505
1510
|
/** Styling for H1 nodes. */
|
|
1506
1511
|
headerOne?: TextNodeStyle;
|
|
1507
1512
|
/** Styling for H2 nodes. */
|
|
@@ -1521,7 +1526,7 @@ interface DocumentStyle {
|
|
|
1521
1526
|
/** Styling for code block nodes. */
|
|
1522
1527
|
codeBlock?: TextNodeStyle;
|
|
1523
1528
|
}
|
|
1524
|
-
interface TextNodeStyle {
|
|
1529
|
+
export interface TextNodeStyle {
|
|
1525
1530
|
/** The decorations to apply to the node. */
|
|
1526
1531
|
decorations?: Decoration[];
|
|
1527
1532
|
/** Padding and background color for the node. */
|
|
@@ -1529,7 +1534,7 @@ interface TextNodeStyle {
|
|
|
1529
1534
|
/** Line height for text in the node. */
|
|
1530
1535
|
lineHeight?: string | null;
|
|
1531
1536
|
}
|
|
1532
|
-
interface FocalPoint {
|
|
1537
|
+
export interface FocalPoint {
|
|
1533
1538
|
/** X-coordinate of the focal point. */
|
|
1534
1539
|
x?: number;
|
|
1535
1540
|
/** Y-coordinate of the focal point. */
|
|
@@ -1539,7 +1544,7 @@ interface FocalPoint {
|
|
|
1539
1544
|
/** crop by width */
|
|
1540
1545
|
width?: number | null;
|
|
1541
1546
|
}
|
|
1542
|
-
interface VideoResolution {
|
|
1547
|
+
export interface VideoResolution {
|
|
1543
1548
|
/** Video URL. */
|
|
1544
1549
|
url?: string;
|
|
1545
1550
|
/** Video height. */
|
|
@@ -1549,7 +1554,7 @@ interface VideoResolution {
|
|
|
1549
1554
|
/** Video format for example, mp4, hls. */
|
|
1550
1555
|
format?: string;
|
|
1551
1556
|
}
|
|
1552
|
-
interface ExtendedFields {
|
|
1557
|
+
export interface ExtendedFields {
|
|
1553
1558
|
/**
|
|
1554
1559
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1555
1560
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -1560,22 +1565,22 @@ interface ExtendedFields {
|
|
|
1560
1565
|
*/
|
|
1561
1566
|
namespaces?: Record<string, Record<string, any>>;
|
|
1562
1567
|
}
|
|
1563
|
-
interface GetPublishedContentRequest {
|
|
1568
|
+
export interface GetPublishedContentRequest {
|
|
1564
1569
|
/**
|
|
1565
1570
|
* The ID of the published content
|
|
1566
1571
|
* @format GUID
|
|
1567
1572
|
*/
|
|
1568
1573
|
contentId?: string;
|
|
1569
1574
|
}
|
|
1570
|
-
interface GetPublishedContentResponse {
|
|
1575
|
+
export interface GetPublishedContentResponse {
|
|
1571
1576
|
/** The published content */
|
|
1572
1577
|
publishedContent?: PublishedContent;
|
|
1573
1578
|
}
|
|
1574
|
-
interface QueryPublishedContentRequest {
|
|
1579
|
+
export interface QueryPublishedContentRequest {
|
|
1575
1580
|
/** Query options. Note that some query filters are required. See the API description for a list of required filters. */
|
|
1576
1581
|
query: CursorQuery;
|
|
1577
1582
|
}
|
|
1578
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1583
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1579
1584
|
/**
|
|
1580
1585
|
* Cursor paging options.
|
|
1581
1586
|
*
|
|
@@ -1597,7 +1602,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1597
1602
|
sort?: Sorting[];
|
|
1598
1603
|
}
|
|
1599
1604
|
/** @oneof */
|
|
1600
|
-
interface CursorQueryPagingMethodOneOf {
|
|
1605
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1601
1606
|
/**
|
|
1602
1607
|
* Cursor paging options.
|
|
1603
1608
|
*
|
|
@@ -1605,7 +1610,7 @@ interface CursorQueryPagingMethodOneOf {
|
|
|
1605
1610
|
*/
|
|
1606
1611
|
cursorPaging?: CursorPaging;
|
|
1607
1612
|
}
|
|
1608
|
-
interface Sorting {
|
|
1613
|
+
export interface Sorting {
|
|
1609
1614
|
/**
|
|
1610
1615
|
* Name of the field to sort by.
|
|
1611
1616
|
* @maxLength 512
|
|
@@ -1614,11 +1619,11 @@ interface Sorting {
|
|
|
1614
1619
|
/** Sort order. */
|
|
1615
1620
|
order?: SortOrder;
|
|
1616
1621
|
}
|
|
1617
|
-
declare enum SortOrder {
|
|
1622
|
+
export declare enum SortOrder {
|
|
1618
1623
|
ASC = "ASC",
|
|
1619
1624
|
DESC = "DESC"
|
|
1620
1625
|
}
|
|
1621
|
-
interface CursorPaging {
|
|
1626
|
+
export interface CursorPaging {
|
|
1622
1627
|
/**
|
|
1623
1628
|
* Maximum number of items to return in the results.
|
|
1624
1629
|
* @max 100
|
|
@@ -1633,13 +1638,13 @@ interface CursorPaging {
|
|
|
1633
1638
|
*/
|
|
1634
1639
|
cursor?: string | null;
|
|
1635
1640
|
}
|
|
1636
|
-
interface QueryPublishedContentResponse {
|
|
1641
|
+
export interface QueryPublishedContentResponse {
|
|
1637
1642
|
/** The published translation content. */
|
|
1638
1643
|
publishedContent?: PublishedContent[];
|
|
1639
1644
|
/** Details on the paged set of results returned. */
|
|
1640
1645
|
pagingMetadata?: CursorPagingMetadata;
|
|
1641
1646
|
}
|
|
1642
|
-
interface CursorPagingMetadata {
|
|
1647
|
+
export interface CursorPagingMetadata {
|
|
1643
1648
|
/** Number of items returned in current page. */
|
|
1644
1649
|
count?: number | null;
|
|
1645
1650
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1652,7 +1657,7 @@ interface CursorPagingMetadata {
|
|
|
1652
1657
|
*/
|
|
1653
1658
|
hasNext?: boolean | null;
|
|
1654
1659
|
}
|
|
1655
|
-
interface Cursors {
|
|
1660
|
+
export interface Cursors {
|
|
1656
1661
|
/**
|
|
1657
1662
|
* Cursor string pointing to the next page in the list of results.
|
|
1658
1663
|
* @maxLength 16000
|
|
@@ -1664,7 +1669,7 @@ interface Cursors {
|
|
|
1664
1669
|
*/
|
|
1665
1670
|
prev?: string | null;
|
|
1666
1671
|
}
|
|
1667
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1672
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1668
1673
|
createdEvent?: EntityCreatedEvent;
|
|
1669
1674
|
updatedEvent?: EntityUpdatedEvent;
|
|
1670
1675
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1707,19 +1712,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1707
1712
|
entityEventSequence?: string | null;
|
|
1708
1713
|
}
|
|
1709
1714
|
/** @oneof */
|
|
1710
|
-
interface DomainEventBodyOneOf {
|
|
1715
|
+
export interface DomainEventBodyOneOf {
|
|
1711
1716
|
createdEvent?: EntityCreatedEvent;
|
|
1712
1717
|
updatedEvent?: EntityUpdatedEvent;
|
|
1713
1718
|
deletedEvent?: EntityDeletedEvent;
|
|
1714
1719
|
actionEvent?: ActionEvent;
|
|
1715
1720
|
}
|
|
1716
|
-
interface EntityCreatedEvent {
|
|
1721
|
+
export interface EntityCreatedEvent {
|
|
1717
1722
|
entity?: string;
|
|
1718
1723
|
}
|
|
1719
|
-
interface RestoreInfo {
|
|
1724
|
+
export interface RestoreInfo {
|
|
1720
1725
|
deletedDate?: Date | null;
|
|
1721
1726
|
}
|
|
1722
|
-
interface EntityUpdatedEvent {
|
|
1727
|
+
export interface EntityUpdatedEvent {
|
|
1723
1728
|
/**
|
|
1724
1729
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1725
1730
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1727,25 +1732,25 @@ interface EntityUpdatedEvent {
|
|
|
1727
1732
|
*/
|
|
1728
1733
|
currentEntity?: string;
|
|
1729
1734
|
}
|
|
1730
|
-
interface EntityDeletedEvent {
|
|
1735
|
+
export interface EntityDeletedEvent {
|
|
1731
1736
|
/** Entity that was deleted */
|
|
1732
1737
|
deletedEntity?: string | null;
|
|
1733
1738
|
}
|
|
1734
|
-
interface ActionEvent {
|
|
1739
|
+
export interface ActionEvent {
|
|
1735
1740
|
body?: string;
|
|
1736
1741
|
}
|
|
1737
|
-
interface Empty {
|
|
1742
|
+
export interface Empty {
|
|
1738
1743
|
}
|
|
1739
|
-
interface DeletePublishedContentRequest {
|
|
1744
|
+
export interface DeletePublishedContentRequest {
|
|
1740
1745
|
/**
|
|
1741
1746
|
* The ID of the published content to delete
|
|
1742
1747
|
* @format GUID
|
|
1743
1748
|
*/
|
|
1744
1749
|
contentId?: string;
|
|
1745
1750
|
}
|
|
1746
|
-
interface DeletePublishedContentResponse {
|
|
1751
|
+
export interface DeletePublishedContentResponse {
|
|
1747
1752
|
}
|
|
1748
|
-
interface MessageEnvelope {
|
|
1753
|
+
export interface MessageEnvelope {
|
|
1749
1754
|
/**
|
|
1750
1755
|
* App instance ID.
|
|
1751
1756
|
* @format GUID
|
|
@@ -1761,7 +1766,7 @@ interface MessageEnvelope {
|
|
|
1761
1766
|
/** Stringify payload. */
|
|
1762
1767
|
data?: string;
|
|
1763
1768
|
}
|
|
1764
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1769
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1765
1770
|
/**
|
|
1766
1771
|
* ID of a site visitor that has not logged in to the site.
|
|
1767
1772
|
* @format GUID
|
|
@@ -1786,7 +1791,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1786
1791
|
identityType?: WebhookIdentityType;
|
|
1787
1792
|
}
|
|
1788
1793
|
/** @oneof */
|
|
1789
|
-
interface IdentificationDataIdOneOf {
|
|
1794
|
+
export interface IdentificationDataIdOneOf {
|
|
1790
1795
|
/**
|
|
1791
1796
|
* ID of a site visitor that has not logged in to the site.
|
|
1792
1797
|
* @format GUID
|
|
@@ -1808,14 +1813,14 @@ interface IdentificationDataIdOneOf {
|
|
|
1808
1813
|
*/
|
|
1809
1814
|
appId?: string;
|
|
1810
1815
|
}
|
|
1811
|
-
declare enum WebhookIdentityType {
|
|
1816
|
+
export declare enum WebhookIdentityType {
|
|
1812
1817
|
UNKNOWN = "UNKNOWN",
|
|
1813
1818
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1814
1819
|
MEMBER = "MEMBER",
|
|
1815
1820
|
WIX_USER = "WIX_USER",
|
|
1816
1821
|
APP = "APP"
|
|
1817
1822
|
}
|
|
1818
|
-
interface BaseEventMetadata {
|
|
1823
|
+
export interface BaseEventMetadata {
|
|
1819
1824
|
/**
|
|
1820
1825
|
* App instance ID.
|
|
1821
1826
|
* @format GUID
|
|
@@ -1829,7 +1834,7 @@ interface BaseEventMetadata {
|
|
|
1829
1834
|
/** The identification type and identity data. */
|
|
1830
1835
|
identity?: IdentificationData;
|
|
1831
1836
|
}
|
|
1832
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
1837
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
1833
1838
|
/**
|
|
1834
1839
|
* Unique event ID.
|
|
1835
1840
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1867,18 +1872,86 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1867
1872
|
*/
|
|
1868
1873
|
entityEventSequence?: string | null;
|
|
1869
1874
|
}
|
|
1870
|
-
interface PublishedContentCreatedEnvelope {
|
|
1875
|
+
export interface PublishedContentCreatedEnvelope {
|
|
1871
1876
|
entity: PublishedContent;
|
|
1872
1877
|
metadata: EventMetadata;
|
|
1873
1878
|
}
|
|
1874
|
-
|
|
1879
|
+
/**
|
|
1880
|
+
* Triggered when published content is created.
|
|
1881
|
+
* @permissionScope Wix Multilingual - Translation API
|
|
1882
|
+
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1883
|
+
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1884
|
+
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1885
|
+
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1886
|
+
* @webhook
|
|
1887
|
+
* @eventType wix.multilingual.localization_public.v3.published_content_created
|
|
1888
|
+
* @slug created
|
|
1889
|
+
*/
|
|
1890
|
+
export declare function onPublishedContentCreated(handler: (event: PublishedContentCreatedEnvelope) => void | Promise<void>): void;
|
|
1891
|
+
export interface PublishedContentDeletedEnvelope {
|
|
1875
1892
|
entity: PublishedContent;
|
|
1876
1893
|
metadata: EventMetadata;
|
|
1877
1894
|
}
|
|
1878
|
-
|
|
1895
|
+
/**
|
|
1896
|
+
* Triggered when published content is deleted.
|
|
1897
|
+
* @permissionScope Wix Multilingual - Translation API
|
|
1898
|
+
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1899
|
+
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1900
|
+
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1901
|
+
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1902
|
+
* @webhook
|
|
1903
|
+
* @eventType wix.multilingual.localization_public.v3.published_content_deleted
|
|
1904
|
+
* @slug deleted
|
|
1905
|
+
*/
|
|
1906
|
+
export declare function onPublishedContentDeleted(handler: (event: PublishedContentDeletedEnvelope) => void | Promise<void>): void;
|
|
1907
|
+
export interface PublishedContentUpdatedEnvelope {
|
|
1879
1908
|
entity: PublishedContent;
|
|
1880
1909
|
metadata: EventMetadata;
|
|
1881
1910
|
}
|
|
1911
|
+
/**
|
|
1912
|
+
* Triggered when published content is updated.
|
|
1913
|
+
* @permissionScope Wix Multilingual - Translation API
|
|
1914
|
+
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1915
|
+
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1916
|
+
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1917
|
+
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1918
|
+
* @webhook
|
|
1919
|
+
* @eventType wix.multilingual.localization_public.v3.published_content_updated
|
|
1920
|
+
* @slug updated
|
|
1921
|
+
*/
|
|
1922
|
+
export declare function onPublishedContentUpdated(handler: (event: PublishedContentUpdatedEnvelope) => void | Promise<void>): void;
|
|
1923
|
+
/**
|
|
1924
|
+
* Creates a query to retrieve a list of translation content items.
|
|
1925
|
+
*
|
|
1926
|
+
* The `queryPublishedContent()` function builds a query to retrieve a list of translation content items and returns a `PublishedContentQueryBuilder` object.
|
|
1927
|
+
*
|
|
1928
|
+
* 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.
|
|
1929
|
+
*
|
|
1930
|
+
* 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.
|
|
1931
|
+
*
|
|
1932
|
+
* `queryPublishedContent()` runs with the following `PublishedContentQueryBuilder` defaults which you can override:
|
|
1933
|
+
*
|
|
1934
|
+
* + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/limit)
|
|
1935
|
+
* + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/ascending)
|
|
1936
|
+
*
|
|
1937
|
+
* The following query filter fields are required:
|
|
1938
|
+
*
|
|
1939
|
+
* + `schemaKey.appId`
|
|
1940
|
+
* + `schemaKey.entityType`
|
|
1941
|
+
* + `schemaKey.scope`
|
|
1942
|
+
*
|
|
1943
|
+
* 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`.
|
|
1944
|
+
* @public
|
|
1945
|
+
* @permissionScope Wix Multilingual - Translation API
|
|
1946
|
+
* @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
|
|
1947
|
+
* @permissionScope Wix Multilingual - Translation Content + Published Content Read
|
|
1948
|
+
* @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
|
|
1949
|
+
* @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
|
|
1950
|
+
* @applicableIdentity APP
|
|
1951
|
+
* @applicableIdentity VISITOR
|
|
1952
|
+
* @fqn com.wixpress.localizationpublic.v3.TranslationPublishedContent.QueryPublishedContent
|
|
1953
|
+
*/
|
|
1954
|
+
export declare function queryPublishedContent(): PublishedContentQueryBuilder;
|
|
1882
1955
|
interface QueryCursorResult {
|
|
1883
1956
|
cursors: Cursors;
|
|
1884
1957
|
hasNext: () => boolean;
|
|
@@ -1886,13 +1959,13 @@ interface QueryCursorResult {
|
|
|
1886
1959
|
length: number;
|
|
1887
1960
|
pageSize: number;
|
|
1888
1961
|
}
|
|
1889
|
-
interface PublishedContentQueryResult extends QueryCursorResult {
|
|
1962
|
+
export interface PublishedContentQueryResult extends QueryCursorResult {
|
|
1890
1963
|
items: PublishedContent[];
|
|
1891
1964
|
query: PublishedContentQueryBuilder;
|
|
1892
1965
|
next: () => Promise<PublishedContentQueryResult>;
|
|
1893
1966
|
prev: () => Promise<PublishedContentQueryResult>;
|
|
1894
1967
|
}
|
|
1895
|
-
interface PublishedContentQueryBuilder {
|
|
1968
|
+
export interface PublishedContentQueryBuilder {
|
|
1896
1969
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1897
1970
|
* @param value - Value to compare against.
|
|
1898
1971
|
*/
|
|
@@ -1921,5 +1994,4 @@ interface PublishedContentQueryBuilder {
|
|
|
1921
1994
|
skipTo: (cursor: string) => PublishedContentQueryBuilder;
|
|
1922
1995
|
find: () => Promise<PublishedContentQueryResult>;
|
|
1923
1996
|
}
|
|
1924
|
-
|
|
1925
|
-
export { type Rel as $, Alignment as A, BackgroundType as B, Crop as C, DecorationType as D, type Border as E, FontType as F, GIFType as G, type Colors as H, InitialExpandedItems as I, type PluginContainerData as J, type PluginContainerDataWidth as K, LineStyle as L, MapType as M, NodeType as N, Orientation as O, type PublishedContentQueryBuilder as P, type PluginContainerDataWidthDataOneOf as Q, type RichContent as R, SchemaScope as S, Type as T, type Spoiler as U, ViewMode as V, WidthType as W, type Height as X, type Styles as Y, type Link as Z, type LinkDataOneOf as _, PluginContainerDataAlignment as a, type Dimensions as a$, type CodeBlockData as a0, type TextStyle as a1, type DividerData as a2, type FileData as a3, type FileSource as a4, type FileSourceDataOneOf as a5, type PDFSettings as a6, type GalleryData as a7, type Media as a8, type Image as a9, type Gradient as aA, type Background as aB, type BackgroundBackgroundOneOf as aC, type PollDesign as aD, type OptionDesign as aE, type Poll as aF, type PollDataLayout as aG, type Design as aH, type TextData as aI, type Decoration as aJ, type DecorationDataOneOf as aK, type AnchorData as aL, type ColorData as aM, type LinkData as aN, type MentionData as aO, type FontSizeData as aP, type SpoilerData as aQ, type AppEmbedData as aR, type AppEmbedDataAppDataOneOf as aS, type BookingData as aT, type EventData as aU, type VideoData as aV, type PlaybackOptions as aW, type EmbedData as aX, type Oembed as aY, type CollapsibleListData as aZ, type TableData as a_, type Video as aa, type Item as ab, type ItemDataOneOf as ac, type GalleryOptions as ad, type Layout as ae, type ItemStyle as af, type Thumbnails as ag, type GIFData as ah, type GIF as ai, type HeadingData as aj, type HTMLData as ak, type HTMLDataDataOneOf as al, type ImageData as am, type StylesBorder as an, type ImageDataStyles as ao, type LinkPreviewData as ap, type LinkPreviewDataStyles as aq, type MapData as ar, type MapSettings as as, type ParagraphData as at, type PollData as au, type Permissions as av, type Option as aw, type Settings as ax, type PollLayout as ay, type OptionLayout as az, Target as b, type TableCellData as b0, type CellStyle as b1, type BorderColors as b2, type ListValue as b3, type AudioData as b4, type OrderedListData as b5, type BulletedListData as b6, type BlockquoteData as b7, type CaptionData as b8, type LayoutCellData as b9, type MessageEnvelope as bA, type IdentificationData as bB, type IdentificationDataIdOneOf as bC, type BaseEventMetadata as bD, type EventMetadata as bE, type PublishedContentCreatedEnvelope as bF, type PublishedContentDeletedEnvelope as bG, type PublishedContentUpdatedEnvelope as bH, type PublishedContentQueryResult as bI, type Metadata as ba, type DocumentStyle as bb, type TextNodeStyle as bc, type FocalPoint as bd, type VideoResolution as be, type ExtendedFields as bf, type GetPublishedContentRequest as bg, type GetPublishedContentResponse as bh, type QueryPublishedContentRequest as bi, type CursorQuery as bj, type CursorQueryPagingMethodOneOf as bk, type Sorting as bl, type CursorPaging as bm, type QueryPublishedContentResponse as bn, type CursorPagingMetadata as bo, type Cursors as bp, type DomainEvent as bq, type DomainEventBodyOneOf as br, type EntityCreatedEvent as bs, type RestoreInfo as bt, type EntityUpdatedEvent as bu, type EntityDeletedEvent as bv, type ActionEvent as bw, type Empty as bx, type DeletePublishedContentRequest as by, type DeletePublishedContentResponse as bz, TextAlignment as c, Width as d, LayoutType as e, ThumbnailsAlignment as f, Source as g, Position as h, ViewRole as i, VoteRole as j, PollLayoutType as k, PollLayoutDirection as l, AppType as m, Direction as n, VerticalAlignment as o, NullValue as p, SortOrder as q, WebhookIdentityType as r, type PublishedContent as s, type SchemaKey as t, type PublishedContentField as u, type PublishedContentFieldValueOneOf as v, type Node as w, type NodeDataOneOf as x, type NodeStyle as y, type ButtonData as z };
|
|
1997
|
+
export {};
|