@wix/auto_sdk_comments_comments 1.0.6 → 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} +554 -736
- package/build/{internal/cjs/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.ts} +554 -736
- 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} +554 -736
- package/build/internal/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.ts} +554 -736
- 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 -3626
- 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 -3626
- 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 -3626
- 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 -3626
- 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
|
|
@@ -429,7 +429,10 @@ export interface Styles {
|
|
|
429
429
|
colors?: Colors;
|
|
430
430
|
/** Border width in pixels. */
|
|
431
431
|
borderWidth?: number | null;
|
|
432
|
-
/**
|
|
432
|
+
/**
|
|
433
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
434
|
+
* @deprecated
|
|
435
|
+
*/
|
|
433
436
|
borderWidthHover?: number | null;
|
|
434
437
|
/** Border radius in pixels. */
|
|
435
438
|
borderRadius?: number | null;
|
|
@@ -466,7 +469,7 @@ export interface Styles {
|
|
|
466
469
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
467
470
|
buttonSize?: string | null;
|
|
468
471
|
}
|
|
469
|
-
|
|
472
|
+
interface Link extends LinkDataOneOf {
|
|
470
473
|
/** The absolute URL for the linked document. */
|
|
471
474
|
url?: string;
|
|
472
475
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -485,13 +488,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
485
488
|
customData?: string | null;
|
|
486
489
|
}
|
|
487
490
|
/** @oneof */
|
|
488
|
-
|
|
491
|
+
interface LinkDataOneOf {
|
|
489
492
|
/** The absolute URL for the linked document. */
|
|
490
493
|
url?: string;
|
|
491
494
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
492
495
|
anchor?: string;
|
|
493
496
|
}
|
|
494
|
-
|
|
497
|
+
declare enum Target {
|
|
495
498
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
496
499
|
SELF = "SELF",
|
|
497
500
|
/** Opens the linked document in a new window or tab */
|
|
@@ -501,7 +504,7 @@ export declare enum Target {
|
|
|
501
504
|
/** Opens the linked document in the full body of the window */
|
|
502
505
|
TOP = "TOP"
|
|
503
506
|
}
|
|
504
|
-
|
|
507
|
+
interface Rel {
|
|
505
508
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
506
509
|
nofollow?: boolean | null;
|
|
507
510
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -511,17 +514,17 @@ export interface Rel {
|
|
|
511
514
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
512
515
|
noreferrer?: boolean | null;
|
|
513
516
|
}
|
|
514
|
-
|
|
517
|
+
interface CodeBlockData {
|
|
515
518
|
/** Styling for the code block's text. */
|
|
516
519
|
textStyle?: TextStyle;
|
|
517
520
|
}
|
|
518
|
-
|
|
521
|
+
interface TextStyle {
|
|
519
522
|
/** Text alignment. Defaults to `AUTO`. */
|
|
520
523
|
textAlignment?: TextAlignment;
|
|
521
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. */
|
|
522
525
|
lineHeight?: string | null;
|
|
523
526
|
}
|
|
524
|
-
|
|
527
|
+
declare enum TextAlignment {
|
|
525
528
|
/** browser default, eqivalent to `initial` */
|
|
526
529
|
AUTO = "AUTO",
|
|
527
530
|
/** Left align */
|
|
@@ -533,7 +536,7 @@ export declare enum TextAlignment {
|
|
|
533
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 */
|
|
534
537
|
JUSTIFY = "JUSTIFY"
|
|
535
538
|
}
|
|
536
|
-
|
|
539
|
+
interface DividerData {
|
|
537
540
|
/** Styling for the divider's container. */
|
|
538
541
|
containerData?: PluginContainerData;
|
|
539
542
|
/** Divider line style. */
|
|
@@ -543,7 +546,7 @@ export interface DividerData {
|
|
|
543
546
|
/** Divider alignment. */
|
|
544
547
|
alignment?: Alignment;
|
|
545
548
|
}
|
|
546
|
-
|
|
549
|
+
declare enum LineStyle {
|
|
547
550
|
/** Single Line */
|
|
548
551
|
SINGLE = "SINGLE",
|
|
549
552
|
/** Double Line */
|
|
@@ -553,7 +556,7 @@ export declare enum LineStyle {
|
|
|
553
556
|
/** Dotted Line */
|
|
554
557
|
DOTTED = "DOTTED"
|
|
555
558
|
}
|
|
556
|
-
|
|
559
|
+
declare enum Width {
|
|
557
560
|
/** Large line */
|
|
558
561
|
LARGE = "LARGE",
|
|
559
562
|
/** Medium line */
|
|
@@ -561,7 +564,7 @@ export declare enum Width {
|
|
|
561
564
|
/** Small line */
|
|
562
565
|
SMALL = "SMALL"
|
|
563
566
|
}
|
|
564
|
-
|
|
567
|
+
declare enum Alignment {
|
|
565
568
|
/** Center alignment */
|
|
566
569
|
CENTER = "CENTER",
|
|
567
570
|
/** Left alignment */
|
|
@@ -569,7 +572,7 @@ export declare enum Alignment {
|
|
|
569
572
|
/** Right alignment */
|
|
570
573
|
RIGHT = "RIGHT"
|
|
571
574
|
}
|
|
572
|
-
|
|
575
|
+
interface FileData {
|
|
573
576
|
/** Styling for the file's container. */
|
|
574
577
|
containerData?: PluginContainerData;
|
|
575
578
|
/** The source for the file's data. */
|
|
@@ -592,7 +595,7 @@ export interface FileData {
|
|
|
592
595
|
/** File size in KB. */
|
|
593
596
|
sizeInKb?: string | null;
|
|
594
597
|
}
|
|
595
|
-
|
|
598
|
+
declare enum ViewMode {
|
|
596
599
|
/** No PDF view */
|
|
597
600
|
NONE = "NONE",
|
|
598
601
|
/** Full PDF view */
|
|
@@ -600,7 +603,7 @@ export declare enum ViewMode {
|
|
|
600
603
|
/** Mini PDF view */
|
|
601
604
|
MINI = "MINI"
|
|
602
605
|
}
|
|
603
|
-
|
|
606
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
604
607
|
/** The absolute URL for the file's source. */
|
|
605
608
|
url?: string | null;
|
|
606
609
|
/**
|
|
@@ -609,12 +612,12 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
609
612
|
*/
|
|
610
613
|
custom?: string | null;
|
|
611
614
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
612
|
-
|
|
615
|
+
_id?: string | null;
|
|
613
616
|
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
614
617
|
private?: boolean | null;
|
|
615
618
|
}
|
|
616
619
|
/** @oneof */
|
|
617
|
-
|
|
620
|
+
interface FileSourceDataOneOf {
|
|
618
621
|
/** The absolute URL for the file's source. */
|
|
619
622
|
url?: string | null;
|
|
620
623
|
/**
|
|
@@ -623,9 +626,9 @@ export interface FileSourceDataOneOf {
|
|
|
623
626
|
*/
|
|
624
627
|
custom?: string | null;
|
|
625
628
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
626
|
-
|
|
629
|
+
_id?: string | null;
|
|
627
630
|
}
|
|
628
|
-
|
|
631
|
+
interface PDFSettings {
|
|
629
632
|
/**
|
|
630
633
|
* PDF view mode. One of the following:
|
|
631
634
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -638,7 +641,7 @@ export interface PDFSettings {
|
|
|
638
641
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
639
642
|
disablePrint?: boolean | null;
|
|
640
643
|
}
|
|
641
|
-
|
|
644
|
+
interface GalleryData {
|
|
642
645
|
/** Styling for the gallery's container. */
|
|
643
646
|
containerData?: PluginContainerData;
|
|
644
647
|
/** The items in the gallery. */
|
|
@@ -650,7 +653,7 @@ export interface GalleryData {
|
|
|
650
653
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
651
654
|
disableDownload?: boolean | null;
|
|
652
655
|
}
|
|
653
|
-
|
|
656
|
+
interface Media {
|
|
654
657
|
/** The source for the media's data. */
|
|
655
658
|
src?: FileSource;
|
|
656
659
|
/** Media width in pixels. */
|
|
@@ -660,21 +663,21 @@ export interface Media {
|
|
|
660
663
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
661
664
|
duration?: number | null;
|
|
662
665
|
}
|
|
663
|
-
|
|
666
|
+
interface Image {
|
|
664
667
|
/** Image file details. */
|
|
665
668
|
media?: Media;
|
|
666
669
|
/** Link details for images that are links. */
|
|
667
670
|
link?: Link;
|
|
668
671
|
}
|
|
669
|
-
|
|
672
|
+
interface Video {
|
|
670
673
|
/** Video file details. */
|
|
671
674
|
media?: Media;
|
|
672
675
|
/** Video thumbnail file details. */
|
|
673
676
|
thumbnail?: Media;
|
|
674
677
|
}
|
|
675
|
-
|
|
678
|
+
interface Item extends ItemDataOneOf {
|
|
676
679
|
/** An image item. */
|
|
677
|
-
image?:
|
|
680
|
+
image?: Image;
|
|
678
681
|
/** A video item. */
|
|
679
682
|
video?: Video;
|
|
680
683
|
/** Item title. */
|
|
@@ -683,13 +686,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
683
686
|
altText?: string | null;
|
|
684
687
|
}
|
|
685
688
|
/** @oneof */
|
|
686
|
-
|
|
689
|
+
interface ItemDataOneOf {
|
|
687
690
|
/** An image item. */
|
|
688
|
-
image?:
|
|
691
|
+
image?: Image;
|
|
689
692
|
/** A video item. */
|
|
690
693
|
video?: Video;
|
|
691
694
|
}
|
|
692
|
-
|
|
695
|
+
interface GalleryOptions {
|
|
693
696
|
/** Gallery layout. */
|
|
694
697
|
layout?: Layout;
|
|
695
698
|
/** Styling for gallery items. */
|
|
@@ -697,7 +700,7 @@ export interface GalleryOptions {
|
|
|
697
700
|
/** Styling for gallery thumbnail images. */
|
|
698
701
|
thumbnails?: Thumbnails;
|
|
699
702
|
}
|
|
700
|
-
|
|
703
|
+
declare enum LayoutType {
|
|
701
704
|
/** Collage type */
|
|
702
705
|
COLLAGE = "COLLAGE",
|
|
703
706
|
/** Masonry type */
|
|
@@ -719,19 +722,19 @@ export declare enum LayoutType {
|
|
|
719
722
|
/** Fullsize images type */
|
|
720
723
|
FULLSIZE = "FULLSIZE"
|
|
721
724
|
}
|
|
722
|
-
|
|
725
|
+
declare enum Orientation {
|
|
723
726
|
/** Rows Orientation */
|
|
724
727
|
ROWS = "ROWS",
|
|
725
728
|
/** Columns Orientation */
|
|
726
729
|
COLUMNS = "COLUMNS"
|
|
727
730
|
}
|
|
728
|
-
|
|
731
|
+
declare enum Crop {
|
|
729
732
|
/** Crop to fill */
|
|
730
733
|
FILL = "FILL",
|
|
731
734
|
/** Crop to fit */
|
|
732
735
|
FIT = "FIT"
|
|
733
736
|
}
|
|
734
|
-
|
|
737
|
+
declare enum ThumbnailsAlignment {
|
|
735
738
|
/** Top alignment */
|
|
736
739
|
TOP = "TOP",
|
|
737
740
|
/** Right alignment */
|
|
@@ -743,7 +746,7 @@ export declare enum ThumbnailsAlignment {
|
|
|
743
746
|
/** No thumbnail */
|
|
744
747
|
NONE = "NONE"
|
|
745
748
|
}
|
|
746
|
-
|
|
749
|
+
interface Layout {
|
|
747
750
|
/** Gallery layout type. */
|
|
748
751
|
type?: LayoutType;
|
|
749
752
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -755,7 +758,7 @@ export interface Layout {
|
|
|
755
758
|
/** The number of columns to display on mobile screens. */
|
|
756
759
|
mobileNumberOfColumns?: number | null;
|
|
757
760
|
}
|
|
758
|
-
|
|
761
|
+
interface ItemStyle {
|
|
759
762
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
760
763
|
targetSize?: number | null;
|
|
761
764
|
/** Item ratio */
|
|
@@ -765,13 +768,13 @@ export interface ItemStyle {
|
|
|
765
768
|
/** The spacing between items in pixels. */
|
|
766
769
|
spacing?: number | null;
|
|
767
770
|
}
|
|
768
|
-
|
|
771
|
+
interface Thumbnails {
|
|
769
772
|
/** Thumbnail alignment. */
|
|
770
773
|
placement?: ThumbnailsAlignment;
|
|
771
774
|
/** Spacing between thumbnails in pixels. */
|
|
772
775
|
spacing?: number | null;
|
|
773
776
|
}
|
|
774
|
-
|
|
777
|
+
interface GIFData {
|
|
775
778
|
/** Styling for the GIF's container. */
|
|
776
779
|
containerData?: PluginContainerData;
|
|
777
780
|
/** The source of the full size GIF. */
|
|
@@ -785,7 +788,7 @@ export interface GIFData {
|
|
|
785
788
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
786
789
|
gifType?: GIFType;
|
|
787
790
|
}
|
|
788
|
-
|
|
791
|
+
interface GIF {
|
|
789
792
|
/**
|
|
790
793
|
* GIF format URL.
|
|
791
794
|
* @format WEB_URL
|
|
@@ -802,11 +805,11 @@ export interface GIF {
|
|
|
802
805
|
*/
|
|
803
806
|
still?: string | null;
|
|
804
807
|
}
|
|
805
|
-
|
|
808
|
+
declare enum GIFType {
|
|
806
809
|
NORMAL = "NORMAL",
|
|
807
810
|
STICKER = "STICKER"
|
|
808
811
|
}
|
|
809
|
-
|
|
812
|
+
interface HeadingData {
|
|
810
813
|
/** Heading level from 1-6. */
|
|
811
814
|
level?: number;
|
|
812
815
|
/** Styling for the heading text. */
|
|
@@ -814,7 +817,7 @@ export interface HeadingData {
|
|
|
814
817
|
/** Indentation level from 1-4. */
|
|
815
818
|
indentation?: number | null;
|
|
816
819
|
}
|
|
817
|
-
|
|
820
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
818
821
|
/** The URL for the HTML code for the node. */
|
|
819
822
|
url?: string;
|
|
820
823
|
/** The HTML code for the node. */
|
|
@@ -832,7 +835,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
832
835
|
autoHeight?: boolean | null;
|
|
833
836
|
}
|
|
834
837
|
/** @oneof */
|
|
835
|
-
|
|
838
|
+
interface HTMLDataDataOneOf {
|
|
836
839
|
/** The URL for the HTML code for the node. */
|
|
837
840
|
url?: string;
|
|
838
841
|
/** The HTML code for the node. */
|
|
@@ -843,11 +846,11 @@ export interface HTMLDataDataOneOf {
|
|
|
843
846
|
*/
|
|
844
847
|
isAdsense?: boolean | null;
|
|
845
848
|
}
|
|
846
|
-
|
|
849
|
+
declare enum Source {
|
|
847
850
|
HTML = "HTML",
|
|
848
851
|
ADSENSE = "ADSENSE"
|
|
849
852
|
}
|
|
850
|
-
|
|
853
|
+
interface ImageData {
|
|
851
854
|
/** Styling for the image's container. */
|
|
852
855
|
containerData?: PluginContainerData;
|
|
853
856
|
/** Image file details. */
|
|
@@ -870,7 +873,7 @@ export interface ImageData {
|
|
|
870
873
|
/** Styling for the image. */
|
|
871
874
|
styles?: ImageDataStyles;
|
|
872
875
|
}
|
|
873
|
-
|
|
876
|
+
interface StylesBorder {
|
|
874
877
|
/** Border width in pixels. */
|
|
875
878
|
width?: number | null;
|
|
876
879
|
/**
|
|
@@ -881,11 +884,11 @@ export interface StylesBorder {
|
|
|
881
884
|
/** Border radius in pixels. */
|
|
882
885
|
radius?: number | null;
|
|
883
886
|
}
|
|
884
|
-
|
|
887
|
+
interface ImageDataStyles {
|
|
885
888
|
/** Border attributes. */
|
|
886
889
|
border?: StylesBorder;
|
|
887
890
|
}
|
|
888
|
-
|
|
891
|
+
interface LinkPreviewData {
|
|
889
892
|
/** Styling for the link preview's container. */
|
|
890
893
|
containerData?: PluginContainerData;
|
|
891
894
|
/** Link details. */
|
|
@@ -901,7 +904,7 @@ export interface LinkPreviewData {
|
|
|
901
904
|
/** Styling for the link preview. */
|
|
902
905
|
styles?: LinkPreviewDataStyles;
|
|
903
906
|
}
|
|
904
|
-
|
|
907
|
+
declare enum Position {
|
|
905
908
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
906
909
|
START = "START",
|
|
907
910
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -911,7 +914,7 @@ export declare enum Position {
|
|
|
911
914
|
/** Thumbnail hidden and not displayed */
|
|
912
915
|
HIDDEN = "HIDDEN"
|
|
913
916
|
}
|
|
914
|
-
|
|
917
|
+
interface LinkPreviewDataStyles {
|
|
915
918
|
/**
|
|
916
919
|
* Background color as a hexadecimal value.
|
|
917
920
|
* @format COLOR_HEX
|
|
@@ -944,13 +947,13 @@ export interface LinkPreviewDataStyles {
|
|
|
944
947
|
/** Position of thumbnail. Defaults to `START`. */
|
|
945
948
|
thumbnailPosition?: Position;
|
|
946
949
|
}
|
|
947
|
-
|
|
950
|
+
interface MapData {
|
|
948
951
|
/** Styling for the map's container. */
|
|
949
952
|
containerData?: PluginContainerData;
|
|
950
953
|
/** Map settings. */
|
|
951
954
|
mapSettings?: MapSettings;
|
|
952
955
|
}
|
|
953
|
-
|
|
956
|
+
interface MapSettings {
|
|
954
957
|
/** The address to display on the map. */
|
|
955
958
|
address?: string | null;
|
|
956
959
|
/** Sets whether the map is draggable. */
|
|
@@ -974,7 +977,7 @@ export interface MapSettings {
|
|
|
974
977
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
975
978
|
mapType?: MapType;
|
|
976
979
|
}
|
|
977
|
-
|
|
980
|
+
declare enum MapType {
|
|
978
981
|
/** Roadmap map type */
|
|
979
982
|
ROADMAP = "ROADMAP",
|
|
980
983
|
/** Satellite map type */
|
|
@@ -984,7 +987,7 @@ export declare enum MapType {
|
|
|
984
987
|
/** Terrain map type */
|
|
985
988
|
TERRAIN = "TERRAIN"
|
|
986
989
|
}
|
|
987
|
-
|
|
990
|
+
interface ParagraphData {
|
|
988
991
|
/** Styling for the paragraph text. */
|
|
989
992
|
textStyle?: TextStyle;
|
|
990
993
|
/** Indentation level from 1-4. */
|
|
@@ -992,7 +995,7 @@ export interface ParagraphData {
|
|
|
992
995
|
/** Paragraph level */
|
|
993
996
|
level?: number | null;
|
|
994
997
|
}
|
|
995
|
-
|
|
998
|
+
interface PollData {
|
|
996
999
|
/** Styling for the poll's container. */
|
|
997
1000
|
containerData?: PluginContainerData;
|
|
998
1001
|
/** Poll data. */
|
|
@@ -1002,7 +1005,7 @@ export interface PollData {
|
|
|
1002
1005
|
/** Styling for the poll and voting options. */
|
|
1003
1006
|
design?: Design;
|
|
1004
1007
|
}
|
|
1005
|
-
|
|
1008
|
+
declare enum ViewRole {
|
|
1006
1009
|
/** Only Poll creator can view the results */
|
|
1007
1010
|
CREATOR = "CREATOR",
|
|
1008
1011
|
/** Anyone who voted can see the results */
|
|
@@ -1010,13 +1013,13 @@ export declare enum ViewRole {
|
|
|
1010
1013
|
/** Anyone can see the results, even if one didn't vote */
|
|
1011
1014
|
EVERYONE = "EVERYONE"
|
|
1012
1015
|
}
|
|
1013
|
-
|
|
1016
|
+
declare enum VoteRole {
|
|
1014
1017
|
/** Logged in member */
|
|
1015
1018
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1016
1019
|
/** Anyone */
|
|
1017
1020
|
ALL = "ALL"
|
|
1018
1021
|
}
|
|
1019
|
-
|
|
1022
|
+
interface Permissions {
|
|
1020
1023
|
/** Sets who can view the poll results. */
|
|
1021
1024
|
view?: ViewRole;
|
|
1022
1025
|
/** Sets who can vote. */
|
|
@@ -1024,15 +1027,15 @@ export interface Permissions {
|
|
|
1024
1027
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1025
1028
|
allowMultipleVotes?: boolean | null;
|
|
1026
1029
|
}
|
|
1027
|
-
|
|
1030
|
+
interface Option {
|
|
1028
1031
|
/** Option ID. */
|
|
1029
|
-
|
|
1032
|
+
_id?: string | null;
|
|
1030
1033
|
/** Option title. */
|
|
1031
1034
|
title?: string | null;
|
|
1032
1035
|
/** The image displayed with the option. */
|
|
1033
1036
|
image?: Media;
|
|
1034
1037
|
}
|
|
1035
|
-
|
|
1038
|
+
interface Settings {
|
|
1036
1039
|
/** Permissions settings for voting. */
|
|
1037
1040
|
permissions?: Permissions;
|
|
1038
1041
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1040,19 +1043,19 @@ export interface Settings {
|
|
|
1040
1043
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1041
1044
|
showVotesCount?: boolean | null;
|
|
1042
1045
|
}
|
|
1043
|
-
|
|
1046
|
+
declare enum PollLayoutType {
|
|
1044
1047
|
/** List */
|
|
1045
1048
|
LIST = "LIST",
|
|
1046
1049
|
/** Grid */
|
|
1047
1050
|
GRID = "GRID"
|
|
1048
1051
|
}
|
|
1049
|
-
|
|
1052
|
+
declare enum PollLayoutDirection {
|
|
1050
1053
|
/** Left-to-right */
|
|
1051
1054
|
LTR = "LTR",
|
|
1052
1055
|
/** Right-to-left */
|
|
1053
1056
|
RTL = "RTL"
|
|
1054
1057
|
}
|
|
1055
|
-
|
|
1058
|
+
interface PollLayout {
|
|
1056
1059
|
/** The layout for displaying the voting options. */
|
|
1057
1060
|
type?: PollLayoutType;
|
|
1058
1061
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1060,11 +1063,11 @@ export interface PollLayout {
|
|
|
1060
1063
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1061
1064
|
enableImage?: boolean | null;
|
|
1062
1065
|
}
|
|
1063
|
-
|
|
1066
|
+
interface OptionLayout {
|
|
1064
1067
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1065
1068
|
enableImage?: boolean | null;
|
|
1066
1069
|
}
|
|
1067
|
-
|
|
1070
|
+
declare enum BackgroundType {
|
|
1068
1071
|
/** Color background type */
|
|
1069
1072
|
COLOR = "COLOR",
|
|
1070
1073
|
/** Image background type */
|
|
@@ -1072,7 +1075,7 @@ export declare enum BackgroundType {
|
|
|
1072
1075
|
/** Gradiant background type */
|
|
1073
1076
|
GRADIENT = "GRADIENT"
|
|
1074
1077
|
}
|
|
1075
|
-
|
|
1078
|
+
interface Gradient {
|
|
1076
1079
|
/** The gradient angle in degrees. */
|
|
1077
1080
|
angle?: number | null;
|
|
1078
1081
|
/**
|
|
@@ -1086,7 +1089,7 @@ export interface Gradient {
|
|
|
1086
1089
|
*/
|
|
1087
1090
|
lastColor?: string | null;
|
|
1088
1091
|
}
|
|
1089
|
-
|
|
1092
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1090
1093
|
/**
|
|
1091
1094
|
* The background color as a hexademical value.
|
|
1092
1095
|
* @format COLOR_HEX
|
|
@@ -1100,7 +1103,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1100
1103
|
type?: BackgroundType;
|
|
1101
1104
|
}
|
|
1102
1105
|
/** @oneof */
|
|
1103
|
-
|
|
1106
|
+
interface BackgroundBackgroundOneOf {
|
|
1104
1107
|
/**
|
|
1105
1108
|
* The background color as a hexademical value.
|
|
1106
1109
|
* @format COLOR_HEX
|
|
@@ -1111,19 +1114,19 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1111
1114
|
/** Details for a gradient background. */
|
|
1112
1115
|
gradient?: Gradient;
|
|
1113
1116
|
}
|
|
1114
|
-
|
|
1117
|
+
interface PollDesign {
|
|
1115
1118
|
/** Background styling. */
|
|
1116
1119
|
background?: Background;
|
|
1117
1120
|
/** Border radius in pixels. */
|
|
1118
1121
|
borderRadius?: number | null;
|
|
1119
1122
|
}
|
|
1120
|
-
|
|
1123
|
+
interface OptionDesign {
|
|
1121
1124
|
/** Border radius in pixels. */
|
|
1122
1125
|
borderRadius?: number | null;
|
|
1123
1126
|
}
|
|
1124
|
-
|
|
1127
|
+
interface Poll {
|
|
1125
1128
|
/** Poll ID. */
|
|
1126
|
-
|
|
1129
|
+
_id?: string | null;
|
|
1127
1130
|
/** Poll title. */
|
|
1128
1131
|
title?: string | null;
|
|
1129
1132
|
/** Poll creator ID. */
|
|
@@ -1135,26 +1138,26 @@ export interface Poll {
|
|
|
1135
1138
|
/** The poll's permissions and display settings. */
|
|
1136
1139
|
settings?: Settings;
|
|
1137
1140
|
}
|
|
1138
|
-
|
|
1141
|
+
interface PollDataLayout {
|
|
1139
1142
|
/** Poll layout settings. */
|
|
1140
1143
|
poll?: PollLayout;
|
|
1141
1144
|
/** Voting otpions layout settings. */
|
|
1142
1145
|
options?: OptionLayout;
|
|
1143
1146
|
}
|
|
1144
|
-
|
|
1147
|
+
interface Design {
|
|
1145
1148
|
/** Styling for the poll. */
|
|
1146
1149
|
poll?: PollDesign;
|
|
1147
1150
|
/** Styling for voting options. */
|
|
1148
1151
|
options?: OptionDesign;
|
|
1149
1152
|
}
|
|
1150
|
-
|
|
1153
|
+
interface TextData {
|
|
1151
1154
|
/** The text to apply decorations to. */
|
|
1152
1155
|
text?: string;
|
|
1153
1156
|
/** The decorations to apply. */
|
|
1154
1157
|
decorations?: Decoration[];
|
|
1155
1158
|
}
|
|
1156
1159
|
/** Adds appearence changes to text */
|
|
1157
|
-
|
|
1160
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1158
1161
|
/** Data for an anchor link decoration. */
|
|
1159
1162
|
anchorData?: AnchorData;
|
|
1160
1163
|
/** Data for a color decoration. */
|
|
@@ -1177,7 +1180,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1177
1180
|
type?: DecorationType;
|
|
1178
1181
|
}
|
|
1179
1182
|
/** @oneof */
|
|
1180
|
-
|
|
1183
|
+
interface DecorationDataOneOf {
|
|
1181
1184
|
/** Data for an anchor link decoration. */
|
|
1182
1185
|
anchorData?: AnchorData;
|
|
1183
1186
|
/** Data for a color decoration. */
|
|
@@ -1197,7 +1200,7 @@ export interface DecorationDataOneOf {
|
|
|
1197
1200
|
/** Data for a spoiler decoration. */
|
|
1198
1201
|
spoilerData?: SpoilerData;
|
|
1199
1202
|
}
|
|
1200
|
-
|
|
1203
|
+
declare enum DecorationType {
|
|
1201
1204
|
BOLD = "BOLD",
|
|
1202
1205
|
ITALIC = "ITALIC",
|
|
1203
1206
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1209,43 +1212,43 @@ export declare enum DecorationType {
|
|
|
1209
1212
|
FONT_SIZE = "FONT_SIZE",
|
|
1210
1213
|
EXTERNAL = "EXTERNAL"
|
|
1211
1214
|
}
|
|
1212
|
-
|
|
1215
|
+
interface AnchorData {
|
|
1213
1216
|
/** The target node's ID. */
|
|
1214
1217
|
anchor?: string;
|
|
1215
1218
|
}
|
|
1216
|
-
|
|
1219
|
+
interface ColorData {
|
|
1217
1220
|
/** The text's background color as a hexadecimal value. */
|
|
1218
1221
|
background?: string | null;
|
|
1219
1222
|
/** The text's foreground color as a hexadecimal value. */
|
|
1220
1223
|
foreground?: string | null;
|
|
1221
1224
|
}
|
|
1222
|
-
|
|
1225
|
+
interface LinkData {
|
|
1223
1226
|
/** Link details. */
|
|
1224
1227
|
link?: Link;
|
|
1225
1228
|
}
|
|
1226
|
-
|
|
1229
|
+
interface MentionData {
|
|
1227
1230
|
/** The mentioned user's name. */
|
|
1228
1231
|
name?: string;
|
|
1229
1232
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1230
1233
|
slug?: string;
|
|
1231
1234
|
/** Mentioned user's ID. */
|
|
1232
|
-
|
|
1235
|
+
_id?: string | null;
|
|
1233
1236
|
}
|
|
1234
|
-
|
|
1237
|
+
interface FontSizeData {
|
|
1235
1238
|
/** The units used for the font size. */
|
|
1236
1239
|
unit?: FontType;
|
|
1237
1240
|
/** Font size value. */
|
|
1238
1241
|
value?: number | null;
|
|
1239
1242
|
}
|
|
1240
|
-
|
|
1243
|
+
declare enum FontType {
|
|
1241
1244
|
PX = "PX",
|
|
1242
1245
|
EM = "EM"
|
|
1243
1246
|
}
|
|
1244
|
-
|
|
1247
|
+
interface SpoilerData {
|
|
1245
1248
|
/** Spoiler ID. */
|
|
1246
|
-
|
|
1249
|
+
_id?: string | null;
|
|
1247
1250
|
}
|
|
1248
|
-
|
|
1251
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1249
1252
|
/** Data for embedded Wix Bookings content. */
|
|
1250
1253
|
bookingData?: BookingData;
|
|
1251
1254
|
/** Data for embedded Wix Events content. */
|
|
@@ -1267,28 +1270,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1267
1270
|
image?: Media;
|
|
1268
1271
|
}
|
|
1269
1272
|
/** @oneof */
|
|
1270
|
-
|
|
1273
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1271
1274
|
/** Data for embedded Wix Bookings content. */
|
|
1272
1275
|
bookingData?: BookingData;
|
|
1273
1276
|
/** Data for embedded Wix Events content. */
|
|
1274
1277
|
eventData?: EventData;
|
|
1275
1278
|
}
|
|
1276
|
-
|
|
1279
|
+
declare enum AppType {
|
|
1277
1280
|
PRODUCT = "PRODUCT",
|
|
1278
1281
|
EVENT = "EVENT",
|
|
1279
1282
|
BOOKING = "BOOKING"
|
|
1280
1283
|
}
|
|
1281
|
-
|
|
1284
|
+
interface BookingData {
|
|
1282
1285
|
/** Booking duration in minutes. */
|
|
1283
1286
|
durations?: string | null;
|
|
1284
1287
|
}
|
|
1285
|
-
|
|
1288
|
+
interface EventData {
|
|
1286
1289
|
/** Event schedule. */
|
|
1287
1290
|
scheduling?: string | null;
|
|
1288
1291
|
/** Event location. */
|
|
1289
1292
|
location?: string | null;
|
|
1290
1293
|
}
|
|
1291
|
-
|
|
1294
|
+
interface VideoData {
|
|
1292
1295
|
/** Styling for the video's container. */
|
|
1293
1296
|
containerData?: PluginContainerData;
|
|
1294
1297
|
/** Video details. */
|
|
@@ -1302,7 +1305,7 @@ export interface VideoData {
|
|
|
1302
1305
|
/** Video options. */
|
|
1303
1306
|
options?: PlaybackOptions;
|
|
1304
1307
|
}
|
|
1305
|
-
|
|
1308
|
+
interface PlaybackOptions {
|
|
1306
1309
|
/** Sets whether the media will automatically start playing. */
|
|
1307
1310
|
autoPlay?: boolean | null;
|
|
1308
1311
|
/** Sets whether media's will be looped. */
|
|
@@ -1310,7 +1313,7 @@ export interface PlaybackOptions {
|
|
|
1310
1313
|
/** Sets whether media's controls will be shown. */
|
|
1311
1314
|
showControls?: boolean | null;
|
|
1312
1315
|
}
|
|
1313
|
-
|
|
1316
|
+
interface EmbedData {
|
|
1314
1317
|
/** Styling for the oEmbed node's container. */
|
|
1315
1318
|
containerData?: PluginContainerData;
|
|
1316
1319
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1318,7 +1321,7 @@ export interface EmbedData {
|
|
|
1318
1321
|
/** Origin asset source. */
|
|
1319
1322
|
src?: string | null;
|
|
1320
1323
|
}
|
|
1321
|
-
|
|
1324
|
+
interface Oembed {
|
|
1322
1325
|
/** The resource type. */
|
|
1323
1326
|
type?: string | null;
|
|
1324
1327
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1350,7 +1353,7 @@ export interface Oembed {
|
|
|
1350
1353
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1351
1354
|
version?: string | null;
|
|
1352
1355
|
}
|
|
1353
|
-
|
|
1356
|
+
interface CollapsibleListData {
|
|
1354
1357
|
/** Styling for the collapsible list's container. */
|
|
1355
1358
|
containerData?: PluginContainerData;
|
|
1356
1359
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1362,7 +1365,7 @@ export interface CollapsibleListData {
|
|
|
1362
1365
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1363
1366
|
isQapageData?: boolean | null;
|
|
1364
1367
|
}
|
|
1365
|
-
|
|
1368
|
+
declare enum InitialExpandedItems {
|
|
1366
1369
|
/** First item will be expended initally */
|
|
1367
1370
|
FIRST = "FIRST",
|
|
1368
1371
|
/** All items will expended initally */
|
|
@@ -1370,13 +1373,13 @@ export declare enum InitialExpandedItems {
|
|
|
1370
1373
|
/** All items collapsed initally */
|
|
1371
1374
|
NONE = "NONE"
|
|
1372
1375
|
}
|
|
1373
|
-
|
|
1376
|
+
declare enum Direction {
|
|
1374
1377
|
/** Left-to-right */
|
|
1375
1378
|
LTR = "LTR",
|
|
1376
1379
|
/** Right-to-left */
|
|
1377
1380
|
RTL = "RTL"
|
|
1378
1381
|
}
|
|
1379
|
-
|
|
1382
|
+
interface TableData {
|
|
1380
1383
|
/** Styling for the table's container. */
|
|
1381
1384
|
containerData?: PluginContainerData;
|
|
1382
1385
|
/** The table's dimensions. */
|
|
@@ -1391,7 +1394,7 @@ export interface TableData {
|
|
|
1391
1394
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1392
1395
|
columnHeader?: boolean | null;
|
|
1393
1396
|
}
|
|
1394
|
-
|
|
1397
|
+
interface Dimensions {
|
|
1395
1398
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1396
1399
|
colsWidthRatio?: number[];
|
|
1397
1400
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1399,13 +1402,13 @@ export interface Dimensions {
|
|
|
1399
1402
|
/** An array representing the minimum width of each column in pixels. */
|
|
1400
1403
|
colsMinWidth?: number[];
|
|
1401
1404
|
}
|
|
1402
|
-
|
|
1405
|
+
interface TableCellData {
|
|
1403
1406
|
/** Styling for the cell's background color and text alignment. */
|
|
1404
1407
|
cellStyle?: CellStyle;
|
|
1405
1408
|
/** The cell's border colors. */
|
|
1406
1409
|
borderColors?: BorderColors;
|
|
1407
1410
|
}
|
|
1408
|
-
|
|
1411
|
+
declare enum VerticalAlignment {
|
|
1409
1412
|
/** Top alignment */
|
|
1410
1413
|
TOP = "TOP",
|
|
1411
1414
|
/** Middle alignment */
|
|
@@ -1413,7 +1416,7 @@ export declare enum VerticalAlignment {
|
|
|
1413
1416
|
/** Bottom alignment */
|
|
1414
1417
|
BOTTOM = "BOTTOM"
|
|
1415
1418
|
}
|
|
1416
|
-
|
|
1419
|
+
interface CellStyle {
|
|
1417
1420
|
/** Vertical alignment for the cell's text. */
|
|
1418
1421
|
verticalAlignment?: VerticalAlignment;
|
|
1419
1422
|
/**
|
|
@@ -1422,7 +1425,7 @@ export interface CellStyle {
|
|
|
1422
1425
|
*/
|
|
1423
1426
|
backgroundColor?: string | null;
|
|
1424
1427
|
}
|
|
1425
|
-
|
|
1428
|
+
interface BorderColors {
|
|
1426
1429
|
/**
|
|
1427
1430
|
* Left border color as a hexadecimal value.
|
|
1428
1431
|
* @format COLOR_HEX
|
|
@@ -1450,7 +1453,7 @@ export interface BorderColors {
|
|
|
1450
1453
|
*
|
|
1451
1454
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1452
1455
|
*/
|
|
1453
|
-
|
|
1456
|
+
declare enum NullValue {
|
|
1454
1457
|
/** Null value. */
|
|
1455
1458
|
NULL_VALUE = "NULL_VALUE"
|
|
1456
1459
|
}
|
|
@@ -1459,11 +1462,11 @@ export declare enum NullValue {
|
|
|
1459
1462
|
*
|
|
1460
1463
|
* The JSON representation for `ListValue` is JSON array.
|
|
1461
1464
|
*/
|
|
1462
|
-
|
|
1465
|
+
interface ListValue {
|
|
1463
1466
|
/** Repeated field of dynamically typed values. */
|
|
1464
1467
|
values?: any[];
|
|
1465
1468
|
}
|
|
1466
|
-
|
|
1469
|
+
interface AudioData {
|
|
1467
1470
|
/** Styling for the audio node's container. */
|
|
1468
1471
|
containerData?: PluginContainerData;
|
|
1469
1472
|
/** Audio file details. */
|
|
@@ -1479,7 +1482,7 @@ export interface AudioData {
|
|
|
1479
1482
|
/** An HTML version of the audio node. */
|
|
1480
1483
|
html?: string | null;
|
|
1481
1484
|
}
|
|
1482
|
-
|
|
1485
|
+
interface OrderedListData {
|
|
1483
1486
|
/** Indentation level from 0-4. */
|
|
1484
1487
|
indentation?: number;
|
|
1485
1488
|
/** Offset level from 0-4. */
|
|
@@ -1487,24 +1490,24 @@ export interface OrderedListData {
|
|
|
1487
1490
|
/** List start number. */
|
|
1488
1491
|
start?: number | null;
|
|
1489
1492
|
}
|
|
1490
|
-
|
|
1493
|
+
interface BulletedListData {
|
|
1491
1494
|
/** Indentation level from 0-4. */
|
|
1492
1495
|
indentation?: number;
|
|
1493
1496
|
/** Offset level from 0-4. */
|
|
1494
1497
|
offset?: number | null;
|
|
1495
1498
|
}
|
|
1496
|
-
|
|
1499
|
+
interface BlockquoteData {
|
|
1497
1500
|
/** Indentation level from 1-4. */
|
|
1498
1501
|
indentation?: number;
|
|
1499
1502
|
}
|
|
1500
|
-
|
|
1503
|
+
interface CaptionData {
|
|
1501
1504
|
textStyle?: TextStyle;
|
|
1502
1505
|
}
|
|
1503
|
-
|
|
1506
|
+
interface LayoutCellData {
|
|
1504
1507
|
/** Size of the cell in 12 columns grid. */
|
|
1505
1508
|
colSpan?: number | null;
|
|
1506
1509
|
}
|
|
1507
|
-
|
|
1510
|
+
interface Metadata {
|
|
1508
1511
|
/** Schema version. */
|
|
1509
1512
|
version?: number;
|
|
1510
1513
|
/**
|
|
@@ -1519,9 +1522,9 @@ export interface Metadata {
|
|
|
1519
1522
|
*/
|
|
1520
1523
|
updatedTimestamp?: Date | null;
|
|
1521
1524
|
/** Object ID. */
|
|
1522
|
-
|
|
1525
|
+
_id?: string | null;
|
|
1523
1526
|
}
|
|
1524
|
-
|
|
1527
|
+
interface DocumentStyle {
|
|
1525
1528
|
/** Styling for H1 nodes. */
|
|
1526
1529
|
headerOne?: TextNodeStyle;
|
|
1527
1530
|
/** Styling for H2 nodes. */
|
|
@@ -1541,7 +1544,7 @@ export interface DocumentStyle {
|
|
|
1541
1544
|
/** Styling for code block nodes. */
|
|
1542
1545
|
codeBlock?: TextNodeStyle;
|
|
1543
1546
|
}
|
|
1544
|
-
|
|
1547
|
+
interface TextNodeStyle {
|
|
1545
1548
|
/** The decorations to apply to the node. */
|
|
1546
1549
|
decorations?: Decoration[];
|
|
1547
1550
|
/** Padding and background color for the node. */
|
|
@@ -1549,7 +1552,7 @@ export interface TextNodeStyle {
|
|
|
1549
1552
|
/** Line height for text in the node. */
|
|
1550
1553
|
lineHeight?: string | null;
|
|
1551
1554
|
}
|
|
1552
|
-
|
|
1555
|
+
interface Mention extends MentionIdentityOneOf {
|
|
1553
1556
|
/**
|
|
1554
1557
|
* Wix user ID.
|
|
1555
1558
|
* @format GUID
|
|
@@ -1572,7 +1575,7 @@ export interface Mention extends MentionIdentityOneOf {
|
|
|
1572
1575
|
groupId?: string | null;
|
|
1573
1576
|
}
|
|
1574
1577
|
/** @oneof */
|
|
1575
|
-
|
|
1578
|
+
interface MentionIdentityOneOf {
|
|
1576
1579
|
/**
|
|
1577
1580
|
* Wix user ID.
|
|
1578
1581
|
* @format GUID
|
|
@@ -1594,15 +1597,15 @@ export interface MentionIdentityOneOf {
|
|
|
1594
1597
|
*/
|
|
1595
1598
|
groupId?: string | null;
|
|
1596
1599
|
}
|
|
1597
|
-
|
|
1600
|
+
interface Attachment extends AttachmentMediaOneOf {
|
|
1598
1601
|
/** Information about the image. */
|
|
1599
|
-
image?:
|
|
1602
|
+
image?: string;
|
|
1600
1603
|
/** Information about the video. */
|
|
1601
|
-
video?:
|
|
1604
|
+
video?: string;
|
|
1602
1605
|
/** Information about the audio. */
|
|
1603
|
-
audio?:
|
|
1606
|
+
audio?: string;
|
|
1604
1607
|
/** Information about the document. */
|
|
1605
|
-
document?:
|
|
1608
|
+
document?: string;
|
|
1606
1609
|
/**
|
|
1607
1610
|
* Mime type of attachment.
|
|
1608
1611
|
* @maxLength 3000
|
|
@@ -1610,87 +1613,17 @@ export interface Attachment extends AttachmentMediaOneOf {
|
|
|
1610
1613
|
mimeType?: string | null;
|
|
1611
1614
|
}
|
|
1612
1615
|
/** @oneof */
|
|
1613
|
-
|
|
1616
|
+
interface AttachmentMediaOneOf {
|
|
1614
1617
|
/** Information about the image. */
|
|
1615
|
-
image?:
|
|
1618
|
+
image?: string;
|
|
1616
1619
|
/** Information about the video. */
|
|
1617
|
-
video?:
|
|
1620
|
+
video?: string;
|
|
1618
1621
|
/** Information about the audio. */
|
|
1619
|
-
audio?:
|
|
1622
|
+
audio?: string;
|
|
1620
1623
|
/** Information about the document. */
|
|
1621
|
-
document?:
|
|
1622
|
-
}
|
|
1623
|
-
export interface Image {
|
|
1624
|
-
/** WixMedia image ID. */
|
|
1625
|
-
id?: string;
|
|
1626
|
-
/** Image URL. */
|
|
1627
|
-
url?: string;
|
|
1628
|
-
/**
|
|
1629
|
-
* Original image height.
|
|
1630
|
-
* @readonly
|
|
1631
|
-
*/
|
|
1632
|
-
height?: number;
|
|
1633
|
-
/**
|
|
1634
|
-
* Original image width.
|
|
1635
|
-
* @readonly
|
|
1636
|
-
*/
|
|
1637
|
-
width?: number;
|
|
1638
|
-
/**
|
|
1639
|
-
* Image alt text.
|
|
1640
|
-
* @readonly
|
|
1641
|
-
*/
|
|
1642
|
-
altText?: string | null;
|
|
1643
|
-
/**
|
|
1644
|
-
* Image URL expiration date (when relevant).
|
|
1645
|
-
* @readonly
|
|
1646
|
-
*/
|
|
1647
|
-
urlExpirationDate?: Date | null;
|
|
1648
|
-
/**
|
|
1649
|
-
* Image filename.
|
|
1650
|
-
* @readonly
|
|
1651
|
-
*/
|
|
1652
|
-
filename?: string | null;
|
|
1653
|
-
/**
|
|
1654
|
-
* Image size in bytes.
|
|
1655
|
-
* @readonly
|
|
1656
|
-
* @format DECIMAL_VALUE
|
|
1657
|
-
*/
|
|
1658
|
-
sizeInBytes?: string | null;
|
|
1624
|
+
document?: string;
|
|
1659
1625
|
}
|
|
1660
|
-
|
|
1661
|
-
/** WixMedia ID. */
|
|
1662
|
-
id?: string;
|
|
1663
|
-
/** Original video URL. */
|
|
1664
|
-
url?: string;
|
|
1665
|
-
/**
|
|
1666
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
1667
|
-
* @readonly
|
|
1668
|
-
* @maxSize 100
|
|
1669
|
-
*/
|
|
1670
|
-
resolutions?: VideoResolution[];
|
|
1671
|
-
/**
|
|
1672
|
-
* Video filename.
|
|
1673
|
-
* @readonly
|
|
1674
|
-
*/
|
|
1675
|
-
filename?: string | null;
|
|
1676
|
-
/**
|
|
1677
|
-
* Video posters.
|
|
1678
|
-
* @readonly
|
|
1679
|
-
*/
|
|
1680
|
-
posters?: Image[];
|
|
1681
|
-
/**
|
|
1682
|
-
* Original video size in bytes.
|
|
1683
|
-
* @readonly
|
|
1684
|
-
* @format DECIMAL_VALUE
|
|
1685
|
-
*/
|
|
1686
|
-
sizeInBytes?: string | null;
|
|
1687
|
-
/**
|
|
1688
|
-
* Video URL expiration date (when relevant).
|
|
1689
|
-
* @readonly
|
|
1690
|
-
*/
|
|
1691
|
-
urlExpirationDate?: Date | null;
|
|
1692
|
-
}
|
|
1693
|
-
export interface VideoResolution {
|
|
1626
|
+
interface VideoResolution {
|
|
1694
1627
|
/** Video URL. */
|
|
1695
1628
|
url?: string;
|
|
1696
1629
|
/** Video height. */
|
|
@@ -1729,80 +1662,7 @@ export interface VideoResolution {
|
|
|
1729
1662
|
*/
|
|
1730
1663
|
assetKey?: string | null;
|
|
1731
1664
|
}
|
|
1732
|
-
|
|
1733
|
-
/** WixMedia ID. */
|
|
1734
|
-
id?: string;
|
|
1735
|
-
/** Audio URL. */
|
|
1736
|
-
url?: string;
|
|
1737
|
-
/**
|
|
1738
|
-
* Audio URL expiration date (when relevant).
|
|
1739
|
-
* @readonly
|
|
1740
|
-
*/
|
|
1741
|
-
urlExpirationDate?: Date | null;
|
|
1742
|
-
/**
|
|
1743
|
-
* Audio size in bytes.
|
|
1744
|
-
* @readonly
|
|
1745
|
-
* @format DECIMAL_VALUE
|
|
1746
|
-
*/
|
|
1747
|
-
sizeInBytes?: string | null;
|
|
1748
|
-
/**
|
|
1749
|
-
* Audio filename.
|
|
1750
|
-
* @readonly
|
|
1751
|
-
*/
|
|
1752
|
-
filename?: string | null;
|
|
1753
|
-
/**
|
|
1754
|
-
* Audio duration in seconds.
|
|
1755
|
-
* @readonly
|
|
1756
|
-
*/
|
|
1757
|
-
duration?: number | null;
|
|
1758
|
-
/**
|
|
1759
|
-
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
1760
|
-
* In order to access private assets, make a request to:
|
|
1761
|
-
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
1762
|
-
* @readonly
|
|
1763
|
-
*/
|
|
1764
|
-
private?: boolean | null;
|
|
1765
|
-
/**
|
|
1766
|
-
* Key to identify the object relationship to the original media in WixMedia.
|
|
1767
|
-
* Can be used to request a download for the specific asset.
|
|
1768
|
-
* For example: 128-30kbs.mp3, 320kbs.mp3, 128kbs.mp3
|
|
1769
|
-
* @readonly
|
|
1770
|
-
*/
|
|
1771
|
-
assetKey?: string | null;
|
|
1772
|
-
/**
|
|
1773
|
-
* Audio format.
|
|
1774
|
-
* @readonly
|
|
1775
|
-
*/
|
|
1776
|
-
format?: string | null;
|
|
1777
|
-
/**
|
|
1778
|
-
* Audio quality.
|
|
1779
|
-
* @readonly
|
|
1780
|
-
*/
|
|
1781
|
-
quality?: string | null;
|
|
1782
|
-
}
|
|
1783
|
-
export interface Document {
|
|
1784
|
-
/** WixMedia ID. */
|
|
1785
|
-
id?: string;
|
|
1786
|
-
/** Document URL. */
|
|
1787
|
-
url?: string;
|
|
1788
|
-
/**
|
|
1789
|
-
* Document URL expiration date (when relevant).
|
|
1790
|
-
* @readonly
|
|
1791
|
-
*/
|
|
1792
|
-
urlExpirationDate?: Date | null;
|
|
1793
|
-
/**
|
|
1794
|
-
* Document size in bytes.
|
|
1795
|
-
* @readonly
|
|
1796
|
-
* @format DECIMAL_VALUE
|
|
1797
|
-
*/
|
|
1798
|
-
sizeInBytes?: string | null;
|
|
1799
|
-
/**
|
|
1800
|
-
* Document filename.
|
|
1801
|
-
* @readonly
|
|
1802
|
-
*/
|
|
1803
|
-
filename?: string | null;
|
|
1804
|
-
}
|
|
1805
|
-
export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1665
|
+
interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1806
1666
|
/**
|
|
1807
1667
|
* Wix user ID.
|
|
1808
1668
|
* @format GUID
|
|
@@ -1825,7 +1685,7 @@ export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
|
1825
1685
|
appId?: string | null;
|
|
1826
1686
|
}
|
|
1827
1687
|
/** @oneof */
|
|
1828
|
-
|
|
1688
|
+
interface ContentAuthorAuthorOneOf {
|
|
1829
1689
|
/**
|
|
1830
1690
|
* Wix user ID.
|
|
1831
1691
|
* @format GUID
|
|
@@ -1847,7 +1707,7 @@ export interface ContentAuthorAuthorOneOf {
|
|
|
1847
1707
|
*/
|
|
1848
1708
|
appId?: string | null;
|
|
1849
1709
|
}
|
|
1850
|
-
|
|
1710
|
+
interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1851
1711
|
/**
|
|
1852
1712
|
* Wix user ID.
|
|
1853
1713
|
* @format GUID
|
|
@@ -1865,7 +1725,7 @@ export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1865
1725
|
visitorId?: string | null;
|
|
1866
1726
|
}
|
|
1867
1727
|
/** @oneof */
|
|
1868
|
-
|
|
1728
|
+
interface CommentAuthorIdentityOneOf {
|
|
1869
1729
|
/**
|
|
1870
1730
|
* Wix user ID.
|
|
1871
1731
|
* @format GUID
|
|
@@ -1882,13 +1742,13 @@ export interface CommentAuthorIdentityOneOf {
|
|
|
1882
1742
|
*/
|
|
1883
1743
|
visitorId?: string | null;
|
|
1884
1744
|
}
|
|
1885
|
-
|
|
1745
|
+
interface ParentComment {
|
|
1886
1746
|
/**
|
|
1887
1747
|
* Comment ID of the parent comment.
|
|
1888
1748
|
* @format GUID
|
|
1889
1749
|
* @immutable
|
|
1890
1750
|
*/
|
|
1891
|
-
|
|
1751
|
+
_id?: string | null;
|
|
1892
1752
|
/**
|
|
1893
1753
|
* Author of the parent comment.
|
|
1894
1754
|
* @readonly
|
|
@@ -1900,7 +1760,7 @@ export interface ParentComment {
|
|
|
1900
1760
|
*/
|
|
1901
1761
|
status?: Status;
|
|
1902
1762
|
}
|
|
1903
|
-
|
|
1763
|
+
declare enum Status {
|
|
1904
1764
|
/** Unknown status. */
|
|
1905
1765
|
UNKNOWN = "UNKNOWN",
|
|
1906
1766
|
/** This comment is published and publicly visible. */
|
|
@@ -1912,7 +1772,7 @@ export declare enum Status {
|
|
|
1912
1772
|
/** This comment has been hidden by a site moderator. */
|
|
1913
1773
|
HIDDEN = "HIDDEN"
|
|
1914
1774
|
}
|
|
1915
|
-
|
|
1775
|
+
interface VoteSummary {
|
|
1916
1776
|
/** Number of upvotes less downvotes on this comment. */
|
|
1917
1777
|
netVoteCount?: number;
|
|
1918
1778
|
/** Number of upvotes on this comment. */
|
|
@@ -1920,7 +1780,7 @@ export interface VoteSummary {
|
|
|
1920
1780
|
/** Number of downvotes on this comment. */
|
|
1921
1781
|
downvoteCount?: number;
|
|
1922
1782
|
}
|
|
1923
|
-
|
|
1783
|
+
interface CommentReactionSummary {
|
|
1924
1784
|
/** Total amount of reactions. */
|
|
1925
1785
|
total?: number;
|
|
1926
1786
|
/**
|
|
@@ -1929,7 +1789,7 @@ export interface CommentReactionSummary {
|
|
|
1929
1789
|
*/
|
|
1930
1790
|
reactionCodeCount?: Record<string, number>;
|
|
1931
1791
|
}
|
|
1932
|
-
|
|
1792
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1933
1793
|
/** insert/update documents */
|
|
1934
1794
|
update?: InternalDocumentUpdateOperation;
|
|
1935
1795
|
/** delete by document ids */
|
|
@@ -1970,7 +1830,7 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
|
|
|
1970
1830
|
issuedAt?: Date | null;
|
|
1971
1831
|
}
|
|
1972
1832
|
/** @oneof */
|
|
1973
|
-
|
|
1833
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1974
1834
|
/** insert/update documents */
|
|
1975
1835
|
update?: InternalDocumentUpdateOperation;
|
|
1976
1836
|
/** delete by document ids */
|
|
@@ -1986,39 +1846,39 @@ export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
1986
1846
|
/** delete by document ids with versioning */
|
|
1987
1847
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1988
1848
|
}
|
|
1989
|
-
|
|
1849
|
+
interface InternalDocument {
|
|
1990
1850
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
1991
1851
|
document?: Record<string, any> | null;
|
|
1992
1852
|
}
|
|
1993
|
-
|
|
1853
|
+
interface InternalDocumentUpdateOperation {
|
|
1994
1854
|
/** documents to index or update */
|
|
1995
1855
|
documents?: InternalDocument[];
|
|
1996
1856
|
}
|
|
1997
|
-
|
|
1857
|
+
interface DeleteByIdsOperation {
|
|
1998
1858
|
/** ids of the documents to delete */
|
|
1999
1859
|
documentIds?: string[];
|
|
2000
1860
|
}
|
|
2001
|
-
|
|
1861
|
+
interface DeleteByFilterOperation {
|
|
2002
1862
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2003
1863
|
filter?: Record<string, any> | null;
|
|
2004
1864
|
}
|
|
2005
|
-
|
|
1865
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
2006
1866
|
/** documents matching this filter will be updated */
|
|
2007
1867
|
filter?: Record<string, any> | null;
|
|
2008
1868
|
/** partial document to apply */
|
|
2009
1869
|
document?: InternalDocument;
|
|
2010
1870
|
}
|
|
2011
|
-
|
|
1871
|
+
interface InternalUpdateExistingOperation {
|
|
2012
1872
|
/** documents to update */
|
|
2013
1873
|
documents?: InternalDocument[];
|
|
2014
1874
|
}
|
|
2015
|
-
|
|
1875
|
+
interface VersionedDocumentUpdateOperation {
|
|
2016
1876
|
/** documents to create or overwrite */
|
|
2017
1877
|
documents?: InternalDocument[];
|
|
2018
1878
|
/** versioning mode to use instead of default */
|
|
2019
1879
|
versioningMode?: VersioningMode;
|
|
2020
1880
|
}
|
|
2021
|
-
|
|
1881
|
+
declare enum VersioningMode {
|
|
2022
1882
|
/** use default versioning mode agreed with search team */
|
|
2023
1883
|
DEFAULT = "DEFAULT",
|
|
2024
1884
|
/** execute only if version is greater than existing */
|
|
@@ -2026,11 +1886,11 @@ export declare enum VersioningMode {
|
|
|
2026
1886
|
/** execute only if version is greater or equal to existing */
|
|
2027
1887
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2028
1888
|
}
|
|
2029
|
-
|
|
1889
|
+
interface VersionedDeleteByIdsOperation {
|
|
2030
1890
|
/** ids with version of the documents to delete */
|
|
2031
1891
|
documentIds?: VersionedDocumentId[];
|
|
2032
1892
|
}
|
|
2033
|
-
|
|
1893
|
+
interface VersionedDocumentId {
|
|
2034
1894
|
/** document id */
|
|
2035
1895
|
documentId?: string;
|
|
2036
1896
|
/** document version */
|
|
@@ -2038,11 +1898,11 @@ export interface VersionedDocumentId {
|
|
|
2038
1898
|
/** versioning mode to use instead of default */
|
|
2039
1899
|
versioningMode?: VersioningMode;
|
|
2040
1900
|
}
|
|
2041
|
-
|
|
1901
|
+
interface CommentModerated {
|
|
2042
1902
|
comment?: Comment;
|
|
2043
1903
|
moderationAction?: Action;
|
|
2044
1904
|
}
|
|
2045
|
-
|
|
1905
|
+
declare enum Action {
|
|
2046
1906
|
/** Unknown content. */
|
|
2047
1907
|
UNKNOWN = "UNKNOWN",
|
|
2048
1908
|
/** Approve draft content. */
|
|
@@ -2050,17 +1910,17 @@ export declare enum Action {
|
|
|
2050
1910
|
/** Reject draft content. */
|
|
2051
1911
|
REJECT = "REJECT"
|
|
2052
1912
|
}
|
|
2053
|
-
|
|
1913
|
+
interface CreateCommentRequest {
|
|
2054
1914
|
/** Comment to create. */
|
|
2055
1915
|
comment?: Comment;
|
|
2056
1916
|
}
|
|
2057
|
-
|
|
1917
|
+
interface ContactDetails {
|
|
2058
1918
|
}
|
|
2059
|
-
|
|
1919
|
+
interface CreateCommentResponse {
|
|
2060
1920
|
/** Created comment. */
|
|
2061
1921
|
comment?: Comment;
|
|
2062
1922
|
}
|
|
2063
|
-
|
|
1923
|
+
interface ResourceCommentCountChanged {
|
|
2064
1924
|
/** ID of the app that the comment is added to. */
|
|
2065
1925
|
appId?: string;
|
|
2066
1926
|
/**
|
|
@@ -2078,27 +1938,27 @@ export interface ResourceCommentCountChanged {
|
|
|
2078
1938
|
/** How many comments are published for the resource. */
|
|
2079
1939
|
publishedCommentCount?: number;
|
|
2080
1940
|
}
|
|
2081
|
-
|
|
1941
|
+
interface GetCommentRequest {
|
|
2082
1942
|
/**
|
|
2083
1943
|
* ID of the comment to retrieve.
|
|
2084
1944
|
* @format GUID
|
|
2085
1945
|
*/
|
|
2086
1946
|
commentId: string;
|
|
2087
1947
|
}
|
|
2088
|
-
|
|
1948
|
+
interface GetCommentResponse {
|
|
2089
1949
|
/** Retrieved comment. */
|
|
2090
1950
|
comment?: Comment;
|
|
2091
1951
|
}
|
|
2092
1952
|
/** Comment info to update. */
|
|
2093
|
-
|
|
1953
|
+
interface UpdateCommentRequest {
|
|
2094
1954
|
/** Comment info to update. */
|
|
2095
1955
|
comment?: Comment;
|
|
2096
1956
|
}
|
|
2097
|
-
|
|
1957
|
+
interface UpdateCommentResponse {
|
|
2098
1958
|
/** Updated comment. */
|
|
2099
1959
|
comment?: Comment;
|
|
2100
1960
|
}
|
|
2101
|
-
|
|
1961
|
+
interface CommentContentChanged {
|
|
2102
1962
|
/** Comment ID. */
|
|
2103
1963
|
commentId?: string;
|
|
2104
1964
|
/** Content before the update. */
|
|
@@ -2106,19 +1966,19 @@ export interface CommentContentChanged {
|
|
|
2106
1966
|
/** Content after the update. */
|
|
2107
1967
|
currentContent?: CommentContent;
|
|
2108
1968
|
}
|
|
2109
|
-
|
|
1969
|
+
interface DeleteCommentRequest {
|
|
2110
1970
|
/**
|
|
2111
1971
|
* ID of the comment to delete.
|
|
2112
1972
|
* @format GUID
|
|
2113
1973
|
*/
|
|
2114
1974
|
commentId: string;
|
|
2115
1975
|
}
|
|
2116
|
-
|
|
1976
|
+
interface DeleteCommentResponse {
|
|
2117
1977
|
}
|
|
2118
|
-
|
|
1978
|
+
interface CommentDeleted {
|
|
2119
1979
|
comment?: Comment;
|
|
2120
1980
|
}
|
|
2121
|
-
|
|
1981
|
+
interface ModerateDraftContentRequest {
|
|
2122
1982
|
/**
|
|
2123
1983
|
* ID of the comment to moderate.
|
|
2124
1984
|
* @format GUID
|
|
@@ -2133,20 +1993,20 @@ export interface ModerateDraftContentRequest {
|
|
|
2133
1993
|
/** Draft content action. */
|
|
2134
1994
|
draftContentAction?: Action;
|
|
2135
1995
|
}
|
|
2136
|
-
|
|
1996
|
+
interface ModerateDraftContentResponse {
|
|
2137
1997
|
/** Moderated comment. */
|
|
2138
1998
|
comment?: Comment;
|
|
2139
1999
|
}
|
|
2140
|
-
|
|
2000
|
+
interface CommentPublished {
|
|
2141
2001
|
/** Comment info. */
|
|
2142
2002
|
comment?: Comment;
|
|
2143
2003
|
/** Whether this is the first comment publish. */
|
|
2144
2004
|
firstPublish?: boolean;
|
|
2145
2005
|
}
|
|
2146
|
-
|
|
2006
|
+
interface CommentHidden {
|
|
2147
2007
|
comment?: Comment;
|
|
2148
2008
|
}
|
|
2149
|
-
|
|
2009
|
+
interface QueryCommentsRequest {
|
|
2150
2010
|
/**
|
|
2151
2011
|
* App ID to query comments for.
|
|
2152
2012
|
* @format GUID
|
|
@@ -2155,7 +2015,7 @@ export interface QueryCommentsRequest {
|
|
|
2155
2015
|
/** Query options. */
|
|
2156
2016
|
query: CursorQuery;
|
|
2157
2017
|
}
|
|
2158
|
-
|
|
2018
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2159
2019
|
/**
|
|
2160
2020
|
* Cursor paging options.
|
|
2161
2021
|
*
|
|
@@ -2177,7 +2037,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2177
2037
|
sort?: Sorting[];
|
|
2178
2038
|
}
|
|
2179
2039
|
/** @oneof */
|
|
2180
|
-
|
|
2040
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2181
2041
|
/**
|
|
2182
2042
|
* Cursor paging options.
|
|
2183
2043
|
*
|
|
@@ -2185,7 +2045,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2185
2045
|
*/
|
|
2186
2046
|
cursorPaging?: CursorPaging;
|
|
2187
2047
|
}
|
|
2188
|
-
|
|
2048
|
+
interface Sorting {
|
|
2189
2049
|
/**
|
|
2190
2050
|
* Name of the field to sort by.
|
|
2191
2051
|
* @maxLength 512
|
|
@@ -2194,11 +2054,11 @@ export interface Sorting {
|
|
|
2194
2054
|
/** Sort order. */
|
|
2195
2055
|
order?: SortOrder;
|
|
2196
2056
|
}
|
|
2197
|
-
|
|
2057
|
+
declare enum SortOrder {
|
|
2198
2058
|
ASC = "ASC",
|
|
2199
2059
|
DESC = "DESC"
|
|
2200
2060
|
}
|
|
2201
|
-
|
|
2061
|
+
interface CursorPaging {
|
|
2202
2062
|
/**
|
|
2203
2063
|
* Maximum number of items to return in the results.
|
|
2204
2064
|
* @max 100
|
|
@@ -2213,13 +2073,13 @@ export interface CursorPaging {
|
|
|
2213
2073
|
*/
|
|
2214
2074
|
cursor?: string | null;
|
|
2215
2075
|
}
|
|
2216
|
-
|
|
2076
|
+
interface QueryCommentsResponse {
|
|
2217
2077
|
/** Retrieved comments. */
|
|
2218
2078
|
comments?: Comment[];
|
|
2219
2079
|
/** Paging metadata. */
|
|
2220
2080
|
pagingMetadata?: CursorPagingMetadata;
|
|
2221
2081
|
}
|
|
2222
|
-
|
|
2082
|
+
interface CursorPagingMetadata {
|
|
2223
2083
|
/** Number of items returned in current page. */
|
|
2224
2084
|
count?: number | null;
|
|
2225
2085
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2232,7 +2092,7 @@ export interface CursorPagingMetadata {
|
|
|
2232
2092
|
*/
|
|
2233
2093
|
hasNext?: boolean | null;
|
|
2234
2094
|
}
|
|
2235
|
-
|
|
2095
|
+
interface Cursors {
|
|
2236
2096
|
/**
|
|
2237
2097
|
* Cursor string pointing to the next page in the list of results.
|
|
2238
2098
|
* @maxLength 16000
|
|
@@ -2244,58 +2104,58 @@ export interface Cursors {
|
|
|
2244
2104
|
*/
|
|
2245
2105
|
prev?: string | null;
|
|
2246
2106
|
}
|
|
2247
|
-
|
|
2107
|
+
interface MarkCommentRequest {
|
|
2248
2108
|
/**
|
|
2249
2109
|
* ID of the comment to mark.
|
|
2250
2110
|
* @format GUID
|
|
2251
2111
|
*/
|
|
2252
2112
|
commentId: string;
|
|
2253
2113
|
}
|
|
2254
|
-
|
|
2114
|
+
interface MarkCommentResponse {
|
|
2255
2115
|
/** Marked comment. */
|
|
2256
2116
|
comment?: Comment;
|
|
2257
2117
|
}
|
|
2258
|
-
|
|
2118
|
+
interface CommentMarked {
|
|
2259
2119
|
comment?: Comment;
|
|
2260
2120
|
}
|
|
2261
|
-
|
|
2121
|
+
interface UnmarkCommentRequest {
|
|
2262
2122
|
/**
|
|
2263
2123
|
* ID of the comment to unmark.
|
|
2264
2124
|
* @format GUID
|
|
2265
2125
|
*/
|
|
2266
2126
|
commentId: string;
|
|
2267
2127
|
}
|
|
2268
|
-
|
|
2128
|
+
interface UnmarkCommentResponse {
|
|
2269
2129
|
/** Unmarked comment. */
|
|
2270
2130
|
comment?: Comment;
|
|
2271
2131
|
}
|
|
2272
|
-
|
|
2132
|
+
interface CommentUnmarked {
|
|
2273
2133
|
comment?: Comment;
|
|
2274
2134
|
}
|
|
2275
|
-
|
|
2135
|
+
interface HideCommentRequest {
|
|
2276
2136
|
/**
|
|
2277
2137
|
* ID of the comment to hide.
|
|
2278
2138
|
* @format GUID
|
|
2279
2139
|
*/
|
|
2280
2140
|
commentId: string;
|
|
2281
2141
|
}
|
|
2282
|
-
|
|
2142
|
+
interface HideCommentResponse {
|
|
2283
2143
|
/** Hidden comment. */
|
|
2284
2144
|
comment?: Comment;
|
|
2285
2145
|
}
|
|
2286
|
-
|
|
2146
|
+
interface PublishCommentRequest {
|
|
2287
2147
|
/**
|
|
2288
2148
|
* ID of the comment to publish.
|
|
2289
2149
|
* @format GUID
|
|
2290
2150
|
*/
|
|
2291
2151
|
commentId: string;
|
|
2292
2152
|
}
|
|
2293
|
-
|
|
2153
|
+
interface PublishCommentResponse {
|
|
2294
2154
|
/** Published comment. */
|
|
2295
2155
|
comment?: Comment;
|
|
2296
2156
|
}
|
|
2297
2157
|
/** Count comments options. */
|
|
2298
|
-
|
|
2158
|
+
interface CountCommentsRequest {
|
|
2299
2159
|
/**
|
|
2300
2160
|
* App ID to count the comments of.
|
|
2301
2161
|
* @format GUID
|
|
@@ -2304,11 +2164,11 @@ export interface CountCommentsRequest {
|
|
|
2304
2164
|
/** Filter to identify the comments that need to be counted. */
|
|
2305
2165
|
filter?: Record<string, any> | null;
|
|
2306
2166
|
}
|
|
2307
|
-
|
|
2167
|
+
interface CountCommentsResponse {
|
|
2308
2168
|
/** Number of comments. */
|
|
2309
2169
|
count?: number;
|
|
2310
2170
|
}
|
|
2311
|
-
|
|
2171
|
+
interface ListCommentsByResourceRequest {
|
|
2312
2172
|
/**
|
|
2313
2173
|
* ID of the app from which the comments are listed.
|
|
2314
2174
|
* @format GUID
|
|
@@ -2340,7 +2200,7 @@ export interface ListCommentsByResourceRequest {
|
|
|
2340
2200
|
/** Cursor paging. */
|
|
2341
2201
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2342
2202
|
}
|
|
2343
|
-
|
|
2203
|
+
interface CommentSort {
|
|
2344
2204
|
/** Sort order. */
|
|
2345
2205
|
order?: Order;
|
|
2346
2206
|
/**
|
|
@@ -2350,7 +2210,7 @@ export interface CommentSort {
|
|
|
2350
2210
|
*/
|
|
2351
2211
|
keepMarkedInOriginalOrder?: boolean;
|
|
2352
2212
|
}
|
|
2353
|
-
|
|
2213
|
+
declare enum Order {
|
|
2354
2214
|
/** Unknown order. */
|
|
2355
2215
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2356
2216
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2368,7 +2228,7 @@ export declare enum Order {
|
|
|
2368
2228
|
/** Comments with the lowest rating appear at the top of the list. */
|
|
2369
2229
|
RATING_ASC = "RATING_ASC"
|
|
2370
2230
|
}
|
|
2371
|
-
|
|
2231
|
+
interface ReplySort {
|
|
2372
2232
|
/** Sort order. */
|
|
2373
2233
|
order?: ReplySortOrder;
|
|
2374
2234
|
/**
|
|
@@ -2380,7 +2240,7 @@ export interface ReplySort {
|
|
|
2380
2240
|
*/
|
|
2381
2241
|
keepMarkedInOriginalOrder?: boolean;
|
|
2382
2242
|
}
|
|
2383
|
-
|
|
2243
|
+
declare enum ReplySortOrder {
|
|
2384
2244
|
/** Unknown order. */
|
|
2385
2245
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2386
2246
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2390,7 +2250,7 @@ export declare enum ReplySortOrder {
|
|
|
2390
2250
|
/** Comments with the highest reaction count appear at the top of the list. */
|
|
2391
2251
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2392
2252
|
}
|
|
2393
|
-
|
|
2253
|
+
interface ListCommentsByResourceCursorPaging {
|
|
2394
2254
|
/** Pointer to the next or previous page in the list of results. */
|
|
2395
2255
|
cursor?: string | null;
|
|
2396
2256
|
/**
|
|
@@ -2405,7 +2265,7 @@ export interface ListCommentsByResourceCursorPaging {
|
|
|
2405
2265
|
*/
|
|
2406
2266
|
repliesLimit?: number | null;
|
|
2407
2267
|
}
|
|
2408
|
-
|
|
2268
|
+
interface ListCommentsByResourceResponse {
|
|
2409
2269
|
/** Listed comments. */
|
|
2410
2270
|
comments?: Comment[];
|
|
2411
2271
|
/** Paging metadata. */
|
|
@@ -2413,13 +2273,13 @@ export interface ListCommentsByResourceResponse {
|
|
|
2413
2273
|
/** Listed comment replies. */
|
|
2414
2274
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2415
2275
|
}
|
|
2416
|
-
|
|
2276
|
+
interface RepliesListResponse {
|
|
2417
2277
|
/** Listed comment replies. */
|
|
2418
2278
|
replies?: Comment[];
|
|
2419
2279
|
/** Paging metadata. */
|
|
2420
2280
|
pagingMetadata?: CursorPagingMetadata;
|
|
2421
2281
|
}
|
|
2422
|
-
|
|
2282
|
+
interface GetCommentThreadRequest {
|
|
2423
2283
|
/**
|
|
2424
2284
|
* App ID.
|
|
2425
2285
|
* @maxLength 128
|
|
@@ -2437,7 +2297,7 @@ export interface GetCommentThreadRequest {
|
|
|
2437
2297
|
/** Reply sorting. */
|
|
2438
2298
|
replySort?: ReplySort;
|
|
2439
2299
|
}
|
|
2440
|
-
|
|
2300
|
+
interface GetCommentThreadResponse {
|
|
2441
2301
|
/** Retrieved replies. */
|
|
2442
2302
|
comments?: Comment[];
|
|
2443
2303
|
/** Paging metadata. */
|
|
@@ -2445,7 +2305,7 @@ export interface GetCommentThreadResponse {
|
|
|
2445
2305
|
/** Retrieved replies of a reply. */
|
|
2446
2306
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2447
2307
|
}
|
|
2448
|
-
|
|
2308
|
+
interface BulkPublishCommentRequest {
|
|
2449
2309
|
/**
|
|
2450
2310
|
* ID of the app where to publish the comment.
|
|
2451
2311
|
* @format GUID
|
|
@@ -2454,7 +2314,7 @@ export interface BulkPublishCommentRequest {
|
|
|
2454
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"`}. */
|
|
2455
2315
|
filter: Record<string, any> | null;
|
|
2456
2316
|
}
|
|
2457
|
-
|
|
2317
|
+
interface BulkPublishCommentResponse {
|
|
2458
2318
|
/**
|
|
2459
2319
|
* Job ID.
|
|
2460
2320
|
*
|
|
@@ -2463,7 +2323,7 @@ export interface BulkPublishCommentResponse {
|
|
|
2463
2323
|
*/
|
|
2464
2324
|
jobId?: string;
|
|
2465
2325
|
}
|
|
2466
|
-
|
|
2326
|
+
interface BulkHideCommentRequest {
|
|
2467
2327
|
/**
|
|
2468
2328
|
* ID of the app where to hide the comments.
|
|
2469
2329
|
* @format GUID
|
|
@@ -2472,7 +2332,7 @@ export interface BulkHideCommentRequest {
|
|
|
2472
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"`}. */
|
|
2473
2333
|
filter: Record<string, any> | null;
|
|
2474
2334
|
}
|
|
2475
|
-
|
|
2335
|
+
interface BulkHideCommentResponse {
|
|
2476
2336
|
/**
|
|
2477
2337
|
* Job ID.
|
|
2478
2338
|
*
|
|
@@ -2481,7 +2341,7 @@ export interface BulkHideCommentResponse {
|
|
|
2481
2341
|
*/
|
|
2482
2342
|
jobId?: string;
|
|
2483
2343
|
}
|
|
2484
|
-
|
|
2344
|
+
interface BulkDeleteCommentRequest {
|
|
2485
2345
|
/**
|
|
2486
2346
|
* ID of the app where to delete the comments.
|
|
2487
2347
|
* @format GUID
|
|
@@ -2490,7 +2350,7 @@ export interface BulkDeleteCommentRequest {
|
|
|
2490
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"`}. */
|
|
2491
2351
|
filter: Record<string, any> | null;
|
|
2492
2352
|
}
|
|
2493
|
-
|
|
2353
|
+
interface BulkDeleteCommentResponse {
|
|
2494
2354
|
/**
|
|
2495
2355
|
* Job ID.
|
|
2496
2356
|
*
|
|
@@ -2499,7 +2359,7 @@ export interface BulkDeleteCommentResponse {
|
|
|
2499
2359
|
*/
|
|
2500
2360
|
jobId?: string;
|
|
2501
2361
|
}
|
|
2502
|
-
|
|
2362
|
+
interface BulkModerateDraftContentRequest {
|
|
2503
2363
|
/**
|
|
2504
2364
|
* ID of the app where to moderate the comments.
|
|
2505
2365
|
* @format GUID
|
|
@@ -2510,7 +2370,7 @@ export interface BulkModerateDraftContentRequest {
|
|
|
2510
2370
|
/** Action to do regarding draft content */
|
|
2511
2371
|
draftContentAction: Action;
|
|
2512
2372
|
}
|
|
2513
|
-
|
|
2373
|
+
interface BulkModerateDraftContentResponse {
|
|
2514
2374
|
/**
|
|
2515
2375
|
* Job ID.
|
|
2516
2376
|
*
|
|
@@ -2519,7 +2379,7 @@ export interface BulkModerateDraftContentResponse {
|
|
|
2519
2379
|
*/
|
|
2520
2380
|
jobId?: string;
|
|
2521
2381
|
}
|
|
2522
|
-
|
|
2382
|
+
interface BulkMoveCommentByFilterRequest {
|
|
2523
2383
|
/**
|
|
2524
2384
|
* ID of the app from which to move the comments.
|
|
2525
2385
|
* @format GUID
|
|
@@ -2530,7 +2390,7 @@ export interface BulkMoveCommentByFilterRequest {
|
|
|
2530
2390
|
/** Where to move the comment. */
|
|
2531
2391
|
destination?: Destination;
|
|
2532
2392
|
}
|
|
2533
|
-
|
|
2393
|
+
interface Destination {
|
|
2534
2394
|
/**
|
|
2535
2395
|
* Context ID of where to move the comment to.
|
|
2536
2396
|
* @maxLength 128
|
|
@@ -2542,7 +2402,7 @@ export interface Destination {
|
|
|
2542
2402
|
*/
|
|
2543
2403
|
resourceId?: string;
|
|
2544
2404
|
}
|
|
2545
|
-
|
|
2405
|
+
interface BulkMoveCommentByFilterResponse {
|
|
2546
2406
|
/**
|
|
2547
2407
|
* Job ID.
|
|
2548
2408
|
*
|
|
@@ -2551,11 +2411,11 @@ export interface BulkMoveCommentByFilterResponse {
|
|
|
2551
2411
|
*/
|
|
2552
2412
|
jobId?: string;
|
|
2553
2413
|
}
|
|
2554
|
-
|
|
2414
|
+
interface CommentMoved {
|
|
2555
2415
|
comment?: Comment;
|
|
2556
2416
|
destination?: Destination;
|
|
2557
2417
|
}
|
|
2558
|
-
|
|
2418
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2559
2419
|
createdEvent?: EntityCreatedEvent;
|
|
2560
2420
|
updatedEvent?: EntityUpdatedEvent;
|
|
2561
2421
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2564,7 +2424,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2564
2424
|
* Unique event ID.
|
|
2565
2425
|
* Allows clients to ignore duplicate webhooks.
|
|
2566
2426
|
*/
|
|
2567
|
-
|
|
2427
|
+
_id?: string;
|
|
2568
2428
|
/**
|
|
2569
2429
|
* Assumes actions are also always typed to an entity_type
|
|
2570
2430
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -2598,36 +2458,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2598
2458
|
entityEventSequence?: string | null;
|
|
2599
2459
|
}
|
|
2600
2460
|
/** @oneof */
|
|
2601
|
-
|
|
2461
|
+
interface DomainEventBodyOneOf {
|
|
2602
2462
|
createdEvent?: EntityCreatedEvent;
|
|
2603
2463
|
updatedEvent?: EntityUpdatedEvent;
|
|
2604
2464
|
deletedEvent?: EntityDeletedEvent;
|
|
2605
2465
|
actionEvent?: ActionEvent;
|
|
2606
2466
|
}
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2610
|
-
restoreInfo?: RestoreInfo;
|
|
2467
|
+
interface EntityCreatedEvent {
|
|
2468
|
+
entity?: string;
|
|
2611
2469
|
}
|
|
2612
|
-
|
|
2470
|
+
interface RestoreInfo {
|
|
2613
2471
|
deletedDate?: Date | null;
|
|
2614
2472
|
}
|
|
2615
|
-
|
|
2473
|
+
interface EntityUpdatedEvent {
|
|
2616
2474
|
/**
|
|
2617
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.
|
|
2618
2476
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2619
2477
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2620
2478
|
*/
|
|
2621
|
-
|
|
2479
|
+
currentEntity?: string;
|
|
2622
2480
|
}
|
|
2623
|
-
|
|
2481
|
+
interface EntityDeletedEvent {
|
|
2624
2482
|
/** Entity that was deleted */
|
|
2625
|
-
|
|
2483
|
+
deletedEntity?: string | null;
|
|
2626
2484
|
}
|
|
2627
|
-
|
|
2628
|
-
|
|
2485
|
+
interface ActionEvent {
|
|
2486
|
+
body?: string;
|
|
2629
2487
|
}
|
|
2630
|
-
|
|
2488
|
+
interface MessageEnvelope {
|
|
2631
2489
|
/**
|
|
2632
2490
|
* App instance ID.
|
|
2633
2491
|
* @format GUID
|
|
@@ -2643,7 +2501,7 @@ export interface MessageEnvelope {
|
|
|
2643
2501
|
/** Stringify payload. */
|
|
2644
2502
|
data?: string;
|
|
2645
2503
|
}
|
|
2646
|
-
|
|
2504
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2647
2505
|
/**
|
|
2648
2506
|
* ID of a site visitor that has not logged in to the site.
|
|
2649
2507
|
* @format GUID
|
|
@@ -2668,7 +2526,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2668
2526
|
identityType?: WebhookIdentityType;
|
|
2669
2527
|
}
|
|
2670
2528
|
/** @oneof */
|
|
2671
|
-
|
|
2529
|
+
interface IdentificationDataIdOneOf {
|
|
2672
2530
|
/**
|
|
2673
2531
|
* ID of a site visitor that has not logged in to the site.
|
|
2674
2532
|
* @format GUID
|
|
@@ -2690,372 +2548,332 @@ export interface IdentificationDataIdOneOf {
|
|
|
2690
2548
|
*/
|
|
2691
2549
|
appId?: string;
|
|
2692
2550
|
}
|
|
2693
|
-
|
|
2551
|
+
declare enum WebhookIdentityType {
|
|
2694
2552
|
UNKNOWN = "UNKNOWN",
|
|
2695
2553
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2696
2554
|
MEMBER = "MEMBER",
|
|
2697
2555
|
WIX_USER = "WIX_USER",
|
|
2698
2556
|
APP = "APP"
|
|
2699
2557
|
}
|
|
2700
|
-
interface
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2714
|
-
type: Type;
|
|
2715
|
-
link?: LinkNonNullableFields;
|
|
2716
|
-
}
|
|
2717
|
-
interface TextStyleNonNullableFields {
|
|
2718
|
-
textAlignment: TextAlignment;
|
|
2719
|
-
}
|
|
2720
|
-
interface CodeBlockDataNonNullableFields {
|
|
2721
|
-
textStyle?: TextStyleNonNullableFields;
|
|
2722
|
-
}
|
|
2723
|
-
interface DividerDataNonNullableFields {
|
|
2724
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2725
|
-
lineStyle: LineStyle;
|
|
2726
|
-
width: Width;
|
|
2727
|
-
alignment: Alignment;
|
|
2728
|
-
}
|
|
2729
|
-
interface PDFSettingsNonNullableFields {
|
|
2730
|
-
viewMode: ViewMode;
|
|
2731
|
-
}
|
|
2732
|
-
interface FileDataNonNullableFields {
|
|
2733
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2734
|
-
pdfSettings?: PDFSettingsNonNullableFields;
|
|
2735
|
-
}
|
|
2736
|
-
interface ItemImageNonNullableFields {
|
|
2737
|
-
link?: LinkNonNullableFields;
|
|
2738
|
-
}
|
|
2739
|
-
interface ItemNonNullableFields {
|
|
2740
|
-
image?: ItemImageNonNullableFields;
|
|
2741
|
-
}
|
|
2742
|
-
interface LayoutNonNullableFields {
|
|
2743
|
-
type: LayoutType;
|
|
2744
|
-
orientation: Orientation;
|
|
2745
|
-
}
|
|
2746
|
-
interface ItemStyleNonNullableFields {
|
|
2747
|
-
crop: Crop;
|
|
2748
|
-
}
|
|
2749
|
-
interface ThumbnailsNonNullableFields {
|
|
2750
|
-
placement: ThumbnailsAlignment;
|
|
2751
|
-
}
|
|
2752
|
-
interface GalleryOptionsNonNullableFields {
|
|
2753
|
-
layout?: LayoutNonNullableFields;
|
|
2754
|
-
item?: ItemStyleNonNullableFields;
|
|
2755
|
-
thumbnails?: ThumbnailsNonNullableFields;
|
|
2756
|
-
}
|
|
2757
|
-
interface GalleryDataNonNullableFields {
|
|
2758
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2759
|
-
items: ItemNonNullableFields[];
|
|
2760
|
-
options?: GalleryOptionsNonNullableFields;
|
|
2761
|
-
}
|
|
2762
|
-
interface GIFDataNonNullableFields {
|
|
2763
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2764
|
-
height: number;
|
|
2765
|
-
width: number;
|
|
2766
|
-
gifType: GIFType;
|
|
2767
|
-
}
|
|
2768
|
-
interface HeadingDataNonNullableFields {
|
|
2769
|
-
level: number;
|
|
2770
|
-
textStyle?: TextStyleNonNullableFields;
|
|
2771
|
-
}
|
|
2772
|
-
interface HTMLDataNonNullableFields {
|
|
2773
|
-
url: string;
|
|
2774
|
-
html: string;
|
|
2775
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2776
|
-
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;
|
|
2777
2571
|
}
|
|
2778
|
-
interface
|
|
2779
|
-
|
|
2780
|
-
|
|
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;
|
|
2781
2609
|
}
|
|
2782
|
-
interface
|
|
2783
|
-
|
|
2610
|
+
interface CommentContentChangedEnvelope {
|
|
2611
|
+
data: CommentContentChanged;
|
|
2612
|
+
metadata: EventMetadata;
|
|
2784
2613
|
}
|
|
2785
|
-
interface
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
styles?: LinkPreviewDataStylesNonNullableFields;
|
|
2614
|
+
interface CommentHiddenEnvelope {
|
|
2615
|
+
data: CommentHidden;
|
|
2616
|
+
metadata: EventMetadata;
|
|
2789
2617
|
}
|
|
2790
|
-
interface
|
|
2791
|
-
|
|
2618
|
+
interface CommentMarkedEnvelope {
|
|
2619
|
+
data: CommentMarked;
|
|
2620
|
+
metadata: EventMetadata;
|
|
2792
2621
|
}
|
|
2793
|
-
interface
|
|
2794
|
-
|
|
2795
|
-
|
|
2622
|
+
interface CommentMovedEnvelope {
|
|
2623
|
+
data: CommentMoved;
|
|
2624
|
+
metadata: EventMetadata;
|
|
2796
2625
|
}
|
|
2797
|
-
interface
|
|
2798
|
-
|
|
2626
|
+
interface CommentPublishedEnvelope {
|
|
2627
|
+
data: CommentPublished;
|
|
2628
|
+
metadata: EventMetadata;
|
|
2799
2629
|
}
|
|
2800
|
-
interface
|
|
2801
|
-
|
|
2802
|
-
|
|
2630
|
+
interface CommentUnmarkedEnvelope {
|
|
2631
|
+
data: CommentUnmarked;
|
|
2632
|
+
metadata: EventMetadata;
|
|
2803
2633
|
}
|
|
2804
|
-
interface
|
|
2805
|
-
|
|
2634
|
+
interface CommentCreatedEnvelope {
|
|
2635
|
+
entity: Comment;
|
|
2636
|
+
metadata: EventMetadata;
|
|
2806
2637
|
}
|
|
2807
|
-
interface
|
|
2808
|
-
|
|
2638
|
+
interface CommentResourceCommentCountChangedEnvelope {
|
|
2639
|
+
data: ResourceCommentCountChanged;
|
|
2640
|
+
metadata: EventMetadata;
|
|
2809
2641
|
}
|
|
2810
|
-
interface
|
|
2811
|
-
|
|
2812
|
-
|
|
2642
|
+
interface CommentUpdatedEnvelope {
|
|
2643
|
+
entity: Comment;
|
|
2644
|
+
metadata: EventMetadata;
|
|
2813
2645
|
}
|
|
2814
|
-
interface
|
|
2815
|
-
|
|
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;
|
|
2816
2748
|
}
|
|
2817
|
-
interface
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
interface PollDesignNonNullableFields {
|
|
2821
|
-
background?: BackgroundNonNullableFields;
|
|
2822
|
-
}
|
|
2823
|
-
interface DesignNonNullableFields {
|
|
2824
|
-
poll?: PollDesignNonNullableFields;
|
|
2825
|
-
}
|
|
2826
|
-
interface PollDataNonNullableFields {
|
|
2827
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2828
|
-
poll?: PollNonNullableFields;
|
|
2829
|
-
layout?: PollDataLayoutNonNullableFields;
|
|
2830
|
-
design?: DesignNonNullableFields;
|
|
2831
|
-
}
|
|
2832
|
-
interface AnchorDataNonNullableFields {
|
|
2833
|
-
anchor: string;
|
|
2834
|
-
}
|
|
2835
|
-
interface LinkDataNonNullableFields {
|
|
2836
|
-
link?: LinkNonNullableFields;
|
|
2837
|
-
}
|
|
2838
|
-
interface MentionDataNonNullableFields {
|
|
2839
|
-
name: string;
|
|
2840
|
-
slug: string;
|
|
2841
|
-
}
|
|
2842
|
-
interface FontSizeDataNonNullableFields {
|
|
2843
|
-
unit: FontType;
|
|
2844
|
-
}
|
|
2845
|
-
interface DecorationNonNullableFields {
|
|
2846
|
-
anchorData?: AnchorDataNonNullableFields;
|
|
2847
|
-
linkData?: LinkDataNonNullableFields;
|
|
2848
|
-
mentionData?: MentionDataNonNullableFields;
|
|
2849
|
-
fontSizeData?: FontSizeDataNonNullableFields;
|
|
2850
|
-
type: DecorationType;
|
|
2851
|
-
}
|
|
2852
|
-
interface TextDataNonNullableFields {
|
|
2853
|
-
text: string;
|
|
2854
|
-
decorations: DecorationNonNullableFields[];
|
|
2855
|
-
}
|
|
2856
|
-
interface AppEmbedDataNonNullableFields {
|
|
2857
|
-
type: AppType;
|
|
2858
|
-
}
|
|
2859
|
-
interface VideoDataNonNullableFields {
|
|
2860
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2861
|
-
}
|
|
2862
|
-
interface EmbedDataNonNullableFields {
|
|
2863
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2864
|
-
}
|
|
2865
|
-
interface CollapsibleListDataNonNullableFields {
|
|
2866
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2867
|
-
initialExpandedItems: InitialExpandedItems;
|
|
2868
|
-
direction: Direction;
|
|
2869
|
-
}
|
|
2870
|
-
interface DimensionsNonNullableFields {
|
|
2871
|
-
colsWidthRatio: number[];
|
|
2872
|
-
rowsHeight: number[];
|
|
2873
|
-
colsMinWidth: number[];
|
|
2874
|
-
}
|
|
2875
|
-
interface TableDataNonNullableFields {
|
|
2876
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2877
|
-
dimensions?: DimensionsNonNullableFields;
|
|
2878
|
-
}
|
|
2879
|
-
interface CellStyleNonNullableFields {
|
|
2880
|
-
verticalAlignment: VerticalAlignment;
|
|
2881
|
-
}
|
|
2882
|
-
interface TableCellDataNonNullableFields {
|
|
2883
|
-
cellStyle?: CellStyleNonNullableFields;
|
|
2884
|
-
}
|
|
2885
|
-
interface AudioDataNonNullableFields {
|
|
2886
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
2887
|
-
}
|
|
2888
|
-
interface OrderedListDataNonNullableFields {
|
|
2889
|
-
indentation: number;
|
|
2890
|
-
}
|
|
2891
|
-
interface BulletedListDataNonNullableFields {
|
|
2892
|
-
indentation: number;
|
|
2893
|
-
}
|
|
2894
|
-
interface BlockquoteDataNonNullableFields {
|
|
2895
|
-
indentation: number;
|
|
2896
|
-
}
|
|
2897
|
-
interface CaptionDataNonNullableFields {
|
|
2898
|
-
textStyle?: TextStyleNonNullableFields;
|
|
2899
|
-
}
|
|
2900
|
-
interface NodeNonNullableFields {
|
|
2901
|
-
buttonData?: ButtonDataNonNullableFields;
|
|
2902
|
-
codeBlockData?: CodeBlockDataNonNullableFields;
|
|
2903
|
-
dividerData?: DividerDataNonNullableFields;
|
|
2904
|
-
fileData?: FileDataNonNullableFields;
|
|
2905
|
-
galleryData?: GalleryDataNonNullableFields;
|
|
2906
|
-
gifData?: GIFDataNonNullableFields;
|
|
2907
|
-
headingData?: HeadingDataNonNullableFields;
|
|
2908
|
-
htmlData?: HTMLDataNonNullableFields;
|
|
2909
|
-
imageData?: ImageDataNonNullableFields;
|
|
2910
|
-
linkPreviewData?: LinkPreviewDataNonNullableFields;
|
|
2911
|
-
mapData?: MapDataNonNullableFields;
|
|
2912
|
-
paragraphData?: ParagraphDataNonNullableFields;
|
|
2913
|
-
pollData?: PollDataNonNullableFields;
|
|
2914
|
-
textData?: TextDataNonNullableFields;
|
|
2915
|
-
appEmbedData?: AppEmbedDataNonNullableFields;
|
|
2916
|
-
videoData?: VideoDataNonNullableFields;
|
|
2917
|
-
embedData?: EmbedDataNonNullableFields;
|
|
2918
|
-
collapsibleListData?: CollapsibleListDataNonNullableFields;
|
|
2919
|
-
tableData?: TableDataNonNullableFields;
|
|
2920
|
-
tableCellData?: TableCellDataNonNullableFields;
|
|
2921
|
-
audioData?: AudioDataNonNullableFields;
|
|
2922
|
-
orderedListData?: OrderedListDataNonNullableFields;
|
|
2923
|
-
bulletedListData?: BulletedListDataNonNullableFields;
|
|
2924
|
-
blockquoteData?: BlockquoteDataNonNullableFields;
|
|
2925
|
-
captionData?: CaptionDataNonNullableFields;
|
|
2926
|
-
type: NodeType;
|
|
2927
|
-
id: string;
|
|
2928
|
-
nodes: NodeNonNullableFields[];
|
|
2929
|
-
}
|
|
2930
|
-
interface MetadataNonNullableFields {
|
|
2931
|
-
version: number;
|
|
2932
|
-
}
|
|
2933
|
-
interface TextNodeStyleNonNullableFields {
|
|
2934
|
-
decorations: DecorationNonNullableFields[];
|
|
2935
|
-
}
|
|
2936
|
-
interface DocumentStyleNonNullableFields {
|
|
2937
|
-
headerOne?: TextNodeStyleNonNullableFields;
|
|
2938
|
-
headerTwo?: TextNodeStyleNonNullableFields;
|
|
2939
|
-
headerThree?: TextNodeStyleNonNullableFields;
|
|
2940
|
-
headerFour?: TextNodeStyleNonNullableFields;
|
|
2941
|
-
headerFive?: TextNodeStyleNonNullableFields;
|
|
2942
|
-
headerSix?: TextNodeStyleNonNullableFields;
|
|
2943
|
-
paragraph?: TextNodeStyleNonNullableFields;
|
|
2944
|
-
blockquote?: TextNodeStyleNonNullableFields;
|
|
2945
|
-
codeBlock?: TextNodeStyleNonNullableFields;
|
|
2946
|
-
}
|
|
2947
|
-
interface RichContentNonNullableFields {
|
|
2948
|
-
nodes: NodeNonNullableFields[];
|
|
2949
|
-
metadata?: MetadataNonNullableFields;
|
|
2950
|
-
documentStyle?: DocumentStyleNonNullableFields;
|
|
2951
|
-
}
|
|
2952
|
-
interface ImageNonNullableFields {
|
|
2953
|
-
id: string;
|
|
2954
|
-
url: string;
|
|
2955
|
-
height: number;
|
|
2956
|
-
width: number;
|
|
2957
|
-
}
|
|
2958
|
-
interface VideoResolutionNonNullableFields {
|
|
2959
|
-
url: string;
|
|
2960
|
-
height: number;
|
|
2961
|
-
width: number;
|
|
2962
|
-
format: string;
|
|
2963
|
-
}
|
|
2964
|
-
interface VideoV2NonNullableFields {
|
|
2965
|
-
id: string;
|
|
2966
|
-
url: string;
|
|
2967
|
-
resolutions: VideoResolutionNonNullableFields[];
|
|
2968
|
-
posters: ImageNonNullableFields[];
|
|
2969
|
-
}
|
|
2970
|
-
interface AudioNonNullableFields {
|
|
2971
|
-
id: string;
|
|
2972
|
-
url: string;
|
|
2973
|
-
}
|
|
2974
|
-
interface DocumentNonNullableFields {
|
|
2975
|
-
id: string;
|
|
2976
|
-
url: string;
|
|
2977
|
-
}
|
|
2978
|
-
interface AttachmentNonNullableFields {
|
|
2979
|
-
image?: ImageNonNullableFields;
|
|
2980
|
-
video?: VideoV2NonNullableFields;
|
|
2981
|
-
audio?: AudioNonNullableFields;
|
|
2982
|
-
document?: DocumentNonNullableFields;
|
|
2983
|
-
}
|
|
2984
|
-
interface CommentContentNonNullableFields {
|
|
2985
|
-
richContent?: RichContentNonNullableFields;
|
|
2986
|
-
attachments: AttachmentNonNullableFields[];
|
|
2987
|
-
}
|
|
2988
|
-
interface ParentCommentNonNullableFields {
|
|
2989
|
-
status: Status;
|
|
2990
|
-
}
|
|
2991
|
-
interface VoteSummaryNonNullableFields {
|
|
2992
|
-
netVoteCount: number;
|
|
2993
|
-
upvoteCount: number;
|
|
2994
|
-
downvoteCount: number;
|
|
2995
|
-
}
|
|
2996
|
-
interface CommentReactionSummaryNonNullableFields {
|
|
2997
|
-
total: number;
|
|
2998
|
-
}
|
|
2999
|
-
interface CommentNonNullableFields {
|
|
3000
|
-
content?: CommentContentNonNullableFields;
|
|
3001
|
-
draftContent?: CommentContentNonNullableFields;
|
|
3002
|
-
parentComment?: ParentCommentNonNullableFields;
|
|
3003
|
-
parentIdsInThread: string[];
|
|
3004
|
-
replyCount: number;
|
|
3005
|
-
voteSummary?: VoteSummaryNonNullableFields;
|
|
3006
|
-
status: Status;
|
|
3007
|
-
reactionSummary?: CommentReactionSummaryNonNullableFields;
|
|
3008
|
-
marked: boolean;
|
|
3009
|
-
}
|
|
3010
|
-
export interface CreateCommentResponseNonNullableFields {
|
|
3011
|
-
comment?: CommentNonNullableFields;
|
|
3012
|
-
}
|
|
3013
|
-
export interface GetCommentResponseNonNullableFields {
|
|
3014
|
-
comment?: CommentNonNullableFields;
|
|
3015
|
-
}
|
|
3016
|
-
export interface UpdateCommentResponseNonNullableFields {
|
|
3017
|
-
comment?: CommentNonNullableFields;
|
|
3018
|
-
}
|
|
3019
|
-
export interface ModerateDraftContentResponseNonNullableFields {
|
|
3020
|
-
comment?: CommentNonNullableFields;
|
|
3021
|
-
}
|
|
3022
|
-
export interface QueryCommentsResponseNonNullableFields {
|
|
3023
|
-
comments: CommentNonNullableFields[];
|
|
3024
|
-
}
|
|
3025
|
-
export interface MarkCommentResponseNonNullableFields {
|
|
3026
|
-
comment?: CommentNonNullableFields;
|
|
2749
|
+
interface ModerateDraftContentOptions {
|
|
2750
|
+
/** Draft content action. */
|
|
2751
|
+
draftContentAction?: Action;
|
|
3027
2752
|
}
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
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;
|
|
3039
2813
|
}
|
|
3040
|
-
|
|
3041
|
-
|
|
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;
|
|
3042
2840
|
}
|
|
3043
|
-
|
|
3044
|
-
|
|
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;
|
|
3045
2853
|
}
|
|
3046
|
-
|
|
3047
|
-
|
|
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;
|
|
3048
2857
|
}
|
|
3049
|
-
|
|
3050
|
-
|
|
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;
|
|
3051
2861
|
}
|
|
3052
|
-
|
|
3053
|
-
|
|
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;
|
|
3054
2865
|
}
|
|
3055
|
-
|
|
3056
|
-
|
|
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;
|
|
3057
2871
|
}
|
|
3058
|
-
|
|
3059
|
-
|
|
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;
|
|
3060
2877
|
}
|
|
3061
|
-
|
|
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 };
|