@wix/auto_sdk_comments_comments 1.0.7 → 1.0.9
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/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-Bt560XJw.d.mts} +556 -736
- package/build/{internal/cjs/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-Bt560XJw.d.ts} +556 -736
- package/build/index.d.mts +249 -0
- package/build/index.d.ts +249 -0
- package/build/index.js +5232 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +5145 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/comments-v2-comment-comments.types.d.ts → internal/comments-v2-comment-comments.universal-Bt560XJw.d.mts} +556 -736
- package/build/internal/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-Bt560XJw.d.ts} +556 -736
- package/build/internal/index.d.mts +249 -0
- package/build/internal/index.d.ts +249 -0
- package/build/internal/index.js +5232 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +5145 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2389 -0
- package/build/internal/meta.d.ts +2389 -0
- package/build/internal/meta.js +2832 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +2788 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2389 -0
- package/build/meta.d.ts +2389 -0
- package/build/meta.js +2832 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +2788 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/cjs/src/comments-v2-comment-comments.context.js +0 -109
- package/build/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/cjs/src/comments-v2-comment-comments.http.js +0 -2533
- package/build/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/cjs/src/comments-v2-comment-comments.meta.js +0 -370
- package/build/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/cjs/src/comments-v2-comment-comments.public.js +0 -1341
- package/build/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.types.js +0 -385
- package/build/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.universal.d.ts +0 -3629
- package/build/cjs/src/comments-v2-comment-comments.universal.js +0 -1598
- package/build/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/es/src/comments-v2-comment-comments.context.js +0 -68
- package/build/es/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/es/src/comments-v2-comment-comments.http.js +0 -2512
- package/build/es/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/es/src/comments-v2-comment-comments.meta.js +0 -326
- package/build/es/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/es/src/comments-v2-comment-comments.public.js +0 -1282
- package/build/es/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.types.js +0 -382
- package/build/es/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.universal.d.ts +0 -3629
- package/build/es/src/comments-v2-comment-comments.universal.js +0 -1553
- package/build/es/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js +0 -109
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js +0 -2533
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js +0 -370
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js +0 -1341
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js +0 -385
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.d.ts +0 -3629
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +0 -1598
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/internal/es/src/comments-v2-comment-comments.context.js +0 -68
- package/build/internal/es/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/internal/es/src/comments-v2-comment-comments.http.js +0 -2512
- package/build/internal/es/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/internal/es/src/comments-v2-comment-comments.meta.js +0 -326
- package/build/internal/es/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/internal/es/src/comments-v2-comment-comments.public.js +0 -1282
- package/build/internal/es/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.types.js +0 -382
- package/build/internal/es/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.universal.d.ts +0 -3629
- package/build/internal/es/src/comments-v2-comment-comments.universal.js +0 -1553
- package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +0 -1
|
@@ -3,13 +3,13 @@
|
|
|
3
3
|
* to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
|
|
4
4
|
* or other site content. Comments are composed of text, images, videos, or other forms of media.
|
|
5
5
|
*/
|
|
6
|
-
|
|
6
|
+
interface Comment {
|
|
7
7
|
/**
|
|
8
8
|
* Comment ID.
|
|
9
9
|
* @format GUID
|
|
10
10
|
* @readonly
|
|
11
11
|
*/
|
|
12
|
-
|
|
12
|
+
_id?: string | null;
|
|
13
13
|
/**
|
|
14
14
|
* Revision number, which increments by 1 each time the comment is updated.
|
|
15
15
|
*
|
|
@@ -23,12 +23,12 @@ export interface Comment {
|
|
|
23
23
|
* **Note:** This is the date from the system database, not the actual date when the comment was created. For example, if you migrate comments created in 2016, the `createdDate` field will show the current year. For the actual creation date, see the `commentDate` field.
|
|
24
24
|
* @readonly
|
|
25
25
|
*/
|
|
26
|
-
|
|
26
|
+
_createdDate?: Date | null;
|
|
27
27
|
/**
|
|
28
28
|
* Date and time the comment was last updated.
|
|
29
29
|
* @readonly
|
|
30
30
|
*/
|
|
31
|
-
|
|
31
|
+
_updatedDate?: Date | null;
|
|
32
32
|
/**
|
|
33
33
|
* ID of the app that the comment is added to.
|
|
34
34
|
* @format GUID
|
|
@@ -107,7 +107,7 @@ export interface Comment {
|
|
|
107
107
|
contentEdited?: boolean | null;
|
|
108
108
|
}
|
|
109
109
|
/** Comment content. */
|
|
110
|
-
|
|
110
|
+
interface CommentContent {
|
|
111
111
|
/**
|
|
112
112
|
* Comment rich content.
|
|
113
113
|
*
|
|
@@ -129,7 +129,7 @@ export interface CommentContent {
|
|
|
129
129
|
*/
|
|
130
130
|
attachments?: Attachment[];
|
|
131
131
|
}
|
|
132
|
-
|
|
132
|
+
interface RichContent {
|
|
133
133
|
/** Node objects representing a rich content document. */
|
|
134
134
|
nodes?: Node[];
|
|
135
135
|
/** Object metadata. */
|
|
@@ -137,7 +137,7 @@ export interface RichContent {
|
|
|
137
137
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
138
138
|
documentStyle?: DocumentStyle;
|
|
139
139
|
}
|
|
140
|
-
|
|
140
|
+
interface Node extends NodeDataOneOf {
|
|
141
141
|
/** Data for a button node. */
|
|
142
142
|
buttonData?: ButtonData;
|
|
143
143
|
/** Data for a code block node. */
|
|
@@ -195,14 +195,14 @@ export interface Node extends NodeDataOneOf {
|
|
|
195
195
|
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
196
196
|
type?: NodeType;
|
|
197
197
|
/** Node ID. */
|
|
198
|
-
|
|
198
|
+
_id?: string;
|
|
199
199
|
/** A list of child nodes. */
|
|
200
200
|
nodes?: Node[];
|
|
201
201
|
/** Padding and background color styling for the node. */
|
|
202
202
|
style?: NodeStyle;
|
|
203
203
|
}
|
|
204
204
|
/** @oneof */
|
|
205
|
-
|
|
205
|
+
interface NodeDataOneOf {
|
|
206
206
|
/** Data for a button node. */
|
|
207
207
|
buttonData?: ButtonData;
|
|
208
208
|
/** Data for a code block node. */
|
|
@@ -258,7 +258,7 @@ export interface NodeDataOneOf {
|
|
|
258
258
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
259
259
|
layoutCellData?: LayoutCellData;
|
|
260
260
|
}
|
|
261
|
-
|
|
261
|
+
declare enum NodeType {
|
|
262
262
|
PARAGRAPH = "PARAGRAPH",
|
|
263
263
|
TEXT = "TEXT",
|
|
264
264
|
HEADING = "HEADING",
|
|
@@ -294,7 +294,7 @@ export declare enum NodeType {
|
|
|
294
294
|
LAYOUT = "LAYOUT",
|
|
295
295
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
296
296
|
}
|
|
297
|
-
|
|
297
|
+
interface NodeStyle {
|
|
298
298
|
/** The top padding value in pixels. */
|
|
299
299
|
paddingTop?: string | null;
|
|
300
300
|
/** The bottom padding value in pixels. */
|
|
@@ -302,7 +302,7 @@ export interface NodeStyle {
|
|
|
302
302
|
/** The background color as a hexadecimal value. */
|
|
303
303
|
backgroundColor?: string | null;
|
|
304
304
|
}
|
|
305
|
-
|
|
305
|
+
interface ButtonData {
|
|
306
306
|
/** Styling for the button's container. */
|
|
307
307
|
containerData?: PluginContainerData;
|
|
308
308
|
/** The button type. */
|
|
@@ -314,7 +314,7 @@ export interface ButtonData {
|
|
|
314
314
|
/** Button link details. */
|
|
315
315
|
link?: Link;
|
|
316
316
|
}
|
|
317
|
-
|
|
317
|
+
interface Border {
|
|
318
318
|
/**
|
|
319
319
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
320
320
|
* @deprecated
|
|
@@ -326,7 +326,7 @@ export interface Border {
|
|
|
326
326
|
*/
|
|
327
327
|
radius?: number | null;
|
|
328
328
|
}
|
|
329
|
-
|
|
329
|
+
interface Colors {
|
|
330
330
|
/**
|
|
331
331
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
332
332
|
* @deprecated
|
|
@@ -343,7 +343,7 @@ export interface Colors {
|
|
|
343
343
|
*/
|
|
344
344
|
background?: string | null;
|
|
345
345
|
}
|
|
346
|
-
|
|
346
|
+
interface PluginContainerData {
|
|
347
347
|
/** The width of the node when it's displayed. */
|
|
348
348
|
width?: PluginContainerDataWidth;
|
|
349
349
|
/** The node's alignment within its container. */
|
|
@@ -355,7 +355,7 @@ export interface PluginContainerData {
|
|
|
355
355
|
/** 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`. */
|
|
356
356
|
textWrap?: boolean | null;
|
|
357
357
|
}
|
|
358
|
-
|
|
358
|
+
declare enum WidthType {
|
|
359
359
|
/** Width matches the content width */
|
|
360
360
|
CONTENT = "CONTENT",
|
|
361
361
|
/** Small Width */
|
|
@@ -365,7 +365,7 @@ export declare enum WidthType {
|
|
|
365
365
|
/** coast-to-coast display */
|
|
366
366
|
FULL_WIDTH = "FULL_WIDTH"
|
|
367
367
|
}
|
|
368
|
-
|
|
368
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
369
369
|
/**
|
|
370
370
|
* One of the following predefined width options:
|
|
371
371
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -378,7 +378,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
378
378
|
custom?: string | null;
|
|
379
379
|
}
|
|
380
380
|
/** @oneof */
|
|
381
|
-
|
|
381
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
382
382
|
/**
|
|
383
383
|
* One of the following predefined width options:
|
|
384
384
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -390,7 +390,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
390
390
|
/** A custom width value in pixels. */
|
|
391
391
|
custom?: string | null;
|
|
392
392
|
}
|
|
393
|
-
|
|
393
|
+
declare enum PluginContainerDataAlignment {
|
|
394
394
|
/** Center Alignment */
|
|
395
395
|
CENTER = "CENTER",
|
|
396
396
|
/** Left Alignment */
|
|
@@ -398,7 +398,7 @@ export declare enum PluginContainerDataAlignment {
|
|
|
398
398
|
/** Right Alignment */
|
|
399
399
|
RIGHT = "RIGHT"
|
|
400
400
|
}
|
|
401
|
-
|
|
401
|
+
interface Spoiler {
|
|
402
402
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
403
403
|
enabled?: boolean | null;
|
|
404
404
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -406,17 +406,17 @@ export interface Spoiler {
|
|
|
406
406
|
/** The text for the button used to remove the spoiler cover. */
|
|
407
407
|
buttonText?: string | null;
|
|
408
408
|
}
|
|
409
|
-
|
|
409
|
+
interface Height {
|
|
410
410
|
/** A custom height value in pixels. */
|
|
411
411
|
custom?: string | null;
|
|
412
412
|
}
|
|
413
|
-
|
|
413
|
+
declare enum Type {
|
|
414
414
|
/** Regular link button */
|
|
415
415
|
LINK = "LINK",
|
|
416
416
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
417
417
|
ACTION = "ACTION"
|
|
418
418
|
}
|
|
419
|
-
|
|
419
|
+
interface Styles {
|
|
420
420
|
/**
|
|
421
421
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
422
422
|
* @deprecated
|
|
@@ -469,7 +469,7 @@ export interface Styles {
|
|
|
469
469
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
470
470
|
buttonSize?: string | null;
|
|
471
471
|
}
|
|
472
|
-
|
|
472
|
+
interface Link extends LinkDataOneOf {
|
|
473
473
|
/** The absolute URL for the linked document. */
|
|
474
474
|
url?: string;
|
|
475
475
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -488,13 +488,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
488
488
|
customData?: string | null;
|
|
489
489
|
}
|
|
490
490
|
/** @oneof */
|
|
491
|
-
|
|
491
|
+
interface LinkDataOneOf {
|
|
492
492
|
/** The absolute URL for the linked document. */
|
|
493
493
|
url?: string;
|
|
494
494
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
495
495
|
anchor?: string;
|
|
496
496
|
}
|
|
497
|
-
|
|
497
|
+
declare enum Target {
|
|
498
498
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
499
499
|
SELF = "SELF",
|
|
500
500
|
/** Opens the linked document in a new window or tab */
|
|
@@ -504,7 +504,7 @@ export declare enum Target {
|
|
|
504
504
|
/** Opens the linked document in the full body of the window */
|
|
505
505
|
TOP = "TOP"
|
|
506
506
|
}
|
|
507
|
-
|
|
507
|
+
interface Rel {
|
|
508
508
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
509
509
|
nofollow?: boolean | null;
|
|
510
510
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -514,17 +514,17 @@ export interface Rel {
|
|
|
514
514
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
515
515
|
noreferrer?: boolean | null;
|
|
516
516
|
}
|
|
517
|
-
|
|
517
|
+
interface CodeBlockData {
|
|
518
518
|
/** Styling for the code block's text. */
|
|
519
519
|
textStyle?: TextStyle;
|
|
520
520
|
}
|
|
521
|
-
|
|
521
|
+
interface TextStyle {
|
|
522
522
|
/** Text alignment. Defaults to `AUTO`. */
|
|
523
523
|
textAlignment?: TextAlignment;
|
|
524
524
|
/** 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. */
|
|
525
525
|
lineHeight?: string | null;
|
|
526
526
|
}
|
|
527
|
-
|
|
527
|
+
declare enum TextAlignment {
|
|
528
528
|
/** browser default, eqivalent to `initial` */
|
|
529
529
|
AUTO = "AUTO",
|
|
530
530
|
/** Left align */
|
|
@@ -536,7 +536,7 @@ export declare enum TextAlignment {
|
|
|
536
536
|
/** 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 */
|
|
537
537
|
JUSTIFY = "JUSTIFY"
|
|
538
538
|
}
|
|
539
|
-
|
|
539
|
+
interface DividerData {
|
|
540
540
|
/** Styling for the divider's container. */
|
|
541
541
|
containerData?: PluginContainerData;
|
|
542
542
|
/** Divider line style. */
|
|
@@ -546,7 +546,7 @@ export interface DividerData {
|
|
|
546
546
|
/** Divider alignment. */
|
|
547
547
|
alignment?: Alignment;
|
|
548
548
|
}
|
|
549
|
-
|
|
549
|
+
declare enum LineStyle {
|
|
550
550
|
/** Single Line */
|
|
551
551
|
SINGLE = "SINGLE",
|
|
552
552
|
/** Double Line */
|
|
@@ -556,7 +556,7 @@ export declare enum LineStyle {
|
|
|
556
556
|
/** Dotted Line */
|
|
557
557
|
DOTTED = "DOTTED"
|
|
558
558
|
}
|
|
559
|
-
|
|
559
|
+
declare enum Width {
|
|
560
560
|
/** Large line */
|
|
561
561
|
LARGE = "LARGE",
|
|
562
562
|
/** Medium line */
|
|
@@ -564,7 +564,7 @@ export declare enum Width {
|
|
|
564
564
|
/** Small line */
|
|
565
565
|
SMALL = "SMALL"
|
|
566
566
|
}
|
|
567
|
-
|
|
567
|
+
declare enum Alignment {
|
|
568
568
|
/** Center alignment */
|
|
569
569
|
CENTER = "CENTER",
|
|
570
570
|
/** Left alignment */
|
|
@@ -572,7 +572,7 @@ export declare enum Alignment {
|
|
|
572
572
|
/** Right alignment */
|
|
573
573
|
RIGHT = "RIGHT"
|
|
574
574
|
}
|
|
575
|
-
|
|
575
|
+
interface FileData {
|
|
576
576
|
/** Styling for the file's container. */
|
|
577
577
|
containerData?: PluginContainerData;
|
|
578
578
|
/** The source for the file's data. */
|
|
@@ -595,7 +595,7 @@ export interface FileData {
|
|
|
595
595
|
/** File size in KB. */
|
|
596
596
|
sizeInKb?: string | null;
|
|
597
597
|
}
|
|
598
|
-
|
|
598
|
+
declare enum ViewMode {
|
|
599
599
|
/** No PDF view */
|
|
600
600
|
NONE = "NONE",
|
|
601
601
|
/** Full PDF view */
|
|
@@ -603,7 +603,7 @@ export declare enum ViewMode {
|
|
|
603
603
|
/** Mini PDF view */
|
|
604
604
|
MINI = "MINI"
|
|
605
605
|
}
|
|
606
|
-
|
|
606
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
607
607
|
/** The absolute URL for the file's source. */
|
|
608
608
|
url?: string | null;
|
|
609
609
|
/**
|
|
@@ -612,12 +612,12 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
612
612
|
*/
|
|
613
613
|
custom?: string | null;
|
|
614
614
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
615
|
-
|
|
615
|
+
_id?: string | null;
|
|
616
616
|
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
617
617
|
private?: boolean | null;
|
|
618
618
|
}
|
|
619
619
|
/** @oneof */
|
|
620
|
-
|
|
620
|
+
interface FileSourceDataOneOf {
|
|
621
621
|
/** The absolute URL for the file's source. */
|
|
622
622
|
url?: string | null;
|
|
623
623
|
/**
|
|
@@ -626,9 +626,9 @@ export interface FileSourceDataOneOf {
|
|
|
626
626
|
*/
|
|
627
627
|
custom?: string | null;
|
|
628
628
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
629
|
-
|
|
629
|
+
_id?: string | null;
|
|
630
630
|
}
|
|
631
|
-
|
|
631
|
+
interface PDFSettings {
|
|
632
632
|
/**
|
|
633
633
|
* PDF view mode. One of the following:
|
|
634
634
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -641,7 +641,7 @@ export interface PDFSettings {
|
|
|
641
641
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
642
642
|
disablePrint?: boolean | null;
|
|
643
643
|
}
|
|
644
|
-
|
|
644
|
+
interface GalleryData {
|
|
645
645
|
/** Styling for the gallery's container. */
|
|
646
646
|
containerData?: PluginContainerData;
|
|
647
647
|
/** The items in the gallery. */
|
|
@@ -653,7 +653,7 @@ export interface GalleryData {
|
|
|
653
653
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
654
654
|
disableDownload?: boolean | null;
|
|
655
655
|
}
|
|
656
|
-
|
|
656
|
+
interface Media {
|
|
657
657
|
/** The source for the media's data. */
|
|
658
658
|
src?: FileSource;
|
|
659
659
|
/** Media width in pixels. */
|
|
@@ -663,21 +663,21 @@ export interface Media {
|
|
|
663
663
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
664
664
|
duration?: number | null;
|
|
665
665
|
}
|
|
666
|
-
|
|
666
|
+
interface Image {
|
|
667
667
|
/** Image file details. */
|
|
668
668
|
media?: Media;
|
|
669
669
|
/** Link details for images that are links. */
|
|
670
670
|
link?: Link;
|
|
671
671
|
}
|
|
672
|
-
|
|
672
|
+
interface Video {
|
|
673
673
|
/** Video file details. */
|
|
674
674
|
media?: Media;
|
|
675
675
|
/** Video thumbnail file details. */
|
|
676
676
|
thumbnail?: Media;
|
|
677
677
|
}
|
|
678
|
-
|
|
678
|
+
interface Item extends ItemDataOneOf {
|
|
679
679
|
/** An image item. */
|
|
680
|
-
image?:
|
|
680
|
+
image?: Image;
|
|
681
681
|
/** A video item. */
|
|
682
682
|
video?: Video;
|
|
683
683
|
/** Item title. */
|
|
@@ -686,13 +686,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
686
686
|
altText?: string | null;
|
|
687
687
|
}
|
|
688
688
|
/** @oneof */
|
|
689
|
-
|
|
689
|
+
interface ItemDataOneOf {
|
|
690
690
|
/** An image item. */
|
|
691
|
-
image?:
|
|
691
|
+
image?: Image;
|
|
692
692
|
/** A video item. */
|
|
693
693
|
video?: Video;
|
|
694
694
|
}
|
|
695
|
-
|
|
695
|
+
interface GalleryOptions {
|
|
696
696
|
/** Gallery layout. */
|
|
697
697
|
layout?: Layout;
|
|
698
698
|
/** Styling for gallery items. */
|
|
@@ -700,7 +700,7 @@ export interface GalleryOptions {
|
|
|
700
700
|
/** Styling for gallery thumbnail images. */
|
|
701
701
|
thumbnails?: Thumbnails;
|
|
702
702
|
}
|
|
703
|
-
|
|
703
|
+
declare enum LayoutType {
|
|
704
704
|
/** Collage type */
|
|
705
705
|
COLLAGE = "COLLAGE",
|
|
706
706
|
/** Masonry type */
|
|
@@ -722,19 +722,19 @@ export declare enum LayoutType {
|
|
|
722
722
|
/** Fullsize images type */
|
|
723
723
|
FULLSIZE = "FULLSIZE"
|
|
724
724
|
}
|
|
725
|
-
|
|
725
|
+
declare enum Orientation {
|
|
726
726
|
/** Rows Orientation */
|
|
727
727
|
ROWS = "ROWS",
|
|
728
728
|
/** Columns Orientation */
|
|
729
729
|
COLUMNS = "COLUMNS"
|
|
730
730
|
}
|
|
731
|
-
|
|
731
|
+
declare enum Crop {
|
|
732
732
|
/** Crop to fill */
|
|
733
733
|
FILL = "FILL",
|
|
734
734
|
/** Crop to fit */
|
|
735
735
|
FIT = "FIT"
|
|
736
736
|
}
|
|
737
|
-
|
|
737
|
+
declare enum ThumbnailsAlignment {
|
|
738
738
|
/** Top alignment */
|
|
739
739
|
TOP = "TOP",
|
|
740
740
|
/** Right alignment */
|
|
@@ -746,7 +746,7 @@ export declare enum ThumbnailsAlignment {
|
|
|
746
746
|
/** No thumbnail */
|
|
747
747
|
NONE = "NONE"
|
|
748
748
|
}
|
|
749
|
-
|
|
749
|
+
interface Layout {
|
|
750
750
|
/** Gallery layout type. */
|
|
751
751
|
type?: LayoutType;
|
|
752
752
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -758,7 +758,7 @@ export interface Layout {
|
|
|
758
758
|
/** The number of columns to display on mobile screens. */
|
|
759
759
|
mobileNumberOfColumns?: number | null;
|
|
760
760
|
}
|
|
761
|
-
|
|
761
|
+
interface ItemStyle {
|
|
762
762
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
763
763
|
targetSize?: number | null;
|
|
764
764
|
/** Item ratio */
|
|
@@ -768,13 +768,13 @@ export interface ItemStyle {
|
|
|
768
768
|
/** The spacing between items in pixels. */
|
|
769
769
|
spacing?: number | null;
|
|
770
770
|
}
|
|
771
|
-
|
|
771
|
+
interface Thumbnails {
|
|
772
772
|
/** Thumbnail alignment. */
|
|
773
773
|
placement?: ThumbnailsAlignment;
|
|
774
774
|
/** Spacing between thumbnails in pixels. */
|
|
775
775
|
spacing?: number | null;
|
|
776
776
|
}
|
|
777
|
-
|
|
777
|
+
interface GIFData {
|
|
778
778
|
/** Styling for the GIF's container. */
|
|
779
779
|
containerData?: PluginContainerData;
|
|
780
780
|
/** The source of the full size GIF. */
|
|
@@ -788,7 +788,7 @@ export interface GIFData {
|
|
|
788
788
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
789
789
|
gifType?: GIFType;
|
|
790
790
|
}
|
|
791
|
-
|
|
791
|
+
interface GIF {
|
|
792
792
|
/**
|
|
793
793
|
* GIF format URL.
|
|
794
794
|
* @format WEB_URL
|
|
@@ -805,11 +805,11 @@ export interface GIF {
|
|
|
805
805
|
*/
|
|
806
806
|
still?: string | null;
|
|
807
807
|
}
|
|
808
|
-
|
|
808
|
+
declare enum GIFType {
|
|
809
809
|
NORMAL = "NORMAL",
|
|
810
810
|
STICKER = "STICKER"
|
|
811
811
|
}
|
|
812
|
-
|
|
812
|
+
interface HeadingData {
|
|
813
813
|
/** Heading level from 1-6. */
|
|
814
814
|
level?: number;
|
|
815
815
|
/** Styling for the heading text. */
|
|
@@ -817,7 +817,7 @@ export interface HeadingData {
|
|
|
817
817
|
/** Indentation level from 1-4. */
|
|
818
818
|
indentation?: number | null;
|
|
819
819
|
}
|
|
820
|
-
|
|
820
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
821
821
|
/** The URL for the HTML code for the node. */
|
|
822
822
|
url?: string;
|
|
823
823
|
/** The HTML code for the node. */
|
|
@@ -835,7 +835,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
835
835
|
autoHeight?: boolean | null;
|
|
836
836
|
}
|
|
837
837
|
/** @oneof */
|
|
838
|
-
|
|
838
|
+
interface HTMLDataDataOneOf {
|
|
839
839
|
/** The URL for the HTML code for the node. */
|
|
840
840
|
url?: string;
|
|
841
841
|
/** The HTML code for the node. */
|
|
@@ -846,11 +846,11 @@ export interface HTMLDataDataOneOf {
|
|
|
846
846
|
*/
|
|
847
847
|
isAdsense?: boolean | null;
|
|
848
848
|
}
|
|
849
|
-
|
|
849
|
+
declare enum Source {
|
|
850
850
|
HTML = "HTML",
|
|
851
851
|
ADSENSE = "ADSENSE"
|
|
852
852
|
}
|
|
853
|
-
|
|
853
|
+
interface ImageData {
|
|
854
854
|
/** Styling for the image's container. */
|
|
855
855
|
containerData?: PluginContainerData;
|
|
856
856
|
/** Image file details. */
|
|
@@ -873,7 +873,7 @@ export interface ImageData {
|
|
|
873
873
|
/** Styling for the image. */
|
|
874
874
|
styles?: ImageDataStyles;
|
|
875
875
|
}
|
|
876
|
-
|
|
876
|
+
interface StylesBorder {
|
|
877
877
|
/** Border width in pixels. */
|
|
878
878
|
width?: number | null;
|
|
879
879
|
/**
|
|
@@ -884,11 +884,11 @@ export interface StylesBorder {
|
|
|
884
884
|
/** Border radius in pixels. */
|
|
885
885
|
radius?: number | null;
|
|
886
886
|
}
|
|
887
|
-
|
|
887
|
+
interface ImageDataStyles {
|
|
888
888
|
/** Border attributes. */
|
|
889
889
|
border?: StylesBorder;
|
|
890
890
|
}
|
|
891
|
-
|
|
891
|
+
interface LinkPreviewData {
|
|
892
892
|
/** Styling for the link preview's container. */
|
|
893
893
|
containerData?: PluginContainerData;
|
|
894
894
|
/** Link details. */
|
|
@@ -904,7 +904,7 @@ export interface LinkPreviewData {
|
|
|
904
904
|
/** Styling for the link preview. */
|
|
905
905
|
styles?: LinkPreviewDataStyles;
|
|
906
906
|
}
|
|
907
|
-
|
|
907
|
+
declare enum Position {
|
|
908
908
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
909
909
|
START = "START",
|
|
910
910
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -914,7 +914,7 @@ export declare enum Position {
|
|
|
914
914
|
/** Thumbnail hidden and not displayed */
|
|
915
915
|
HIDDEN = "HIDDEN"
|
|
916
916
|
}
|
|
917
|
-
|
|
917
|
+
interface LinkPreviewDataStyles {
|
|
918
918
|
/**
|
|
919
919
|
* Background color as a hexadecimal value.
|
|
920
920
|
* @format COLOR_HEX
|
|
@@ -947,13 +947,13 @@ export interface LinkPreviewDataStyles {
|
|
|
947
947
|
/** Position of thumbnail. Defaults to `START`. */
|
|
948
948
|
thumbnailPosition?: Position;
|
|
949
949
|
}
|
|
950
|
-
|
|
950
|
+
interface MapData {
|
|
951
951
|
/** Styling for the map's container. */
|
|
952
952
|
containerData?: PluginContainerData;
|
|
953
953
|
/** Map settings. */
|
|
954
954
|
mapSettings?: MapSettings;
|
|
955
955
|
}
|
|
956
|
-
|
|
956
|
+
interface MapSettings {
|
|
957
957
|
/** The address to display on the map. */
|
|
958
958
|
address?: string | null;
|
|
959
959
|
/** Sets whether the map is draggable. */
|
|
@@ -977,7 +977,7 @@ export interface MapSettings {
|
|
|
977
977
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
978
978
|
mapType?: MapType;
|
|
979
979
|
}
|
|
980
|
-
|
|
980
|
+
declare enum MapType {
|
|
981
981
|
/** Roadmap map type */
|
|
982
982
|
ROADMAP = "ROADMAP",
|
|
983
983
|
/** Satellite map type */
|
|
@@ -987,7 +987,7 @@ export declare enum MapType {
|
|
|
987
987
|
/** Terrain map type */
|
|
988
988
|
TERRAIN = "TERRAIN"
|
|
989
989
|
}
|
|
990
|
-
|
|
990
|
+
interface ParagraphData {
|
|
991
991
|
/** Styling for the paragraph text. */
|
|
992
992
|
textStyle?: TextStyle;
|
|
993
993
|
/** Indentation level from 1-4. */
|
|
@@ -995,7 +995,7 @@ export interface ParagraphData {
|
|
|
995
995
|
/** Paragraph level */
|
|
996
996
|
level?: number | null;
|
|
997
997
|
}
|
|
998
|
-
|
|
998
|
+
interface PollData {
|
|
999
999
|
/** Styling for the poll's container. */
|
|
1000
1000
|
containerData?: PluginContainerData;
|
|
1001
1001
|
/** Poll data. */
|
|
@@ -1005,7 +1005,7 @@ export interface PollData {
|
|
|
1005
1005
|
/** Styling for the poll and voting options. */
|
|
1006
1006
|
design?: Design;
|
|
1007
1007
|
}
|
|
1008
|
-
|
|
1008
|
+
declare enum ViewRole {
|
|
1009
1009
|
/** Only Poll creator can view the results */
|
|
1010
1010
|
CREATOR = "CREATOR",
|
|
1011
1011
|
/** Anyone who voted can see the results */
|
|
@@ -1013,13 +1013,13 @@ export declare enum ViewRole {
|
|
|
1013
1013
|
/** Anyone can see the results, even if one didn't vote */
|
|
1014
1014
|
EVERYONE = "EVERYONE"
|
|
1015
1015
|
}
|
|
1016
|
-
|
|
1016
|
+
declare enum VoteRole {
|
|
1017
1017
|
/** Logged in member */
|
|
1018
1018
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1019
1019
|
/** Anyone */
|
|
1020
1020
|
ALL = "ALL"
|
|
1021
1021
|
}
|
|
1022
|
-
|
|
1022
|
+
interface Permissions {
|
|
1023
1023
|
/** Sets who can view the poll results. */
|
|
1024
1024
|
view?: ViewRole;
|
|
1025
1025
|
/** Sets who can vote. */
|
|
@@ -1027,15 +1027,15 @@ export interface Permissions {
|
|
|
1027
1027
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1028
1028
|
allowMultipleVotes?: boolean | null;
|
|
1029
1029
|
}
|
|
1030
|
-
|
|
1030
|
+
interface Option {
|
|
1031
1031
|
/** Option ID. */
|
|
1032
|
-
|
|
1032
|
+
_id?: string | null;
|
|
1033
1033
|
/** Option title. */
|
|
1034
1034
|
title?: string | null;
|
|
1035
1035
|
/** The image displayed with the option. */
|
|
1036
1036
|
image?: Media;
|
|
1037
1037
|
}
|
|
1038
|
-
|
|
1038
|
+
interface Settings {
|
|
1039
1039
|
/** Permissions settings for voting. */
|
|
1040
1040
|
permissions?: Permissions;
|
|
1041
1041
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1043,19 +1043,19 @@ export interface Settings {
|
|
|
1043
1043
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1044
1044
|
showVotesCount?: boolean | null;
|
|
1045
1045
|
}
|
|
1046
|
-
|
|
1046
|
+
declare enum PollLayoutType {
|
|
1047
1047
|
/** List */
|
|
1048
1048
|
LIST = "LIST",
|
|
1049
1049
|
/** Grid */
|
|
1050
1050
|
GRID = "GRID"
|
|
1051
1051
|
}
|
|
1052
|
-
|
|
1052
|
+
declare enum PollLayoutDirection {
|
|
1053
1053
|
/** Left-to-right */
|
|
1054
1054
|
LTR = "LTR",
|
|
1055
1055
|
/** Right-to-left */
|
|
1056
1056
|
RTL = "RTL"
|
|
1057
1057
|
}
|
|
1058
|
-
|
|
1058
|
+
interface PollLayout {
|
|
1059
1059
|
/** The layout for displaying the voting options. */
|
|
1060
1060
|
type?: PollLayoutType;
|
|
1061
1061
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1063,11 +1063,11 @@ export interface PollLayout {
|
|
|
1063
1063
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1064
1064
|
enableImage?: boolean | null;
|
|
1065
1065
|
}
|
|
1066
|
-
|
|
1066
|
+
interface OptionLayout {
|
|
1067
1067
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1068
1068
|
enableImage?: boolean | null;
|
|
1069
1069
|
}
|
|
1070
|
-
|
|
1070
|
+
declare enum BackgroundType {
|
|
1071
1071
|
/** Color background type */
|
|
1072
1072
|
COLOR = "COLOR",
|
|
1073
1073
|
/** Image background type */
|
|
@@ -1075,7 +1075,7 @@ export declare enum BackgroundType {
|
|
|
1075
1075
|
/** Gradiant background type */
|
|
1076
1076
|
GRADIENT = "GRADIENT"
|
|
1077
1077
|
}
|
|
1078
|
-
|
|
1078
|
+
interface Gradient {
|
|
1079
1079
|
/** The gradient angle in degrees. */
|
|
1080
1080
|
angle?: number | null;
|
|
1081
1081
|
/**
|
|
@@ -1089,7 +1089,7 @@ export interface Gradient {
|
|
|
1089
1089
|
*/
|
|
1090
1090
|
lastColor?: string | null;
|
|
1091
1091
|
}
|
|
1092
|
-
|
|
1092
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1093
1093
|
/**
|
|
1094
1094
|
* The background color as a hexademical value.
|
|
1095
1095
|
* @format COLOR_HEX
|
|
@@ -1103,7 +1103,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1103
1103
|
type?: BackgroundType;
|
|
1104
1104
|
}
|
|
1105
1105
|
/** @oneof */
|
|
1106
|
-
|
|
1106
|
+
interface BackgroundBackgroundOneOf {
|
|
1107
1107
|
/**
|
|
1108
1108
|
* The background color as a hexademical value.
|
|
1109
1109
|
* @format COLOR_HEX
|
|
@@ -1114,19 +1114,19 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1114
1114
|
/** Details for a gradient background. */
|
|
1115
1115
|
gradient?: Gradient;
|
|
1116
1116
|
}
|
|
1117
|
-
|
|
1117
|
+
interface PollDesign {
|
|
1118
1118
|
/** Background styling. */
|
|
1119
1119
|
background?: Background;
|
|
1120
1120
|
/** Border radius in pixels. */
|
|
1121
1121
|
borderRadius?: number | null;
|
|
1122
1122
|
}
|
|
1123
|
-
|
|
1123
|
+
interface OptionDesign {
|
|
1124
1124
|
/** Border radius in pixels. */
|
|
1125
1125
|
borderRadius?: number | null;
|
|
1126
1126
|
}
|
|
1127
|
-
|
|
1127
|
+
interface Poll {
|
|
1128
1128
|
/** Poll ID. */
|
|
1129
|
-
|
|
1129
|
+
_id?: string | null;
|
|
1130
1130
|
/** Poll title. */
|
|
1131
1131
|
title?: string | null;
|
|
1132
1132
|
/** Poll creator ID. */
|
|
@@ -1138,26 +1138,26 @@ export interface Poll {
|
|
|
1138
1138
|
/** The poll's permissions and display settings. */
|
|
1139
1139
|
settings?: Settings;
|
|
1140
1140
|
}
|
|
1141
|
-
|
|
1141
|
+
interface PollDataLayout {
|
|
1142
1142
|
/** Poll layout settings. */
|
|
1143
1143
|
poll?: PollLayout;
|
|
1144
1144
|
/** Voting otpions layout settings. */
|
|
1145
1145
|
options?: OptionLayout;
|
|
1146
1146
|
}
|
|
1147
|
-
|
|
1147
|
+
interface Design {
|
|
1148
1148
|
/** Styling for the poll. */
|
|
1149
1149
|
poll?: PollDesign;
|
|
1150
1150
|
/** Styling for voting options. */
|
|
1151
1151
|
options?: OptionDesign;
|
|
1152
1152
|
}
|
|
1153
|
-
|
|
1153
|
+
interface TextData {
|
|
1154
1154
|
/** The text to apply decorations to. */
|
|
1155
1155
|
text?: string;
|
|
1156
1156
|
/** The decorations to apply. */
|
|
1157
1157
|
decorations?: Decoration[];
|
|
1158
1158
|
}
|
|
1159
1159
|
/** Adds appearence changes to text */
|
|
1160
|
-
|
|
1160
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1161
1161
|
/** Data for an anchor link decoration. */
|
|
1162
1162
|
anchorData?: AnchorData;
|
|
1163
1163
|
/** Data for a color decoration. */
|
|
@@ -1176,11 +1176,13 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1176
1176
|
underlineData?: boolean | null;
|
|
1177
1177
|
/** Data for a spoiler decoration. */
|
|
1178
1178
|
spoilerData?: SpoilerData;
|
|
1179
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1180
|
+
strikethroughData?: boolean | null;
|
|
1179
1181
|
/** The type of decoration to apply. */
|
|
1180
1182
|
type?: DecorationType;
|
|
1181
1183
|
}
|
|
1182
1184
|
/** @oneof */
|
|
1183
|
-
|
|
1185
|
+
interface DecorationDataOneOf {
|
|
1184
1186
|
/** Data for an anchor link decoration. */
|
|
1185
1187
|
anchorData?: AnchorData;
|
|
1186
1188
|
/** Data for a color decoration. */
|
|
@@ -1199,8 +1201,10 @@ export interface DecorationDataOneOf {
|
|
|
1199
1201
|
underlineData?: boolean | null;
|
|
1200
1202
|
/** Data for a spoiler decoration. */
|
|
1201
1203
|
spoilerData?: SpoilerData;
|
|
1204
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1205
|
+
strikethroughData?: boolean | null;
|
|
1202
1206
|
}
|
|
1203
|
-
|
|
1207
|
+
declare enum DecorationType {
|
|
1204
1208
|
BOLD = "BOLD",
|
|
1205
1209
|
ITALIC = "ITALIC",
|
|
1206
1210
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1210,45 +1214,46 @@ export declare enum DecorationType {
|
|
|
1210
1214
|
LINK = "LINK",
|
|
1211
1215
|
COLOR = "COLOR",
|
|
1212
1216
|
FONT_SIZE = "FONT_SIZE",
|
|
1213
|
-
EXTERNAL = "EXTERNAL"
|
|
1217
|
+
EXTERNAL = "EXTERNAL",
|
|
1218
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1214
1219
|
}
|
|
1215
|
-
|
|
1220
|
+
interface AnchorData {
|
|
1216
1221
|
/** The target node's ID. */
|
|
1217
1222
|
anchor?: string;
|
|
1218
1223
|
}
|
|
1219
|
-
|
|
1224
|
+
interface ColorData {
|
|
1220
1225
|
/** The text's background color as a hexadecimal value. */
|
|
1221
1226
|
background?: string | null;
|
|
1222
1227
|
/** The text's foreground color as a hexadecimal value. */
|
|
1223
1228
|
foreground?: string | null;
|
|
1224
1229
|
}
|
|
1225
|
-
|
|
1230
|
+
interface LinkData {
|
|
1226
1231
|
/** Link details. */
|
|
1227
1232
|
link?: Link;
|
|
1228
1233
|
}
|
|
1229
|
-
|
|
1234
|
+
interface MentionData {
|
|
1230
1235
|
/** The mentioned user's name. */
|
|
1231
1236
|
name?: string;
|
|
1232
1237
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1233
1238
|
slug?: string;
|
|
1234
1239
|
/** Mentioned user's ID. */
|
|
1235
|
-
|
|
1240
|
+
_id?: string | null;
|
|
1236
1241
|
}
|
|
1237
|
-
|
|
1242
|
+
interface FontSizeData {
|
|
1238
1243
|
/** The units used for the font size. */
|
|
1239
1244
|
unit?: FontType;
|
|
1240
1245
|
/** Font size value. */
|
|
1241
1246
|
value?: number | null;
|
|
1242
1247
|
}
|
|
1243
|
-
|
|
1248
|
+
declare enum FontType {
|
|
1244
1249
|
PX = "PX",
|
|
1245
1250
|
EM = "EM"
|
|
1246
1251
|
}
|
|
1247
|
-
|
|
1252
|
+
interface SpoilerData {
|
|
1248
1253
|
/** Spoiler ID. */
|
|
1249
|
-
|
|
1254
|
+
_id?: string | null;
|
|
1250
1255
|
}
|
|
1251
|
-
|
|
1256
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1252
1257
|
/** Data for embedded Wix Bookings content. */
|
|
1253
1258
|
bookingData?: BookingData;
|
|
1254
1259
|
/** Data for embedded Wix Events content. */
|
|
@@ -1270,28 +1275,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1270
1275
|
image?: Media;
|
|
1271
1276
|
}
|
|
1272
1277
|
/** @oneof */
|
|
1273
|
-
|
|
1278
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1274
1279
|
/** Data for embedded Wix Bookings content. */
|
|
1275
1280
|
bookingData?: BookingData;
|
|
1276
1281
|
/** Data for embedded Wix Events content. */
|
|
1277
1282
|
eventData?: EventData;
|
|
1278
1283
|
}
|
|
1279
|
-
|
|
1284
|
+
declare enum AppType {
|
|
1280
1285
|
PRODUCT = "PRODUCT",
|
|
1281
1286
|
EVENT = "EVENT",
|
|
1282
1287
|
BOOKING = "BOOKING"
|
|
1283
1288
|
}
|
|
1284
|
-
|
|
1289
|
+
interface BookingData {
|
|
1285
1290
|
/** Booking duration in minutes. */
|
|
1286
1291
|
durations?: string | null;
|
|
1287
1292
|
}
|
|
1288
|
-
|
|
1293
|
+
interface EventData {
|
|
1289
1294
|
/** Event schedule. */
|
|
1290
1295
|
scheduling?: string | null;
|
|
1291
1296
|
/** Event location. */
|
|
1292
1297
|
location?: string | null;
|
|
1293
1298
|
}
|
|
1294
|
-
|
|
1299
|
+
interface VideoData {
|
|
1295
1300
|
/** Styling for the video's container. */
|
|
1296
1301
|
containerData?: PluginContainerData;
|
|
1297
1302
|
/** Video details. */
|
|
@@ -1305,7 +1310,7 @@ export interface VideoData {
|
|
|
1305
1310
|
/** Video options. */
|
|
1306
1311
|
options?: PlaybackOptions;
|
|
1307
1312
|
}
|
|
1308
|
-
|
|
1313
|
+
interface PlaybackOptions {
|
|
1309
1314
|
/** Sets whether the media will automatically start playing. */
|
|
1310
1315
|
autoPlay?: boolean | null;
|
|
1311
1316
|
/** Sets whether media's will be looped. */
|
|
@@ -1313,7 +1318,7 @@ export interface PlaybackOptions {
|
|
|
1313
1318
|
/** Sets whether media's controls will be shown. */
|
|
1314
1319
|
showControls?: boolean | null;
|
|
1315
1320
|
}
|
|
1316
|
-
|
|
1321
|
+
interface EmbedData {
|
|
1317
1322
|
/** Styling for the oEmbed node's container. */
|
|
1318
1323
|
containerData?: PluginContainerData;
|
|
1319
1324
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1321,7 +1326,7 @@ export interface EmbedData {
|
|
|
1321
1326
|
/** Origin asset source. */
|
|
1322
1327
|
src?: string | null;
|
|
1323
1328
|
}
|
|
1324
|
-
|
|
1329
|
+
interface Oembed {
|
|
1325
1330
|
/** The resource type. */
|
|
1326
1331
|
type?: string | null;
|
|
1327
1332
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1353,7 +1358,7 @@ export interface Oembed {
|
|
|
1353
1358
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1354
1359
|
version?: string | null;
|
|
1355
1360
|
}
|
|
1356
|
-
|
|
1361
|
+
interface CollapsibleListData {
|
|
1357
1362
|
/** Styling for the collapsible list's container. */
|
|
1358
1363
|
containerData?: PluginContainerData;
|
|
1359
1364
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1365,7 +1370,7 @@ export interface CollapsibleListData {
|
|
|
1365
1370
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1366
1371
|
isQapageData?: boolean | null;
|
|
1367
1372
|
}
|
|
1368
|
-
|
|
1373
|
+
declare enum InitialExpandedItems {
|
|
1369
1374
|
/** First item will be expended initally */
|
|
1370
1375
|
FIRST = "FIRST",
|
|
1371
1376
|
/** All items will expended initally */
|
|
@@ -1373,13 +1378,13 @@ export declare enum InitialExpandedItems {
|
|
|
1373
1378
|
/** All items collapsed initally */
|
|
1374
1379
|
NONE = "NONE"
|
|
1375
1380
|
}
|
|
1376
|
-
|
|
1381
|
+
declare enum Direction {
|
|
1377
1382
|
/** Left-to-right */
|
|
1378
1383
|
LTR = "LTR",
|
|
1379
1384
|
/** Right-to-left */
|
|
1380
1385
|
RTL = "RTL"
|
|
1381
1386
|
}
|
|
1382
|
-
|
|
1387
|
+
interface TableData {
|
|
1383
1388
|
/** Styling for the table's container. */
|
|
1384
1389
|
containerData?: PluginContainerData;
|
|
1385
1390
|
/** The table's dimensions. */
|
|
@@ -1394,7 +1399,7 @@ export interface TableData {
|
|
|
1394
1399
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1395
1400
|
columnHeader?: boolean | null;
|
|
1396
1401
|
}
|
|
1397
|
-
|
|
1402
|
+
interface Dimensions {
|
|
1398
1403
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1399
1404
|
colsWidthRatio?: number[];
|
|
1400
1405
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1402,13 +1407,13 @@ export interface Dimensions {
|
|
|
1402
1407
|
/** An array representing the minimum width of each column in pixels. */
|
|
1403
1408
|
colsMinWidth?: number[];
|
|
1404
1409
|
}
|
|
1405
|
-
|
|
1410
|
+
interface TableCellData {
|
|
1406
1411
|
/** Styling for the cell's background color and text alignment. */
|
|
1407
1412
|
cellStyle?: CellStyle;
|
|
1408
1413
|
/** The cell's border colors. */
|
|
1409
1414
|
borderColors?: BorderColors;
|
|
1410
1415
|
}
|
|
1411
|
-
|
|
1416
|
+
declare enum VerticalAlignment {
|
|
1412
1417
|
/** Top alignment */
|
|
1413
1418
|
TOP = "TOP",
|
|
1414
1419
|
/** Middle alignment */
|
|
@@ -1416,7 +1421,7 @@ export declare enum VerticalAlignment {
|
|
|
1416
1421
|
/** Bottom alignment */
|
|
1417
1422
|
BOTTOM = "BOTTOM"
|
|
1418
1423
|
}
|
|
1419
|
-
|
|
1424
|
+
interface CellStyle {
|
|
1420
1425
|
/** Vertical alignment for the cell's text. */
|
|
1421
1426
|
verticalAlignment?: VerticalAlignment;
|
|
1422
1427
|
/**
|
|
@@ -1425,7 +1430,7 @@ export interface CellStyle {
|
|
|
1425
1430
|
*/
|
|
1426
1431
|
backgroundColor?: string | null;
|
|
1427
1432
|
}
|
|
1428
|
-
|
|
1433
|
+
interface BorderColors {
|
|
1429
1434
|
/**
|
|
1430
1435
|
* Left border color as a hexadecimal value.
|
|
1431
1436
|
* @format COLOR_HEX
|
|
@@ -1453,7 +1458,7 @@ export interface BorderColors {
|
|
|
1453
1458
|
*
|
|
1454
1459
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1455
1460
|
*/
|
|
1456
|
-
|
|
1461
|
+
declare enum NullValue {
|
|
1457
1462
|
/** Null value. */
|
|
1458
1463
|
NULL_VALUE = "NULL_VALUE"
|
|
1459
1464
|
}
|
|
@@ -1462,11 +1467,11 @@ export declare enum NullValue {
|
|
|
1462
1467
|
*
|
|
1463
1468
|
* The JSON representation for `ListValue` is JSON array.
|
|
1464
1469
|
*/
|
|
1465
|
-
|
|
1470
|
+
interface ListValue {
|
|
1466
1471
|
/** Repeated field of dynamically typed values. */
|
|
1467
1472
|
values?: any[];
|
|
1468
1473
|
}
|
|
1469
|
-
|
|
1474
|
+
interface AudioData {
|
|
1470
1475
|
/** Styling for the audio node's container. */
|
|
1471
1476
|
containerData?: PluginContainerData;
|
|
1472
1477
|
/** Audio file details. */
|
|
@@ -1482,7 +1487,7 @@ export interface AudioData {
|
|
|
1482
1487
|
/** An HTML version of the audio node. */
|
|
1483
1488
|
html?: string | null;
|
|
1484
1489
|
}
|
|
1485
|
-
|
|
1490
|
+
interface OrderedListData {
|
|
1486
1491
|
/** Indentation level from 0-4. */
|
|
1487
1492
|
indentation?: number;
|
|
1488
1493
|
/** Offset level from 0-4. */
|
|
@@ -1490,24 +1495,24 @@ export interface OrderedListData {
|
|
|
1490
1495
|
/** List start number. */
|
|
1491
1496
|
start?: number | null;
|
|
1492
1497
|
}
|
|
1493
|
-
|
|
1498
|
+
interface BulletedListData {
|
|
1494
1499
|
/** Indentation level from 0-4. */
|
|
1495
1500
|
indentation?: number;
|
|
1496
1501
|
/** Offset level from 0-4. */
|
|
1497
1502
|
offset?: number | null;
|
|
1498
1503
|
}
|
|
1499
|
-
|
|
1504
|
+
interface BlockquoteData {
|
|
1500
1505
|
/** Indentation level from 1-4. */
|
|
1501
1506
|
indentation?: number;
|
|
1502
1507
|
}
|
|
1503
|
-
|
|
1508
|
+
interface CaptionData {
|
|
1504
1509
|
textStyle?: TextStyle;
|
|
1505
1510
|
}
|
|
1506
|
-
|
|
1511
|
+
interface LayoutCellData {
|
|
1507
1512
|
/** Size of the cell in 12 columns grid. */
|
|
1508
1513
|
colSpan?: number | null;
|
|
1509
1514
|
}
|
|
1510
|
-
|
|
1515
|
+
interface Metadata {
|
|
1511
1516
|
/** Schema version. */
|
|
1512
1517
|
version?: number;
|
|
1513
1518
|
/**
|
|
@@ -1522,9 +1527,9 @@ export interface Metadata {
|
|
|
1522
1527
|
*/
|
|
1523
1528
|
updatedTimestamp?: Date | null;
|
|
1524
1529
|
/** Object ID. */
|
|
1525
|
-
|
|
1530
|
+
_id?: string | null;
|
|
1526
1531
|
}
|
|
1527
|
-
|
|
1532
|
+
interface DocumentStyle {
|
|
1528
1533
|
/** Styling for H1 nodes. */
|
|
1529
1534
|
headerOne?: TextNodeStyle;
|
|
1530
1535
|
/** Styling for H2 nodes. */
|
|
@@ -1544,7 +1549,7 @@ export interface DocumentStyle {
|
|
|
1544
1549
|
/** Styling for code block nodes. */
|
|
1545
1550
|
codeBlock?: TextNodeStyle;
|
|
1546
1551
|
}
|
|
1547
|
-
|
|
1552
|
+
interface TextNodeStyle {
|
|
1548
1553
|
/** The decorations to apply to the node. */
|
|
1549
1554
|
decorations?: Decoration[];
|
|
1550
1555
|
/** Padding and background color for the node. */
|
|
@@ -1552,7 +1557,7 @@ export interface TextNodeStyle {
|
|
|
1552
1557
|
/** Line height for text in the node. */
|
|
1553
1558
|
lineHeight?: string | null;
|
|
1554
1559
|
}
|
|
1555
|
-
|
|
1560
|
+
interface Mention extends MentionIdentityOneOf {
|
|
1556
1561
|
/**
|
|
1557
1562
|
* Wix user ID.
|
|
1558
1563
|
* @format GUID
|
|
@@ -1575,7 +1580,7 @@ export interface Mention extends MentionIdentityOneOf {
|
|
|
1575
1580
|
groupId?: string | null;
|
|
1576
1581
|
}
|
|
1577
1582
|
/** @oneof */
|
|
1578
|
-
|
|
1583
|
+
interface MentionIdentityOneOf {
|
|
1579
1584
|
/**
|
|
1580
1585
|
* Wix user ID.
|
|
1581
1586
|
* @format GUID
|
|
@@ -1597,15 +1602,15 @@ export interface MentionIdentityOneOf {
|
|
|
1597
1602
|
*/
|
|
1598
1603
|
groupId?: string | null;
|
|
1599
1604
|
}
|
|
1600
|
-
|
|
1605
|
+
interface Attachment extends AttachmentMediaOneOf {
|
|
1601
1606
|
/** Information about the image. */
|
|
1602
|
-
image?:
|
|
1607
|
+
image?: string;
|
|
1603
1608
|
/** Information about the video. */
|
|
1604
|
-
video?:
|
|
1609
|
+
video?: string;
|
|
1605
1610
|
/** Information about the audio. */
|
|
1606
|
-
audio?:
|
|
1611
|
+
audio?: string;
|
|
1607
1612
|
/** Information about the document. */
|
|
1608
|
-
document?:
|
|
1613
|
+
document?: string;
|
|
1609
1614
|
/**
|
|
1610
1615
|
* Mime type of attachment.
|
|
1611
1616
|
* @maxLength 3000
|
|
@@ -1613,87 +1618,17 @@ export interface Attachment extends AttachmentMediaOneOf {
|
|
|
1613
1618
|
mimeType?: string | null;
|
|
1614
1619
|
}
|
|
1615
1620
|
/** @oneof */
|
|
1616
|
-
|
|
1621
|
+
interface AttachmentMediaOneOf {
|
|
1617
1622
|
/** Information about the image. */
|
|
1618
|
-
image?:
|
|
1623
|
+
image?: string;
|
|
1619
1624
|
/** Information about the video. */
|
|
1620
|
-
video?:
|
|
1625
|
+
video?: string;
|
|
1621
1626
|
/** Information about the audio. */
|
|
1622
|
-
audio?:
|
|
1627
|
+
audio?: string;
|
|
1623
1628
|
/** Information about the document. */
|
|
1624
|
-
document?:
|
|
1625
|
-
}
|
|
1626
|
-
export interface Image {
|
|
1627
|
-
/** WixMedia image ID. */
|
|
1628
|
-
id?: string;
|
|
1629
|
-
/** Image URL. */
|
|
1630
|
-
url?: string;
|
|
1631
|
-
/**
|
|
1632
|
-
* Original image height.
|
|
1633
|
-
* @readonly
|
|
1634
|
-
*/
|
|
1635
|
-
height?: number;
|
|
1636
|
-
/**
|
|
1637
|
-
* Original image width.
|
|
1638
|
-
* @readonly
|
|
1639
|
-
*/
|
|
1640
|
-
width?: number;
|
|
1641
|
-
/**
|
|
1642
|
-
* Image alt text.
|
|
1643
|
-
* @readonly
|
|
1644
|
-
*/
|
|
1645
|
-
altText?: string | null;
|
|
1646
|
-
/**
|
|
1647
|
-
* Image URL expiration date (when relevant).
|
|
1648
|
-
* @readonly
|
|
1649
|
-
*/
|
|
1650
|
-
urlExpirationDate?: Date | null;
|
|
1651
|
-
/**
|
|
1652
|
-
* Image filename.
|
|
1653
|
-
* @readonly
|
|
1654
|
-
*/
|
|
1655
|
-
filename?: string | null;
|
|
1656
|
-
/**
|
|
1657
|
-
* Image size in bytes.
|
|
1658
|
-
* @readonly
|
|
1659
|
-
* @format DECIMAL_VALUE
|
|
1660
|
-
*/
|
|
1661
|
-
sizeInBytes?: string | null;
|
|
1662
|
-
}
|
|
1663
|
-
export interface VideoV2 {
|
|
1664
|
-
/** WixMedia ID. */
|
|
1665
|
-
id?: string;
|
|
1666
|
-
/** Original video URL. */
|
|
1667
|
-
url?: string;
|
|
1668
|
-
/**
|
|
1669
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
1670
|
-
* @readonly
|
|
1671
|
-
* @maxSize 100
|
|
1672
|
-
*/
|
|
1673
|
-
resolutions?: VideoResolution[];
|
|
1674
|
-
/**
|
|
1675
|
-
* Video filename.
|
|
1676
|
-
* @readonly
|
|
1677
|
-
*/
|
|
1678
|
-
filename?: string | null;
|
|
1679
|
-
/**
|
|
1680
|
-
* Video posters.
|
|
1681
|
-
* @readonly
|
|
1682
|
-
*/
|
|
1683
|
-
posters?: Image[];
|
|
1684
|
-
/**
|
|
1685
|
-
* Original video size in bytes.
|
|
1686
|
-
* @readonly
|
|
1687
|
-
* @format DECIMAL_VALUE
|
|
1688
|
-
*/
|
|
1689
|
-
sizeInBytes?: string | null;
|
|
1690
|
-
/**
|
|
1691
|
-
* Video URL expiration date (when relevant).
|
|
1692
|
-
* @readonly
|
|
1693
|
-
*/
|
|
1694
|
-
urlExpirationDate?: Date | null;
|
|
1629
|
+
document?: string;
|
|
1695
1630
|
}
|
|
1696
|
-
|
|
1631
|
+
interface VideoResolution {
|
|
1697
1632
|
/** Video URL. */
|
|
1698
1633
|
url?: string;
|
|
1699
1634
|
/** Video height. */
|
|
@@ -1732,80 +1667,7 @@ export interface VideoResolution {
|
|
|
1732
1667
|
*/
|
|
1733
1668
|
assetKey?: string | null;
|
|
1734
1669
|
}
|
|
1735
|
-
|
|
1736
|
-
/** WixMedia ID. */
|
|
1737
|
-
id?: string;
|
|
1738
|
-
/** Audio URL. */
|
|
1739
|
-
url?: string;
|
|
1740
|
-
/**
|
|
1741
|
-
* Audio URL expiration date (when relevant).
|
|
1742
|
-
* @readonly
|
|
1743
|
-
*/
|
|
1744
|
-
urlExpirationDate?: Date | null;
|
|
1745
|
-
/**
|
|
1746
|
-
* Audio size in bytes.
|
|
1747
|
-
* @readonly
|
|
1748
|
-
* @format DECIMAL_VALUE
|
|
1749
|
-
*/
|
|
1750
|
-
sizeInBytes?: string | null;
|
|
1751
|
-
/**
|
|
1752
|
-
* Audio filename.
|
|
1753
|
-
* @readonly
|
|
1754
|
-
*/
|
|
1755
|
-
filename?: string | null;
|
|
1756
|
-
/**
|
|
1757
|
-
* Audio duration in seconds.
|
|
1758
|
-
* @readonly
|
|
1759
|
-
*/
|
|
1760
|
-
duration?: number | null;
|
|
1761
|
-
/**
|
|
1762
|
-
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
1763
|
-
* In order to access private assets, make a request to:
|
|
1764
|
-
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
1765
|
-
* @readonly
|
|
1766
|
-
*/
|
|
1767
|
-
private?: boolean | null;
|
|
1768
|
-
/**
|
|
1769
|
-
* Key to identify the object relationship to the original media in WixMedia.
|
|
1770
|
-
* Can be used to request a download for the specific asset.
|
|
1771
|
-
* For example: 128-30kbs.mp3, 320kbs.mp3, 128kbs.mp3
|
|
1772
|
-
* @readonly
|
|
1773
|
-
*/
|
|
1774
|
-
assetKey?: string | null;
|
|
1775
|
-
/**
|
|
1776
|
-
* Audio format.
|
|
1777
|
-
* @readonly
|
|
1778
|
-
*/
|
|
1779
|
-
format?: string | null;
|
|
1780
|
-
/**
|
|
1781
|
-
* Audio quality.
|
|
1782
|
-
* @readonly
|
|
1783
|
-
*/
|
|
1784
|
-
quality?: string | null;
|
|
1785
|
-
}
|
|
1786
|
-
export interface Document {
|
|
1787
|
-
/** WixMedia ID. */
|
|
1788
|
-
id?: string;
|
|
1789
|
-
/** Document URL. */
|
|
1790
|
-
url?: string;
|
|
1791
|
-
/**
|
|
1792
|
-
* Document URL expiration date (when relevant).
|
|
1793
|
-
* @readonly
|
|
1794
|
-
*/
|
|
1795
|
-
urlExpirationDate?: Date | null;
|
|
1796
|
-
/**
|
|
1797
|
-
* Document size in bytes.
|
|
1798
|
-
* @readonly
|
|
1799
|
-
* @format DECIMAL_VALUE
|
|
1800
|
-
*/
|
|
1801
|
-
sizeInBytes?: string | null;
|
|
1802
|
-
/**
|
|
1803
|
-
* Document filename.
|
|
1804
|
-
* @readonly
|
|
1805
|
-
*/
|
|
1806
|
-
filename?: string | null;
|
|
1807
|
-
}
|
|
1808
|
-
export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1670
|
+
interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1809
1671
|
/**
|
|
1810
1672
|
* Wix user ID.
|
|
1811
1673
|
* @format GUID
|
|
@@ -1828,7 +1690,7 @@ export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
|
1828
1690
|
appId?: string | null;
|
|
1829
1691
|
}
|
|
1830
1692
|
/** @oneof */
|
|
1831
|
-
|
|
1693
|
+
interface ContentAuthorAuthorOneOf {
|
|
1832
1694
|
/**
|
|
1833
1695
|
* Wix user ID.
|
|
1834
1696
|
* @format GUID
|
|
@@ -1850,7 +1712,7 @@ export interface ContentAuthorAuthorOneOf {
|
|
|
1850
1712
|
*/
|
|
1851
1713
|
appId?: string | null;
|
|
1852
1714
|
}
|
|
1853
|
-
|
|
1715
|
+
interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1854
1716
|
/**
|
|
1855
1717
|
* Wix user ID.
|
|
1856
1718
|
* @format GUID
|
|
@@ -1868,7 +1730,7 @@ export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1868
1730
|
visitorId?: string | null;
|
|
1869
1731
|
}
|
|
1870
1732
|
/** @oneof */
|
|
1871
|
-
|
|
1733
|
+
interface CommentAuthorIdentityOneOf {
|
|
1872
1734
|
/**
|
|
1873
1735
|
* Wix user ID.
|
|
1874
1736
|
* @format GUID
|
|
@@ -1885,13 +1747,13 @@ export interface CommentAuthorIdentityOneOf {
|
|
|
1885
1747
|
*/
|
|
1886
1748
|
visitorId?: string | null;
|
|
1887
1749
|
}
|
|
1888
|
-
|
|
1750
|
+
interface ParentComment {
|
|
1889
1751
|
/**
|
|
1890
1752
|
* Comment ID of the parent comment.
|
|
1891
1753
|
* @format GUID
|
|
1892
1754
|
* @immutable
|
|
1893
1755
|
*/
|
|
1894
|
-
|
|
1756
|
+
_id?: string | null;
|
|
1895
1757
|
/**
|
|
1896
1758
|
* Author of the parent comment.
|
|
1897
1759
|
* @readonly
|
|
@@ -1903,7 +1765,7 @@ export interface ParentComment {
|
|
|
1903
1765
|
*/
|
|
1904
1766
|
status?: Status;
|
|
1905
1767
|
}
|
|
1906
|
-
|
|
1768
|
+
declare enum Status {
|
|
1907
1769
|
/** Unknown status. */
|
|
1908
1770
|
UNKNOWN = "UNKNOWN",
|
|
1909
1771
|
/** This comment is published and publicly visible. */
|
|
@@ -1915,7 +1777,7 @@ export declare enum Status {
|
|
|
1915
1777
|
/** This comment has been hidden by a site moderator. */
|
|
1916
1778
|
HIDDEN = "HIDDEN"
|
|
1917
1779
|
}
|
|
1918
|
-
|
|
1780
|
+
interface VoteSummary {
|
|
1919
1781
|
/** Number of upvotes less downvotes on this comment. */
|
|
1920
1782
|
netVoteCount?: number;
|
|
1921
1783
|
/** Number of upvotes on this comment. */
|
|
@@ -1923,7 +1785,7 @@ export interface VoteSummary {
|
|
|
1923
1785
|
/** Number of downvotes on this comment. */
|
|
1924
1786
|
downvoteCount?: number;
|
|
1925
1787
|
}
|
|
1926
|
-
|
|
1788
|
+
interface CommentReactionSummary {
|
|
1927
1789
|
/** Total amount of reactions. */
|
|
1928
1790
|
total?: number;
|
|
1929
1791
|
/**
|
|
@@ -1932,7 +1794,7 @@ export interface CommentReactionSummary {
|
|
|
1932
1794
|
*/
|
|
1933
1795
|
reactionCodeCount?: Record<string, number>;
|
|
1934
1796
|
}
|
|
1935
|
-
|
|
1797
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1936
1798
|
/** insert/update documents */
|
|
1937
1799
|
update?: InternalDocumentUpdateOperation;
|
|
1938
1800
|
/** delete by document ids */
|
|
@@ -1973,7 +1835,7 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
|
|
|
1973
1835
|
issuedAt?: Date | null;
|
|
1974
1836
|
}
|
|
1975
1837
|
/** @oneof */
|
|
1976
|
-
|
|
1838
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1977
1839
|
/** insert/update documents */
|
|
1978
1840
|
update?: InternalDocumentUpdateOperation;
|
|
1979
1841
|
/** delete by document ids */
|
|
@@ -1989,39 +1851,39 @@ export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
1989
1851
|
/** delete by document ids with versioning */
|
|
1990
1852
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1991
1853
|
}
|
|
1992
|
-
|
|
1854
|
+
interface InternalDocument {
|
|
1993
1855
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
1994
1856
|
document?: Record<string, any> | null;
|
|
1995
1857
|
}
|
|
1996
|
-
|
|
1858
|
+
interface InternalDocumentUpdateOperation {
|
|
1997
1859
|
/** documents to index or update */
|
|
1998
1860
|
documents?: InternalDocument[];
|
|
1999
1861
|
}
|
|
2000
|
-
|
|
1862
|
+
interface DeleteByIdsOperation {
|
|
2001
1863
|
/** ids of the documents to delete */
|
|
2002
1864
|
documentIds?: string[];
|
|
2003
1865
|
}
|
|
2004
|
-
|
|
1866
|
+
interface DeleteByFilterOperation {
|
|
2005
1867
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2006
1868
|
filter?: Record<string, any> | null;
|
|
2007
1869
|
}
|
|
2008
|
-
|
|
1870
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
2009
1871
|
/** documents matching this filter will be updated */
|
|
2010
1872
|
filter?: Record<string, any> | null;
|
|
2011
1873
|
/** partial document to apply */
|
|
2012
1874
|
document?: InternalDocument;
|
|
2013
1875
|
}
|
|
2014
|
-
|
|
1876
|
+
interface InternalUpdateExistingOperation {
|
|
2015
1877
|
/** documents to update */
|
|
2016
1878
|
documents?: InternalDocument[];
|
|
2017
1879
|
}
|
|
2018
|
-
|
|
1880
|
+
interface VersionedDocumentUpdateOperation {
|
|
2019
1881
|
/** documents to create or overwrite */
|
|
2020
1882
|
documents?: InternalDocument[];
|
|
2021
1883
|
/** versioning mode to use instead of default */
|
|
2022
1884
|
versioningMode?: VersioningMode;
|
|
2023
1885
|
}
|
|
2024
|
-
|
|
1886
|
+
declare enum VersioningMode {
|
|
2025
1887
|
/** use default versioning mode agreed with search team */
|
|
2026
1888
|
DEFAULT = "DEFAULT",
|
|
2027
1889
|
/** execute only if version is greater than existing */
|
|
@@ -2029,11 +1891,11 @@ export declare enum VersioningMode {
|
|
|
2029
1891
|
/** execute only if version is greater or equal to existing */
|
|
2030
1892
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2031
1893
|
}
|
|
2032
|
-
|
|
1894
|
+
interface VersionedDeleteByIdsOperation {
|
|
2033
1895
|
/** ids with version of the documents to delete */
|
|
2034
1896
|
documentIds?: VersionedDocumentId[];
|
|
2035
1897
|
}
|
|
2036
|
-
|
|
1898
|
+
interface VersionedDocumentId {
|
|
2037
1899
|
/** document id */
|
|
2038
1900
|
documentId?: string;
|
|
2039
1901
|
/** document version */
|
|
@@ -2041,11 +1903,11 @@ export interface VersionedDocumentId {
|
|
|
2041
1903
|
/** versioning mode to use instead of default */
|
|
2042
1904
|
versioningMode?: VersioningMode;
|
|
2043
1905
|
}
|
|
2044
|
-
|
|
1906
|
+
interface CommentModerated {
|
|
2045
1907
|
comment?: Comment;
|
|
2046
1908
|
moderationAction?: Action;
|
|
2047
1909
|
}
|
|
2048
|
-
|
|
1910
|
+
declare enum Action {
|
|
2049
1911
|
/** Unknown content. */
|
|
2050
1912
|
UNKNOWN = "UNKNOWN",
|
|
2051
1913
|
/** Approve draft content. */
|
|
@@ -2053,17 +1915,17 @@ export declare enum Action {
|
|
|
2053
1915
|
/** Reject draft content. */
|
|
2054
1916
|
REJECT = "REJECT"
|
|
2055
1917
|
}
|
|
2056
|
-
|
|
1918
|
+
interface CreateCommentRequest {
|
|
2057
1919
|
/** Comment to create. */
|
|
2058
1920
|
comment?: Comment;
|
|
2059
1921
|
}
|
|
2060
|
-
|
|
1922
|
+
interface ContactDetails {
|
|
2061
1923
|
}
|
|
2062
|
-
|
|
1924
|
+
interface CreateCommentResponse {
|
|
2063
1925
|
/** Created comment. */
|
|
2064
1926
|
comment?: Comment;
|
|
2065
1927
|
}
|
|
2066
|
-
|
|
1928
|
+
interface ResourceCommentCountChanged {
|
|
2067
1929
|
/** ID of the app that the comment is added to. */
|
|
2068
1930
|
appId?: string;
|
|
2069
1931
|
/**
|
|
@@ -2081,27 +1943,27 @@ export interface ResourceCommentCountChanged {
|
|
|
2081
1943
|
/** How many comments are published for the resource. */
|
|
2082
1944
|
publishedCommentCount?: number;
|
|
2083
1945
|
}
|
|
2084
|
-
|
|
1946
|
+
interface GetCommentRequest {
|
|
2085
1947
|
/**
|
|
2086
1948
|
* ID of the comment to retrieve.
|
|
2087
1949
|
* @format GUID
|
|
2088
1950
|
*/
|
|
2089
1951
|
commentId: string;
|
|
2090
1952
|
}
|
|
2091
|
-
|
|
1953
|
+
interface GetCommentResponse {
|
|
2092
1954
|
/** Retrieved comment. */
|
|
2093
1955
|
comment?: Comment;
|
|
2094
1956
|
}
|
|
2095
1957
|
/** Comment info to update. */
|
|
2096
|
-
|
|
1958
|
+
interface UpdateCommentRequest {
|
|
2097
1959
|
/** Comment info to update. */
|
|
2098
1960
|
comment?: Comment;
|
|
2099
1961
|
}
|
|
2100
|
-
|
|
1962
|
+
interface UpdateCommentResponse {
|
|
2101
1963
|
/** Updated comment. */
|
|
2102
1964
|
comment?: Comment;
|
|
2103
1965
|
}
|
|
2104
|
-
|
|
1966
|
+
interface CommentContentChanged {
|
|
2105
1967
|
/** Comment ID. */
|
|
2106
1968
|
commentId?: string;
|
|
2107
1969
|
/** Content before the update. */
|
|
@@ -2109,19 +1971,19 @@ export interface CommentContentChanged {
|
|
|
2109
1971
|
/** Content after the update. */
|
|
2110
1972
|
currentContent?: CommentContent;
|
|
2111
1973
|
}
|
|
2112
|
-
|
|
1974
|
+
interface DeleteCommentRequest {
|
|
2113
1975
|
/**
|
|
2114
1976
|
* ID of the comment to delete.
|
|
2115
1977
|
* @format GUID
|
|
2116
1978
|
*/
|
|
2117
1979
|
commentId: string;
|
|
2118
1980
|
}
|
|
2119
|
-
|
|
1981
|
+
interface DeleteCommentResponse {
|
|
2120
1982
|
}
|
|
2121
|
-
|
|
1983
|
+
interface CommentDeleted {
|
|
2122
1984
|
comment?: Comment;
|
|
2123
1985
|
}
|
|
2124
|
-
|
|
1986
|
+
interface ModerateDraftContentRequest {
|
|
2125
1987
|
/**
|
|
2126
1988
|
* ID of the comment to moderate.
|
|
2127
1989
|
* @format GUID
|
|
@@ -2136,20 +1998,20 @@ export interface ModerateDraftContentRequest {
|
|
|
2136
1998
|
/** Draft content action. */
|
|
2137
1999
|
draftContentAction?: Action;
|
|
2138
2000
|
}
|
|
2139
|
-
|
|
2001
|
+
interface ModerateDraftContentResponse {
|
|
2140
2002
|
/** Moderated comment. */
|
|
2141
2003
|
comment?: Comment;
|
|
2142
2004
|
}
|
|
2143
|
-
|
|
2005
|
+
interface CommentPublished {
|
|
2144
2006
|
/** Comment info. */
|
|
2145
2007
|
comment?: Comment;
|
|
2146
2008
|
/** Whether this is the first comment publish. */
|
|
2147
2009
|
firstPublish?: boolean;
|
|
2148
2010
|
}
|
|
2149
|
-
|
|
2011
|
+
interface CommentHidden {
|
|
2150
2012
|
comment?: Comment;
|
|
2151
2013
|
}
|
|
2152
|
-
|
|
2014
|
+
interface QueryCommentsRequest {
|
|
2153
2015
|
/**
|
|
2154
2016
|
* App ID to query comments for.
|
|
2155
2017
|
* @format GUID
|
|
@@ -2158,7 +2020,7 @@ export interface QueryCommentsRequest {
|
|
|
2158
2020
|
/** Query options. */
|
|
2159
2021
|
query: CursorQuery;
|
|
2160
2022
|
}
|
|
2161
|
-
|
|
2023
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2162
2024
|
/**
|
|
2163
2025
|
* Cursor paging options.
|
|
2164
2026
|
*
|
|
@@ -2180,7 +2042,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2180
2042
|
sort?: Sorting[];
|
|
2181
2043
|
}
|
|
2182
2044
|
/** @oneof */
|
|
2183
|
-
|
|
2045
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2184
2046
|
/**
|
|
2185
2047
|
* Cursor paging options.
|
|
2186
2048
|
*
|
|
@@ -2188,7 +2050,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2188
2050
|
*/
|
|
2189
2051
|
cursorPaging?: CursorPaging;
|
|
2190
2052
|
}
|
|
2191
|
-
|
|
2053
|
+
interface Sorting {
|
|
2192
2054
|
/**
|
|
2193
2055
|
* Name of the field to sort by.
|
|
2194
2056
|
* @maxLength 512
|
|
@@ -2197,11 +2059,11 @@ export interface Sorting {
|
|
|
2197
2059
|
/** Sort order. */
|
|
2198
2060
|
order?: SortOrder;
|
|
2199
2061
|
}
|
|
2200
|
-
|
|
2062
|
+
declare enum SortOrder {
|
|
2201
2063
|
ASC = "ASC",
|
|
2202
2064
|
DESC = "DESC"
|
|
2203
2065
|
}
|
|
2204
|
-
|
|
2066
|
+
interface CursorPaging {
|
|
2205
2067
|
/**
|
|
2206
2068
|
* Maximum number of items to return in the results.
|
|
2207
2069
|
* @max 100
|
|
@@ -2216,13 +2078,13 @@ export interface CursorPaging {
|
|
|
2216
2078
|
*/
|
|
2217
2079
|
cursor?: string | null;
|
|
2218
2080
|
}
|
|
2219
|
-
|
|
2081
|
+
interface QueryCommentsResponse {
|
|
2220
2082
|
/** Retrieved comments. */
|
|
2221
2083
|
comments?: Comment[];
|
|
2222
2084
|
/** Paging metadata. */
|
|
2223
2085
|
pagingMetadata?: CursorPagingMetadata;
|
|
2224
2086
|
}
|
|
2225
|
-
|
|
2087
|
+
interface CursorPagingMetadata {
|
|
2226
2088
|
/** Number of items returned in current page. */
|
|
2227
2089
|
count?: number | null;
|
|
2228
2090
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2235,7 +2097,7 @@ export interface CursorPagingMetadata {
|
|
|
2235
2097
|
*/
|
|
2236
2098
|
hasNext?: boolean | null;
|
|
2237
2099
|
}
|
|
2238
|
-
|
|
2100
|
+
interface Cursors {
|
|
2239
2101
|
/**
|
|
2240
2102
|
* Cursor string pointing to the next page in the list of results.
|
|
2241
2103
|
* @maxLength 16000
|
|
@@ -2247,58 +2109,58 @@ export interface Cursors {
|
|
|
2247
2109
|
*/
|
|
2248
2110
|
prev?: string | null;
|
|
2249
2111
|
}
|
|
2250
|
-
|
|
2112
|
+
interface MarkCommentRequest {
|
|
2251
2113
|
/**
|
|
2252
2114
|
* ID of the comment to mark.
|
|
2253
2115
|
* @format GUID
|
|
2254
2116
|
*/
|
|
2255
2117
|
commentId: string;
|
|
2256
2118
|
}
|
|
2257
|
-
|
|
2119
|
+
interface MarkCommentResponse {
|
|
2258
2120
|
/** Marked comment. */
|
|
2259
2121
|
comment?: Comment;
|
|
2260
2122
|
}
|
|
2261
|
-
|
|
2123
|
+
interface CommentMarked {
|
|
2262
2124
|
comment?: Comment;
|
|
2263
2125
|
}
|
|
2264
|
-
|
|
2126
|
+
interface UnmarkCommentRequest {
|
|
2265
2127
|
/**
|
|
2266
2128
|
* ID of the comment to unmark.
|
|
2267
2129
|
* @format GUID
|
|
2268
2130
|
*/
|
|
2269
2131
|
commentId: string;
|
|
2270
2132
|
}
|
|
2271
|
-
|
|
2133
|
+
interface UnmarkCommentResponse {
|
|
2272
2134
|
/** Unmarked comment. */
|
|
2273
2135
|
comment?: Comment;
|
|
2274
2136
|
}
|
|
2275
|
-
|
|
2137
|
+
interface CommentUnmarked {
|
|
2276
2138
|
comment?: Comment;
|
|
2277
2139
|
}
|
|
2278
|
-
|
|
2140
|
+
interface HideCommentRequest {
|
|
2279
2141
|
/**
|
|
2280
2142
|
* ID of the comment to hide.
|
|
2281
2143
|
* @format GUID
|
|
2282
2144
|
*/
|
|
2283
2145
|
commentId: string;
|
|
2284
2146
|
}
|
|
2285
|
-
|
|
2147
|
+
interface HideCommentResponse {
|
|
2286
2148
|
/** Hidden comment. */
|
|
2287
2149
|
comment?: Comment;
|
|
2288
2150
|
}
|
|
2289
|
-
|
|
2151
|
+
interface PublishCommentRequest {
|
|
2290
2152
|
/**
|
|
2291
2153
|
* ID of the comment to publish.
|
|
2292
2154
|
* @format GUID
|
|
2293
2155
|
*/
|
|
2294
2156
|
commentId: string;
|
|
2295
2157
|
}
|
|
2296
|
-
|
|
2158
|
+
interface PublishCommentResponse {
|
|
2297
2159
|
/** Published comment. */
|
|
2298
2160
|
comment?: Comment;
|
|
2299
2161
|
}
|
|
2300
2162
|
/** Count comments options. */
|
|
2301
|
-
|
|
2163
|
+
interface CountCommentsRequest {
|
|
2302
2164
|
/**
|
|
2303
2165
|
* App ID to count the comments of.
|
|
2304
2166
|
* @format GUID
|
|
@@ -2307,11 +2169,11 @@ export interface CountCommentsRequest {
|
|
|
2307
2169
|
/** Filter to identify the comments that need to be counted. */
|
|
2308
2170
|
filter?: Record<string, any> | null;
|
|
2309
2171
|
}
|
|
2310
|
-
|
|
2172
|
+
interface CountCommentsResponse {
|
|
2311
2173
|
/** Number of comments. */
|
|
2312
2174
|
count?: number;
|
|
2313
2175
|
}
|
|
2314
|
-
|
|
2176
|
+
interface ListCommentsByResourceRequest {
|
|
2315
2177
|
/**
|
|
2316
2178
|
* ID of the app from which the comments are listed.
|
|
2317
2179
|
* @format GUID
|
|
@@ -2343,7 +2205,7 @@ export interface ListCommentsByResourceRequest {
|
|
|
2343
2205
|
/** Cursor paging. */
|
|
2344
2206
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2345
2207
|
}
|
|
2346
|
-
|
|
2208
|
+
interface CommentSort {
|
|
2347
2209
|
/** Sort order. */
|
|
2348
2210
|
order?: Order;
|
|
2349
2211
|
/**
|
|
@@ -2353,7 +2215,7 @@ export interface CommentSort {
|
|
|
2353
2215
|
*/
|
|
2354
2216
|
keepMarkedInOriginalOrder?: boolean;
|
|
2355
2217
|
}
|
|
2356
|
-
|
|
2218
|
+
declare enum Order {
|
|
2357
2219
|
/** Unknown order. */
|
|
2358
2220
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2359
2221
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2371,7 +2233,7 @@ export declare enum Order {
|
|
|
2371
2233
|
/** Comments with the lowest rating appear at the top of the list. */
|
|
2372
2234
|
RATING_ASC = "RATING_ASC"
|
|
2373
2235
|
}
|
|
2374
|
-
|
|
2236
|
+
interface ReplySort {
|
|
2375
2237
|
/** Sort order. */
|
|
2376
2238
|
order?: ReplySortOrder;
|
|
2377
2239
|
/**
|
|
@@ -2383,7 +2245,7 @@ export interface ReplySort {
|
|
|
2383
2245
|
*/
|
|
2384
2246
|
keepMarkedInOriginalOrder?: boolean;
|
|
2385
2247
|
}
|
|
2386
|
-
|
|
2248
|
+
declare enum ReplySortOrder {
|
|
2387
2249
|
/** Unknown order. */
|
|
2388
2250
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2389
2251
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2393,7 +2255,7 @@ export declare enum ReplySortOrder {
|
|
|
2393
2255
|
/** Comments with the highest reaction count appear at the top of the list. */
|
|
2394
2256
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2395
2257
|
}
|
|
2396
|
-
|
|
2258
|
+
interface ListCommentsByResourceCursorPaging {
|
|
2397
2259
|
/** Pointer to the next or previous page in the list of results. */
|
|
2398
2260
|
cursor?: string | null;
|
|
2399
2261
|
/**
|
|
@@ -2408,7 +2270,7 @@ export interface ListCommentsByResourceCursorPaging {
|
|
|
2408
2270
|
*/
|
|
2409
2271
|
repliesLimit?: number | null;
|
|
2410
2272
|
}
|
|
2411
|
-
|
|
2273
|
+
interface ListCommentsByResourceResponse {
|
|
2412
2274
|
/** Listed comments. */
|
|
2413
2275
|
comments?: Comment[];
|
|
2414
2276
|
/** Paging metadata. */
|
|
@@ -2416,13 +2278,13 @@ export interface ListCommentsByResourceResponse {
|
|
|
2416
2278
|
/** Listed comment replies. */
|
|
2417
2279
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2418
2280
|
}
|
|
2419
|
-
|
|
2281
|
+
interface RepliesListResponse {
|
|
2420
2282
|
/** Listed comment replies. */
|
|
2421
2283
|
replies?: Comment[];
|
|
2422
2284
|
/** Paging metadata. */
|
|
2423
2285
|
pagingMetadata?: CursorPagingMetadata;
|
|
2424
2286
|
}
|
|
2425
|
-
|
|
2287
|
+
interface GetCommentThreadRequest {
|
|
2426
2288
|
/**
|
|
2427
2289
|
* App ID.
|
|
2428
2290
|
* @maxLength 128
|
|
@@ -2440,7 +2302,7 @@ export interface GetCommentThreadRequest {
|
|
|
2440
2302
|
/** Reply sorting. */
|
|
2441
2303
|
replySort?: ReplySort;
|
|
2442
2304
|
}
|
|
2443
|
-
|
|
2305
|
+
interface GetCommentThreadResponse {
|
|
2444
2306
|
/** Retrieved replies. */
|
|
2445
2307
|
comments?: Comment[];
|
|
2446
2308
|
/** Paging metadata. */
|
|
@@ -2448,7 +2310,7 @@ export interface GetCommentThreadResponse {
|
|
|
2448
2310
|
/** Retrieved replies of a reply. */
|
|
2449
2311
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2450
2312
|
}
|
|
2451
|
-
|
|
2313
|
+
interface BulkPublishCommentRequest {
|
|
2452
2314
|
/**
|
|
2453
2315
|
* ID of the app where to publish the comment.
|
|
2454
2316
|
* @format GUID
|
|
@@ -2457,7 +2319,7 @@ export interface BulkPublishCommentRequest {
|
|
|
2457
2319
|
/** Filter to identify the comments that need to be published. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2458
2320
|
filter: Record<string, any> | null;
|
|
2459
2321
|
}
|
|
2460
|
-
|
|
2322
|
+
interface BulkPublishCommentResponse {
|
|
2461
2323
|
/**
|
|
2462
2324
|
* Job ID.
|
|
2463
2325
|
*
|
|
@@ -2466,7 +2328,7 @@ export interface BulkPublishCommentResponse {
|
|
|
2466
2328
|
*/
|
|
2467
2329
|
jobId?: string;
|
|
2468
2330
|
}
|
|
2469
|
-
|
|
2331
|
+
interface BulkHideCommentRequest {
|
|
2470
2332
|
/**
|
|
2471
2333
|
* ID of the app where to hide the comments.
|
|
2472
2334
|
* @format GUID
|
|
@@ -2475,7 +2337,7 @@ export interface BulkHideCommentRequest {
|
|
|
2475
2337
|
/** Filter to identify the comments that need to be hidden. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2476
2338
|
filter: Record<string, any> | null;
|
|
2477
2339
|
}
|
|
2478
|
-
|
|
2340
|
+
interface BulkHideCommentResponse {
|
|
2479
2341
|
/**
|
|
2480
2342
|
* Job ID.
|
|
2481
2343
|
*
|
|
@@ -2484,7 +2346,7 @@ export interface BulkHideCommentResponse {
|
|
|
2484
2346
|
*/
|
|
2485
2347
|
jobId?: string;
|
|
2486
2348
|
}
|
|
2487
|
-
|
|
2349
|
+
interface BulkDeleteCommentRequest {
|
|
2488
2350
|
/**
|
|
2489
2351
|
* ID of the app where to delete the comments.
|
|
2490
2352
|
* @format GUID
|
|
@@ -2493,7 +2355,7 @@ export interface BulkDeleteCommentRequest {
|
|
|
2493
2355
|
/** Filter to identify the comments that need to be deleted. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2494
2356
|
filter: Record<string, any> | null;
|
|
2495
2357
|
}
|
|
2496
|
-
|
|
2358
|
+
interface BulkDeleteCommentResponse {
|
|
2497
2359
|
/**
|
|
2498
2360
|
* Job ID.
|
|
2499
2361
|
*
|
|
@@ -2502,7 +2364,7 @@ export interface BulkDeleteCommentResponse {
|
|
|
2502
2364
|
*/
|
|
2503
2365
|
jobId?: string;
|
|
2504
2366
|
}
|
|
2505
|
-
|
|
2367
|
+
interface BulkModerateDraftContentRequest {
|
|
2506
2368
|
/**
|
|
2507
2369
|
* ID of the app where to moderate the comments.
|
|
2508
2370
|
* @format GUID
|
|
@@ -2513,7 +2375,7 @@ export interface BulkModerateDraftContentRequest {
|
|
|
2513
2375
|
/** Action to do regarding draft content */
|
|
2514
2376
|
draftContentAction: Action;
|
|
2515
2377
|
}
|
|
2516
|
-
|
|
2378
|
+
interface BulkModerateDraftContentResponse {
|
|
2517
2379
|
/**
|
|
2518
2380
|
* Job ID.
|
|
2519
2381
|
*
|
|
@@ -2522,7 +2384,7 @@ export interface BulkModerateDraftContentResponse {
|
|
|
2522
2384
|
*/
|
|
2523
2385
|
jobId?: string;
|
|
2524
2386
|
}
|
|
2525
|
-
|
|
2387
|
+
interface BulkMoveCommentByFilterRequest {
|
|
2526
2388
|
/**
|
|
2527
2389
|
* ID of the app from which to move the comments.
|
|
2528
2390
|
* @format GUID
|
|
@@ -2533,7 +2395,7 @@ export interface BulkMoveCommentByFilterRequest {
|
|
|
2533
2395
|
/** Where to move the comment. */
|
|
2534
2396
|
destination?: Destination;
|
|
2535
2397
|
}
|
|
2536
|
-
|
|
2398
|
+
interface Destination {
|
|
2537
2399
|
/**
|
|
2538
2400
|
* Context ID of where to move the comment to.
|
|
2539
2401
|
* @maxLength 128
|
|
@@ -2545,7 +2407,7 @@ export interface Destination {
|
|
|
2545
2407
|
*/
|
|
2546
2408
|
resourceId?: string;
|
|
2547
2409
|
}
|
|
2548
|
-
|
|
2410
|
+
interface BulkMoveCommentByFilterResponse {
|
|
2549
2411
|
/**
|
|
2550
2412
|
* Job ID.
|
|
2551
2413
|
*
|
|
@@ -2554,11 +2416,11 @@ export interface BulkMoveCommentByFilterResponse {
|
|
|
2554
2416
|
*/
|
|
2555
2417
|
jobId?: string;
|
|
2556
2418
|
}
|
|
2557
|
-
|
|
2419
|
+
interface CommentMoved {
|
|
2558
2420
|
comment?: Comment;
|
|
2559
2421
|
destination?: Destination;
|
|
2560
2422
|
}
|
|
2561
|
-
|
|
2423
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2562
2424
|
createdEvent?: EntityCreatedEvent;
|
|
2563
2425
|
updatedEvent?: EntityUpdatedEvent;
|
|
2564
2426
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2567,7 +2429,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2567
2429
|
* Unique event ID.
|
|
2568
2430
|
* Allows clients to ignore duplicate webhooks.
|
|
2569
2431
|
*/
|
|
2570
|
-
|
|
2432
|
+
_id?: string;
|
|
2571
2433
|
/**
|
|
2572
2434
|
* Assumes actions are also always typed to an entity_type
|
|
2573
2435
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -2601,36 +2463,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2601
2463
|
entityEventSequence?: string | null;
|
|
2602
2464
|
}
|
|
2603
2465
|
/** @oneof */
|
|
2604
|
-
|
|
2466
|
+
interface DomainEventBodyOneOf {
|
|
2605
2467
|
createdEvent?: EntityCreatedEvent;
|
|
2606
2468
|
updatedEvent?: EntityUpdatedEvent;
|
|
2607
2469
|
deletedEvent?: EntityDeletedEvent;
|
|
2608
2470
|
actionEvent?: ActionEvent;
|
|
2609
2471
|
}
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2613
|
-
restoreInfo?: RestoreInfo;
|
|
2472
|
+
interface EntityCreatedEvent {
|
|
2473
|
+
entity?: string;
|
|
2614
2474
|
}
|
|
2615
|
-
|
|
2475
|
+
interface RestoreInfo {
|
|
2616
2476
|
deletedDate?: Date | null;
|
|
2617
2477
|
}
|
|
2618
|
-
|
|
2478
|
+
interface EntityUpdatedEvent {
|
|
2619
2479
|
/**
|
|
2620
2480
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2621
2481
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2622
2482
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2623
2483
|
*/
|
|
2624
|
-
|
|
2484
|
+
currentEntity?: string;
|
|
2625
2485
|
}
|
|
2626
|
-
|
|
2486
|
+
interface EntityDeletedEvent {
|
|
2627
2487
|
/** Entity that was deleted */
|
|
2628
|
-
|
|
2488
|
+
deletedEntity?: string | null;
|
|
2629
2489
|
}
|
|
2630
|
-
|
|
2631
|
-
|
|
2490
|
+
interface ActionEvent {
|
|
2491
|
+
body?: string;
|
|
2632
2492
|
}
|
|
2633
|
-
|
|
2493
|
+
interface MessageEnvelope {
|
|
2634
2494
|
/**
|
|
2635
2495
|
* App instance ID.
|
|
2636
2496
|
* @format GUID
|
|
@@ -2646,7 +2506,7 @@ export interface MessageEnvelope {
|
|
|
2646
2506
|
/** Stringify payload. */
|
|
2647
2507
|
data?: string;
|
|
2648
2508
|
}
|
|
2649
|
-
|
|
2509
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2650
2510
|
/**
|
|
2651
2511
|
* ID of a site visitor that has not logged in to the site.
|
|
2652
2512
|
* @format GUID
|
|
@@ -2671,7 +2531,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2671
2531
|
identityType?: WebhookIdentityType;
|
|
2672
2532
|
}
|
|
2673
2533
|
/** @oneof */
|
|
2674
|
-
|
|
2534
|
+
interface IdentificationDataIdOneOf {
|
|
2675
2535
|
/**
|
|
2676
2536
|
* ID of a site visitor that has not logged in to the site.
|
|
2677
2537
|
* @format GUID
|
|
@@ -2693,372 +2553,332 @@ export interface IdentificationDataIdOneOf {
|
|
|
2693
2553
|
*/
|
|
2694
2554
|
appId?: string;
|
|
2695
2555
|
}
|
|
2696
|
-
|
|
2556
|
+
declare enum WebhookIdentityType {
|
|
2697
2557
|
UNKNOWN = "UNKNOWN",
|
|
2698
2558
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2699
2559
|
MEMBER = "MEMBER",
|
|
2700
2560
|
WIX_USER = "WIX_USER",
|
|
2701
2561
|
APP = "APP"
|
|
2702
2562
|
}
|
|
2703
|
-
interface
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2717
|
-
type: Type;
|
|
2718
|
-
link?: LinkNonNullableFields;
|
|
2719
|
-
}
|
|
2720
|
-
interface TextStyleNonNullableFields {
|
|
2721
|
-
textAlignment: TextAlignment;
|
|
2722
|
-
}
|
|
2723
|
-
interface CodeBlockDataNonNullableFields {
|
|
2724
|
-
textStyle?: TextStyleNonNullableFields;
|
|
2725
|
-
}
|
|
2726
|
-
interface DividerDataNonNullableFields {
|
|
2727
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2728
|
-
lineStyle: LineStyle;
|
|
2729
|
-
width: Width;
|
|
2730
|
-
alignment: Alignment;
|
|
2731
|
-
}
|
|
2732
|
-
interface PDFSettingsNonNullableFields {
|
|
2733
|
-
viewMode: ViewMode;
|
|
2734
|
-
}
|
|
2735
|
-
interface FileDataNonNullableFields {
|
|
2736
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2737
|
-
pdfSettings?: PDFSettingsNonNullableFields;
|
|
2738
|
-
}
|
|
2739
|
-
interface ItemImageNonNullableFields {
|
|
2740
|
-
link?: LinkNonNullableFields;
|
|
2741
|
-
}
|
|
2742
|
-
interface ItemNonNullableFields {
|
|
2743
|
-
image?: ItemImageNonNullableFields;
|
|
2744
|
-
}
|
|
2745
|
-
interface LayoutNonNullableFields {
|
|
2746
|
-
type: LayoutType;
|
|
2747
|
-
orientation: Orientation;
|
|
2748
|
-
}
|
|
2749
|
-
interface ItemStyleNonNullableFields {
|
|
2750
|
-
crop: Crop;
|
|
2751
|
-
}
|
|
2752
|
-
interface ThumbnailsNonNullableFields {
|
|
2753
|
-
placement: ThumbnailsAlignment;
|
|
2754
|
-
}
|
|
2755
|
-
interface GalleryOptionsNonNullableFields {
|
|
2756
|
-
layout?: LayoutNonNullableFields;
|
|
2757
|
-
item?: ItemStyleNonNullableFields;
|
|
2758
|
-
thumbnails?: ThumbnailsNonNullableFields;
|
|
2759
|
-
}
|
|
2760
|
-
interface GalleryDataNonNullableFields {
|
|
2761
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2762
|
-
items: ItemNonNullableFields[];
|
|
2763
|
-
options?: GalleryOptionsNonNullableFields;
|
|
2764
|
-
}
|
|
2765
|
-
interface GIFDataNonNullableFields {
|
|
2766
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2767
|
-
height: number;
|
|
2768
|
-
width: number;
|
|
2769
|
-
gifType: GIFType;
|
|
2770
|
-
}
|
|
2771
|
-
interface HeadingDataNonNullableFields {
|
|
2772
|
-
level: number;
|
|
2773
|
-
textStyle?: TextStyleNonNullableFields;
|
|
2774
|
-
}
|
|
2775
|
-
interface HTMLDataNonNullableFields {
|
|
2776
|
-
url: string;
|
|
2777
|
-
html: string;
|
|
2778
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2779
|
-
source: Source;
|
|
2563
|
+
interface BaseEventMetadata {
|
|
2564
|
+
/**
|
|
2565
|
+
* App instance ID.
|
|
2566
|
+
* @format GUID
|
|
2567
|
+
*/
|
|
2568
|
+
instanceId?: string | null;
|
|
2569
|
+
/**
|
|
2570
|
+
* Event type.
|
|
2571
|
+
* @maxLength 150
|
|
2572
|
+
*/
|
|
2573
|
+
eventType?: string;
|
|
2574
|
+
/** The identification type and identity data. */
|
|
2575
|
+
identity?: IdentificationData;
|
|
2780
2576
|
}
|
|
2781
|
-
interface
|
|
2782
|
-
|
|
2783
|
-
|
|
2577
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2578
|
+
/**
|
|
2579
|
+
* Unique event ID.
|
|
2580
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2581
|
+
*/
|
|
2582
|
+
_id?: string;
|
|
2583
|
+
/**
|
|
2584
|
+
* Assumes actions are also always typed to an entity_type
|
|
2585
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2586
|
+
*/
|
|
2587
|
+
entityFqdn?: string;
|
|
2588
|
+
/**
|
|
2589
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2590
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2591
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2592
|
+
*/
|
|
2593
|
+
slug?: string;
|
|
2594
|
+
/** ID of the entity associated with the event. */
|
|
2595
|
+
entityId?: string;
|
|
2596
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2597
|
+
eventTime?: Date | null;
|
|
2598
|
+
/**
|
|
2599
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2600
|
+
* (for example, GDPR).
|
|
2601
|
+
*/
|
|
2602
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2603
|
+
/** If present, indicates the action that triggered the event. */
|
|
2604
|
+
originatedFrom?: string | null;
|
|
2605
|
+
/**
|
|
2606
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2607
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2608
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2609
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2610
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2611
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2612
|
+
*/
|
|
2613
|
+
entityEventSequence?: string | null;
|
|
2784
2614
|
}
|
|
2785
|
-
interface
|
|
2786
|
-
|
|
2615
|
+
interface CommentContentChangedEnvelope {
|
|
2616
|
+
data: CommentContentChanged;
|
|
2617
|
+
metadata: EventMetadata;
|
|
2787
2618
|
}
|
|
2788
|
-
interface
|
|
2789
|
-
|
|
2790
|
-
|
|
2791
|
-
styles?: LinkPreviewDataStylesNonNullableFields;
|
|
2619
|
+
interface CommentHiddenEnvelope {
|
|
2620
|
+
data: CommentHidden;
|
|
2621
|
+
metadata: EventMetadata;
|
|
2792
2622
|
}
|
|
2793
|
-
interface
|
|
2794
|
-
|
|
2623
|
+
interface CommentMarkedEnvelope {
|
|
2624
|
+
data: CommentMarked;
|
|
2625
|
+
metadata: EventMetadata;
|
|
2795
2626
|
}
|
|
2796
|
-
interface
|
|
2797
|
-
|
|
2798
|
-
|
|
2627
|
+
interface CommentMovedEnvelope {
|
|
2628
|
+
data: CommentMoved;
|
|
2629
|
+
metadata: EventMetadata;
|
|
2799
2630
|
}
|
|
2800
|
-
interface
|
|
2801
|
-
|
|
2631
|
+
interface CommentPublishedEnvelope {
|
|
2632
|
+
data: CommentPublished;
|
|
2633
|
+
metadata: EventMetadata;
|
|
2802
2634
|
}
|
|
2803
|
-
interface
|
|
2804
|
-
|
|
2805
|
-
|
|
2635
|
+
interface CommentUnmarkedEnvelope {
|
|
2636
|
+
data: CommentUnmarked;
|
|
2637
|
+
metadata: EventMetadata;
|
|
2806
2638
|
}
|
|
2807
|
-
interface
|
|
2808
|
-
|
|
2639
|
+
interface CommentCreatedEnvelope {
|
|
2640
|
+
entity: Comment;
|
|
2641
|
+
metadata: EventMetadata;
|
|
2809
2642
|
}
|
|
2810
|
-
interface
|
|
2811
|
-
|
|
2643
|
+
interface CommentResourceCommentCountChangedEnvelope {
|
|
2644
|
+
data: ResourceCommentCountChanged;
|
|
2645
|
+
metadata: EventMetadata;
|
|
2812
2646
|
}
|
|
2813
|
-
interface
|
|
2814
|
-
|
|
2815
|
-
|
|
2647
|
+
interface CommentUpdatedEnvelope {
|
|
2648
|
+
entity: Comment;
|
|
2649
|
+
metadata: EventMetadata;
|
|
2816
2650
|
}
|
|
2817
|
-
interface
|
|
2818
|
-
|
|
2651
|
+
interface UpdateComment {
|
|
2652
|
+
/**
|
|
2653
|
+
* Comment ID.
|
|
2654
|
+
* @format GUID
|
|
2655
|
+
* @readonly
|
|
2656
|
+
*/
|
|
2657
|
+
_id?: string | null;
|
|
2658
|
+
/**
|
|
2659
|
+
* Revision number, which increments by 1 each time the comment is updated.
|
|
2660
|
+
*
|
|
2661
|
+
* To prevent conflicting changes, the current `revision` must be passed when updating the comment.
|
|
2662
|
+
* @readonly
|
|
2663
|
+
*/
|
|
2664
|
+
revision?: string | null;
|
|
2665
|
+
/**
|
|
2666
|
+
* Date and time the comment was created.
|
|
2667
|
+
*
|
|
2668
|
+
* **Note:** This is the date from the system database, not the actual date when the comment was created. For example, if you migrate comments created in 2016, the `createdDate` field will show the current year. For the actual creation date, see the `commentDate` field.
|
|
2669
|
+
* @readonly
|
|
2670
|
+
*/
|
|
2671
|
+
_createdDate?: Date | null;
|
|
2672
|
+
/**
|
|
2673
|
+
* Date and time the comment was last updated.
|
|
2674
|
+
* @readonly
|
|
2675
|
+
*/
|
|
2676
|
+
_updatedDate?: Date | null;
|
|
2677
|
+
/**
|
|
2678
|
+
* ID of the app that the comment is added to.
|
|
2679
|
+
* @format GUID
|
|
2680
|
+
* @immutable
|
|
2681
|
+
*/
|
|
2682
|
+
appId?: string | null;
|
|
2683
|
+
/**
|
|
2684
|
+
* ID of the specific context the comment is in response to.
|
|
2685
|
+
*
|
|
2686
|
+
* Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
|
|
2687
|
+
* the `forumPostId` is used as both the `contextId` and the `resourceId`.
|
|
2688
|
+
* @immutable
|
|
2689
|
+
* @maxLength 128
|
|
2690
|
+
*/
|
|
2691
|
+
contextId?: string | null;
|
|
2692
|
+
/**
|
|
2693
|
+
* ID of the specific resource that the comment is in response to.
|
|
2694
|
+
*
|
|
2695
|
+
* Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
|
|
2696
|
+
* the `forumPostId` is used as both the `resourceId` and the `contextId`.
|
|
2697
|
+
* @immutable
|
|
2698
|
+
* @maxLength 128
|
|
2699
|
+
*/
|
|
2700
|
+
resourceId?: string | null;
|
|
2701
|
+
/** Published comment content. */
|
|
2702
|
+
content?: CommentContent;
|
|
2703
|
+
/**
|
|
2704
|
+
* Comment's author.
|
|
2705
|
+
* @immutable
|
|
2706
|
+
*/
|
|
2707
|
+
author?: CommentAuthor;
|
|
2708
|
+
/**
|
|
2709
|
+
* Parent comment information.
|
|
2710
|
+
*
|
|
2711
|
+
* Only present if this comment is in a direct reply to another comment.
|
|
2712
|
+
* See **Terminology** in the Comments introduction
|
|
2713
|
+
* for more information about parent comments.
|
|
2714
|
+
*/
|
|
2715
|
+
parentComment?: ParentComment;
|
|
2716
|
+
/**
|
|
2717
|
+
* Number of comments that reply to this comment.
|
|
2718
|
+
* @readonly
|
|
2719
|
+
*/
|
|
2720
|
+
replyCount?: number;
|
|
2721
|
+
/**
|
|
2722
|
+
* Summary of votes.
|
|
2723
|
+
* @readonly
|
|
2724
|
+
*/
|
|
2725
|
+
voteSummary?: VoteSummary;
|
|
2726
|
+
/**
|
|
2727
|
+
* Comment status.
|
|
2728
|
+
* @readonly
|
|
2729
|
+
*/
|
|
2730
|
+
status?: Status;
|
|
2731
|
+
/**
|
|
2732
|
+
* Comment rating.
|
|
2733
|
+
* @readonly
|
|
2734
|
+
*/
|
|
2735
|
+
rating?: number | null;
|
|
2736
|
+
/**
|
|
2737
|
+
* Summary of reactions.
|
|
2738
|
+
* @readonly
|
|
2739
|
+
*/
|
|
2740
|
+
reactionSummary?: CommentReactionSummary;
|
|
2741
|
+
/** Whether the comment is marked. */
|
|
2742
|
+
marked?: boolean;
|
|
2743
|
+
/**
|
|
2744
|
+
* Date and time when the comment was actually created.
|
|
2745
|
+
* @immutable
|
|
2746
|
+
*/
|
|
2747
|
+
commentDate?: Date | null;
|
|
2748
|
+
/**
|
|
2749
|
+
* Whether the comment has the updated content.
|
|
2750
|
+
* @readonly
|
|
2751
|
+
*/
|
|
2752
|
+
contentEdited?: boolean | null;
|
|
2819
2753
|
}
|
|
2820
|
-
interface
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
interface PollDesignNonNullableFields {
|
|
2824
|
-
background?: BackgroundNonNullableFields;
|
|
2825
|
-
}
|
|
2826
|
-
interface DesignNonNullableFields {
|
|
2827
|
-
poll?: PollDesignNonNullableFields;
|
|
2828
|
-
}
|
|
2829
|
-
interface PollDataNonNullableFields {
|
|
2830
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2831
|
-
poll?: PollNonNullableFields;
|
|
2832
|
-
layout?: PollDataLayoutNonNullableFields;
|
|
2833
|
-
design?: DesignNonNullableFields;
|
|
2834
|
-
}
|
|
2835
|
-
interface AnchorDataNonNullableFields {
|
|
2836
|
-
anchor: string;
|
|
2837
|
-
}
|
|
2838
|
-
interface LinkDataNonNullableFields {
|
|
2839
|
-
link?: LinkNonNullableFields;
|
|
2840
|
-
}
|
|
2841
|
-
interface MentionDataNonNullableFields {
|
|
2842
|
-
name: string;
|
|
2843
|
-
slug: string;
|
|
2844
|
-
}
|
|
2845
|
-
interface FontSizeDataNonNullableFields {
|
|
2846
|
-
unit: FontType;
|
|
2847
|
-
}
|
|
2848
|
-
interface DecorationNonNullableFields {
|
|
2849
|
-
anchorData?: AnchorDataNonNullableFields;
|
|
2850
|
-
linkData?: LinkDataNonNullableFields;
|
|
2851
|
-
mentionData?: MentionDataNonNullableFields;
|
|
2852
|
-
fontSizeData?: FontSizeDataNonNullableFields;
|
|
2853
|
-
type: DecorationType;
|
|
2854
|
-
}
|
|
2855
|
-
interface TextDataNonNullableFields {
|
|
2856
|
-
text: string;
|
|
2857
|
-
decorations: DecorationNonNullableFields[];
|
|
2858
|
-
}
|
|
2859
|
-
interface AppEmbedDataNonNullableFields {
|
|
2860
|
-
type: AppType;
|
|
2861
|
-
}
|
|
2862
|
-
interface VideoDataNonNullableFields {
|
|
2863
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2864
|
-
}
|
|
2865
|
-
interface EmbedDataNonNullableFields {
|
|
2866
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2867
|
-
}
|
|
2868
|
-
interface CollapsibleListDataNonNullableFields {
|
|
2869
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2870
|
-
initialExpandedItems: InitialExpandedItems;
|
|
2871
|
-
direction: Direction;
|
|
2872
|
-
}
|
|
2873
|
-
interface DimensionsNonNullableFields {
|
|
2874
|
-
colsWidthRatio: number[];
|
|
2875
|
-
rowsHeight: number[];
|
|
2876
|
-
colsMinWidth: number[];
|
|
2877
|
-
}
|
|
2878
|
-
interface TableDataNonNullableFields {
|
|
2879
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2880
|
-
dimensions?: DimensionsNonNullableFields;
|
|
2881
|
-
}
|
|
2882
|
-
interface CellStyleNonNullableFields {
|
|
2883
|
-
verticalAlignment: VerticalAlignment;
|
|
2884
|
-
}
|
|
2885
|
-
interface TableCellDataNonNullableFields {
|
|
2886
|
-
cellStyle?: CellStyleNonNullableFields;
|
|
2887
|
-
}
|
|
2888
|
-
interface AudioDataNonNullableFields {
|
|
2889
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2890
|
-
}
|
|
2891
|
-
interface OrderedListDataNonNullableFields {
|
|
2892
|
-
indentation: number;
|
|
2893
|
-
}
|
|
2894
|
-
interface BulletedListDataNonNullableFields {
|
|
2895
|
-
indentation: number;
|
|
2896
|
-
}
|
|
2897
|
-
interface BlockquoteDataNonNullableFields {
|
|
2898
|
-
indentation: number;
|
|
2899
|
-
}
|
|
2900
|
-
interface CaptionDataNonNullableFields {
|
|
2901
|
-
textStyle?: TextStyleNonNullableFields;
|
|
2902
|
-
}
|
|
2903
|
-
interface NodeNonNullableFields {
|
|
2904
|
-
buttonData?: ButtonDataNonNullableFields;
|
|
2905
|
-
codeBlockData?: CodeBlockDataNonNullableFields;
|
|
2906
|
-
dividerData?: DividerDataNonNullableFields;
|
|
2907
|
-
fileData?: FileDataNonNullableFields;
|
|
2908
|
-
galleryData?: GalleryDataNonNullableFields;
|
|
2909
|
-
gifData?: GIFDataNonNullableFields;
|
|
2910
|
-
headingData?: HeadingDataNonNullableFields;
|
|
2911
|
-
htmlData?: HTMLDataNonNullableFields;
|
|
2912
|
-
imageData?: ImageDataNonNullableFields;
|
|
2913
|
-
linkPreviewData?: LinkPreviewDataNonNullableFields;
|
|
2914
|
-
mapData?: MapDataNonNullableFields;
|
|
2915
|
-
paragraphData?: ParagraphDataNonNullableFields;
|
|
2916
|
-
pollData?: PollDataNonNullableFields;
|
|
2917
|
-
textData?: TextDataNonNullableFields;
|
|
2918
|
-
appEmbedData?: AppEmbedDataNonNullableFields;
|
|
2919
|
-
videoData?: VideoDataNonNullableFields;
|
|
2920
|
-
embedData?: EmbedDataNonNullableFields;
|
|
2921
|
-
collapsibleListData?: CollapsibleListDataNonNullableFields;
|
|
2922
|
-
tableData?: TableDataNonNullableFields;
|
|
2923
|
-
tableCellData?: TableCellDataNonNullableFields;
|
|
2924
|
-
audioData?: AudioDataNonNullableFields;
|
|
2925
|
-
orderedListData?: OrderedListDataNonNullableFields;
|
|
2926
|
-
bulletedListData?: BulletedListDataNonNullableFields;
|
|
2927
|
-
blockquoteData?: BlockquoteDataNonNullableFields;
|
|
2928
|
-
captionData?: CaptionDataNonNullableFields;
|
|
2929
|
-
type: NodeType;
|
|
2930
|
-
id: string;
|
|
2931
|
-
nodes: NodeNonNullableFields[];
|
|
2932
|
-
}
|
|
2933
|
-
interface MetadataNonNullableFields {
|
|
2934
|
-
version: number;
|
|
2935
|
-
}
|
|
2936
|
-
interface TextNodeStyleNonNullableFields {
|
|
2937
|
-
decorations: DecorationNonNullableFields[];
|
|
2938
|
-
}
|
|
2939
|
-
interface DocumentStyleNonNullableFields {
|
|
2940
|
-
headerOne?: TextNodeStyleNonNullableFields;
|
|
2941
|
-
headerTwo?: TextNodeStyleNonNullableFields;
|
|
2942
|
-
headerThree?: TextNodeStyleNonNullableFields;
|
|
2943
|
-
headerFour?: TextNodeStyleNonNullableFields;
|
|
2944
|
-
headerFive?: TextNodeStyleNonNullableFields;
|
|
2945
|
-
headerSix?: TextNodeStyleNonNullableFields;
|
|
2946
|
-
paragraph?: TextNodeStyleNonNullableFields;
|
|
2947
|
-
blockquote?: TextNodeStyleNonNullableFields;
|
|
2948
|
-
codeBlock?: TextNodeStyleNonNullableFields;
|
|
2949
|
-
}
|
|
2950
|
-
interface RichContentNonNullableFields {
|
|
2951
|
-
nodes: NodeNonNullableFields[];
|
|
2952
|
-
metadata?: MetadataNonNullableFields;
|
|
2953
|
-
documentStyle?: DocumentStyleNonNullableFields;
|
|
2954
|
-
}
|
|
2955
|
-
interface ImageNonNullableFields {
|
|
2956
|
-
id: string;
|
|
2957
|
-
url: string;
|
|
2958
|
-
height: number;
|
|
2959
|
-
width: number;
|
|
2960
|
-
}
|
|
2961
|
-
interface VideoResolutionNonNullableFields {
|
|
2962
|
-
url: string;
|
|
2963
|
-
height: number;
|
|
2964
|
-
width: number;
|
|
2965
|
-
format: string;
|
|
2966
|
-
}
|
|
2967
|
-
interface VideoV2NonNullableFields {
|
|
2968
|
-
id: string;
|
|
2969
|
-
url: string;
|
|
2970
|
-
resolutions: VideoResolutionNonNullableFields[];
|
|
2971
|
-
posters: ImageNonNullableFields[];
|
|
2972
|
-
}
|
|
2973
|
-
interface AudioNonNullableFields {
|
|
2974
|
-
id: string;
|
|
2975
|
-
url: string;
|
|
2976
|
-
}
|
|
2977
|
-
interface DocumentNonNullableFields {
|
|
2978
|
-
id: string;
|
|
2979
|
-
url: string;
|
|
2980
|
-
}
|
|
2981
|
-
interface AttachmentNonNullableFields {
|
|
2982
|
-
image?: ImageNonNullableFields;
|
|
2983
|
-
video?: VideoV2NonNullableFields;
|
|
2984
|
-
audio?: AudioNonNullableFields;
|
|
2985
|
-
document?: DocumentNonNullableFields;
|
|
2986
|
-
}
|
|
2987
|
-
interface CommentContentNonNullableFields {
|
|
2988
|
-
richContent?: RichContentNonNullableFields;
|
|
2989
|
-
attachments: AttachmentNonNullableFields[];
|
|
2990
|
-
}
|
|
2991
|
-
interface ParentCommentNonNullableFields {
|
|
2992
|
-
status: Status;
|
|
2993
|
-
}
|
|
2994
|
-
interface VoteSummaryNonNullableFields {
|
|
2995
|
-
netVoteCount: number;
|
|
2996
|
-
upvoteCount: number;
|
|
2997
|
-
downvoteCount: number;
|
|
2998
|
-
}
|
|
2999
|
-
interface CommentReactionSummaryNonNullableFields {
|
|
3000
|
-
total: number;
|
|
3001
|
-
}
|
|
3002
|
-
interface CommentNonNullableFields {
|
|
3003
|
-
content?: CommentContentNonNullableFields;
|
|
3004
|
-
draftContent?: CommentContentNonNullableFields;
|
|
3005
|
-
parentComment?: ParentCommentNonNullableFields;
|
|
3006
|
-
parentIdsInThread: string[];
|
|
3007
|
-
replyCount: number;
|
|
3008
|
-
voteSummary?: VoteSummaryNonNullableFields;
|
|
3009
|
-
status: Status;
|
|
3010
|
-
reactionSummary?: CommentReactionSummaryNonNullableFields;
|
|
3011
|
-
marked: boolean;
|
|
3012
|
-
}
|
|
3013
|
-
export interface CreateCommentResponseNonNullableFields {
|
|
3014
|
-
comment?: CommentNonNullableFields;
|
|
3015
|
-
}
|
|
3016
|
-
export interface GetCommentResponseNonNullableFields {
|
|
3017
|
-
comment?: CommentNonNullableFields;
|
|
3018
|
-
}
|
|
3019
|
-
export interface UpdateCommentResponseNonNullableFields {
|
|
3020
|
-
comment?: CommentNonNullableFields;
|
|
3021
|
-
}
|
|
3022
|
-
export interface ModerateDraftContentResponseNonNullableFields {
|
|
3023
|
-
comment?: CommentNonNullableFields;
|
|
3024
|
-
}
|
|
3025
|
-
export interface QueryCommentsResponseNonNullableFields {
|
|
3026
|
-
comments: CommentNonNullableFields[];
|
|
3027
|
-
}
|
|
3028
|
-
export interface MarkCommentResponseNonNullableFields {
|
|
3029
|
-
comment?: CommentNonNullableFields;
|
|
2754
|
+
interface ModerateDraftContentOptions {
|
|
2755
|
+
/** Draft content action. */
|
|
2756
|
+
draftContentAction?: Action;
|
|
3030
2757
|
}
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
|
|
2758
|
+
interface QueryCursorResult {
|
|
2759
|
+
cursors: Cursors;
|
|
2760
|
+
hasNext: () => boolean;
|
|
2761
|
+
hasPrev: () => boolean;
|
|
2762
|
+
length: number;
|
|
2763
|
+
pageSize: number;
|
|
2764
|
+
}
|
|
2765
|
+
interface CommentsQueryResult extends QueryCursorResult {
|
|
2766
|
+
items: Comment[];
|
|
2767
|
+
query: CommentsQueryBuilder;
|
|
2768
|
+
next: () => Promise<CommentsQueryResult>;
|
|
2769
|
+
prev: () => Promise<CommentsQueryResult>;
|
|
2770
|
+
}
|
|
2771
|
+
interface CommentsQueryBuilder {
|
|
2772
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2773
|
+
* @param value - Value to compare against.
|
|
2774
|
+
*/
|
|
2775
|
+
eq: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'replyCount' | 'voteSummary.netVoteCount' | 'status' | 'rating' | 'reactionSummary.total' | 'marked', value: any) => CommentsQueryBuilder;
|
|
2776
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2777
|
+
* @param value - Value to compare against.
|
|
2778
|
+
*/
|
|
2779
|
+
ne: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'replyCount' | 'voteSummary.netVoteCount' | 'status' | 'rating' | 'reactionSummary.total' | 'marked', value: any) => CommentsQueryBuilder;
|
|
2780
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2781
|
+
* @param value - Value to compare against.
|
|
2782
|
+
*/
|
|
2783
|
+
ge: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2784
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2785
|
+
* @param value - Value to compare against.
|
|
2786
|
+
*/
|
|
2787
|
+
gt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2788
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2789
|
+
* @param value - Value to compare against.
|
|
2790
|
+
*/
|
|
2791
|
+
le: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2792
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2793
|
+
* @param value - Value to compare against.
|
|
2794
|
+
*/
|
|
2795
|
+
lt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2796
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2797
|
+
* @param values - List of values to compare against.
|
|
2798
|
+
*/
|
|
2799
|
+
hasSome: (propertyName: string, value: any[]) => CommentsQueryBuilder;
|
|
2800
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2801
|
+
* @param values - List of values to compare against.
|
|
2802
|
+
*/
|
|
2803
|
+
hasAll: (propertyName: string, value: any[]) => CommentsQueryBuilder;
|
|
2804
|
+
in: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'status', value: any) => CommentsQueryBuilder;
|
|
2805
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
2806
|
+
ascending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
|
|
2807
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
2808
|
+
descending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
|
|
2809
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
2810
|
+
limit: (limit: number) => CommentsQueryBuilder;
|
|
2811
|
+
/** @param cursor - A pointer to specific record */
|
|
2812
|
+
skipTo: (cursor: string) => CommentsQueryBuilder;
|
|
2813
|
+
find: () => Promise<CommentsQueryResult>;
|
|
2814
|
+
}
|
|
2815
|
+
interface CountCommentsOptions {
|
|
2816
|
+
/** Filter to identify the comments that need to be counted. */
|
|
2817
|
+
filter?: Record<string, any> | null;
|
|
3042
2818
|
}
|
|
3043
|
-
|
|
3044
|
-
|
|
2819
|
+
interface ListCommentsByResourceOptions {
|
|
2820
|
+
/**
|
|
2821
|
+
* ID of the specific context the comment is in response to.
|
|
2822
|
+
*
|
|
2823
|
+
* Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum, the `forumPostId` is used as both the `contextId` and the `resourceId`.
|
|
2824
|
+
* @maxLength 128
|
|
2825
|
+
*/
|
|
2826
|
+
contextId: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* Reserved for internal use.
|
|
2829
|
+
* @maxLength 128
|
|
2830
|
+
*/
|
|
2831
|
+
contextType?: string;
|
|
2832
|
+
/**
|
|
2833
|
+
* ID of the specific resource that the comment is in response to.
|
|
2834
|
+
*
|
|
2835
|
+
* Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum, the `forumPostId` is used as both the `resourceId` and the `contextId`.
|
|
2836
|
+
* @maxLength 128
|
|
2837
|
+
*/
|
|
2838
|
+
resourceId: string;
|
|
2839
|
+
/** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
|
|
2840
|
+
commentSort?: CommentSort;
|
|
2841
|
+
/** Reply sort. Is ignored if `cursorPaging.cursor` is defined. */
|
|
2842
|
+
replySort?: ReplySort;
|
|
2843
|
+
/** Cursor paging. */
|
|
2844
|
+
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
3045
2845
|
}
|
|
3046
|
-
|
|
3047
|
-
|
|
2846
|
+
interface GetCommentThreadOptions {
|
|
2847
|
+
/**
|
|
2848
|
+
* App ID.
|
|
2849
|
+
* @maxLength 128
|
|
2850
|
+
* @deprecated App ID.
|
|
2851
|
+
* @targetRemovalDate 2024-11-01
|
|
2852
|
+
*/
|
|
2853
|
+
appId?: string;
|
|
2854
|
+
/** Comment sorting. */
|
|
2855
|
+
commentSort?: CommentSort;
|
|
2856
|
+
/** Reply sorting. */
|
|
2857
|
+
replySort?: ReplySort;
|
|
3048
2858
|
}
|
|
3049
|
-
|
|
3050
|
-
|
|
2859
|
+
interface BulkPublishCommentOptions {
|
|
2860
|
+
/** Filter to identify the comments that need to be published. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2861
|
+
filter: Record<string, any> | null;
|
|
3051
2862
|
}
|
|
3052
|
-
|
|
3053
|
-
|
|
2863
|
+
interface BulkHideCommentOptions {
|
|
2864
|
+
/** Filter to identify the comments that need to be hidden. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2865
|
+
filter: Record<string, any> | null;
|
|
3054
2866
|
}
|
|
3055
|
-
|
|
3056
|
-
|
|
2867
|
+
interface BulkDeleteCommentOptions {
|
|
2868
|
+
/** Filter to identify the comments that need to be deleted. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2869
|
+
filter: Record<string, any> | null;
|
|
3057
2870
|
}
|
|
3058
|
-
|
|
3059
|
-
|
|
2871
|
+
interface BulkModerateDraftContentOptions {
|
|
2872
|
+
/** Filter to identify the comment content that needs to be moderated. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2873
|
+
filter: Record<string, any> | null;
|
|
2874
|
+
/** Action to do regarding draft content */
|
|
2875
|
+
draftContentAction: Action;
|
|
3060
2876
|
}
|
|
3061
|
-
|
|
3062
|
-
|
|
2877
|
+
interface BulkMoveCommentByFilterOptions {
|
|
2878
|
+
/** Filter to identify the comments that need to be moved. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2879
|
+
filter: Record<string, any> | null;
|
|
2880
|
+
/** Where to move the comment. */
|
|
2881
|
+
destination?: Destination;
|
|
3063
2882
|
}
|
|
3064
|
-
|
|
2883
|
+
|
|
2884
|
+
export { VerticalAlignment as $, Alignment as A, type BulkPublishCommentOptions as B, type Comment as C, Position as D, MapType as E, ViewRole as F, type GetCommentThreadOptions as G, type HideCommentResponse as H, VoteRole as I, PollLayoutType as J, PollLayoutDirection as K, type ListCommentsByResourceOptions as L, type ModerateDraftContentOptions as M, NodeType as N, Orientation as O, type PublishCommentResponse as P, BackgroundType as Q, DecorationType as R, Source as S, Type as T, type UpdateComment as U, ViewMode as V, WidthType as W, FontType as X, AppType as Y, InitialExpandedItems as Z, Direction as _, type ModerateDraftContentResponse as a, type BackgroundBackgroundOneOf as a$, NullValue as a0, Status as a1, VersioningMode as a2, Action as a3, SortOrder as a4, Order as a5, ReplySortOrder as a6, WebhookIdentityType as a7, type CommentContent as a8, type RichContent as a9, type Item as aA, type ItemDataOneOf as aB, type GalleryOptions as aC, type Layout as aD, type ItemStyle as aE, type Thumbnails as aF, type GIFData as aG, type GIF as aH, type HeadingData as aI, type HTMLData as aJ, type HTMLDataDataOneOf as aK, type ImageData as aL, type StylesBorder as aM, type ImageDataStyles as aN, type LinkPreviewData as aO, type LinkPreviewDataStyles as aP, type MapData as aQ, type MapSettings as aR, type ParagraphData as aS, type PollData as aT, type Permissions as aU, type Option as aV, type Settings as aW, type PollLayout as aX, type OptionLayout as aY, type Gradient as aZ, type Background as a_, type Node as aa, type NodeDataOneOf as ab, type NodeStyle as ac, type ButtonData as ad, type Border as ae, type Colors as af, type PluginContainerData as ag, type PluginContainerDataWidth as ah, type PluginContainerDataWidthDataOneOf as ai, type Spoiler as aj, type Height as ak, type Styles as al, type Link as am, type LinkDataOneOf as an, type Rel as ao, type CodeBlockData as ap, type TextStyle as aq, type DividerData as ar, type FileData as as, type FileSource as at, type FileSourceDataOneOf as au, type PDFSettings as av, type GalleryData as aw, type Media as ax, type Image as ay, type Video as az, type CommentsQueryBuilder as b, type ContactDetails as b$, type PollDesign as b0, type OptionDesign as b1, type Poll as b2, type PollDataLayout as b3, type Design as b4, type TextData as b5, type Decoration as b6, type DecorationDataOneOf as b7, type AnchorData as b8, type ColorData as b9, type DocumentStyle as bA, type TextNodeStyle as bB, type Mention as bC, type MentionIdentityOneOf as bD, type Attachment as bE, type AttachmentMediaOneOf as bF, type VideoResolution as bG, type ContentAuthor as bH, type ContentAuthorAuthorOneOf as bI, type CommentAuthor as bJ, type CommentAuthorIdentityOneOf as bK, type ParentComment as bL, type VoteSummary as bM, type CommentReactionSummary as bN, type UpdateInternalDocumentsEvent as bO, type UpdateInternalDocumentsEventOperationOneOf as bP, type InternalDocument as bQ, type InternalDocumentUpdateOperation as bR, type DeleteByIdsOperation as bS, type DeleteByFilterOperation as bT, type InternalDocumentUpdateByFilterOperation as bU, type InternalUpdateExistingOperation as bV, type VersionedDocumentUpdateOperation as bW, type VersionedDeleteByIdsOperation as bX, type VersionedDocumentId as bY, type CommentModerated as bZ, type CreateCommentRequest as b_, type LinkData as ba, type MentionData as bb, type FontSizeData as bc, type SpoilerData as bd, type AppEmbedData as be, type AppEmbedDataAppDataOneOf as bf, type BookingData as bg, type EventData as bh, type VideoData as bi, type PlaybackOptions as bj, type EmbedData as bk, type Oembed as bl, type CollapsibleListData as bm, type TableData as bn, type Dimensions as bo, type TableCellData as bp, type CellStyle as bq, type BorderColors as br, type ListValue as bs, type AudioData as bt, type OrderedListData as bu, type BulletedListData as bv, type BlockquoteData as bw, type CaptionData as bx, type LayoutCellData as by, type Metadata as bz, type MarkCommentResponse as c, type CreateCommentResponse as c0, type ResourceCommentCountChanged as c1, type GetCommentRequest as c2, type GetCommentResponse as c3, type UpdateCommentRequest as c4, type UpdateCommentResponse as c5, type CommentContentChanged as c6, type DeleteCommentRequest as c7, type DeleteCommentResponse as c8, type CommentDeleted as c9, type BulkDeleteCommentRequest as cA, type BulkModerateDraftContentRequest as cB, type BulkMoveCommentByFilterRequest as cC, type Destination as cD, type CommentMoved as cE, type DomainEvent as cF, type DomainEventBodyOneOf as cG, type EntityCreatedEvent as cH, type RestoreInfo as cI, type EntityUpdatedEvent as cJ, type EntityDeletedEvent as cK, type ActionEvent as cL, type MessageEnvelope as cM, type IdentificationData as cN, type IdentificationDataIdOneOf as cO, type BaseEventMetadata as cP, type EventMetadata as cQ, type CommentContentChangedEnvelope as cR, type CommentHiddenEnvelope as cS, type CommentMarkedEnvelope as cT, type CommentMovedEnvelope as cU, type CommentPublishedEnvelope as cV, type CommentUnmarkedEnvelope as cW, type CommentCreatedEnvelope as cX, type CommentResourceCommentCountChangedEnvelope as cY, type CommentUpdatedEnvelope as cZ, type CommentsQueryResult as c_, type ModerateDraftContentRequest as ca, type CommentPublished as cb, type CommentHidden as cc, type QueryCommentsRequest as cd, type CursorQuery as ce, type CursorQueryPagingMethodOneOf as cf, type Sorting as cg, type CursorPaging as ch, type QueryCommentsResponse as ci, type CursorPagingMetadata as cj, type Cursors as ck, type MarkCommentRequest as cl, type CommentMarked as cm, type UnmarkCommentRequest as cn, type CommentUnmarked as co, type HideCommentRequest as cp, type PublishCommentRequest as cq, type CountCommentsRequest as cr, type ListCommentsByResourceRequest as cs, type CommentSort as ct, type ReplySort as cu, type ListCommentsByResourceCursorPaging as cv, type RepliesListResponse as cw, type GetCommentThreadRequest as cx, type BulkPublishCommentRequest as cy, type BulkHideCommentRequest as cz, type UnmarkCommentResponse as d, type CountCommentsOptions as e, type CountCommentsResponse as f, type ListCommentsByResourceResponse as g, type GetCommentThreadResponse as h, type BulkPublishCommentResponse as i, type BulkHideCommentOptions as j, type BulkHideCommentResponse as k, type BulkDeleteCommentOptions as l, type BulkDeleteCommentResponse as m, type BulkModerateDraftContentOptions as n, type BulkModerateDraftContentResponse as o, type BulkMoveCommentByFilterOptions as p, type BulkMoveCommentByFilterResponse as q, PluginContainerDataAlignment as r, Target as s, TextAlignment as t, LineStyle as u, Width as v, LayoutType as w, Crop as x, ThumbnailsAlignment as y, GIFType as z };
|