@wix/auto_sdk_comments_comments 1.0.7 → 1.0.8
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-DjW1a70o.d.mts} +550 -735
- package/build/{internal/cjs/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.ts} +550 -735
- package/build/index.d.mts +249 -0
- package/build/index.d.ts +249 -0
- package/build/index.js +5231 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +5144 -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-DjW1a70o.d.mts} +550 -735
- package/build/internal/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.ts} +550 -735
- package/build/internal/index.d.mts +249 -0
- package/build/internal/index.d.ts +249 -0
- package/build/internal/index.js +5231 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +5144 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2384 -0
- package/build/internal/meta.d.ts +2384 -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 +2384 -0
- package/build/meta.d.ts +2384 -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. */
|
|
@@ -1180,7 +1180,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1180
1180
|
type?: DecorationType;
|
|
1181
1181
|
}
|
|
1182
1182
|
/** @oneof */
|
|
1183
|
-
|
|
1183
|
+
interface DecorationDataOneOf {
|
|
1184
1184
|
/** Data for an anchor link decoration. */
|
|
1185
1185
|
anchorData?: AnchorData;
|
|
1186
1186
|
/** Data for a color decoration. */
|
|
@@ -1200,7 +1200,7 @@ export interface DecorationDataOneOf {
|
|
|
1200
1200
|
/** Data for a spoiler decoration. */
|
|
1201
1201
|
spoilerData?: SpoilerData;
|
|
1202
1202
|
}
|
|
1203
|
-
|
|
1203
|
+
declare enum DecorationType {
|
|
1204
1204
|
BOLD = "BOLD",
|
|
1205
1205
|
ITALIC = "ITALIC",
|
|
1206
1206
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1212,43 +1212,43 @@ export declare enum DecorationType {
|
|
|
1212
1212
|
FONT_SIZE = "FONT_SIZE",
|
|
1213
1213
|
EXTERNAL = "EXTERNAL"
|
|
1214
1214
|
}
|
|
1215
|
-
|
|
1215
|
+
interface AnchorData {
|
|
1216
1216
|
/** The target node's ID. */
|
|
1217
1217
|
anchor?: string;
|
|
1218
1218
|
}
|
|
1219
|
-
|
|
1219
|
+
interface ColorData {
|
|
1220
1220
|
/** The text's background color as a hexadecimal value. */
|
|
1221
1221
|
background?: string | null;
|
|
1222
1222
|
/** The text's foreground color as a hexadecimal value. */
|
|
1223
1223
|
foreground?: string | null;
|
|
1224
1224
|
}
|
|
1225
|
-
|
|
1225
|
+
interface LinkData {
|
|
1226
1226
|
/** Link details. */
|
|
1227
1227
|
link?: Link;
|
|
1228
1228
|
}
|
|
1229
|
-
|
|
1229
|
+
interface MentionData {
|
|
1230
1230
|
/** The mentioned user's name. */
|
|
1231
1231
|
name?: string;
|
|
1232
1232
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1233
1233
|
slug?: string;
|
|
1234
1234
|
/** Mentioned user's ID. */
|
|
1235
|
-
|
|
1235
|
+
_id?: string | null;
|
|
1236
1236
|
}
|
|
1237
|
-
|
|
1237
|
+
interface FontSizeData {
|
|
1238
1238
|
/** The units used for the font size. */
|
|
1239
1239
|
unit?: FontType;
|
|
1240
1240
|
/** Font size value. */
|
|
1241
1241
|
value?: number | null;
|
|
1242
1242
|
}
|
|
1243
|
-
|
|
1243
|
+
declare enum FontType {
|
|
1244
1244
|
PX = "PX",
|
|
1245
1245
|
EM = "EM"
|
|
1246
1246
|
}
|
|
1247
|
-
|
|
1247
|
+
interface SpoilerData {
|
|
1248
1248
|
/** Spoiler ID. */
|
|
1249
|
-
|
|
1249
|
+
_id?: string | null;
|
|
1250
1250
|
}
|
|
1251
|
-
|
|
1251
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1252
1252
|
/** Data for embedded Wix Bookings content. */
|
|
1253
1253
|
bookingData?: BookingData;
|
|
1254
1254
|
/** Data for embedded Wix Events content. */
|
|
@@ -1270,28 +1270,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1270
1270
|
image?: Media;
|
|
1271
1271
|
}
|
|
1272
1272
|
/** @oneof */
|
|
1273
|
-
|
|
1273
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1274
1274
|
/** Data for embedded Wix Bookings content. */
|
|
1275
1275
|
bookingData?: BookingData;
|
|
1276
1276
|
/** Data for embedded Wix Events content. */
|
|
1277
1277
|
eventData?: EventData;
|
|
1278
1278
|
}
|
|
1279
|
-
|
|
1279
|
+
declare enum AppType {
|
|
1280
1280
|
PRODUCT = "PRODUCT",
|
|
1281
1281
|
EVENT = "EVENT",
|
|
1282
1282
|
BOOKING = "BOOKING"
|
|
1283
1283
|
}
|
|
1284
|
-
|
|
1284
|
+
interface BookingData {
|
|
1285
1285
|
/** Booking duration in minutes. */
|
|
1286
1286
|
durations?: string | null;
|
|
1287
1287
|
}
|
|
1288
|
-
|
|
1288
|
+
interface EventData {
|
|
1289
1289
|
/** Event schedule. */
|
|
1290
1290
|
scheduling?: string | null;
|
|
1291
1291
|
/** Event location. */
|
|
1292
1292
|
location?: string | null;
|
|
1293
1293
|
}
|
|
1294
|
-
|
|
1294
|
+
interface VideoData {
|
|
1295
1295
|
/** Styling for the video's container. */
|
|
1296
1296
|
containerData?: PluginContainerData;
|
|
1297
1297
|
/** Video details. */
|
|
@@ -1305,7 +1305,7 @@ export interface VideoData {
|
|
|
1305
1305
|
/** Video options. */
|
|
1306
1306
|
options?: PlaybackOptions;
|
|
1307
1307
|
}
|
|
1308
|
-
|
|
1308
|
+
interface PlaybackOptions {
|
|
1309
1309
|
/** Sets whether the media will automatically start playing. */
|
|
1310
1310
|
autoPlay?: boolean | null;
|
|
1311
1311
|
/** Sets whether media's will be looped. */
|
|
@@ -1313,7 +1313,7 @@ export interface PlaybackOptions {
|
|
|
1313
1313
|
/** Sets whether media's controls will be shown. */
|
|
1314
1314
|
showControls?: boolean | null;
|
|
1315
1315
|
}
|
|
1316
|
-
|
|
1316
|
+
interface EmbedData {
|
|
1317
1317
|
/** Styling for the oEmbed node's container. */
|
|
1318
1318
|
containerData?: PluginContainerData;
|
|
1319
1319
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1321,7 +1321,7 @@ export interface EmbedData {
|
|
|
1321
1321
|
/** Origin asset source. */
|
|
1322
1322
|
src?: string | null;
|
|
1323
1323
|
}
|
|
1324
|
-
|
|
1324
|
+
interface Oembed {
|
|
1325
1325
|
/** The resource type. */
|
|
1326
1326
|
type?: string | null;
|
|
1327
1327
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1353,7 +1353,7 @@ export interface Oembed {
|
|
|
1353
1353
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1354
1354
|
version?: string | null;
|
|
1355
1355
|
}
|
|
1356
|
-
|
|
1356
|
+
interface CollapsibleListData {
|
|
1357
1357
|
/** Styling for the collapsible list's container. */
|
|
1358
1358
|
containerData?: PluginContainerData;
|
|
1359
1359
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1365,7 +1365,7 @@ export interface CollapsibleListData {
|
|
|
1365
1365
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1366
1366
|
isQapageData?: boolean | null;
|
|
1367
1367
|
}
|
|
1368
|
-
|
|
1368
|
+
declare enum InitialExpandedItems {
|
|
1369
1369
|
/** First item will be expended initally */
|
|
1370
1370
|
FIRST = "FIRST",
|
|
1371
1371
|
/** All items will expended initally */
|
|
@@ -1373,13 +1373,13 @@ export declare enum InitialExpandedItems {
|
|
|
1373
1373
|
/** All items collapsed initally */
|
|
1374
1374
|
NONE = "NONE"
|
|
1375
1375
|
}
|
|
1376
|
-
|
|
1376
|
+
declare enum Direction {
|
|
1377
1377
|
/** Left-to-right */
|
|
1378
1378
|
LTR = "LTR",
|
|
1379
1379
|
/** Right-to-left */
|
|
1380
1380
|
RTL = "RTL"
|
|
1381
1381
|
}
|
|
1382
|
-
|
|
1382
|
+
interface TableData {
|
|
1383
1383
|
/** Styling for the table's container. */
|
|
1384
1384
|
containerData?: PluginContainerData;
|
|
1385
1385
|
/** The table's dimensions. */
|
|
@@ -1394,7 +1394,7 @@ export interface TableData {
|
|
|
1394
1394
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1395
1395
|
columnHeader?: boolean | null;
|
|
1396
1396
|
}
|
|
1397
|
-
|
|
1397
|
+
interface Dimensions {
|
|
1398
1398
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1399
1399
|
colsWidthRatio?: number[];
|
|
1400
1400
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1402,13 +1402,13 @@ export interface Dimensions {
|
|
|
1402
1402
|
/** An array representing the minimum width of each column in pixels. */
|
|
1403
1403
|
colsMinWidth?: number[];
|
|
1404
1404
|
}
|
|
1405
|
-
|
|
1405
|
+
interface TableCellData {
|
|
1406
1406
|
/** Styling for the cell's background color and text alignment. */
|
|
1407
1407
|
cellStyle?: CellStyle;
|
|
1408
1408
|
/** The cell's border colors. */
|
|
1409
1409
|
borderColors?: BorderColors;
|
|
1410
1410
|
}
|
|
1411
|
-
|
|
1411
|
+
declare enum VerticalAlignment {
|
|
1412
1412
|
/** Top alignment */
|
|
1413
1413
|
TOP = "TOP",
|
|
1414
1414
|
/** Middle alignment */
|
|
@@ -1416,7 +1416,7 @@ export declare enum VerticalAlignment {
|
|
|
1416
1416
|
/** Bottom alignment */
|
|
1417
1417
|
BOTTOM = "BOTTOM"
|
|
1418
1418
|
}
|
|
1419
|
-
|
|
1419
|
+
interface CellStyle {
|
|
1420
1420
|
/** Vertical alignment for the cell's text. */
|
|
1421
1421
|
verticalAlignment?: VerticalAlignment;
|
|
1422
1422
|
/**
|
|
@@ -1425,7 +1425,7 @@ export interface CellStyle {
|
|
|
1425
1425
|
*/
|
|
1426
1426
|
backgroundColor?: string | null;
|
|
1427
1427
|
}
|
|
1428
|
-
|
|
1428
|
+
interface BorderColors {
|
|
1429
1429
|
/**
|
|
1430
1430
|
* Left border color as a hexadecimal value.
|
|
1431
1431
|
* @format COLOR_HEX
|
|
@@ -1453,7 +1453,7 @@ export interface BorderColors {
|
|
|
1453
1453
|
*
|
|
1454
1454
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1455
1455
|
*/
|
|
1456
|
-
|
|
1456
|
+
declare enum NullValue {
|
|
1457
1457
|
/** Null value. */
|
|
1458
1458
|
NULL_VALUE = "NULL_VALUE"
|
|
1459
1459
|
}
|
|
@@ -1462,11 +1462,11 @@ export declare enum NullValue {
|
|
|
1462
1462
|
*
|
|
1463
1463
|
* The JSON representation for `ListValue` is JSON array.
|
|
1464
1464
|
*/
|
|
1465
|
-
|
|
1465
|
+
interface ListValue {
|
|
1466
1466
|
/** Repeated field of dynamically typed values. */
|
|
1467
1467
|
values?: any[];
|
|
1468
1468
|
}
|
|
1469
|
-
|
|
1469
|
+
interface AudioData {
|
|
1470
1470
|
/** Styling for the audio node's container. */
|
|
1471
1471
|
containerData?: PluginContainerData;
|
|
1472
1472
|
/** Audio file details. */
|
|
@@ -1482,7 +1482,7 @@ export interface AudioData {
|
|
|
1482
1482
|
/** An HTML version of the audio node. */
|
|
1483
1483
|
html?: string | null;
|
|
1484
1484
|
}
|
|
1485
|
-
|
|
1485
|
+
interface OrderedListData {
|
|
1486
1486
|
/** Indentation level from 0-4. */
|
|
1487
1487
|
indentation?: number;
|
|
1488
1488
|
/** Offset level from 0-4. */
|
|
@@ -1490,24 +1490,24 @@ export interface OrderedListData {
|
|
|
1490
1490
|
/** List start number. */
|
|
1491
1491
|
start?: number | null;
|
|
1492
1492
|
}
|
|
1493
|
-
|
|
1493
|
+
interface BulletedListData {
|
|
1494
1494
|
/** Indentation level from 0-4. */
|
|
1495
1495
|
indentation?: number;
|
|
1496
1496
|
/** Offset level from 0-4. */
|
|
1497
1497
|
offset?: number | null;
|
|
1498
1498
|
}
|
|
1499
|
-
|
|
1499
|
+
interface BlockquoteData {
|
|
1500
1500
|
/** Indentation level from 1-4. */
|
|
1501
1501
|
indentation?: number;
|
|
1502
1502
|
}
|
|
1503
|
-
|
|
1503
|
+
interface CaptionData {
|
|
1504
1504
|
textStyle?: TextStyle;
|
|
1505
1505
|
}
|
|
1506
|
-
|
|
1506
|
+
interface LayoutCellData {
|
|
1507
1507
|
/** Size of the cell in 12 columns grid. */
|
|
1508
1508
|
colSpan?: number | null;
|
|
1509
1509
|
}
|
|
1510
|
-
|
|
1510
|
+
interface Metadata {
|
|
1511
1511
|
/** Schema version. */
|
|
1512
1512
|
version?: number;
|
|
1513
1513
|
/**
|
|
@@ -1522,9 +1522,9 @@ export interface Metadata {
|
|
|
1522
1522
|
*/
|
|
1523
1523
|
updatedTimestamp?: Date | null;
|
|
1524
1524
|
/** Object ID. */
|
|
1525
|
-
|
|
1525
|
+
_id?: string | null;
|
|
1526
1526
|
}
|
|
1527
|
-
|
|
1527
|
+
interface DocumentStyle {
|
|
1528
1528
|
/** Styling for H1 nodes. */
|
|
1529
1529
|
headerOne?: TextNodeStyle;
|
|
1530
1530
|
/** Styling for H2 nodes. */
|
|
@@ -1544,7 +1544,7 @@ export interface DocumentStyle {
|
|
|
1544
1544
|
/** Styling for code block nodes. */
|
|
1545
1545
|
codeBlock?: TextNodeStyle;
|
|
1546
1546
|
}
|
|
1547
|
-
|
|
1547
|
+
interface TextNodeStyle {
|
|
1548
1548
|
/** The decorations to apply to the node. */
|
|
1549
1549
|
decorations?: Decoration[];
|
|
1550
1550
|
/** Padding and background color for the node. */
|
|
@@ -1552,7 +1552,7 @@ export interface TextNodeStyle {
|
|
|
1552
1552
|
/** Line height for text in the node. */
|
|
1553
1553
|
lineHeight?: string | null;
|
|
1554
1554
|
}
|
|
1555
|
-
|
|
1555
|
+
interface Mention extends MentionIdentityOneOf {
|
|
1556
1556
|
/**
|
|
1557
1557
|
* Wix user ID.
|
|
1558
1558
|
* @format GUID
|
|
@@ -1575,7 +1575,7 @@ export interface Mention extends MentionIdentityOneOf {
|
|
|
1575
1575
|
groupId?: string | null;
|
|
1576
1576
|
}
|
|
1577
1577
|
/** @oneof */
|
|
1578
|
-
|
|
1578
|
+
interface MentionIdentityOneOf {
|
|
1579
1579
|
/**
|
|
1580
1580
|
* Wix user ID.
|
|
1581
1581
|
* @format GUID
|
|
@@ -1597,15 +1597,15 @@ export interface MentionIdentityOneOf {
|
|
|
1597
1597
|
*/
|
|
1598
1598
|
groupId?: string | null;
|
|
1599
1599
|
}
|
|
1600
|
-
|
|
1600
|
+
interface Attachment extends AttachmentMediaOneOf {
|
|
1601
1601
|
/** Information about the image. */
|
|
1602
|
-
image?:
|
|
1602
|
+
image?: string;
|
|
1603
1603
|
/** Information about the video. */
|
|
1604
|
-
video?:
|
|
1604
|
+
video?: string;
|
|
1605
1605
|
/** Information about the audio. */
|
|
1606
|
-
audio?:
|
|
1606
|
+
audio?: string;
|
|
1607
1607
|
/** Information about the document. */
|
|
1608
|
-
document?:
|
|
1608
|
+
document?: string;
|
|
1609
1609
|
/**
|
|
1610
1610
|
* Mime type of attachment.
|
|
1611
1611
|
* @maxLength 3000
|
|
@@ -1613,87 +1613,17 @@ export interface Attachment extends AttachmentMediaOneOf {
|
|
|
1613
1613
|
mimeType?: string | null;
|
|
1614
1614
|
}
|
|
1615
1615
|
/** @oneof */
|
|
1616
|
-
|
|
1616
|
+
interface AttachmentMediaOneOf {
|
|
1617
1617
|
/** Information about the image. */
|
|
1618
|
-
image?:
|
|
1618
|
+
image?: string;
|
|
1619
1619
|
/** Information about the video. */
|
|
1620
|
-
video?:
|
|
1620
|
+
video?: string;
|
|
1621
1621
|
/** Information about the audio. */
|
|
1622
|
-
audio?:
|
|
1622
|
+
audio?: string;
|
|
1623
1623
|
/** 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;
|
|
1624
|
+
document?: string;
|
|
1695
1625
|
}
|
|
1696
|
-
|
|
1626
|
+
interface VideoResolution {
|
|
1697
1627
|
/** Video URL. */
|
|
1698
1628
|
url?: string;
|
|
1699
1629
|
/** Video height. */
|
|
@@ -1732,80 +1662,7 @@ export interface VideoResolution {
|
|
|
1732
1662
|
*/
|
|
1733
1663
|
assetKey?: string | null;
|
|
1734
1664
|
}
|
|
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 {
|
|
1665
|
+
interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1809
1666
|
/**
|
|
1810
1667
|
* Wix user ID.
|
|
1811
1668
|
* @format GUID
|
|
@@ -1828,7 +1685,7 @@ export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
|
1828
1685
|
appId?: string | null;
|
|
1829
1686
|
}
|
|
1830
1687
|
/** @oneof */
|
|
1831
|
-
|
|
1688
|
+
interface ContentAuthorAuthorOneOf {
|
|
1832
1689
|
/**
|
|
1833
1690
|
* Wix user ID.
|
|
1834
1691
|
* @format GUID
|
|
@@ -1850,7 +1707,7 @@ export interface ContentAuthorAuthorOneOf {
|
|
|
1850
1707
|
*/
|
|
1851
1708
|
appId?: string | null;
|
|
1852
1709
|
}
|
|
1853
|
-
|
|
1710
|
+
interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1854
1711
|
/**
|
|
1855
1712
|
* Wix user ID.
|
|
1856
1713
|
* @format GUID
|
|
@@ -1868,7 +1725,7 @@ export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1868
1725
|
visitorId?: string | null;
|
|
1869
1726
|
}
|
|
1870
1727
|
/** @oneof */
|
|
1871
|
-
|
|
1728
|
+
interface CommentAuthorIdentityOneOf {
|
|
1872
1729
|
/**
|
|
1873
1730
|
* Wix user ID.
|
|
1874
1731
|
* @format GUID
|
|
@@ -1885,13 +1742,13 @@ export interface CommentAuthorIdentityOneOf {
|
|
|
1885
1742
|
*/
|
|
1886
1743
|
visitorId?: string | null;
|
|
1887
1744
|
}
|
|
1888
|
-
|
|
1745
|
+
interface ParentComment {
|
|
1889
1746
|
/**
|
|
1890
1747
|
* Comment ID of the parent comment.
|
|
1891
1748
|
* @format GUID
|
|
1892
1749
|
* @immutable
|
|
1893
1750
|
*/
|
|
1894
|
-
|
|
1751
|
+
_id?: string | null;
|
|
1895
1752
|
/**
|
|
1896
1753
|
* Author of the parent comment.
|
|
1897
1754
|
* @readonly
|
|
@@ -1903,7 +1760,7 @@ export interface ParentComment {
|
|
|
1903
1760
|
*/
|
|
1904
1761
|
status?: Status;
|
|
1905
1762
|
}
|
|
1906
|
-
|
|
1763
|
+
declare enum Status {
|
|
1907
1764
|
/** Unknown status. */
|
|
1908
1765
|
UNKNOWN = "UNKNOWN",
|
|
1909
1766
|
/** This comment is published and publicly visible. */
|
|
@@ -1915,7 +1772,7 @@ export declare enum Status {
|
|
|
1915
1772
|
/** This comment has been hidden by a site moderator. */
|
|
1916
1773
|
HIDDEN = "HIDDEN"
|
|
1917
1774
|
}
|
|
1918
|
-
|
|
1775
|
+
interface VoteSummary {
|
|
1919
1776
|
/** Number of upvotes less downvotes on this comment. */
|
|
1920
1777
|
netVoteCount?: number;
|
|
1921
1778
|
/** Number of upvotes on this comment. */
|
|
@@ -1923,7 +1780,7 @@ export interface VoteSummary {
|
|
|
1923
1780
|
/** Number of downvotes on this comment. */
|
|
1924
1781
|
downvoteCount?: number;
|
|
1925
1782
|
}
|
|
1926
|
-
|
|
1783
|
+
interface CommentReactionSummary {
|
|
1927
1784
|
/** Total amount of reactions. */
|
|
1928
1785
|
total?: number;
|
|
1929
1786
|
/**
|
|
@@ -1932,7 +1789,7 @@ export interface CommentReactionSummary {
|
|
|
1932
1789
|
*/
|
|
1933
1790
|
reactionCodeCount?: Record<string, number>;
|
|
1934
1791
|
}
|
|
1935
|
-
|
|
1792
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1936
1793
|
/** insert/update documents */
|
|
1937
1794
|
update?: InternalDocumentUpdateOperation;
|
|
1938
1795
|
/** delete by document ids */
|
|
@@ -1973,7 +1830,7 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
|
|
|
1973
1830
|
issuedAt?: Date | null;
|
|
1974
1831
|
}
|
|
1975
1832
|
/** @oneof */
|
|
1976
|
-
|
|
1833
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1977
1834
|
/** insert/update documents */
|
|
1978
1835
|
update?: InternalDocumentUpdateOperation;
|
|
1979
1836
|
/** delete by document ids */
|
|
@@ -1989,39 +1846,39 @@ export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
1989
1846
|
/** delete by document ids with versioning */
|
|
1990
1847
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1991
1848
|
}
|
|
1992
|
-
|
|
1849
|
+
interface InternalDocument {
|
|
1993
1850
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
1994
1851
|
document?: Record<string, any> | null;
|
|
1995
1852
|
}
|
|
1996
|
-
|
|
1853
|
+
interface InternalDocumentUpdateOperation {
|
|
1997
1854
|
/** documents to index or update */
|
|
1998
1855
|
documents?: InternalDocument[];
|
|
1999
1856
|
}
|
|
2000
|
-
|
|
1857
|
+
interface DeleteByIdsOperation {
|
|
2001
1858
|
/** ids of the documents to delete */
|
|
2002
1859
|
documentIds?: string[];
|
|
2003
1860
|
}
|
|
2004
|
-
|
|
1861
|
+
interface DeleteByFilterOperation {
|
|
2005
1862
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2006
1863
|
filter?: Record<string, any> | null;
|
|
2007
1864
|
}
|
|
2008
|
-
|
|
1865
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
2009
1866
|
/** documents matching this filter will be updated */
|
|
2010
1867
|
filter?: Record<string, any> | null;
|
|
2011
1868
|
/** partial document to apply */
|
|
2012
1869
|
document?: InternalDocument;
|
|
2013
1870
|
}
|
|
2014
|
-
|
|
1871
|
+
interface InternalUpdateExistingOperation {
|
|
2015
1872
|
/** documents to update */
|
|
2016
1873
|
documents?: InternalDocument[];
|
|
2017
1874
|
}
|
|
2018
|
-
|
|
1875
|
+
interface VersionedDocumentUpdateOperation {
|
|
2019
1876
|
/** documents to create or overwrite */
|
|
2020
1877
|
documents?: InternalDocument[];
|
|
2021
1878
|
/** versioning mode to use instead of default */
|
|
2022
1879
|
versioningMode?: VersioningMode;
|
|
2023
1880
|
}
|
|
2024
|
-
|
|
1881
|
+
declare enum VersioningMode {
|
|
2025
1882
|
/** use default versioning mode agreed with search team */
|
|
2026
1883
|
DEFAULT = "DEFAULT",
|
|
2027
1884
|
/** execute only if version is greater than existing */
|
|
@@ -2029,11 +1886,11 @@ export declare enum VersioningMode {
|
|
|
2029
1886
|
/** execute only if version is greater or equal to existing */
|
|
2030
1887
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2031
1888
|
}
|
|
2032
|
-
|
|
1889
|
+
interface VersionedDeleteByIdsOperation {
|
|
2033
1890
|
/** ids with version of the documents to delete */
|
|
2034
1891
|
documentIds?: VersionedDocumentId[];
|
|
2035
1892
|
}
|
|
2036
|
-
|
|
1893
|
+
interface VersionedDocumentId {
|
|
2037
1894
|
/** document id */
|
|
2038
1895
|
documentId?: string;
|
|
2039
1896
|
/** document version */
|
|
@@ -2041,11 +1898,11 @@ export interface VersionedDocumentId {
|
|
|
2041
1898
|
/** versioning mode to use instead of default */
|
|
2042
1899
|
versioningMode?: VersioningMode;
|
|
2043
1900
|
}
|
|
2044
|
-
|
|
1901
|
+
interface CommentModerated {
|
|
2045
1902
|
comment?: Comment;
|
|
2046
1903
|
moderationAction?: Action;
|
|
2047
1904
|
}
|
|
2048
|
-
|
|
1905
|
+
declare enum Action {
|
|
2049
1906
|
/** Unknown content. */
|
|
2050
1907
|
UNKNOWN = "UNKNOWN",
|
|
2051
1908
|
/** Approve draft content. */
|
|
@@ -2053,17 +1910,17 @@ export declare enum Action {
|
|
|
2053
1910
|
/** Reject draft content. */
|
|
2054
1911
|
REJECT = "REJECT"
|
|
2055
1912
|
}
|
|
2056
|
-
|
|
1913
|
+
interface CreateCommentRequest {
|
|
2057
1914
|
/** Comment to create. */
|
|
2058
1915
|
comment?: Comment;
|
|
2059
1916
|
}
|
|
2060
|
-
|
|
1917
|
+
interface ContactDetails {
|
|
2061
1918
|
}
|
|
2062
|
-
|
|
1919
|
+
interface CreateCommentResponse {
|
|
2063
1920
|
/** Created comment. */
|
|
2064
1921
|
comment?: Comment;
|
|
2065
1922
|
}
|
|
2066
|
-
|
|
1923
|
+
interface ResourceCommentCountChanged {
|
|
2067
1924
|
/** ID of the app that the comment is added to. */
|
|
2068
1925
|
appId?: string;
|
|
2069
1926
|
/**
|
|
@@ -2081,27 +1938,27 @@ export interface ResourceCommentCountChanged {
|
|
|
2081
1938
|
/** How many comments are published for the resource. */
|
|
2082
1939
|
publishedCommentCount?: number;
|
|
2083
1940
|
}
|
|
2084
|
-
|
|
1941
|
+
interface GetCommentRequest {
|
|
2085
1942
|
/**
|
|
2086
1943
|
* ID of the comment to retrieve.
|
|
2087
1944
|
* @format GUID
|
|
2088
1945
|
*/
|
|
2089
1946
|
commentId: string;
|
|
2090
1947
|
}
|
|
2091
|
-
|
|
1948
|
+
interface GetCommentResponse {
|
|
2092
1949
|
/** Retrieved comment. */
|
|
2093
1950
|
comment?: Comment;
|
|
2094
1951
|
}
|
|
2095
1952
|
/** Comment info to update. */
|
|
2096
|
-
|
|
1953
|
+
interface UpdateCommentRequest {
|
|
2097
1954
|
/** Comment info to update. */
|
|
2098
1955
|
comment?: Comment;
|
|
2099
1956
|
}
|
|
2100
|
-
|
|
1957
|
+
interface UpdateCommentResponse {
|
|
2101
1958
|
/** Updated comment. */
|
|
2102
1959
|
comment?: Comment;
|
|
2103
1960
|
}
|
|
2104
|
-
|
|
1961
|
+
interface CommentContentChanged {
|
|
2105
1962
|
/** Comment ID. */
|
|
2106
1963
|
commentId?: string;
|
|
2107
1964
|
/** Content before the update. */
|
|
@@ -2109,19 +1966,19 @@ export interface CommentContentChanged {
|
|
|
2109
1966
|
/** Content after the update. */
|
|
2110
1967
|
currentContent?: CommentContent;
|
|
2111
1968
|
}
|
|
2112
|
-
|
|
1969
|
+
interface DeleteCommentRequest {
|
|
2113
1970
|
/**
|
|
2114
1971
|
* ID of the comment to delete.
|
|
2115
1972
|
* @format GUID
|
|
2116
1973
|
*/
|
|
2117
1974
|
commentId: string;
|
|
2118
1975
|
}
|
|
2119
|
-
|
|
1976
|
+
interface DeleteCommentResponse {
|
|
2120
1977
|
}
|
|
2121
|
-
|
|
1978
|
+
interface CommentDeleted {
|
|
2122
1979
|
comment?: Comment;
|
|
2123
1980
|
}
|
|
2124
|
-
|
|
1981
|
+
interface ModerateDraftContentRequest {
|
|
2125
1982
|
/**
|
|
2126
1983
|
* ID of the comment to moderate.
|
|
2127
1984
|
* @format GUID
|
|
@@ -2136,20 +1993,20 @@ export interface ModerateDraftContentRequest {
|
|
|
2136
1993
|
/** Draft content action. */
|
|
2137
1994
|
draftContentAction?: Action;
|
|
2138
1995
|
}
|
|
2139
|
-
|
|
1996
|
+
interface ModerateDraftContentResponse {
|
|
2140
1997
|
/** Moderated comment. */
|
|
2141
1998
|
comment?: Comment;
|
|
2142
1999
|
}
|
|
2143
|
-
|
|
2000
|
+
interface CommentPublished {
|
|
2144
2001
|
/** Comment info. */
|
|
2145
2002
|
comment?: Comment;
|
|
2146
2003
|
/** Whether this is the first comment publish. */
|
|
2147
2004
|
firstPublish?: boolean;
|
|
2148
2005
|
}
|
|
2149
|
-
|
|
2006
|
+
interface CommentHidden {
|
|
2150
2007
|
comment?: Comment;
|
|
2151
2008
|
}
|
|
2152
|
-
|
|
2009
|
+
interface QueryCommentsRequest {
|
|
2153
2010
|
/**
|
|
2154
2011
|
* App ID to query comments for.
|
|
2155
2012
|
* @format GUID
|
|
@@ -2158,7 +2015,7 @@ export interface QueryCommentsRequest {
|
|
|
2158
2015
|
/** Query options. */
|
|
2159
2016
|
query: CursorQuery;
|
|
2160
2017
|
}
|
|
2161
|
-
|
|
2018
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2162
2019
|
/**
|
|
2163
2020
|
* Cursor paging options.
|
|
2164
2021
|
*
|
|
@@ -2180,7 +2037,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2180
2037
|
sort?: Sorting[];
|
|
2181
2038
|
}
|
|
2182
2039
|
/** @oneof */
|
|
2183
|
-
|
|
2040
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2184
2041
|
/**
|
|
2185
2042
|
* Cursor paging options.
|
|
2186
2043
|
*
|
|
@@ -2188,7 +2045,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2188
2045
|
*/
|
|
2189
2046
|
cursorPaging?: CursorPaging;
|
|
2190
2047
|
}
|
|
2191
|
-
|
|
2048
|
+
interface Sorting {
|
|
2192
2049
|
/**
|
|
2193
2050
|
* Name of the field to sort by.
|
|
2194
2051
|
* @maxLength 512
|
|
@@ -2197,11 +2054,11 @@ export interface Sorting {
|
|
|
2197
2054
|
/** Sort order. */
|
|
2198
2055
|
order?: SortOrder;
|
|
2199
2056
|
}
|
|
2200
|
-
|
|
2057
|
+
declare enum SortOrder {
|
|
2201
2058
|
ASC = "ASC",
|
|
2202
2059
|
DESC = "DESC"
|
|
2203
2060
|
}
|
|
2204
|
-
|
|
2061
|
+
interface CursorPaging {
|
|
2205
2062
|
/**
|
|
2206
2063
|
* Maximum number of items to return in the results.
|
|
2207
2064
|
* @max 100
|
|
@@ -2216,13 +2073,13 @@ export interface CursorPaging {
|
|
|
2216
2073
|
*/
|
|
2217
2074
|
cursor?: string | null;
|
|
2218
2075
|
}
|
|
2219
|
-
|
|
2076
|
+
interface QueryCommentsResponse {
|
|
2220
2077
|
/** Retrieved comments. */
|
|
2221
2078
|
comments?: Comment[];
|
|
2222
2079
|
/** Paging metadata. */
|
|
2223
2080
|
pagingMetadata?: CursorPagingMetadata;
|
|
2224
2081
|
}
|
|
2225
|
-
|
|
2082
|
+
interface CursorPagingMetadata {
|
|
2226
2083
|
/** Number of items returned in current page. */
|
|
2227
2084
|
count?: number | null;
|
|
2228
2085
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2235,7 +2092,7 @@ export interface CursorPagingMetadata {
|
|
|
2235
2092
|
*/
|
|
2236
2093
|
hasNext?: boolean | null;
|
|
2237
2094
|
}
|
|
2238
|
-
|
|
2095
|
+
interface Cursors {
|
|
2239
2096
|
/**
|
|
2240
2097
|
* Cursor string pointing to the next page in the list of results.
|
|
2241
2098
|
* @maxLength 16000
|
|
@@ -2247,58 +2104,58 @@ export interface Cursors {
|
|
|
2247
2104
|
*/
|
|
2248
2105
|
prev?: string | null;
|
|
2249
2106
|
}
|
|
2250
|
-
|
|
2107
|
+
interface MarkCommentRequest {
|
|
2251
2108
|
/**
|
|
2252
2109
|
* ID of the comment to mark.
|
|
2253
2110
|
* @format GUID
|
|
2254
2111
|
*/
|
|
2255
2112
|
commentId: string;
|
|
2256
2113
|
}
|
|
2257
|
-
|
|
2114
|
+
interface MarkCommentResponse {
|
|
2258
2115
|
/** Marked comment. */
|
|
2259
2116
|
comment?: Comment;
|
|
2260
2117
|
}
|
|
2261
|
-
|
|
2118
|
+
interface CommentMarked {
|
|
2262
2119
|
comment?: Comment;
|
|
2263
2120
|
}
|
|
2264
|
-
|
|
2121
|
+
interface UnmarkCommentRequest {
|
|
2265
2122
|
/**
|
|
2266
2123
|
* ID of the comment to unmark.
|
|
2267
2124
|
* @format GUID
|
|
2268
2125
|
*/
|
|
2269
2126
|
commentId: string;
|
|
2270
2127
|
}
|
|
2271
|
-
|
|
2128
|
+
interface UnmarkCommentResponse {
|
|
2272
2129
|
/** Unmarked comment. */
|
|
2273
2130
|
comment?: Comment;
|
|
2274
2131
|
}
|
|
2275
|
-
|
|
2132
|
+
interface CommentUnmarked {
|
|
2276
2133
|
comment?: Comment;
|
|
2277
2134
|
}
|
|
2278
|
-
|
|
2135
|
+
interface HideCommentRequest {
|
|
2279
2136
|
/**
|
|
2280
2137
|
* ID of the comment to hide.
|
|
2281
2138
|
* @format GUID
|
|
2282
2139
|
*/
|
|
2283
2140
|
commentId: string;
|
|
2284
2141
|
}
|
|
2285
|
-
|
|
2142
|
+
interface HideCommentResponse {
|
|
2286
2143
|
/** Hidden comment. */
|
|
2287
2144
|
comment?: Comment;
|
|
2288
2145
|
}
|
|
2289
|
-
|
|
2146
|
+
interface PublishCommentRequest {
|
|
2290
2147
|
/**
|
|
2291
2148
|
* ID of the comment to publish.
|
|
2292
2149
|
* @format GUID
|
|
2293
2150
|
*/
|
|
2294
2151
|
commentId: string;
|
|
2295
2152
|
}
|
|
2296
|
-
|
|
2153
|
+
interface PublishCommentResponse {
|
|
2297
2154
|
/** Published comment. */
|
|
2298
2155
|
comment?: Comment;
|
|
2299
2156
|
}
|
|
2300
2157
|
/** Count comments options. */
|
|
2301
|
-
|
|
2158
|
+
interface CountCommentsRequest {
|
|
2302
2159
|
/**
|
|
2303
2160
|
* App ID to count the comments of.
|
|
2304
2161
|
* @format GUID
|
|
@@ -2307,11 +2164,11 @@ export interface CountCommentsRequest {
|
|
|
2307
2164
|
/** Filter to identify the comments that need to be counted. */
|
|
2308
2165
|
filter?: Record<string, any> | null;
|
|
2309
2166
|
}
|
|
2310
|
-
|
|
2167
|
+
interface CountCommentsResponse {
|
|
2311
2168
|
/** Number of comments. */
|
|
2312
2169
|
count?: number;
|
|
2313
2170
|
}
|
|
2314
|
-
|
|
2171
|
+
interface ListCommentsByResourceRequest {
|
|
2315
2172
|
/**
|
|
2316
2173
|
* ID of the app from which the comments are listed.
|
|
2317
2174
|
* @format GUID
|
|
@@ -2343,7 +2200,7 @@ export interface ListCommentsByResourceRequest {
|
|
|
2343
2200
|
/** Cursor paging. */
|
|
2344
2201
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2345
2202
|
}
|
|
2346
|
-
|
|
2203
|
+
interface CommentSort {
|
|
2347
2204
|
/** Sort order. */
|
|
2348
2205
|
order?: Order;
|
|
2349
2206
|
/**
|
|
@@ -2353,7 +2210,7 @@ export interface CommentSort {
|
|
|
2353
2210
|
*/
|
|
2354
2211
|
keepMarkedInOriginalOrder?: boolean;
|
|
2355
2212
|
}
|
|
2356
|
-
|
|
2213
|
+
declare enum Order {
|
|
2357
2214
|
/** Unknown order. */
|
|
2358
2215
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2359
2216
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2371,7 +2228,7 @@ export declare enum Order {
|
|
|
2371
2228
|
/** Comments with the lowest rating appear at the top of the list. */
|
|
2372
2229
|
RATING_ASC = "RATING_ASC"
|
|
2373
2230
|
}
|
|
2374
|
-
|
|
2231
|
+
interface ReplySort {
|
|
2375
2232
|
/** Sort order. */
|
|
2376
2233
|
order?: ReplySortOrder;
|
|
2377
2234
|
/**
|
|
@@ -2383,7 +2240,7 @@ export interface ReplySort {
|
|
|
2383
2240
|
*/
|
|
2384
2241
|
keepMarkedInOriginalOrder?: boolean;
|
|
2385
2242
|
}
|
|
2386
|
-
|
|
2243
|
+
declare enum ReplySortOrder {
|
|
2387
2244
|
/** Unknown order. */
|
|
2388
2245
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2389
2246
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2393,7 +2250,7 @@ export declare enum ReplySortOrder {
|
|
|
2393
2250
|
/** Comments with the highest reaction count appear at the top of the list. */
|
|
2394
2251
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2395
2252
|
}
|
|
2396
|
-
|
|
2253
|
+
interface ListCommentsByResourceCursorPaging {
|
|
2397
2254
|
/** Pointer to the next or previous page in the list of results. */
|
|
2398
2255
|
cursor?: string | null;
|
|
2399
2256
|
/**
|
|
@@ -2408,7 +2265,7 @@ export interface ListCommentsByResourceCursorPaging {
|
|
|
2408
2265
|
*/
|
|
2409
2266
|
repliesLimit?: number | null;
|
|
2410
2267
|
}
|
|
2411
|
-
|
|
2268
|
+
interface ListCommentsByResourceResponse {
|
|
2412
2269
|
/** Listed comments. */
|
|
2413
2270
|
comments?: Comment[];
|
|
2414
2271
|
/** Paging metadata. */
|
|
@@ -2416,13 +2273,13 @@ export interface ListCommentsByResourceResponse {
|
|
|
2416
2273
|
/** Listed comment replies. */
|
|
2417
2274
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2418
2275
|
}
|
|
2419
|
-
|
|
2276
|
+
interface RepliesListResponse {
|
|
2420
2277
|
/** Listed comment replies. */
|
|
2421
2278
|
replies?: Comment[];
|
|
2422
2279
|
/** Paging metadata. */
|
|
2423
2280
|
pagingMetadata?: CursorPagingMetadata;
|
|
2424
2281
|
}
|
|
2425
|
-
|
|
2282
|
+
interface GetCommentThreadRequest {
|
|
2426
2283
|
/**
|
|
2427
2284
|
* App ID.
|
|
2428
2285
|
* @maxLength 128
|
|
@@ -2440,7 +2297,7 @@ export interface GetCommentThreadRequest {
|
|
|
2440
2297
|
/** Reply sorting. */
|
|
2441
2298
|
replySort?: ReplySort;
|
|
2442
2299
|
}
|
|
2443
|
-
|
|
2300
|
+
interface GetCommentThreadResponse {
|
|
2444
2301
|
/** Retrieved replies. */
|
|
2445
2302
|
comments?: Comment[];
|
|
2446
2303
|
/** Paging metadata. */
|
|
@@ -2448,7 +2305,7 @@ export interface GetCommentThreadResponse {
|
|
|
2448
2305
|
/** Retrieved replies of a reply. */
|
|
2449
2306
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2450
2307
|
}
|
|
2451
|
-
|
|
2308
|
+
interface BulkPublishCommentRequest {
|
|
2452
2309
|
/**
|
|
2453
2310
|
* ID of the app where to publish the comment.
|
|
2454
2311
|
* @format GUID
|
|
@@ -2457,7 +2314,7 @@ export interface BulkPublishCommentRequest {
|
|
|
2457
2314
|
/** 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
2315
|
filter: Record<string, any> | null;
|
|
2459
2316
|
}
|
|
2460
|
-
|
|
2317
|
+
interface BulkPublishCommentResponse {
|
|
2461
2318
|
/**
|
|
2462
2319
|
* Job ID.
|
|
2463
2320
|
*
|
|
@@ -2466,7 +2323,7 @@ export interface BulkPublishCommentResponse {
|
|
|
2466
2323
|
*/
|
|
2467
2324
|
jobId?: string;
|
|
2468
2325
|
}
|
|
2469
|
-
|
|
2326
|
+
interface BulkHideCommentRequest {
|
|
2470
2327
|
/**
|
|
2471
2328
|
* ID of the app where to hide the comments.
|
|
2472
2329
|
* @format GUID
|
|
@@ -2475,7 +2332,7 @@ export interface BulkHideCommentRequest {
|
|
|
2475
2332
|
/** 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
2333
|
filter: Record<string, any> | null;
|
|
2477
2334
|
}
|
|
2478
|
-
|
|
2335
|
+
interface BulkHideCommentResponse {
|
|
2479
2336
|
/**
|
|
2480
2337
|
* Job ID.
|
|
2481
2338
|
*
|
|
@@ -2484,7 +2341,7 @@ export interface BulkHideCommentResponse {
|
|
|
2484
2341
|
*/
|
|
2485
2342
|
jobId?: string;
|
|
2486
2343
|
}
|
|
2487
|
-
|
|
2344
|
+
interface BulkDeleteCommentRequest {
|
|
2488
2345
|
/**
|
|
2489
2346
|
* ID of the app where to delete the comments.
|
|
2490
2347
|
* @format GUID
|
|
@@ -2493,7 +2350,7 @@ export interface BulkDeleteCommentRequest {
|
|
|
2493
2350
|
/** 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
2351
|
filter: Record<string, any> | null;
|
|
2495
2352
|
}
|
|
2496
|
-
|
|
2353
|
+
interface BulkDeleteCommentResponse {
|
|
2497
2354
|
/**
|
|
2498
2355
|
* Job ID.
|
|
2499
2356
|
*
|
|
@@ -2502,7 +2359,7 @@ export interface BulkDeleteCommentResponse {
|
|
|
2502
2359
|
*/
|
|
2503
2360
|
jobId?: string;
|
|
2504
2361
|
}
|
|
2505
|
-
|
|
2362
|
+
interface BulkModerateDraftContentRequest {
|
|
2506
2363
|
/**
|
|
2507
2364
|
* ID of the app where to moderate the comments.
|
|
2508
2365
|
* @format GUID
|
|
@@ -2513,7 +2370,7 @@ export interface BulkModerateDraftContentRequest {
|
|
|
2513
2370
|
/** Action to do regarding draft content */
|
|
2514
2371
|
draftContentAction: Action;
|
|
2515
2372
|
}
|
|
2516
|
-
|
|
2373
|
+
interface BulkModerateDraftContentResponse {
|
|
2517
2374
|
/**
|
|
2518
2375
|
* Job ID.
|
|
2519
2376
|
*
|
|
@@ -2522,7 +2379,7 @@ export interface BulkModerateDraftContentResponse {
|
|
|
2522
2379
|
*/
|
|
2523
2380
|
jobId?: string;
|
|
2524
2381
|
}
|
|
2525
|
-
|
|
2382
|
+
interface BulkMoveCommentByFilterRequest {
|
|
2526
2383
|
/**
|
|
2527
2384
|
* ID of the app from which to move the comments.
|
|
2528
2385
|
* @format GUID
|
|
@@ -2533,7 +2390,7 @@ export interface BulkMoveCommentByFilterRequest {
|
|
|
2533
2390
|
/** Where to move the comment. */
|
|
2534
2391
|
destination?: Destination;
|
|
2535
2392
|
}
|
|
2536
|
-
|
|
2393
|
+
interface Destination {
|
|
2537
2394
|
/**
|
|
2538
2395
|
* Context ID of where to move the comment to.
|
|
2539
2396
|
* @maxLength 128
|
|
@@ -2545,7 +2402,7 @@ export interface Destination {
|
|
|
2545
2402
|
*/
|
|
2546
2403
|
resourceId?: string;
|
|
2547
2404
|
}
|
|
2548
|
-
|
|
2405
|
+
interface BulkMoveCommentByFilterResponse {
|
|
2549
2406
|
/**
|
|
2550
2407
|
* Job ID.
|
|
2551
2408
|
*
|
|
@@ -2554,11 +2411,11 @@ export interface BulkMoveCommentByFilterResponse {
|
|
|
2554
2411
|
*/
|
|
2555
2412
|
jobId?: string;
|
|
2556
2413
|
}
|
|
2557
|
-
|
|
2414
|
+
interface CommentMoved {
|
|
2558
2415
|
comment?: Comment;
|
|
2559
2416
|
destination?: Destination;
|
|
2560
2417
|
}
|
|
2561
|
-
|
|
2418
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2562
2419
|
createdEvent?: EntityCreatedEvent;
|
|
2563
2420
|
updatedEvent?: EntityUpdatedEvent;
|
|
2564
2421
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2567,7 +2424,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2567
2424
|
* Unique event ID.
|
|
2568
2425
|
* Allows clients to ignore duplicate webhooks.
|
|
2569
2426
|
*/
|
|
2570
|
-
|
|
2427
|
+
_id?: string;
|
|
2571
2428
|
/**
|
|
2572
2429
|
* Assumes actions are also always typed to an entity_type
|
|
2573
2430
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -2601,36 +2458,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2601
2458
|
entityEventSequence?: string | null;
|
|
2602
2459
|
}
|
|
2603
2460
|
/** @oneof */
|
|
2604
|
-
|
|
2461
|
+
interface DomainEventBodyOneOf {
|
|
2605
2462
|
createdEvent?: EntityCreatedEvent;
|
|
2606
2463
|
updatedEvent?: EntityUpdatedEvent;
|
|
2607
2464
|
deletedEvent?: EntityDeletedEvent;
|
|
2608
2465
|
actionEvent?: ActionEvent;
|
|
2609
2466
|
}
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2613
|
-
restoreInfo?: RestoreInfo;
|
|
2467
|
+
interface EntityCreatedEvent {
|
|
2468
|
+
entity?: string;
|
|
2614
2469
|
}
|
|
2615
|
-
|
|
2470
|
+
interface RestoreInfo {
|
|
2616
2471
|
deletedDate?: Date | null;
|
|
2617
2472
|
}
|
|
2618
|
-
|
|
2473
|
+
interface EntityUpdatedEvent {
|
|
2619
2474
|
/**
|
|
2620
2475
|
* 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
2476
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2622
2477
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2623
2478
|
*/
|
|
2624
|
-
|
|
2479
|
+
currentEntity?: string;
|
|
2625
2480
|
}
|
|
2626
|
-
|
|
2481
|
+
interface EntityDeletedEvent {
|
|
2627
2482
|
/** Entity that was deleted */
|
|
2628
|
-
|
|
2483
|
+
deletedEntity?: string | null;
|
|
2629
2484
|
}
|
|
2630
|
-
|
|
2631
|
-
|
|
2485
|
+
interface ActionEvent {
|
|
2486
|
+
body?: string;
|
|
2632
2487
|
}
|
|
2633
|
-
|
|
2488
|
+
interface MessageEnvelope {
|
|
2634
2489
|
/**
|
|
2635
2490
|
* App instance ID.
|
|
2636
2491
|
* @format GUID
|
|
@@ -2646,7 +2501,7 @@ export interface MessageEnvelope {
|
|
|
2646
2501
|
/** Stringify payload. */
|
|
2647
2502
|
data?: string;
|
|
2648
2503
|
}
|
|
2649
|
-
|
|
2504
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2650
2505
|
/**
|
|
2651
2506
|
* ID of a site visitor that has not logged in to the site.
|
|
2652
2507
|
* @format GUID
|
|
@@ -2671,7 +2526,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2671
2526
|
identityType?: WebhookIdentityType;
|
|
2672
2527
|
}
|
|
2673
2528
|
/** @oneof */
|
|
2674
|
-
|
|
2529
|
+
interface IdentificationDataIdOneOf {
|
|
2675
2530
|
/**
|
|
2676
2531
|
* ID of a site visitor that has not logged in to the site.
|
|
2677
2532
|
* @format GUID
|
|
@@ -2693,372 +2548,332 @@ export interface IdentificationDataIdOneOf {
|
|
|
2693
2548
|
*/
|
|
2694
2549
|
appId?: string;
|
|
2695
2550
|
}
|
|
2696
|
-
|
|
2551
|
+
declare enum WebhookIdentityType {
|
|
2697
2552
|
UNKNOWN = "UNKNOWN",
|
|
2698
2553
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2699
2554
|
MEMBER = "MEMBER",
|
|
2700
2555
|
WIX_USER = "WIX_USER",
|
|
2701
2556
|
APP = "APP"
|
|
2702
2557
|
}
|
|
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;
|
|
2558
|
+
interface BaseEventMetadata {
|
|
2559
|
+
/**
|
|
2560
|
+
* App instance ID.
|
|
2561
|
+
* @format GUID
|
|
2562
|
+
*/
|
|
2563
|
+
instanceId?: string | null;
|
|
2564
|
+
/**
|
|
2565
|
+
* Event type.
|
|
2566
|
+
* @maxLength 150
|
|
2567
|
+
*/
|
|
2568
|
+
eventType?: string;
|
|
2569
|
+
/** The identification type and identity data. */
|
|
2570
|
+
identity?: IdentificationData;
|
|
2780
2571
|
}
|
|
2781
|
-
interface
|
|
2782
|
-
|
|
2783
|
-
|
|
2572
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2573
|
+
/**
|
|
2574
|
+
* Unique event ID.
|
|
2575
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2576
|
+
*/
|
|
2577
|
+
_id?: string;
|
|
2578
|
+
/**
|
|
2579
|
+
* Assumes actions are also always typed to an entity_type
|
|
2580
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2581
|
+
*/
|
|
2582
|
+
entityFqdn?: string;
|
|
2583
|
+
/**
|
|
2584
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2585
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2586
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2587
|
+
*/
|
|
2588
|
+
slug?: string;
|
|
2589
|
+
/** ID of the entity associated with the event. */
|
|
2590
|
+
entityId?: string;
|
|
2591
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2592
|
+
eventTime?: Date | null;
|
|
2593
|
+
/**
|
|
2594
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2595
|
+
* (for example, GDPR).
|
|
2596
|
+
*/
|
|
2597
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2598
|
+
/** If present, indicates the action that triggered the event. */
|
|
2599
|
+
originatedFrom?: string | null;
|
|
2600
|
+
/**
|
|
2601
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2602
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2603
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2604
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2605
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2606
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2607
|
+
*/
|
|
2608
|
+
entityEventSequence?: string | null;
|
|
2784
2609
|
}
|
|
2785
|
-
interface
|
|
2786
|
-
|
|
2610
|
+
interface CommentContentChangedEnvelope {
|
|
2611
|
+
data: CommentContentChanged;
|
|
2612
|
+
metadata: EventMetadata;
|
|
2787
2613
|
}
|
|
2788
|
-
interface
|
|
2789
|
-
|
|
2790
|
-
|
|
2791
|
-
styles?: LinkPreviewDataStylesNonNullableFields;
|
|
2614
|
+
interface CommentHiddenEnvelope {
|
|
2615
|
+
data: CommentHidden;
|
|
2616
|
+
metadata: EventMetadata;
|
|
2792
2617
|
}
|
|
2793
|
-
interface
|
|
2794
|
-
|
|
2618
|
+
interface CommentMarkedEnvelope {
|
|
2619
|
+
data: CommentMarked;
|
|
2620
|
+
metadata: EventMetadata;
|
|
2795
2621
|
}
|
|
2796
|
-
interface
|
|
2797
|
-
|
|
2798
|
-
|
|
2622
|
+
interface CommentMovedEnvelope {
|
|
2623
|
+
data: CommentMoved;
|
|
2624
|
+
metadata: EventMetadata;
|
|
2799
2625
|
}
|
|
2800
|
-
interface
|
|
2801
|
-
|
|
2626
|
+
interface CommentPublishedEnvelope {
|
|
2627
|
+
data: CommentPublished;
|
|
2628
|
+
metadata: EventMetadata;
|
|
2802
2629
|
}
|
|
2803
|
-
interface
|
|
2804
|
-
|
|
2805
|
-
|
|
2630
|
+
interface CommentUnmarkedEnvelope {
|
|
2631
|
+
data: CommentUnmarked;
|
|
2632
|
+
metadata: EventMetadata;
|
|
2806
2633
|
}
|
|
2807
|
-
interface
|
|
2808
|
-
|
|
2634
|
+
interface CommentCreatedEnvelope {
|
|
2635
|
+
entity: Comment;
|
|
2636
|
+
metadata: EventMetadata;
|
|
2809
2637
|
}
|
|
2810
|
-
interface
|
|
2811
|
-
|
|
2638
|
+
interface CommentResourceCommentCountChangedEnvelope {
|
|
2639
|
+
data: ResourceCommentCountChanged;
|
|
2640
|
+
metadata: EventMetadata;
|
|
2812
2641
|
}
|
|
2813
|
-
interface
|
|
2814
|
-
|
|
2815
|
-
|
|
2642
|
+
interface CommentUpdatedEnvelope {
|
|
2643
|
+
entity: Comment;
|
|
2644
|
+
metadata: EventMetadata;
|
|
2816
2645
|
}
|
|
2817
|
-
interface
|
|
2818
|
-
|
|
2646
|
+
interface UpdateComment {
|
|
2647
|
+
/**
|
|
2648
|
+
* Comment ID.
|
|
2649
|
+
* @format GUID
|
|
2650
|
+
* @readonly
|
|
2651
|
+
*/
|
|
2652
|
+
_id?: string | null;
|
|
2653
|
+
/**
|
|
2654
|
+
* Revision number, which increments by 1 each time the comment is updated.
|
|
2655
|
+
*
|
|
2656
|
+
* To prevent conflicting changes, the current `revision` must be passed when updating the comment.
|
|
2657
|
+
* @readonly
|
|
2658
|
+
*/
|
|
2659
|
+
revision?: string | null;
|
|
2660
|
+
/**
|
|
2661
|
+
* Date and time the comment was created.
|
|
2662
|
+
*
|
|
2663
|
+
* **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.
|
|
2664
|
+
* @readonly
|
|
2665
|
+
*/
|
|
2666
|
+
_createdDate?: Date | null;
|
|
2667
|
+
/**
|
|
2668
|
+
* Date and time the comment was last updated.
|
|
2669
|
+
* @readonly
|
|
2670
|
+
*/
|
|
2671
|
+
_updatedDate?: Date | null;
|
|
2672
|
+
/**
|
|
2673
|
+
* ID of the app that the comment is added to.
|
|
2674
|
+
* @format GUID
|
|
2675
|
+
* @immutable
|
|
2676
|
+
*/
|
|
2677
|
+
appId?: string | null;
|
|
2678
|
+
/**
|
|
2679
|
+
* ID of the specific context the comment is in response to.
|
|
2680
|
+
*
|
|
2681
|
+
* Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
|
|
2682
|
+
* the `forumPostId` is used as both the `contextId` and the `resourceId`.
|
|
2683
|
+
* @immutable
|
|
2684
|
+
* @maxLength 128
|
|
2685
|
+
*/
|
|
2686
|
+
contextId?: string | null;
|
|
2687
|
+
/**
|
|
2688
|
+
* ID of the specific resource that the comment is in response to.
|
|
2689
|
+
*
|
|
2690
|
+
* Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
|
|
2691
|
+
* the `forumPostId` is used as both the `resourceId` and the `contextId`.
|
|
2692
|
+
* @immutable
|
|
2693
|
+
* @maxLength 128
|
|
2694
|
+
*/
|
|
2695
|
+
resourceId?: string | null;
|
|
2696
|
+
/** Published comment content. */
|
|
2697
|
+
content?: CommentContent;
|
|
2698
|
+
/**
|
|
2699
|
+
* Comment's author.
|
|
2700
|
+
* @immutable
|
|
2701
|
+
*/
|
|
2702
|
+
author?: CommentAuthor;
|
|
2703
|
+
/**
|
|
2704
|
+
* Parent comment information.
|
|
2705
|
+
*
|
|
2706
|
+
* Only present if this comment is in a direct reply to another comment.
|
|
2707
|
+
* See **Terminology** in the Comments introduction
|
|
2708
|
+
* for more information about parent comments.
|
|
2709
|
+
*/
|
|
2710
|
+
parentComment?: ParentComment;
|
|
2711
|
+
/**
|
|
2712
|
+
* Number of comments that reply to this comment.
|
|
2713
|
+
* @readonly
|
|
2714
|
+
*/
|
|
2715
|
+
replyCount?: number;
|
|
2716
|
+
/**
|
|
2717
|
+
* Summary of votes.
|
|
2718
|
+
* @readonly
|
|
2719
|
+
*/
|
|
2720
|
+
voteSummary?: VoteSummary;
|
|
2721
|
+
/**
|
|
2722
|
+
* Comment status.
|
|
2723
|
+
* @readonly
|
|
2724
|
+
*/
|
|
2725
|
+
status?: Status;
|
|
2726
|
+
/**
|
|
2727
|
+
* Comment rating.
|
|
2728
|
+
* @readonly
|
|
2729
|
+
*/
|
|
2730
|
+
rating?: number | null;
|
|
2731
|
+
/**
|
|
2732
|
+
* Summary of reactions.
|
|
2733
|
+
* @readonly
|
|
2734
|
+
*/
|
|
2735
|
+
reactionSummary?: CommentReactionSummary;
|
|
2736
|
+
/** Whether the comment is marked. */
|
|
2737
|
+
marked?: boolean;
|
|
2738
|
+
/**
|
|
2739
|
+
* Date and time when the comment was actually created.
|
|
2740
|
+
* @immutable
|
|
2741
|
+
*/
|
|
2742
|
+
commentDate?: Date | null;
|
|
2743
|
+
/**
|
|
2744
|
+
* Whether the comment has the updated content.
|
|
2745
|
+
* @readonly
|
|
2746
|
+
*/
|
|
2747
|
+
contentEdited?: boolean | null;
|
|
2819
2748
|
}
|
|
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;
|
|
2749
|
+
interface ModerateDraftContentOptions {
|
|
2750
|
+
/** Draft content action. */
|
|
2751
|
+
draftContentAction?: Action;
|
|
3030
2752
|
}
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
|
|
2753
|
+
interface QueryCursorResult {
|
|
2754
|
+
cursors: Cursors;
|
|
2755
|
+
hasNext: () => boolean;
|
|
2756
|
+
hasPrev: () => boolean;
|
|
2757
|
+
length: number;
|
|
2758
|
+
pageSize: number;
|
|
2759
|
+
}
|
|
2760
|
+
interface CommentsQueryResult extends QueryCursorResult {
|
|
2761
|
+
items: Comment[];
|
|
2762
|
+
query: CommentsQueryBuilder;
|
|
2763
|
+
next: () => Promise<CommentsQueryResult>;
|
|
2764
|
+
prev: () => Promise<CommentsQueryResult>;
|
|
2765
|
+
}
|
|
2766
|
+
interface CommentsQueryBuilder {
|
|
2767
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2768
|
+
* @param value - Value to compare against.
|
|
2769
|
+
*/
|
|
2770
|
+
eq: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'replyCount' | 'voteSummary.netVoteCount' | 'status' | 'rating' | 'reactionSummary.total' | 'marked', value: any) => CommentsQueryBuilder;
|
|
2771
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2772
|
+
* @param value - Value to compare against.
|
|
2773
|
+
*/
|
|
2774
|
+
ne: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'replyCount' | 'voteSummary.netVoteCount' | 'status' | 'rating' | 'reactionSummary.total' | 'marked', value: any) => CommentsQueryBuilder;
|
|
2775
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2776
|
+
* @param value - Value to compare against.
|
|
2777
|
+
*/
|
|
2778
|
+
ge: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2779
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2780
|
+
* @param value - Value to compare against.
|
|
2781
|
+
*/
|
|
2782
|
+
gt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2783
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2784
|
+
* @param value - Value to compare against.
|
|
2785
|
+
*/
|
|
2786
|
+
le: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2787
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2788
|
+
* @param value - Value to compare against.
|
|
2789
|
+
*/
|
|
2790
|
+
lt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2791
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2792
|
+
* @param values - List of values to compare against.
|
|
2793
|
+
*/
|
|
2794
|
+
hasSome: (propertyName: string, value: any[]) => CommentsQueryBuilder;
|
|
2795
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2796
|
+
* @param values - List of values to compare against.
|
|
2797
|
+
*/
|
|
2798
|
+
hasAll: (propertyName: string, value: any[]) => CommentsQueryBuilder;
|
|
2799
|
+
in: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'status', value: any) => CommentsQueryBuilder;
|
|
2800
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
2801
|
+
ascending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
|
|
2802
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
2803
|
+
descending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
|
|
2804
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
2805
|
+
limit: (limit: number) => CommentsQueryBuilder;
|
|
2806
|
+
/** @param cursor - A pointer to specific record */
|
|
2807
|
+
skipTo: (cursor: string) => CommentsQueryBuilder;
|
|
2808
|
+
find: () => Promise<CommentsQueryResult>;
|
|
2809
|
+
}
|
|
2810
|
+
interface CountCommentsOptions {
|
|
2811
|
+
/** Filter to identify the comments that need to be counted. */
|
|
2812
|
+
filter?: Record<string, any> | null;
|
|
3042
2813
|
}
|
|
3043
|
-
|
|
3044
|
-
|
|
2814
|
+
interface ListCommentsByResourceOptions {
|
|
2815
|
+
/**
|
|
2816
|
+
* ID of the specific context the comment is in response to.
|
|
2817
|
+
*
|
|
2818
|
+
* 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`.
|
|
2819
|
+
* @maxLength 128
|
|
2820
|
+
*/
|
|
2821
|
+
contextId: string;
|
|
2822
|
+
/**
|
|
2823
|
+
* Reserved for internal use.
|
|
2824
|
+
* @maxLength 128
|
|
2825
|
+
*/
|
|
2826
|
+
contextType?: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* ID of the specific resource that the comment is in response to.
|
|
2829
|
+
*
|
|
2830
|
+
* 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`.
|
|
2831
|
+
* @maxLength 128
|
|
2832
|
+
*/
|
|
2833
|
+
resourceId: string;
|
|
2834
|
+
/** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
|
|
2835
|
+
commentSort?: CommentSort;
|
|
2836
|
+
/** Reply sort. Is ignored if `cursorPaging.cursor` is defined. */
|
|
2837
|
+
replySort?: ReplySort;
|
|
2838
|
+
/** Cursor paging. */
|
|
2839
|
+
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
3045
2840
|
}
|
|
3046
|
-
|
|
3047
|
-
|
|
2841
|
+
interface GetCommentThreadOptions {
|
|
2842
|
+
/**
|
|
2843
|
+
* App ID.
|
|
2844
|
+
* @maxLength 128
|
|
2845
|
+
* @deprecated App ID.
|
|
2846
|
+
* @targetRemovalDate 2024-11-01
|
|
2847
|
+
*/
|
|
2848
|
+
appId?: string;
|
|
2849
|
+
/** Comment sorting. */
|
|
2850
|
+
commentSort?: CommentSort;
|
|
2851
|
+
/** Reply sorting. */
|
|
2852
|
+
replySort?: ReplySort;
|
|
3048
2853
|
}
|
|
3049
|
-
|
|
3050
|
-
|
|
2854
|
+
interface BulkPublishCommentOptions {
|
|
2855
|
+
/** 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"`}. */
|
|
2856
|
+
filter: Record<string, any> | null;
|
|
3051
2857
|
}
|
|
3052
|
-
|
|
3053
|
-
|
|
2858
|
+
interface BulkHideCommentOptions {
|
|
2859
|
+
/** 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"`}. */
|
|
2860
|
+
filter: Record<string, any> | null;
|
|
3054
2861
|
}
|
|
3055
|
-
|
|
3056
|
-
|
|
2862
|
+
interface BulkDeleteCommentOptions {
|
|
2863
|
+
/** 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"`}. */
|
|
2864
|
+
filter: Record<string, any> | null;
|
|
3057
2865
|
}
|
|
3058
|
-
|
|
3059
|
-
|
|
2866
|
+
interface BulkModerateDraftContentOptions {
|
|
2867
|
+
/** 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"`}. */
|
|
2868
|
+
filter: Record<string, any> | null;
|
|
2869
|
+
/** Action to do regarding draft content */
|
|
2870
|
+
draftContentAction: Action;
|
|
3060
2871
|
}
|
|
3061
|
-
|
|
3062
|
-
|
|
2872
|
+
interface BulkMoveCommentByFilterOptions {
|
|
2873
|
+
/** 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"`}. */
|
|
2874
|
+
filter: Record<string, any> | null;
|
|
2875
|
+
/** Where to move the comment. */
|
|
2876
|
+
destination?: Destination;
|
|
3063
2877
|
}
|
|
3064
|
-
|
|
2878
|
+
|
|
2879
|
+
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 };
|