@wix/auto_sdk_multilingual_translation-published-contents 1.0.15 → 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/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,6 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
interface PublishedContent {
|
|
1
|
+
export interface PublishedContent {
|
|
4
2
|
/**
|
|
5
3
|
* Published content ID.
|
|
6
4
|
* @readonly
|
|
@@ -35,7 +33,7 @@ interface PublishedContent {
|
|
|
35
33
|
/** Custom field data for the published content object. */
|
|
36
34
|
extendedFields?: ExtendedFields;
|
|
37
35
|
}
|
|
38
|
-
interface SchemaKey {
|
|
36
|
+
export interface SchemaKey {
|
|
39
37
|
/**
|
|
40
38
|
* ID of the app that created the schema.
|
|
41
39
|
* @format GUID
|
|
@@ -58,14 +56,14 @@ interface SchemaKey {
|
|
|
58
56
|
*/
|
|
59
57
|
scope?: SchemaScope;
|
|
60
58
|
}
|
|
61
|
-
declare enum SchemaScope {
|
|
59
|
+
export declare enum SchemaScope {
|
|
62
60
|
UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
|
|
63
61
|
/** Global schema for all sites. */
|
|
64
62
|
GLOBAL = "GLOBAL",
|
|
65
63
|
/** Custom schema for a specific site. */
|
|
66
64
|
SITE = "SITE"
|
|
67
65
|
}
|
|
68
|
-
interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
66
|
+
export interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
69
67
|
/**
|
|
70
68
|
* Plain text.
|
|
71
69
|
* @maxLength 100000
|
|
@@ -93,7 +91,7 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
|
93
91
|
sequenceIds?: string[];
|
|
94
92
|
}
|
|
95
93
|
/** @oneof */
|
|
96
|
-
interface PublishedContentFieldValueOneOf {
|
|
94
|
+
export interface PublishedContentFieldValueOneOf {
|
|
97
95
|
/**
|
|
98
96
|
* Plain text.
|
|
99
97
|
* @maxLength 100000
|
|
@@ -108,7 +106,7 @@ interface PublishedContentFieldValueOneOf {
|
|
|
108
106
|
/** Wix Media Manager document. */
|
|
109
107
|
document?: Document;
|
|
110
108
|
}
|
|
111
|
-
interface RichContent {
|
|
109
|
+
export interface RichContent {
|
|
112
110
|
/** Node objects representing a rich content document. */
|
|
113
111
|
nodes?: Node[];
|
|
114
112
|
/** Object metadata. */
|
|
@@ -116,7 +114,7 @@ interface RichContent {
|
|
|
116
114
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
117
115
|
documentStyle?: DocumentStyle;
|
|
118
116
|
}
|
|
119
|
-
interface Node extends NodeDataOneOf {
|
|
117
|
+
export interface Node extends NodeDataOneOf {
|
|
120
118
|
/** Data for a button node. */
|
|
121
119
|
buttonData?: ButtonData;
|
|
122
120
|
/** Data for a code block node. */
|
|
@@ -181,7 +179,7 @@ interface Node extends NodeDataOneOf {
|
|
|
181
179
|
style?: NodeStyle;
|
|
182
180
|
}
|
|
183
181
|
/** @oneof */
|
|
184
|
-
interface NodeDataOneOf {
|
|
182
|
+
export interface NodeDataOneOf {
|
|
185
183
|
/** Data for a button node. */
|
|
186
184
|
buttonData?: ButtonData;
|
|
187
185
|
/** Data for a code block node. */
|
|
@@ -237,7 +235,7 @@ interface NodeDataOneOf {
|
|
|
237
235
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
238
236
|
layoutCellData?: LayoutCellData;
|
|
239
237
|
}
|
|
240
|
-
declare enum NodeType {
|
|
238
|
+
export declare enum NodeType {
|
|
241
239
|
PARAGRAPH = "PARAGRAPH",
|
|
242
240
|
TEXT = "TEXT",
|
|
243
241
|
HEADING = "HEADING",
|
|
@@ -273,7 +271,7 @@ declare enum NodeType {
|
|
|
273
271
|
LAYOUT = "LAYOUT",
|
|
274
272
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
275
273
|
}
|
|
276
|
-
interface NodeStyle {
|
|
274
|
+
export interface NodeStyle {
|
|
277
275
|
/** The top padding value in pixels. */
|
|
278
276
|
paddingTop?: string | null;
|
|
279
277
|
/** The bottom padding value in pixels. */
|
|
@@ -281,7 +279,7 @@ interface NodeStyle {
|
|
|
281
279
|
/** The background color as a hexadecimal value. */
|
|
282
280
|
backgroundColor?: string | null;
|
|
283
281
|
}
|
|
284
|
-
interface ButtonData {
|
|
282
|
+
export interface ButtonData {
|
|
285
283
|
/** Styling for the button's container. */
|
|
286
284
|
containerData?: PluginContainerData;
|
|
287
285
|
/** The button type. */
|
|
@@ -293,7 +291,7 @@ interface ButtonData {
|
|
|
293
291
|
/** Button link details. */
|
|
294
292
|
link?: Link;
|
|
295
293
|
}
|
|
296
|
-
interface Border {
|
|
294
|
+
export interface Border {
|
|
297
295
|
/**
|
|
298
296
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
299
297
|
* @deprecated
|
|
@@ -305,7 +303,7 @@ interface Border {
|
|
|
305
303
|
*/
|
|
306
304
|
radius?: number | null;
|
|
307
305
|
}
|
|
308
|
-
interface Colors {
|
|
306
|
+
export interface Colors {
|
|
309
307
|
/**
|
|
310
308
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
311
309
|
* @deprecated
|
|
@@ -322,7 +320,7 @@ interface Colors {
|
|
|
322
320
|
*/
|
|
323
321
|
background?: string | null;
|
|
324
322
|
}
|
|
325
|
-
interface PluginContainerData {
|
|
323
|
+
export interface PluginContainerData {
|
|
326
324
|
/** The width of the node when it's displayed. */
|
|
327
325
|
width?: PluginContainerDataWidth;
|
|
328
326
|
/** The node's alignment within its container. */
|
|
@@ -334,7 +332,7 @@ interface PluginContainerData {
|
|
|
334
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`. */
|
|
335
333
|
textWrap?: boolean | null;
|
|
336
334
|
}
|
|
337
|
-
declare enum WidthType {
|
|
335
|
+
export declare enum WidthType {
|
|
338
336
|
/** Width matches the content width */
|
|
339
337
|
CONTENT = "CONTENT",
|
|
340
338
|
/** Small Width */
|
|
@@ -344,7 +342,7 @@ declare enum WidthType {
|
|
|
344
342
|
/** coast-to-coast display */
|
|
345
343
|
FULL_WIDTH = "FULL_WIDTH"
|
|
346
344
|
}
|
|
347
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
345
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
348
346
|
/**
|
|
349
347
|
* One of the following predefined width options:
|
|
350
348
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -357,7 +355,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
357
355
|
custom?: string | null;
|
|
358
356
|
}
|
|
359
357
|
/** @oneof */
|
|
360
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
358
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
361
359
|
/**
|
|
362
360
|
* One of the following predefined width options:
|
|
363
361
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -369,7 +367,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
369
367
|
/** A custom width value in pixels. */
|
|
370
368
|
custom?: string | null;
|
|
371
369
|
}
|
|
372
|
-
declare enum PluginContainerDataAlignment {
|
|
370
|
+
export declare enum PluginContainerDataAlignment {
|
|
373
371
|
/** Center Alignment */
|
|
374
372
|
CENTER = "CENTER",
|
|
375
373
|
/** Left Alignment */
|
|
@@ -377,7 +375,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
377
375
|
/** Right Alignment */
|
|
378
376
|
RIGHT = "RIGHT"
|
|
379
377
|
}
|
|
380
|
-
interface Spoiler {
|
|
378
|
+
export interface Spoiler {
|
|
381
379
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
382
380
|
enabled?: boolean | null;
|
|
383
381
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -385,17 +383,17 @@ interface Spoiler {
|
|
|
385
383
|
/** The text for the button used to remove the spoiler cover. */
|
|
386
384
|
buttonText?: string | null;
|
|
387
385
|
}
|
|
388
|
-
interface Height {
|
|
386
|
+
export interface Height {
|
|
389
387
|
/** A custom height value in pixels. */
|
|
390
388
|
custom?: string | null;
|
|
391
389
|
}
|
|
392
|
-
declare enum Type {
|
|
390
|
+
export declare enum Type {
|
|
393
391
|
/** Regular link button */
|
|
394
392
|
LINK = "LINK",
|
|
395
393
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
396
394
|
ACTION = "ACTION"
|
|
397
395
|
}
|
|
398
|
-
interface Styles {
|
|
396
|
+
export interface Styles {
|
|
399
397
|
/**
|
|
400
398
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
401
399
|
* @deprecated
|
|
@@ -448,7 +446,7 @@ interface Styles {
|
|
|
448
446
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
449
447
|
buttonSize?: string | null;
|
|
450
448
|
}
|
|
451
|
-
interface Link extends LinkDataOneOf {
|
|
449
|
+
export interface Link extends LinkDataOneOf {
|
|
452
450
|
/** The absolute URL for the linked document. */
|
|
453
451
|
url?: string;
|
|
454
452
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -467,13 +465,13 @@ interface Link extends LinkDataOneOf {
|
|
|
467
465
|
customData?: string | null;
|
|
468
466
|
}
|
|
469
467
|
/** @oneof */
|
|
470
|
-
interface LinkDataOneOf {
|
|
468
|
+
export interface LinkDataOneOf {
|
|
471
469
|
/** The absolute URL for the linked document. */
|
|
472
470
|
url?: string;
|
|
473
471
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
474
472
|
anchor?: string;
|
|
475
473
|
}
|
|
476
|
-
declare enum Target {
|
|
474
|
+
export declare enum Target {
|
|
477
475
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
478
476
|
SELF = "SELF",
|
|
479
477
|
/** Opens the linked document in a new window or tab */
|
|
@@ -483,7 +481,7 @@ declare enum Target {
|
|
|
483
481
|
/** Opens the linked document in the full body of the window */
|
|
484
482
|
TOP = "TOP"
|
|
485
483
|
}
|
|
486
|
-
interface Rel {
|
|
484
|
+
export interface Rel {
|
|
487
485
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
488
486
|
nofollow?: boolean | null;
|
|
489
487
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -493,17 +491,17 @@ interface Rel {
|
|
|
493
491
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
494
492
|
noreferrer?: boolean | null;
|
|
495
493
|
}
|
|
496
|
-
interface CodeBlockData {
|
|
494
|
+
export interface CodeBlockData {
|
|
497
495
|
/** Styling for the code block's text. */
|
|
498
496
|
textStyle?: TextStyle;
|
|
499
497
|
}
|
|
500
|
-
interface TextStyle {
|
|
498
|
+
export interface TextStyle {
|
|
501
499
|
/** Text alignment. Defaults to `AUTO`. */
|
|
502
500
|
textAlignment?: TextAlignment;
|
|
503
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. */
|
|
504
502
|
lineHeight?: string | null;
|
|
505
503
|
}
|
|
506
|
-
declare enum TextAlignment {
|
|
504
|
+
export declare enum TextAlignment {
|
|
507
505
|
/** browser default, eqivalent to `initial` */
|
|
508
506
|
AUTO = "AUTO",
|
|
509
507
|
/** Left align */
|
|
@@ -515,7 +513,7 @@ declare enum TextAlignment {
|
|
|
515
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 */
|
|
516
514
|
JUSTIFY = "JUSTIFY"
|
|
517
515
|
}
|
|
518
|
-
interface DividerData {
|
|
516
|
+
export interface DividerData {
|
|
519
517
|
/** Styling for the divider's container. */
|
|
520
518
|
containerData?: PluginContainerData;
|
|
521
519
|
/** Divider line style. */
|
|
@@ -525,7 +523,7 @@ interface DividerData {
|
|
|
525
523
|
/** Divider alignment. */
|
|
526
524
|
alignment?: Alignment;
|
|
527
525
|
}
|
|
528
|
-
declare enum LineStyle {
|
|
526
|
+
export declare enum LineStyle {
|
|
529
527
|
/** Single Line */
|
|
530
528
|
SINGLE = "SINGLE",
|
|
531
529
|
/** Double Line */
|
|
@@ -535,7 +533,7 @@ declare enum LineStyle {
|
|
|
535
533
|
/** Dotted Line */
|
|
536
534
|
DOTTED = "DOTTED"
|
|
537
535
|
}
|
|
538
|
-
declare enum Width {
|
|
536
|
+
export declare enum Width {
|
|
539
537
|
/** Large line */
|
|
540
538
|
LARGE = "LARGE",
|
|
541
539
|
/** Medium line */
|
|
@@ -543,7 +541,7 @@ declare enum Width {
|
|
|
543
541
|
/** Small line */
|
|
544
542
|
SMALL = "SMALL"
|
|
545
543
|
}
|
|
546
|
-
declare enum Alignment {
|
|
544
|
+
export declare enum Alignment {
|
|
547
545
|
/** Center alignment */
|
|
548
546
|
CENTER = "CENTER",
|
|
549
547
|
/** Left alignment */
|
|
@@ -551,7 +549,7 @@ declare enum Alignment {
|
|
|
551
549
|
/** Right alignment */
|
|
552
550
|
RIGHT = "RIGHT"
|
|
553
551
|
}
|
|
554
|
-
interface FileData {
|
|
552
|
+
export interface FileData {
|
|
555
553
|
/** Styling for the file's container. */
|
|
556
554
|
containerData?: PluginContainerData;
|
|
557
555
|
/** The source for the file's data. */
|
|
@@ -574,7 +572,7 @@ interface FileData {
|
|
|
574
572
|
/** File size in KB. */
|
|
575
573
|
sizeInKb?: string | null;
|
|
576
574
|
}
|
|
577
|
-
declare enum ViewMode {
|
|
575
|
+
export declare enum ViewMode {
|
|
578
576
|
/** No PDF view */
|
|
579
577
|
NONE = "NONE",
|
|
580
578
|
/** Full PDF view */
|
|
@@ -582,7 +580,7 @@ declare enum ViewMode {
|
|
|
582
580
|
/** Mini PDF view */
|
|
583
581
|
MINI = "MINI"
|
|
584
582
|
}
|
|
585
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
583
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
586
584
|
/** The absolute URL for the file's source. */
|
|
587
585
|
url?: string | null;
|
|
588
586
|
/**
|
|
@@ -596,7 +594,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
596
594
|
private?: boolean | null;
|
|
597
595
|
}
|
|
598
596
|
/** @oneof */
|
|
599
|
-
interface FileSourceDataOneOf {
|
|
597
|
+
export interface FileSourceDataOneOf {
|
|
600
598
|
/** The absolute URL for the file's source. */
|
|
601
599
|
url?: string | null;
|
|
602
600
|
/**
|
|
@@ -607,7 +605,7 @@ interface FileSourceDataOneOf {
|
|
|
607
605
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
608
606
|
id?: string | null;
|
|
609
607
|
}
|
|
610
|
-
interface PDFSettings {
|
|
608
|
+
export interface PDFSettings {
|
|
611
609
|
/**
|
|
612
610
|
* PDF view mode. One of the following:
|
|
613
611
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -620,7 +618,7 @@ interface PDFSettings {
|
|
|
620
618
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
621
619
|
disablePrint?: boolean | null;
|
|
622
620
|
}
|
|
623
|
-
interface GalleryData {
|
|
621
|
+
export interface GalleryData {
|
|
624
622
|
/** Styling for the gallery's container. */
|
|
625
623
|
containerData?: PluginContainerData;
|
|
626
624
|
/** The items in the gallery. */
|
|
@@ -632,7 +630,7 @@ interface GalleryData {
|
|
|
632
630
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
633
631
|
disableDownload?: boolean | null;
|
|
634
632
|
}
|
|
635
|
-
interface Media {
|
|
633
|
+
export interface Media {
|
|
636
634
|
/** The source for the media's data. */
|
|
637
635
|
src?: FileSource;
|
|
638
636
|
/** Media width in pixels. */
|
|
@@ -642,19 +640,19 @@ interface Media {
|
|
|
642
640
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
643
641
|
duration?: number | null;
|
|
644
642
|
}
|
|
645
|
-
interface ItemImage {
|
|
643
|
+
export interface ItemImage {
|
|
646
644
|
/** Image file details. */
|
|
647
645
|
media?: Media;
|
|
648
646
|
/** Link details for images that are links. */
|
|
649
647
|
link?: Link;
|
|
650
648
|
}
|
|
651
|
-
interface Video {
|
|
649
|
+
export interface Video {
|
|
652
650
|
/** Video file details. */
|
|
653
651
|
media?: Media;
|
|
654
652
|
/** Video thumbnail file details. */
|
|
655
653
|
thumbnail?: Media;
|
|
656
654
|
}
|
|
657
|
-
interface Item extends ItemDataOneOf {
|
|
655
|
+
export interface Item extends ItemDataOneOf {
|
|
658
656
|
/** An image item. */
|
|
659
657
|
image?: ItemImage;
|
|
660
658
|
/** A video item. */
|
|
@@ -665,13 +663,13 @@ interface Item extends ItemDataOneOf {
|
|
|
665
663
|
altText?: string | null;
|
|
666
664
|
}
|
|
667
665
|
/** @oneof */
|
|
668
|
-
interface ItemDataOneOf {
|
|
666
|
+
export interface ItemDataOneOf {
|
|
669
667
|
/** An image item. */
|
|
670
668
|
image?: ItemImage;
|
|
671
669
|
/** A video item. */
|
|
672
670
|
video?: Video;
|
|
673
671
|
}
|
|
674
|
-
interface GalleryOptions {
|
|
672
|
+
export interface GalleryOptions {
|
|
675
673
|
/** Gallery layout. */
|
|
676
674
|
layout?: Layout;
|
|
677
675
|
/** Styling for gallery items. */
|
|
@@ -679,7 +677,7 @@ interface GalleryOptions {
|
|
|
679
677
|
/** Styling for gallery thumbnail images. */
|
|
680
678
|
thumbnails?: Thumbnails;
|
|
681
679
|
}
|
|
682
|
-
declare enum LayoutType {
|
|
680
|
+
export declare enum LayoutType {
|
|
683
681
|
/** Collage type */
|
|
684
682
|
COLLAGE = "COLLAGE",
|
|
685
683
|
/** Masonry type */
|
|
@@ -701,19 +699,19 @@ declare enum LayoutType {
|
|
|
701
699
|
/** Fullsize images type */
|
|
702
700
|
FULLSIZE = "FULLSIZE"
|
|
703
701
|
}
|
|
704
|
-
declare enum Orientation {
|
|
702
|
+
export declare enum Orientation {
|
|
705
703
|
/** Rows Orientation */
|
|
706
704
|
ROWS = "ROWS",
|
|
707
705
|
/** Columns Orientation */
|
|
708
706
|
COLUMNS = "COLUMNS"
|
|
709
707
|
}
|
|
710
|
-
declare enum Crop {
|
|
708
|
+
export declare enum Crop {
|
|
711
709
|
/** Crop to fill */
|
|
712
710
|
FILL = "FILL",
|
|
713
711
|
/** Crop to fit */
|
|
714
712
|
FIT = "FIT"
|
|
715
713
|
}
|
|
716
|
-
declare enum ThumbnailsAlignment {
|
|
714
|
+
export declare enum ThumbnailsAlignment {
|
|
717
715
|
/** Top alignment */
|
|
718
716
|
TOP = "TOP",
|
|
719
717
|
/** Right alignment */
|
|
@@ -725,7 +723,7 @@ declare enum ThumbnailsAlignment {
|
|
|
725
723
|
/** No thumbnail */
|
|
726
724
|
NONE = "NONE"
|
|
727
725
|
}
|
|
728
|
-
interface Layout {
|
|
726
|
+
export interface Layout {
|
|
729
727
|
/** Gallery layout type. */
|
|
730
728
|
type?: LayoutType;
|
|
731
729
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -737,7 +735,7 @@ interface Layout {
|
|
|
737
735
|
/** The number of columns to display on mobile screens. */
|
|
738
736
|
mobileNumberOfColumns?: number | null;
|
|
739
737
|
}
|
|
740
|
-
interface ItemStyle {
|
|
738
|
+
export interface ItemStyle {
|
|
741
739
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
742
740
|
targetSize?: number | null;
|
|
743
741
|
/** Item ratio */
|
|
@@ -747,13 +745,13 @@ interface ItemStyle {
|
|
|
747
745
|
/** The spacing between items in pixels. */
|
|
748
746
|
spacing?: number | null;
|
|
749
747
|
}
|
|
750
|
-
interface Thumbnails {
|
|
748
|
+
export interface Thumbnails {
|
|
751
749
|
/** Thumbnail alignment. */
|
|
752
750
|
placement?: ThumbnailsAlignment;
|
|
753
751
|
/** Spacing between thumbnails in pixels. */
|
|
754
752
|
spacing?: number | null;
|
|
755
753
|
}
|
|
756
|
-
interface GIFData {
|
|
754
|
+
export interface GIFData {
|
|
757
755
|
/** Styling for the GIF's container. */
|
|
758
756
|
containerData?: PluginContainerData;
|
|
759
757
|
/** The source of the full size GIF. */
|
|
@@ -767,7 +765,7 @@ interface GIFData {
|
|
|
767
765
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
768
766
|
gifType?: GIFType;
|
|
769
767
|
}
|
|
770
|
-
interface GIF {
|
|
768
|
+
export interface GIF {
|
|
771
769
|
/**
|
|
772
770
|
* GIF format URL.
|
|
773
771
|
* @format WEB_URL
|
|
@@ -784,11 +782,11 @@ interface GIF {
|
|
|
784
782
|
*/
|
|
785
783
|
still?: string | null;
|
|
786
784
|
}
|
|
787
|
-
declare enum GIFType {
|
|
785
|
+
export declare enum GIFType {
|
|
788
786
|
NORMAL = "NORMAL",
|
|
789
787
|
STICKER = "STICKER"
|
|
790
788
|
}
|
|
791
|
-
interface HeadingData {
|
|
789
|
+
export interface HeadingData {
|
|
792
790
|
/** Heading level from 1-6. */
|
|
793
791
|
level?: number;
|
|
794
792
|
/** Styling for the heading text. */
|
|
@@ -796,7 +794,7 @@ interface HeadingData {
|
|
|
796
794
|
/** Indentation level from 1-4. */
|
|
797
795
|
indentation?: number | null;
|
|
798
796
|
}
|
|
799
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
797
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
800
798
|
/** The URL for the HTML code for the node. */
|
|
801
799
|
url?: string;
|
|
802
800
|
/** The HTML code for the node. */
|
|
@@ -814,7 +812,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
814
812
|
autoHeight?: boolean | null;
|
|
815
813
|
}
|
|
816
814
|
/** @oneof */
|
|
817
|
-
interface HTMLDataDataOneOf {
|
|
815
|
+
export interface HTMLDataDataOneOf {
|
|
818
816
|
/** The URL for the HTML code for the node. */
|
|
819
817
|
url?: string;
|
|
820
818
|
/** The HTML code for the node. */
|
|
@@ -825,11 +823,11 @@ interface HTMLDataDataOneOf {
|
|
|
825
823
|
*/
|
|
826
824
|
isAdsense?: boolean | null;
|
|
827
825
|
}
|
|
828
|
-
declare enum Source {
|
|
826
|
+
export declare enum Source {
|
|
829
827
|
HTML = "HTML",
|
|
830
828
|
ADSENSE = "ADSENSE"
|
|
831
829
|
}
|
|
832
|
-
interface ImageData {
|
|
830
|
+
export interface ImageData {
|
|
833
831
|
/** Styling for the image's container. */
|
|
834
832
|
containerData?: PluginContainerData;
|
|
835
833
|
/** Image file details. */
|
|
@@ -852,7 +850,7 @@ interface ImageData {
|
|
|
852
850
|
/** Styling for the image. */
|
|
853
851
|
styles?: ImageDataStyles;
|
|
854
852
|
}
|
|
855
|
-
interface StylesBorder {
|
|
853
|
+
export interface StylesBorder {
|
|
856
854
|
/** Border width in pixels. */
|
|
857
855
|
width?: number | null;
|
|
858
856
|
/**
|
|
@@ -863,11 +861,11 @@ interface StylesBorder {
|
|
|
863
861
|
/** Border radius in pixels. */
|
|
864
862
|
radius?: number | null;
|
|
865
863
|
}
|
|
866
|
-
interface ImageDataStyles {
|
|
864
|
+
export interface ImageDataStyles {
|
|
867
865
|
/** Border attributes. */
|
|
868
866
|
border?: StylesBorder;
|
|
869
867
|
}
|
|
870
|
-
interface LinkPreviewData {
|
|
868
|
+
export interface LinkPreviewData {
|
|
871
869
|
/** Styling for the link preview's container. */
|
|
872
870
|
containerData?: PluginContainerData;
|
|
873
871
|
/** Link details. */
|
|
@@ -883,7 +881,7 @@ interface LinkPreviewData {
|
|
|
883
881
|
/** Styling for the link preview. */
|
|
884
882
|
styles?: LinkPreviewDataStyles;
|
|
885
883
|
}
|
|
886
|
-
declare enum Position {
|
|
884
|
+
export declare enum Position {
|
|
887
885
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
888
886
|
START = "START",
|
|
889
887
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -893,7 +891,7 @@ declare enum Position {
|
|
|
893
891
|
/** Thumbnail hidden and not displayed */
|
|
894
892
|
HIDDEN = "HIDDEN"
|
|
895
893
|
}
|
|
896
|
-
interface LinkPreviewDataStyles {
|
|
894
|
+
export interface LinkPreviewDataStyles {
|
|
897
895
|
/**
|
|
898
896
|
* Background color as a hexadecimal value.
|
|
899
897
|
* @format COLOR_HEX
|
|
@@ -926,13 +924,13 @@ interface LinkPreviewDataStyles {
|
|
|
926
924
|
/** Position of thumbnail. Defaults to `START`. */
|
|
927
925
|
thumbnailPosition?: Position;
|
|
928
926
|
}
|
|
929
|
-
interface MapData {
|
|
927
|
+
export interface MapData {
|
|
930
928
|
/** Styling for the map's container. */
|
|
931
929
|
containerData?: PluginContainerData;
|
|
932
930
|
/** Map settings. */
|
|
933
931
|
mapSettings?: MapSettings;
|
|
934
932
|
}
|
|
935
|
-
interface MapSettings {
|
|
933
|
+
export interface MapSettings {
|
|
936
934
|
/** The address to display on the map. */
|
|
937
935
|
address?: string | null;
|
|
938
936
|
/** Sets whether the map is draggable. */
|
|
@@ -956,7 +954,7 @@ interface MapSettings {
|
|
|
956
954
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
957
955
|
mapType?: MapType;
|
|
958
956
|
}
|
|
959
|
-
declare enum MapType {
|
|
957
|
+
export declare enum MapType {
|
|
960
958
|
/** Roadmap map type */
|
|
961
959
|
ROADMAP = "ROADMAP",
|
|
962
960
|
/** Satellite map type */
|
|
@@ -966,7 +964,7 @@ declare enum MapType {
|
|
|
966
964
|
/** Terrain map type */
|
|
967
965
|
TERRAIN = "TERRAIN"
|
|
968
966
|
}
|
|
969
|
-
interface ParagraphData {
|
|
967
|
+
export interface ParagraphData {
|
|
970
968
|
/** Styling for the paragraph text. */
|
|
971
969
|
textStyle?: TextStyle;
|
|
972
970
|
/** Indentation level from 1-4. */
|
|
@@ -974,7 +972,7 @@ interface ParagraphData {
|
|
|
974
972
|
/** Paragraph level */
|
|
975
973
|
level?: number | null;
|
|
976
974
|
}
|
|
977
|
-
interface PollData {
|
|
975
|
+
export interface PollData {
|
|
978
976
|
/** Styling for the poll's container. */
|
|
979
977
|
containerData?: PluginContainerData;
|
|
980
978
|
/** Poll data. */
|
|
@@ -984,7 +982,7 @@ interface PollData {
|
|
|
984
982
|
/** Styling for the poll and voting options. */
|
|
985
983
|
design?: Design;
|
|
986
984
|
}
|
|
987
|
-
declare enum ViewRole {
|
|
985
|
+
export declare enum ViewRole {
|
|
988
986
|
/** Only Poll creator can view the results */
|
|
989
987
|
CREATOR = "CREATOR",
|
|
990
988
|
/** Anyone who voted can see the results */
|
|
@@ -992,13 +990,13 @@ declare enum ViewRole {
|
|
|
992
990
|
/** Anyone can see the results, even if one didn't vote */
|
|
993
991
|
EVERYONE = "EVERYONE"
|
|
994
992
|
}
|
|
995
|
-
declare enum VoteRole {
|
|
993
|
+
export declare enum VoteRole {
|
|
996
994
|
/** Logged in member */
|
|
997
995
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
998
996
|
/** Anyone */
|
|
999
997
|
ALL = "ALL"
|
|
1000
998
|
}
|
|
1001
|
-
interface Permissions {
|
|
999
|
+
export interface Permissions {
|
|
1002
1000
|
/** Sets who can view the poll results. */
|
|
1003
1001
|
view?: ViewRole;
|
|
1004
1002
|
/** Sets who can vote. */
|
|
@@ -1006,7 +1004,7 @@ interface Permissions {
|
|
|
1006
1004
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1007
1005
|
allowMultipleVotes?: boolean | null;
|
|
1008
1006
|
}
|
|
1009
|
-
interface Option {
|
|
1007
|
+
export interface Option {
|
|
1010
1008
|
/** Option ID. */
|
|
1011
1009
|
id?: string | null;
|
|
1012
1010
|
/** Option title. */
|
|
@@ -1014,7 +1012,7 @@ interface Option {
|
|
|
1014
1012
|
/** The image displayed with the option. */
|
|
1015
1013
|
image?: Media;
|
|
1016
1014
|
}
|
|
1017
|
-
interface Settings {
|
|
1015
|
+
export interface Settings {
|
|
1018
1016
|
/** Permissions settings for voting. */
|
|
1019
1017
|
permissions?: Permissions;
|
|
1020
1018
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1022,19 +1020,19 @@ interface Settings {
|
|
|
1022
1020
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1023
1021
|
showVotesCount?: boolean | null;
|
|
1024
1022
|
}
|
|
1025
|
-
declare enum PollLayoutType {
|
|
1023
|
+
export declare enum PollLayoutType {
|
|
1026
1024
|
/** List */
|
|
1027
1025
|
LIST = "LIST",
|
|
1028
1026
|
/** Grid */
|
|
1029
1027
|
GRID = "GRID"
|
|
1030
1028
|
}
|
|
1031
|
-
declare enum PollLayoutDirection {
|
|
1029
|
+
export declare enum PollLayoutDirection {
|
|
1032
1030
|
/** Left-to-right */
|
|
1033
1031
|
LTR = "LTR",
|
|
1034
1032
|
/** Right-to-left */
|
|
1035
1033
|
RTL = "RTL"
|
|
1036
1034
|
}
|
|
1037
|
-
interface PollLayout {
|
|
1035
|
+
export interface PollLayout {
|
|
1038
1036
|
/** The layout for displaying the voting options. */
|
|
1039
1037
|
type?: PollLayoutType;
|
|
1040
1038
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1042,11 +1040,11 @@ interface PollLayout {
|
|
|
1042
1040
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1043
1041
|
enableImage?: boolean | null;
|
|
1044
1042
|
}
|
|
1045
|
-
interface OptionLayout {
|
|
1043
|
+
export interface OptionLayout {
|
|
1046
1044
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1047
1045
|
enableImage?: boolean | null;
|
|
1048
1046
|
}
|
|
1049
|
-
declare enum BackgroundType {
|
|
1047
|
+
export declare enum BackgroundType {
|
|
1050
1048
|
/** Color background type */
|
|
1051
1049
|
COLOR = "COLOR",
|
|
1052
1050
|
/** Image background type */
|
|
@@ -1054,7 +1052,7 @@ declare enum BackgroundType {
|
|
|
1054
1052
|
/** Gradiant background type */
|
|
1055
1053
|
GRADIENT = "GRADIENT"
|
|
1056
1054
|
}
|
|
1057
|
-
interface Gradient {
|
|
1055
|
+
export interface Gradient {
|
|
1058
1056
|
/** The gradient angle in degrees. */
|
|
1059
1057
|
angle?: number | null;
|
|
1060
1058
|
/**
|
|
@@ -1068,7 +1066,7 @@ interface Gradient {
|
|
|
1068
1066
|
*/
|
|
1069
1067
|
lastColor?: string | null;
|
|
1070
1068
|
}
|
|
1071
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1069
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1072
1070
|
/**
|
|
1073
1071
|
* The background color as a hexademical value.
|
|
1074
1072
|
* @format COLOR_HEX
|
|
@@ -1082,7 +1080,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1082
1080
|
type?: BackgroundType;
|
|
1083
1081
|
}
|
|
1084
1082
|
/** @oneof */
|
|
1085
|
-
interface BackgroundBackgroundOneOf {
|
|
1083
|
+
export interface BackgroundBackgroundOneOf {
|
|
1086
1084
|
/**
|
|
1087
1085
|
* The background color as a hexademical value.
|
|
1088
1086
|
* @format COLOR_HEX
|
|
@@ -1093,17 +1091,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
1093
1091
|
/** Details for a gradient background. */
|
|
1094
1092
|
gradient?: Gradient;
|
|
1095
1093
|
}
|
|
1096
|
-
interface PollDesign {
|
|
1094
|
+
export interface PollDesign {
|
|
1097
1095
|
/** Background styling. */
|
|
1098
1096
|
background?: Background;
|
|
1099
1097
|
/** Border radius in pixels. */
|
|
1100
1098
|
borderRadius?: number | null;
|
|
1101
1099
|
}
|
|
1102
|
-
interface OptionDesign {
|
|
1100
|
+
export interface OptionDesign {
|
|
1103
1101
|
/** Border radius in pixels. */
|
|
1104
1102
|
borderRadius?: number | null;
|
|
1105
1103
|
}
|
|
1106
|
-
interface Poll {
|
|
1104
|
+
export interface Poll {
|
|
1107
1105
|
/** Poll ID. */
|
|
1108
1106
|
id?: string | null;
|
|
1109
1107
|
/** Poll title. */
|
|
@@ -1117,26 +1115,26 @@ interface Poll {
|
|
|
1117
1115
|
/** The poll's permissions and display settings. */
|
|
1118
1116
|
settings?: Settings;
|
|
1119
1117
|
}
|
|
1120
|
-
interface PollDataLayout {
|
|
1118
|
+
export interface PollDataLayout {
|
|
1121
1119
|
/** Poll layout settings. */
|
|
1122
1120
|
poll?: PollLayout;
|
|
1123
1121
|
/** Voting otpions layout settings. */
|
|
1124
1122
|
options?: OptionLayout;
|
|
1125
1123
|
}
|
|
1126
|
-
interface Design {
|
|
1124
|
+
export interface Design {
|
|
1127
1125
|
/** Styling for the poll. */
|
|
1128
1126
|
poll?: PollDesign;
|
|
1129
1127
|
/** Styling for voting options. */
|
|
1130
1128
|
options?: OptionDesign;
|
|
1131
1129
|
}
|
|
1132
|
-
interface TextData {
|
|
1130
|
+
export interface TextData {
|
|
1133
1131
|
/** The text to apply decorations to. */
|
|
1134
1132
|
text?: string;
|
|
1135
1133
|
/** The decorations to apply. */
|
|
1136
1134
|
decorations?: Decoration[];
|
|
1137
1135
|
}
|
|
1138
1136
|
/** Adds appearence changes to text */
|
|
1139
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1137
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1140
1138
|
/** Data for an anchor link decoration. */
|
|
1141
1139
|
anchorData?: AnchorData;
|
|
1142
1140
|
/** Data for a color decoration. */
|
|
@@ -1155,11 +1153,13 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1155
1153
|
underlineData?: boolean | null;
|
|
1156
1154
|
/** Data for a spoiler decoration. */
|
|
1157
1155
|
spoilerData?: SpoilerData;
|
|
1156
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1157
|
+
strikethroughData?: boolean | null;
|
|
1158
1158
|
/** The type of decoration to apply. */
|
|
1159
1159
|
type?: DecorationType;
|
|
1160
1160
|
}
|
|
1161
1161
|
/** @oneof */
|
|
1162
|
-
interface DecorationDataOneOf {
|
|
1162
|
+
export interface DecorationDataOneOf {
|
|
1163
1163
|
/** Data for an anchor link decoration. */
|
|
1164
1164
|
anchorData?: AnchorData;
|
|
1165
1165
|
/** Data for a color decoration. */
|
|
@@ -1178,8 +1178,10 @@ interface DecorationDataOneOf {
|
|
|
1178
1178
|
underlineData?: boolean | null;
|
|
1179
1179
|
/** Data for a spoiler decoration. */
|
|
1180
1180
|
spoilerData?: SpoilerData;
|
|
1181
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1182
|
+
strikethroughData?: boolean | null;
|
|
1181
1183
|
}
|
|
1182
|
-
declare enum DecorationType {
|
|
1184
|
+
export declare enum DecorationType {
|
|
1183
1185
|
BOLD = "BOLD",
|
|
1184
1186
|
ITALIC = "ITALIC",
|
|
1185
1187
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1189,23 +1191,24 @@ declare enum DecorationType {
|
|
|
1189
1191
|
LINK = "LINK",
|
|
1190
1192
|
COLOR = "COLOR",
|
|
1191
1193
|
FONT_SIZE = "FONT_SIZE",
|
|
1192
|
-
EXTERNAL = "EXTERNAL"
|
|
1194
|
+
EXTERNAL = "EXTERNAL",
|
|
1195
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1193
1196
|
}
|
|
1194
|
-
interface AnchorData {
|
|
1197
|
+
export interface AnchorData {
|
|
1195
1198
|
/** The target node's ID. */
|
|
1196
1199
|
anchor?: string;
|
|
1197
1200
|
}
|
|
1198
|
-
interface ColorData {
|
|
1201
|
+
export interface ColorData {
|
|
1199
1202
|
/** The text's background color as a hexadecimal value. */
|
|
1200
1203
|
background?: string | null;
|
|
1201
1204
|
/** The text's foreground color as a hexadecimal value. */
|
|
1202
1205
|
foreground?: string | null;
|
|
1203
1206
|
}
|
|
1204
|
-
interface LinkData {
|
|
1207
|
+
export interface LinkData {
|
|
1205
1208
|
/** Link details. */
|
|
1206
1209
|
link?: Link;
|
|
1207
1210
|
}
|
|
1208
|
-
interface MentionData {
|
|
1211
|
+
export interface MentionData {
|
|
1209
1212
|
/** The mentioned user's name. */
|
|
1210
1213
|
name?: string;
|
|
1211
1214
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1213,21 +1216,21 @@ interface MentionData {
|
|
|
1213
1216
|
/** Mentioned user's ID. */
|
|
1214
1217
|
id?: string | null;
|
|
1215
1218
|
}
|
|
1216
|
-
interface FontSizeData {
|
|
1219
|
+
export interface FontSizeData {
|
|
1217
1220
|
/** The units used for the font size. */
|
|
1218
1221
|
unit?: FontType;
|
|
1219
1222
|
/** Font size value. */
|
|
1220
1223
|
value?: number | null;
|
|
1221
1224
|
}
|
|
1222
|
-
declare enum FontType {
|
|
1225
|
+
export declare enum FontType {
|
|
1223
1226
|
PX = "PX",
|
|
1224
1227
|
EM = "EM"
|
|
1225
1228
|
}
|
|
1226
|
-
interface SpoilerData {
|
|
1229
|
+
export interface SpoilerData {
|
|
1227
1230
|
/** Spoiler ID. */
|
|
1228
1231
|
id?: string | null;
|
|
1229
1232
|
}
|
|
1230
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1233
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1231
1234
|
/** Data for embedded Wix Bookings content. */
|
|
1232
1235
|
bookingData?: BookingData;
|
|
1233
1236
|
/** Data for embedded Wix Events content. */
|
|
@@ -1249,28 +1252,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1249
1252
|
image?: Media;
|
|
1250
1253
|
}
|
|
1251
1254
|
/** @oneof */
|
|
1252
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1255
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1253
1256
|
/** Data for embedded Wix Bookings content. */
|
|
1254
1257
|
bookingData?: BookingData;
|
|
1255
1258
|
/** Data for embedded Wix Events content. */
|
|
1256
1259
|
eventData?: EventData;
|
|
1257
1260
|
}
|
|
1258
|
-
declare enum AppType {
|
|
1261
|
+
export declare enum AppType {
|
|
1259
1262
|
PRODUCT = "PRODUCT",
|
|
1260
1263
|
EVENT = "EVENT",
|
|
1261
1264
|
BOOKING = "BOOKING"
|
|
1262
1265
|
}
|
|
1263
|
-
interface BookingData {
|
|
1266
|
+
export interface BookingData {
|
|
1264
1267
|
/** Booking duration in minutes. */
|
|
1265
1268
|
durations?: string | null;
|
|
1266
1269
|
}
|
|
1267
|
-
interface EventData {
|
|
1270
|
+
export interface EventData {
|
|
1268
1271
|
/** Event schedule. */
|
|
1269
1272
|
scheduling?: string | null;
|
|
1270
1273
|
/** Event location. */
|
|
1271
1274
|
location?: string | null;
|
|
1272
1275
|
}
|
|
1273
|
-
interface VideoData {
|
|
1276
|
+
export interface VideoData {
|
|
1274
1277
|
/** Styling for the video's container. */
|
|
1275
1278
|
containerData?: PluginContainerData;
|
|
1276
1279
|
/** Video details. */
|
|
@@ -1284,7 +1287,7 @@ interface VideoData {
|
|
|
1284
1287
|
/** Video options. */
|
|
1285
1288
|
options?: PlaybackOptions;
|
|
1286
1289
|
}
|
|
1287
|
-
interface PlaybackOptions {
|
|
1290
|
+
export interface PlaybackOptions {
|
|
1288
1291
|
/** Sets whether the media will automatically start playing. */
|
|
1289
1292
|
autoPlay?: boolean | null;
|
|
1290
1293
|
/** Sets whether media's will be looped. */
|
|
@@ -1292,7 +1295,7 @@ interface PlaybackOptions {
|
|
|
1292
1295
|
/** Sets whether media's controls will be shown. */
|
|
1293
1296
|
showControls?: boolean | null;
|
|
1294
1297
|
}
|
|
1295
|
-
interface EmbedData {
|
|
1298
|
+
export interface EmbedData {
|
|
1296
1299
|
/** Styling for the oEmbed node's container. */
|
|
1297
1300
|
containerData?: PluginContainerData;
|
|
1298
1301
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1300,7 +1303,7 @@ interface EmbedData {
|
|
|
1300
1303
|
/** Origin asset source. */
|
|
1301
1304
|
src?: string | null;
|
|
1302
1305
|
}
|
|
1303
|
-
interface Oembed {
|
|
1306
|
+
export interface Oembed {
|
|
1304
1307
|
/** The resource type. */
|
|
1305
1308
|
type?: string | null;
|
|
1306
1309
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1332,7 +1335,7 @@ interface Oembed {
|
|
|
1332
1335
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1333
1336
|
version?: string | null;
|
|
1334
1337
|
}
|
|
1335
|
-
interface CollapsibleListData {
|
|
1338
|
+
export interface CollapsibleListData {
|
|
1336
1339
|
/** Styling for the collapsible list's container. */
|
|
1337
1340
|
containerData?: PluginContainerData;
|
|
1338
1341
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1344,7 +1347,7 @@ interface CollapsibleListData {
|
|
|
1344
1347
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1345
1348
|
isQapageData?: boolean | null;
|
|
1346
1349
|
}
|
|
1347
|
-
declare enum InitialExpandedItems {
|
|
1350
|
+
export declare enum InitialExpandedItems {
|
|
1348
1351
|
/** First item will be expended initally */
|
|
1349
1352
|
FIRST = "FIRST",
|
|
1350
1353
|
/** All items will expended initally */
|
|
@@ -1352,13 +1355,13 @@ declare enum InitialExpandedItems {
|
|
|
1352
1355
|
/** All items collapsed initally */
|
|
1353
1356
|
NONE = "NONE"
|
|
1354
1357
|
}
|
|
1355
|
-
declare enum Direction {
|
|
1358
|
+
export declare enum Direction {
|
|
1356
1359
|
/** Left-to-right */
|
|
1357
1360
|
LTR = "LTR",
|
|
1358
1361
|
/** Right-to-left */
|
|
1359
1362
|
RTL = "RTL"
|
|
1360
1363
|
}
|
|
1361
|
-
interface TableData {
|
|
1364
|
+
export interface TableData {
|
|
1362
1365
|
/** Styling for the table's container. */
|
|
1363
1366
|
containerData?: PluginContainerData;
|
|
1364
1367
|
/** The table's dimensions. */
|
|
@@ -1373,7 +1376,7 @@ interface TableData {
|
|
|
1373
1376
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1374
1377
|
columnHeader?: boolean | null;
|
|
1375
1378
|
}
|
|
1376
|
-
interface Dimensions {
|
|
1379
|
+
export interface Dimensions {
|
|
1377
1380
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1378
1381
|
colsWidthRatio?: number[];
|
|
1379
1382
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1381,13 +1384,13 @@ interface Dimensions {
|
|
|
1381
1384
|
/** An array representing the minimum width of each column in pixels. */
|
|
1382
1385
|
colsMinWidth?: number[];
|
|
1383
1386
|
}
|
|
1384
|
-
interface TableCellData {
|
|
1387
|
+
export interface TableCellData {
|
|
1385
1388
|
/** Styling for the cell's background color and text alignment. */
|
|
1386
1389
|
cellStyle?: CellStyle;
|
|
1387
1390
|
/** The cell's border colors. */
|
|
1388
1391
|
borderColors?: BorderColors;
|
|
1389
1392
|
}
|
|
1390
|
-
declare enum VerticalAlignment {
|
|
1393
|
+
export declare enum VerticalAlignment {
|
|
1391
1394
|
/** Top alignment */
|
|
1392
1395
|
TOP = "TOP",
|
|
1393
1396
|
/** Middle alignment */
|
|
@@ -1395,7 +1398,7 @@ declare enum VerticalAlignment {
|
|
|
1395
1398
|
/** Bottom alignment */
|
|
1396
1399
|
BOTTOM = "BOTTOM"
|
|
1397
1400
|
}
|
|
1398
|
-
interface CellStyle {
|
|
1401
|
+
export interface CellStyle {
|
|
1399
1402
|
/** Vertical alignment for the cell's text. */
|
|
1400
1403
|
verticalAlignment?: VerticalAlignment;
|
|
1401
1404
|
/**
|
|
@@ -1404,7 +1407,7 @@ interface CellStyle {
|
|
|
1404
1407
|
*/
|
|
1405
1408
|
backgroundColor?: string | null;
|
|
1406
1409
|
}
|
|
1407
|
-
interface BorderColors {
|
|
1410
|
+
export interface BorderColors {
|
|
1408
1411
|
/**
|
|
1409
1412
|
* Left border color as a hexadecimal value.
|
|
1410
1413
|
* @format COLOR_HEX
|
|
@@ -1426,7 +1429,26 @@ interface BorderColors {
|
|
|
1426
1429
|
*/
|
|
1427
1430
|
bottom?: string | null;
|
|
1428
1431
|
}
|
|
1429
|
-
|
|
1432
|
+
/**
|
|
1433
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1434
|
+
* `Value` type union.
|
|
1435
|
+
*
|
|
1436
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
|
1437
|
+
*/
|
|
1438
|
+
export declare enum NullValue {
|
|
1439
|
+
/** Null value. */
|
|
1440
|
+
NULL_VALUE = "NULL_VALUE"
|
|
1441
|
+
}
|
|
1442
|
+
/**
|
|
1443
|
+
* `ListValue` is a wrapper around a repeated field of values.
|
|
1444
|
+
*
|
|
1445
|
+
* The JSON representation for `ListValue` is JSON array.
|
|
1446
|
+
*/
|
|
1447
|
+
export interface ListValue {
|
|
1448
|
+
/** Repeated field of dynamically typed values. */
|
|
1449
|
+
values?: any[];
|
|
1450
|
+
}
|
|
1451
|
+
export interface AudioData {
|
|
1430
1452
|
/** Styling for the audio node's container. */
|
|
1431
1453
|
containerData?: PluginContainerData;
|
|
1432
1454
|
/** Audio file details. */
|
|
@@ -1442,7 +1464,7 @@ interface AudioData {
|
|
|
1442
1464
|
/** An HTML version of the audio node. */
|
|
1443
1465
|
html?: string | null;
|
|
1444
1466
|
}
|
|
1445
|
-
interface OrderedListData {
|
|
1467
|
+
export interface OrderedListData {
|
|
1446
1468
|
/** Indentation level from 0-4. */
|
|
1447
1469
|
indentation?: number;
|
|
1448
1470
|
/** Offset level from 0-4. */
|
|
@@ -1450,24 +1472,24 @@ interface OrderedListData {
|
|
|
1450
1472
|
/** List start number. */
|
|
1451
1473
|
start?: number | null;
|
|
1452
1474
|
}
|
|
1453
|
-
interface BulletedListData {
|
|
1475
|
+
export interface BulletedListData {
|
|
1454
1476
|
/** Indentation level from 0-4. */
|
|
1455
1477
|
indentation?: number;
|
|
1456
1478
|
/** Offset level from 0-4. */
|
|
1457
1479
|
offset?: number | null;
|
|
1458
1480
|
}
|
|
1459
|
-
interface BlockquoteData {
|
|
1481
|
+
export interface BlockquoteData {
|
|
1460
1482
|
/** Indentation level from 1-4. */
|
|
1461
1483
|
indentation?: number;
|
|
1462
1484
|
}
|
|
1463
|
-
interface CaptionData {
|
|
1485
|
+
export interface CaptionData {
|
|
1464
1486
|
textStyle?: TextStyle;
|
|
1465
1487
|
}
|
|
1466
|
-
interface LayoutCellData {
|
|
1488
|
+
export interface LayoutCellData {
|
|
1467
1489
|
/** Size of the cell in 12 columns grid. */
|
|
1468
1490
|
colSpan?: number | null;
|
|
1469
1491
|
}
|
|
1470
|
-
interface Metadata {
|
|
1492
|
+
export interface Metadata {
|
|
1471
1493
|
/** Schema version. */
|
|
1472
1494
|
version?: number;
|
|
1473
1495
|
/**
|
|
@@ -1484,7 +1506,7 @@ interface Metadata {
|
|
|
1484
1506
|
/** Object ID. */
|
|
1485
1507
|
id?: string | null;
|
|
1486
1508
|
}
|
|
1487
|
-
interface DocumentStyle {
|
|
1509
|
+
export interface DocumentStyle {
|
|
1488
1510
|
/** Styling for H1 nodes. */
|
|
1489
1511
|
headerOne?: TextNodeStyle;
|
|
1490
1512
|
/** Styling for H2 nodes. */
|
|
@@ -1504,7 +1526,7 @@ interface DocumentStyle {
|
|
|
1504
1526
|
/** Styling for code block nodes. */
|
|
1505
1527
|
codeBlock?: TextNodeStyle;
|
|
1506
1528
|
}
|
|
1507
|
-
interface TextNodeStyle {
|
|
1529
|
+
export interface TextNodeStyle {
|
|
1508
1530
|
/** The decorations to apply to the node. */
|
|
1509
1531
|
decorations?: Decoration[];
|
|
1510
1532
|
/** Padding and background color for the node. */
|
|
@@ -1512,7 +1534,7 @@ interface TextNodeStyle {
|
|
|
1512
1534
|
/** Line height for text in the node. */
|
|
1513
1535
|
lineHeight?: string | null;
|
|
1514
1536
|
}
|
|
1515
|
-
interface Image {
|
|
1537
|
+
export interface Image {
|
|
1516
1538
|
/** WixMedia image ID. */
|
|
1517
1539
|
id?: string;
|
|
1518
1540
|
/** Image URL. */
|
|
@@ -1535,7 +1557,17 @@ interface Image {
|
|
|
1535
1557
|
*/
|
|
1536
1558
|
filename?: string | null;
|
|
1537
1559
|
}
|
|
1538
|
-
interface
|
|
1560
|
+
export interface FocalPoint {
|
|
1561
|
+
/** X-coordinate of the focal point. */
|
|
1562
|
+
x?: number;
|
|
1563
|
+
/** Y-coordinate of the focal point. */
|
|
1564
|
+
y?: number;
|
|
1565
|
+
/** crop by height */
|
|
1566
|
+
height?: number | null;
|
|
1567
|
+
/** crop by width */
|
|
1568
|
+
width?: number | null;
|
|
1569
|
+
}
|
|
1570
|
+
export interface VideoV2 {
|
|
1539
1571
|
/** WixMedia ID. */
|
|
1540
1572
|
id?: string;
|
|
1541
1573
|
/**
|
|
@@ -1550,7 +1582,7 @@ interface VideoV2 {
|
|
|
1550
1582
|
*/
|
|
1551
1583
|
filename?: string | null;
|
|
1552
1584
|
}
|
|
1553
|
-
interface VideoResolution {
|
|
1585
|
+
export interface VideoResolution {
|
|
1554
1586
|
/** Video URL. */
|
|
1555
1587
|
url?: string;
|
|
1556
1588
|
/** Video height. */
|
|
@@ -1560,7 +1592,7 @@ interface VideoResolution {
|
|
|
1560
1592
|
/** Video format for example, mp4, hls. */
|
|
1561
1593
|
format?: string;
|
|
1562
1594
|
}
|
|
1563
|
-
interface Document {
|
|
1595
|
+
export interface Document {
|
|
1564
1596
|
/** WixMedia ID. */
|
|
1565
1597
|
id?: string;
|
|
1566
1598
|
/** Document URL. */
|
|
@@ -1568,7 +1600,7 @@ interface Document {
|
|
|
1568
1600
|
/** Document filename. */
|
|
1569
1601
|
filename?: string | null;
|
|
1570
1602
|
}
|
|
1571
|
-
interface ExtendedFields {
|
|
1603
|
+
export interface ExtendedFields {
|
|
1572
1604
|
/**
|
|
1573
1605
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1574
1606
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -1579,11 +1611,22 @@ interface ExtendedFields {
|
|
|
1579
1611
|
*/
|
|
1580
1612
|
namespaces?: Record<string, Record<string, any>>;
|
|
1581
1613
|
}
|
|
1582
|
-
interface
|
|
1614
|
+
export interface GetPublishedContentRequest {
|
|
1615
|
+
/**
|
|
1616
|
+
* The ID of the published content
|
|
1617
|
+
* @format GUID
|
|
1618
|
+
*/
|
|
1619
|
+
contentId?: string;
|
|
1620
|
+
}
|
|
1621
|
+
export interface GetPublishedContentResponse {
|
|
1622
|
+
/** The published content */
|
|
1623
|
+
publishedContent?: PublishedContent;
|
|
1624
|
+
}
|
|
1625
|
+
export interface QueryPublishedContentRequest {
|
|
1583
1626
|
/** Query options. Note that some query filters are required. See the API description for a list of required filters. */
|
|
1584
1627
|
query: CursorQuery;
|
|
1585
1628
|
}
|
|
1586
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1629
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1587
1630
|
/**
|
|
1588
1631
|
* Cursor paging options.
|
|
1589
1632
|
*
|
|
@@ -1605,7 +1648,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1605
1648
|
sort?: Sorting[];
|
|
1606
1649
|
}
|
|
1607
1650
|
/** @oneof */
|
|
1608
|
-
interface CursorQueryPagingMethodOneOf {
|
|
1651
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1609
1652
|
/**
|
|
1610
1653
|
* Cursor paging options.
|
|
1611
1654
|
*
|
|
@@ -1613,7 +1656,7 @@ interface CursorQueryPagingMethodOneOf {
|
|
|
1613
1656
|
*/
|
|
1614
1657
|
cursorPaging?: CursorPaging;
|
|
1615
1658
|
}
|
|
1616
|
-
interface Sorting {
|
|
1659
|
+
export interface Sorting {
|
|
1617
1660
|
/**
|
|
1618
1661
|
* Name of the field to sort by.
|
|
1619
1662
|
* @maxLength 512
|
|
@@ -1622,11 +1665,11 @@ interface Sorting {
|
|
|
1622
1665
|
/** Sort order. */
|
|
1623
1666
|
order?: SortOrder;
|
|
1624
1667
|
}
|
|
1625
|
-
declare enum SortOrder {
|
|
1668
|
+
export declare enum SortOrder {
|
|
1626
1669
|
ASC = "ASC",
|
|
1627
1670
|
DESC = "DESC"
|
|
1628
1671
|
}
|
|
1629
|
-
interface CursorPaging {
|
|
1672
|
+
export interface CursorPaging {
|
|
1630
1673
|
/**
|
|
1631
1674
|
* Maximum number of items to return in the results.
|
|
1632
1675
|
* @max 100
|
|
@@ -1641,13 +1684,13 @@ interface CursorPaging {
|
|
|
1641
1684
|
*/
|
|
1642
1685
|
cursor?: string | null;
|
|
1643
1686
|
}
|
|
1644
|
-
interface QueryPublishedContentResponse {
|
|
1687
|
+
export interface QueryPublishedContentResponse {
|
|
1645
1688
|
/** The published translation content. */
|
|
1646
1689
|
publishedContent?: PublishedContent[];
|
|
1647
1690
|
/** Details on the paged set of results returned. */
|
|
1648
1691
|
pagingMetadata?: CursorPagingMetadata;
|
|
1649
1692
|
}
|
|
1650
|
-
interface CursorPagingMetadata {
|
|
1693
|
+
export interface CursorPagingMetadata {
|
|
1651
1694
|
/** Number of items returned in current page. */
|
|
1652
1695
|
count?: number | null;
|
|
1653
1696
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1660,7 +1703,7 @@ interface CursorPagingMetadata {
|
|
|
1660
1703
|
*/
|
|
1661
1704
|
hasNext?: boolean | null;
|
|
1662
1705
|
}
|
|
1663
|
-
interface Cursors {
|
|
1706
|
+
export interface Cursors {
|
|
1664
1707
|
/**
|
|
1665
1708
|
* Cursor string pointing to the next page in the list of results.
|
|
1666
1709
|
* @maxLength 16000
|
|
@@ -1672,17 +1715,156 @@ interface Cursors {
|
|
|
1672
1715
|
*/
|
|
1673
1716
|
prev?: string | null;
|
|
1674
1717
|
}
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1718
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1719
|
+
createdEvent?: EntityCreatedEvent;
|
|
1720
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1721
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1722
|
+
actionEvent?: ActionEvent;
|
|
1723
|
+
/**
|
|
1724
|
+
* Unique event ID.
|
|
1725
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1726
|
+
*/
|
|
1727
|
+
id?: string;
|
|
1728
|
+
/**
|
|
1729
|
+
* Assumes actions are also always typed to an entity_type
|
|
1730
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1731
|
+
*/
|
|
1732
|
+
entityFqdn?: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1735
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1736
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1737
|
+
*/
|
|
1738
|
+
slug?: string;
|
|
1739
|
+
/** ID of the entity associated with the event. */
|
|
1740
|
+
entityId?: string;
|
|
1741
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1742
|
+
eventTime?: Date | null;
|
|
1743
|
+
/**
|
|
1744
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1745
|
+
* (for example, GDPR).
|
|
1746
|
+
*/
|
|
1747
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1748
|
+
/** If present, indicates the action that triggered the event. */
|
|
1749
|
+
originatedFrom?: string | null;
|
|
1750
|
+
/**
|
|
1751
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1752
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1753
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1754
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1755
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1756
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1757
|
+
*/
|
|
1758
|
+
entityEventSequence?: string | null;
|
|
1759
|
+
}
|
|
1760
|
+
/** @oneof */
|
|
1761
|
+
export interface DomainEventBodyOneOf {
|
|
1762
|
+
createdEvent?: EntityCreatedEvent;
|
|
1763
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1764
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1765
|
+
actionEvent?: ActionEvent;
|
|
1766
|
+
}
|
|
1767
|
+
export interface EntityCreatedEvent {
|
|
1768
|
+
entityAsJson?: string;
|
|
1769
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1770
|
+
restoreInfo?: RestoreInfo;
|
|
1771
|
+
}
|
|
1772
|
+
export interface RestoreInfo {
|
|
1773
|
+
deletedDate?: Date | null;
|
|
1774
|
+
}
|
|
1775
|
+
export interface EntityUpdatedEvent {
|
|
1776
|
+
/**
|
|
1777
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1778
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1779
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1780
|
+
*/
|
|
1781
|
+
currentEntityAsJson?: string;
|
|
1782
|
+
}
|
|
1783
|
+
export interface EntityDeletedEvent {
|
|
1784
|
+
/** Entity that was deleted */
|
|
1785
|
+
deletedEntityAsJson?: string | null;
|
|
1786
|
+
}
|
|
1787
|
+
export interface ActionEvent {
|
|
1788
|
+
bodyAsJson?: string;
|
|
1789
|
+
}
|
|
1790
|
+
export interface Empty {
|
|
1791
|
+
}
|
|
1792
|
+
export interface DeletePublishedContentRequest {
|
|
1793
|
+
/**
|
|
1794
|
+
* The ID of the published content to delete
|
|
1795
|
+
* @format GUID
|
|
1796
|
+
*/
|
|
1797
|
+
contentId?: string;
|
|
1798
|
+
}
|
|
1799
|
+
export interface DeletePublishedContentResponse {
|
|
1800
|
+
}
|
|
1801
|
+
export interface MessageEnvelope {
|
|
1802
|
+
/**
|
|
1803
|
+
* App instance ID.
|
|
1804
|
+
* @format GUID
|
|
1805
|
+
*/
|
|
1806
|
+
instanceId?: string | null;
|
|
1807
|
+
/**
|
|
1808
|
+
* Event type.
|
|
1809
|
+
* @maxLength 150
|
|
1810
|
+
*/
|
|
1811
|
+
eventType?: string;
|
|
1812
|
+
/** The identification type and identity data. */
|
|
1813
|
+
identity?: IdentificationData;
|
|
1814
|
+
/** Stringify payload. */
|
|
1815
|
+
data?: string;
|
|
1816
|
+
}
|
|
1817
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1818
|
+
/**
|
|
1819
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1820
|
+
* @format GUID
|
|
1821
|
+
*/
|
|
1822
|
+
anonymousVisitorId?: string;
|
|
1823
|
+
/**
|
|
1824
|
+
* ID of a site visitor that has logged in to the site.
|
|
1825
|
+
* @format GUID
|
|
1826
|
+
*/
|
|
1827
|
+
memberId?: string;
|
|
1828
|
+
/**
|
|
1829
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1830
|
+
* @format GUID
|
|
1831
|
+
*/
|
|
1832
|
+
wixUserId?: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* ID of an app.
|
|
1835
|
+
* @format GUID
|
|
1836
|
+
*/
|
|
1837
|
+
appId?: string;
|
|
1838
|
+
/** @readonly */
|
|
1839
|
+
identityType?: WebhookIdentityType;
|
|
1840
|
+
}
|
|
1841
|
+
/** @oneof */
|
|
1842
|
+
export interface IdentificationDataIdOneOf {
|
|
1843
|
+
/**
|
|
1844
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1845
|
+
* @format GUID
|
|
1846
|
+
*/
|
|
1847
|
+
anonymousVisitorId?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* ID of a site visitor that has logged in to the site.
|
|
1850
|
+
* @format GUID
|
|
1851
|
+
*/
|
|
1852
|
+
memberId?: string;
|
|
1853
|
+
/**
|
|
1854
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1855
|
+
* @format GUID
|
|
1856
|
+
*/
|
|
1857
|
+
wixUserId?: string;
|
|
1858
|
+
/**
|
|
1859
|
+
* ID of an app.
|
|
1860
|
+
* @format GUID
|
|
1861
|
+
*/
|
|
1862
|
+
appId?: string;
|
|
1863
|
+
}
|
|
1864
|
+
export declare enum WebhookIdentityType {
|
|
1865
|
+
UNKNOWN = "UNKNOWN",
|
|
1866
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1867
|
+
MEMBER = "MEMBER",
|
|
1868
|
+
WIX_USER = "WIX_USER",
|
|
1869
|
+
APP = "APP"
|
|
1870
|
+
}
|