@wix/auto_sdk_comments_comments 1.0.9 → 1.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/cjs/src/comments-v2-comment-comments.context.js +109 -0
- package/build/cjs/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/cjs/src/comments-v2-comment-comments.http.js +2533 -0
- package/build/cjs/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/cjs/src/comments-v2-comment-comments.meta.js +370 -0
- package/build/cjs/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/cjs/src/comments-v2-comment-comments.public.js +1341 -0
- package/build/cjs/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{internal/meta.d.mts → cjs/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/cjs/src/comments-v2-comment-comments.types.js +386 -0
- package/build/cjs/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/{comments-v2-comment-comments.universal-Bt560XJw.d.mts → cjs/src/comments-v2-comment-comments.universal.d.ts} +686 -247
- package/build/cjs/src/comments-v2-comment-comments.universal.js +1599 -0
- package/build/cjs/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/es/src/comments-v2-comment-comments.context.js +68 -0
- package/build/es/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/es/src/comments-v2-comment-comments.http.js +2512 -0
- package/build/es/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/es/src/comments-v2-comment-comments.meta.js +326 -0
- package/build/es/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/es/src/comments-v2-comment-comments.public.js +1282 -0
- package/build/es/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{internal/meta.d.ts → es/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/es/src/comments-v2-comment-comments.types.js +383 -0
- package/build/es/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/{comments-v2-comment-comments.universal-Bt560XJw.d.ts → es/src/comments-v2-comment-comments.universal.d.ts} +686 -247
- package/build/es/src/comments-v2-comment-comments.universal.js +1554 -0
- package/build/es/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js +109 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js +2533 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js +370 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js +1341 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{meta.d.mts → internal/cjs/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js +386 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/internal/{comments-v2-comment-comments.universal-Bt560XJw.d.ts → cjs/src/comments-v2-comment-comments.universal.d.ts} +686 -247
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +1599 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/internal/es/src/comments-v2-comment-comments.context.js +68 -0
- package/build/internal/es/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/internal/es/src/comments-v2-comment-comments.http.js +2512 -0
- package/build/internal/es/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/internal/es/src/comments-v2-comment-comments.meta.js +326 -0
- package/build/internal/es/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/internal/es/src/comments-v2-comment-comments.public.js +1282 -0
- package/build/internal/es/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{meta.d.ts → internal/es/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/internal/es/src/comments-v2-comment-comments.types.js +383 -0
- package/build/internal/es/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/internal/{comments-v2-comment-comments.universal-Bt560XJw.d.mts → es/src/comments-v2-comment-comments.universal.d.ts} +686 -247
- package/build/internal/es/src/comments-v2-comment-comments.universal.js +1554 -0
- package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -249
- package/build/index.d.ts +0 -249
- package/build/index.js +0 -5232
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -5145
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -249
- package/build/internal/index.d.ts +0 -249
- package/build/internal/index.js +0 -5232
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -5145
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js +0 -2832
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -2788
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js +0 -2832
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -2788
- package/build/meta.mjs.map +0 -1
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/**
|
|
2
3
|
* A comment is a user-generated message in response to a specific resource. It allows site visitors
|
|
3
4
|
* to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
|
|
4
5
|
* or other site content. Comments are composed of text, images, videos, or other forms of media.
|
|
5
6
|
*/
|
|
6
|
-
interface Comment {
|
|
7
|
+
export interface Comment {
|
|
7
8
|
/**
|
|
8
9
|
* Comment ID.
|
|
9
10
|
* @format GUID
|
|
@@ -107,7 +108,7 @@ interface Comment {
|
|
|
107
108
|
contentEdited?: boolean | null;
|
|
108
109
|
}
|
|
109
110
|
/** Comment content. */
|
|
110
|
-
interface CommentContent {
|
|
111
|
+
export interface CommentContent {
|
|
111
112
|
/**
|
|
112
113
|
* Comment rich content.
|
|
113
114
|
*
|
|
@@ -129,7 +130,7 @@ interface CommentContent {
|
|
|
129
130
|
*/
|
|
130
131
|
attachments?: Attachment[];
|
|
131
132
|
}
|
|
132
|
-
interface RichContent {
|
|
133
|
+
export interface RichContent {
|
|
133
134
|
/** Node objects representing a rich content document. */
|
|
134
135
|
nodes?: Node[];
|
|
135
136
|
/** Object metadata. */
|
|
@@ -137,7 +138,7 @@ interface RichContent {
|
|
|
137
138
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
138
139
|
documentStyle?: DocumentStyle;
|
|
139
140
|
}
|
|
140
|
-
interface Node extends NodeDataOneOf {
|
|
141
|
+
export interface Node extends NodeDataOneOf {
|
|
141
142
|
/** Data for a button node. */
|
|
142
143
|
buttonData?: ButtonData;
|
|
143
144
|
/** Data for a code block node. */
|
|
@@ -202,7 +203,7 @@ interface Node extends NodeDataOneOf {
|
|
|
202
203
|
style?: NodeStyle;
|
|
203
204
|
}
|
|
204
205
|
/** @oneof */
|
|
205
|
-
interface NodeDataOneOf {
|
|
206
|
+
export interface NodeDataOneOf {
|
|
206
207
|
/** Data for a button node. */
|
|
207
208
|
buttonData?: ButtonData;
|
|
208
209
|
/** Data for a code block node. */
|
|
@@ -258,7 +259,7 @@ interface NodeDataOneOf {
|
|
|
258
259
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
259
260
|
layoutCellData?: LayoutCellData;
|
|
260
261
|
}
|
|
261
|
-
declare enum NodeType {
|
|
262
|
+
export declare enum NodeType {
|
|
262
263
|
PARAGRAPH = "PARAGRAPH",
|
|
263
264
|
TEXT = "TEXT",
|
|
264
265
|
HEADING = "HEADING",
|
|
@@ -294,7 +295,7 @@ declare enum NodeType {
|
|
|
294
295
|
LAYOUT = "LAYOUT",
|
|
295
296
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
296
297
|
}
|
|
297
|
-
interface NodeStyle {
|
|
298
|
+
export interface NodeStyle {
|
|
298
299
|
/** The top padding value in pixels. */
|
|
299
300
|
paddingTop?: string | null;
|
|
300
301
|
/** The bottom padding value in pixels. */
|
|
@@ -302,7 +303,7 @@ interface NodeStyle {
|
|
|
302
303
|
/** The background color as a hexadecimal value. */
|
|
303
304
|
backgroundColor?: string | null;
|
|
304
305
|
}
|
|
305
|
-
interface ButtonData {
|
|
306
|
+
export interface ButtonData {
|
|
306
307
|
/** Styling for the button's container. */
|
|
307
308
|
containerData?: PluginContainerData;
|
|
308
309
|
/** The button type. */
|
|
@@ -314,7 +315,7 @@ interface ButtonData {
|
|
|
314
315
|
/** Button link details. */
|
|
315
316
|
link?: Link;
|
|
316
317
|
}
|
|
317
|
-
interface Border {
|
|
318
|
+
export interface Border {
|
|
318
319
|
/**
|
|
319
320
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
320
321
|
* @deprecated
|
|
@@ -326,7 +327,7 @@ interface Border {
|
|
|
326
327
|
*/
|
|
327
328
|
radius?: number | null;
|
|
328
329
|
}
|
|
329
|
-
interface Colors {
|
|
330
|
+
export interface Colors {
|
|
330
331
|
/**
|
|
331
332
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
332
333
|
* @deprecated
|
|
@@ -343,7 +344,7 @@ interface Colors {
|
|
|
343
344
|
*/
|
|
344
345
|
background?: string | null;
|
|
345
346
|
}
|
|
346
|
-
interface PluginContainerData {
|
|
347
|
+
export interface PluginContainerData {
|
|
347
348
|
/** The width of the node when it's displayed. */
|
|
348
349
|
width?: PluginContainerDataWidth;
|
|
349
350
|
/** The node's alignment within its container. */
|
|
@@ -355,7 +356,7 @@ interface PluginContainerData {
|
|
|
355
356
|
/** 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
357
|
textWrap?: boolean | null;
|
|
357
358
|
}
|
|
358
|
-
declare enum WidthType {
|
|
359
|
+
export declare enum WidthType {
|
|
359
360
|
/** Width matches the content width */
|
|
360
361
|
CONTENT = "CONTENT",
|
|
361
362
|
/** Small Width */
|
|
@@ -365,7 +366,7 @@ declare enum WidthType {
|
|
|
365
366
|
/** coast-to-coast display */
|
|
366
367
|
FULL_WIDTH = "FULL_WIDTH"
|
|
367
368
|
}
|
|
368
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
369
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
369
370
|
/**
|
|
370
371
|
* One of the following predefined width options:
|
|
371
372
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -378,7 +379,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
378
379
|
custom?: string | null;
|
|
379
380
|
}
|
|
380
381
|
/** @oneof */
|
|
381
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
382
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
382
383
|
/**
|
|
383
384
|
* One of the following predefined width options:
|
|
384
385
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -390,7 +391,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
390
391
|
/** A custom width value in pixels. */
|
|
391
392
|
custom?: string | null;
|
|
392
393
|
}
|
|
393
|
-
declare enum PluginContainerDataAlignment {
|
|
394
|
+
export declare enum PluginContainerDataAlignment {
|
|
394
395
|
/** Center Alignment */
|
|
395
396
|
CENTER = "CENTER",
|
|
396
397
|
/** Left Alignment */
|
|
@@ -398,7 +399,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
398
399
|
/** Right Alignment */
|
|
399
400
|
RIGHT = "RIGHT"
|
|
400
401
|
}
|
|
401
|
-
interface Spoiler {
|
|
402
|
+
export interface Spoiler {
|
|
402
403
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
403
404
|
enabled?: boolean | null;
|
|
404
405
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -406,17 +407,17 @@ interface Spoiler {
|
|
|
406
407
|
/** The text for the button used to remove the spoiler cover. */
|
|
407
408
|
buttonText?: string | null;
|
|
408
409
|
}
|
|
409
|
-
interface Height {
|
|
410
|
+
export interface Height {
|
|
410
411
|
/** A custom height value in pixels. */
|
|
411
412
|
custom?: string | null;
|
|
412
413
|
}
|
|
413
|
-
declare enum Type {
|
|
414
|
+
export declare enum Type {
|
|
414
415
|
/** Regular link button */
|
|
415
416
|
LINK = "LINK",
|
|
416
417
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
417
418
|
ACTION = "ACTION"
|
|
418
419
|
}
|
|
419
|
-
interface Styles {
|
|
420
|
+
export interface Styles {
|
|
420
421
|
/**
|
|
421
422
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
422
423
|
* @deprecated
|
|
@@ -469,7 +470,7 @@ interface Styles {
|
|
|
469
470
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
470
471
|
buttonSize?: string | null;
|
|
471
472
|
}
|
|
472
|
-
interface Link extends LinkDataOneOf {
|
|
473
|
+
export interface Link extends LinkDataOneOf {
|
|
473
474
|
/** The absolute URL for the linked document. */
|
|
474
475
|
url?: string;
|
|
475
476
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -488,13 +489,13 @@ interface Link extends LinkDataOneOf {
|
|
|
488
489
|
customData?: string | null;
|
|
489
490
|
}
|
|
490
491
|
/** @oneof */
|
|
491
|
-
interface LinkDataOneOf {
|
|
492
|
+
export interface LinkDataOneOf {
|
|
492
493
|
/** The absolute URL for the linked document. */
|
|
493
494
|
url?: string;
|
|
494
495
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
495
496
|
anchor?: string;
|
|
496
497
|
}
|
|
497
|
-
declare enum Target {
|
|
498
|
+
export declare enum Target {
|
|
498
499
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
499
500
|
SELF = "SELF",
|
|
500
501
|
/** Opens the linked document in a new window or tab */
|
|
@@ -504,7 +505,7 @@ declare enum Target {
|
|
|
504
505
|
/** Opens the linked document in the full body of the window */
|
|
505
506
|
TOP = "TOP"
|
|
506
507
|
}
|
|
507
|
-
interface Rel {
|
|
508
|
+
export interface Rel {
|
|
508
509
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
509
510
|
nofollow?: boolean | null;
|
|
510
511
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -514,17 +515,17 @@ interface Rel {
|
|
|
514
515
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
515
516
|
noreferrer?: boolean | null;
|
|
516
517
|
}
|
|
517
|
-
interface CodeBlockData {
|
|
518
|
+
export interface CodeBlockData {
|
|
518
519
|
/** Styling for the code block's text. */
|
|
519
520
|
textStyle?: TextStyle;
|
|
520
521
|
}
|
|
521
|
-
interface TextStyle {
|
|
522
|
+
export interface TextStyle {
|
|
522
523
|
/** Text alignment. Defaults to `AUTO`. */
|
|
523
524
|
textAlignment?: TextAlignment;
|
|
524
525
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
525
526
|
lineHeight?: string | null;
|
|
526
527
|
}
|
|
527
|
-
declare enum TextAlignment {
|
|
528
|
+
export declare enum TextAlignment {
|
|
528
529
|
/** browser default, eqivalent to `initial` */
|
|
529
530
|
AUTO = "AUTO",
|
|
530
531
|
/** Left align */
|
|
@@ -536,7 +537,7 @@ declare enum TextAlignment {
|
|
|
536
537
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
537
538
|
JUSTIFY = "JUSTIFY"
|
|
538
539
|
}
|
|
539
|
-
interface DividerData {
|
|
540
|
+
export interface DividerData {
|
|
540
541
|
/** Styling for the divider's container. */
|
|
541
542
|
containerData?: PluginContainerData;
|
|
542
543
|
/** Divider line style. */
|
|
@@ -546,7 +547,7 @@ interface DividerData {
|
|
|
546
547
|
/** Divider alignment. */
|
|
547
548
|
alignment?: Alignment;
|
|
548
549
|
}
|
|
549
|
-
declare enum LineStyle {
|
|
550
|
+
export declare enum LineStyle {
|
|
550
551
|
/** Single Line */
|
|
551
552
|
SINGLE = "SINGLE",
|
|
552
553
|
/** Double Line */
|
|
@@ -556,7 +557,7 @@ declare enum LineStyle {
|
|
|
556
557
|
/** Dotted Line */
|
|
557
558
|
DOTTED = "DOTTED"
|
|
558
559
|
}
|
|
559
|
-
declare enum Width {
|
|
560
|
+
export declare enum Width {
|
|
560
561
|
/** Large line */
|
|
561
562
|
LARGE = "LARGE",
|
|
562
563
|
/** Medium line */
|
|
@@ -564,7 +565,7 @@ declare enum Width {
|
|
|
564
565
|
/** Small line */
|
|
565
566
|
SMALL = "SMALL"
|
|
566
567
|
}
|
|
567
|
-
declare enum Alignment {
|
|
568
|
+
export declare enum Alignment {
|
|
568
569
|
/** Center alignment */
|
|
569
570
|
CENTER = "CENTER",
|
|
570
571
|
/** Left alignment */
|
|
@@ -572,7 +573,7 @@ declare enum Alignment {
|
|
|
572
573
|
/** Right alignment */
|
|
573
574
|
RIGHT = "RIGHT"
|
|
574
575
|
}
|
|
575
|
-
interface FileData {
|
|
576
|
+
export interface FileData {
|
|
576
577
|
/** Styling for the file's container. */
|
|
577
578
|
containerData?: PluginContainerData;
|
|
578
579
|
/** The source for the file's data. */
|
|
@@ -595,7 +596,7 @@ interface FileData {
|
|
|
595
596
|
/** File size in KB. */
|
|
596
597
|
sizeInKb?: string | null;
|
|
597
598
|
}
|
|
598
|
-
declare enum ViewMode {
|
|
599
|
+
export declare enum ViewMode {
|
|
599
600
|
/** No PDF view */
|
|
600
601
|
NONE = "NONE",
|
|
601
602
|
/** Full PDF view */
|
|
@@ -603,7 +604,7 @@ declare enum ViewMode {
|
|
|
603
604
|
/** Mini PDF view */
|
|
604
605
|
MINI = "MINI"
|
|
605
606
|
}
|
|
606
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
607
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
607
608
|
/** The absolute URL for the file's source. */
|
|
608
609
|
url?: string | null;
|
|
609
610
|
/**
|
|
@@ -617,7 +618,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
617
618
|
private?: boolean | null;
|
|
618
619
|
}
|
|
619
620
|
/** @oneof */
|
|
620
|
-
interface FileSourceDataOneOf {
|
|
621
|
+
export interface FileSourceDataOneOf {
|
|
621
622
|
/** The absolute URL for the file's source. */
|
|
622
623
|
url?: string | null;
|
|
623
624
|
/**
|
|
@@ -628,7 +629,7 @@ interface FileSourceDataOneOf {
|
|
|
628
629
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
629
630
|
_id?: string | null;
|
|
630
631
|
}
|
|
631
|
-
interface PDFSettings {
|
|
632
|
+
export interface PDFSettings {
|
|
632
633
|
/**
|
|
633
634
|
* PDF view mode. One of the following:
|
|
634
635
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -641,7 +642,7 @@ interface PDFSettings {
|
|
|
641
642
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
642
643
|
disablePrint?: boolean | null;
|
|
643
644
|
}
|
|
644
|
-
interface GalleryData {
|
|
645
|
+
export interface GalleryData {
|
|
645
646
|
/** Styling for the gallery's container. */
|
|
646
647
|
containerData?: PluginContainerData;
|
|
647
648
|
/** The items in the gallery. */
|
|
@@ -653,7 +654,7 @@ interface GalleryData {
|
|
|
653
654
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
654
655
|
disableDownload?: boolean | null;
|
|
655
656
|
}
|
|
656
|
-
interface Media {
|
|
657
|
+
export interface Media {
|
|
657
658
|
/** The source for the media's data. */
|
|
658
659
|
src?: FileSource;
|
|
659
660
|
/** Media width in pixels. */
|
|
@@ -663,19 +664,19 @@ interface Media {
|
|
|
663
664
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
664
665
|
duration?: number | null;
|
|
665
666
|
}
|
|
666
|
-
interface Image {
|
|
667
|
+
export interface Image {
|
|
667
668
|
/** Image file details. */
|
|
668
669
|
media?: Media;
|
|
669
670
|
/** Link details for images that are links. */
|
|
670
671
|
link?: Link;
|
|
671
672
|
}
|
|
672
|
-
interface Video {
|
|
673
|
+
export interface Video {
|
|
673
674
|
/** Video file details. */
|
|
674
675
|
media?: Media;
|
|
675
676
|
/** Video thumbnail file details. */
|
|
676
677
|
thumbnail?: Media;
|
|
677
678
|
}
|
|
678
|
-
interface Item extends ItemDataOneOf {
|
|
679
|
+
export interface Item extends ItemDataOneOf {
|
|
679
680
|
/** An image item. */
|
|
680
681
|
image?: Image;
|
|
681
682
|
/** A video item. */
|
|
@@ -686,13 +687,13 @@ interface Item extends ItemDataOneOf {
|
|
|
686
687
|
altText?: string | null;
|
|
687
688
|
}
|
|
688
689
|
/** @oneof */
|
|
689
|
-
interface ItemDataOneOf {
|
|
690
|
+
export interface ItemDataOneOf {
|
|
690
691
|
/** An image item. */
|
|
691
692
|
image?: Image;
|
|
692
693
|
/** A video item. */
|
|
693
694
|
video?: Video;
|
|
694
695
|
}
|
|
695
|
-
interface GalleryOptions {
|
|
696
|
+
export interface GalleryOptions {
|
|
696
697
|
/** Gallery layout. */
|
|
697
698
|
layout?: Layout;
|
|
698
699
|
/** Styling for gallery items. */
|
|
@@ -700,7 +701,7 @@ interface GalleryOptions {
|
|
|
700
701
|
/** Styling for gallery thumbnail images. */
|
|
701
702
|
thumbnails?: Thumbnails;
|
|
702
703
|
}
|
|
703
|
-
declare enum LayoutType {
|
|
704
|
+
export declare enum LayoutType {
|
|
704
705
|
/** Collage type */
|
|
705
706
|
COLLAGE = "COLLAGE",
|
|
706
707
|
/** Masonry type */
|
|
@@ -722,19 +723,19 @@ declare enum LayoutType {
|
|
|
722
723
|
/** Fullsize images type */
|
|
723
724
|
FULLSIZE = "FULLSIZE"
|
|
724
725
|
}
|
|
725
|
-
declare enum Orientation {
|
|
726
|
+
export declare enum Orientation {
|
|
726
727
|
/** Rows Orientation */
|
|
727
728
|
ROWS = "ROWS",
|
|
728
729
|
/** Columns Orientation */
|
|
729
730
|
COLUMNS = "COLUMNS"
|
|
730
731
|
}
|
|
731
|
-
declare enum Crop {
|
|
732
|
+
export declare enum Crop {
|
|
732
733
|
/** Crop to fill */
|
|
733
734
|
FILL = "FILL",
|
|
734
735
|
/** Crop to fit */
|
|
735
736
|
FIT = "FIT"
|
|
736
737
|
}
|
|
737
|
-
declare enum ThumbnailsAlignment {
|
|
738
|
+
export declare enum ThumbnailsAlignment {
|
|
738
739
|
/** Top alignment */
|
|
739
740
|
TOP = "TOP",
|
|
740
741
|
/** Right alignment */
|
|
@@ -746,7 +747,7 @@ declare enum ThumbnailsAlignment {
|
|
|
746
747
|
/** No thumbnail */
|
|
747
748
|
NONE = "NONE"
|
|
748
749
|
}
|
|
749
|
-
interface Layout {
|
|
750
|
+
export interface Layout {
|
|
750
751
|
/** Gallery layout type. */
|
|
751
752
|
type?: LayoutType;
|
|
752
753
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -758,7 +759,7 @@ interface Layout {
|
|
|
758
759
|
/** The number of columns to display on mobile screens. */
|
|
759
760
|
mobileNumberOfColumns?: number | null;
|
|
760
761
|
}
|
|
761
|
-
interface ItemStyle {
|
|
762
|
+
export interface ItemStyle {
|
|
762
763
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
763
764
|
targetSize?: number | null;
|
|
764
765
|
/** Item ratio */
|
|
@@ -768,13 +769,13 @@ interface ItemStyle {
|
|
|
768
769
|
/** The spacing between items in pixels. */
|
|
769
770
|
spacing?: number | null;
|
|
770
771
|
}
|
|
771
|
-
interface Thumbnails {
|
|
772
|
+
export interface Thumbnails {
|
|
772
773
|
/** Thumbnail alignment. */
|
|
773
774
|
placement?: ThumbnailsAlignment;
|
|
774
775
|
/** Spacing between thumbnails in pixels. */
|
|
775
776
|
spacing?: number | null;
|
|
776
777
|
}
|
|
777
|
-
interface GIFData {
|
|
778
|
+
export interface GIFData {
|
|
778
779
|
/** Styling for the GIF's container. */
|
|
779
780
|
containerData?: PluginContainerData;
|
|
780
781
|
/** The source of the full size GIF. */
|
|
@@ -788,7 +789,7 @@ interface GIFData {
|
|
|
788
789
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
789
790
|
gifType?: GIFType;
|
|
790
791
|
}
|
|
791
|
-
interface GIF {
|
|
792
|
+
export interface GIF {
|
|
792
793
|
/**
|
|
793
794
|
* GIF format URL.
|
|
794
795
|
* @format WEB_URL
|
|
@@ -805,11 +806,11 @@ interface GIF {
|
|
|
805
806
|
*/
|
|
806
807
|
still?: string | null;
|
|
807
808
|
}
|
|
808
|
-
declare enum GIFType {
|
|
809
|
+
export declare enum GIFType {
|
|
809
810
|
NORMAL = "NORMAL",
|
|
810
811
|
STICKER = "STICKER"
|
|
811
812
|
}
|
|
812
|
-
interface HeadingData {
|
|
813
|
+
export interface HeadingData {
|
|
813
814
|
/** Heading level from 1-6. */
|
|
814
815
|
level?: number;
|
|
815
816
|
/** Styling for the heading text. */
|
|
@@ -817,7 +818,7 @@ interface HeadingData {
|
|
|
817
818
|
/** Indentation level from 1-4. */
|
|
818
819
|
indentation?: number | null;
|
|
819
820
|
}
|
|
820
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
821
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
821
822
|
/** The URL for the HTML code for the node. */
|
|
822
823
|
url?: string;
|
|
823
824
|
/** The HTML code for the node. */
|
|
@@ -835,7 +836,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
835
836
|
autoHeight?: boolean | null;
|
|
836
837
|
}
|
|
837
838
|
/** @oneof */
|
|
838
|
-
interface HTMLDataDataOneOf {
|
|
839
|
+
export interface HTMLDataDataOneOf {
|
|
839
840
|
/** The URL for the HTML code for the node. */
|
|
840
841
|
url?: string;
|
|
841
842
|
/** The HTML code for the node. */
|
|
@@ -846,11 +847,11 @@ interface HTMLDataDataOneOf {
|
|
|
846
847
|
*/
|
|
847
848
|
isAdsense?: boolean | null;
|
|
848
849
|
}
|
|
849
|
-
declare enum Source {
|
|
850
|
+
export declare enum Source {
|
|
850
851
|
HTML = "HTML",
|
|
851
852
|
ADSENSE = "ADSENSE"
|
|
852
853
|
}
|
|
853
|
-
interface ImageData {
|
|
854
|
+
export interface ImageData {
|
|
854
855
|
/** Styling for the image's container. */
|
|
855
856
|
containerData?: PluginContainerData;
|
|
856
857
|
/** Image file details. */
|
|
@@ -873,7 +874,7 @@ interface ImageData {
|
|
|
873
874
|
/** Styling for the image. */
|
|
874
875
|
styles?: ImageDataStyles;
|
|
875
876
|
}
|
|
876
|
-
interface StylesBorder {
|
|
877
|
+
export interface StylesBorder {
|
|
877
878
|
/** Border width in pixels. */
|
|
878
879
|
width?: number | null;
|
|
879
880
|
/**
|
|
@@ -884,11 +885,11 @@ interface StylesBorder {
|
|
|
884
885
|
/** Border radius in pixels. */
|
|
885
886
|
radius?: number | null;
|
|
886
887
|
}
|
|
887
|
-
interface ImageDataStyles {
|
|
888
|
+
export interface ImageDataStyles {
|
|
888
889
|
/** Border attributes. */
|
|
889
890
|
border?: StylesBorder;
|
|
890
891
|
}
|
|
891
|
-
interface LinkPreviewData {
|
|
892
|
+
export interface LinkPreviewData {
|
|
892
893
|
/** Styling for the link preview's container. */
|
|
893
894
|
containerData?: PluginContainerData;
|
|
894
895
|
/** Link details. */
|
|
@@ -904,7 +905,7 @@ interface LinkPreviewData {
|
|
|
904
905
|
/** Styling for the link preview. */
|
|
905
906
|
styles?: LinkPreviewDataStyles;
|
|
906
907
|
}
|
|
907
|
-
declare enum Position {
|
|
908
|
+
export declare enum Position {
|
|
908
909
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
909
910
|
START = "START",
|
|
910
911
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -914,7 +915,7 @@ declare enum Position {
|
|
|
914
915
|
/** Thumbnail hidden and not displayed */
|
|
915
916
|
HIDDEN = "HIDDEN"
|
|
916
917
|
}
|
|
917
|
-
interface LinkPreviewDataStyles {
|
|
918
|
+
export interface LinkPreviewDataStyles {
|
|
918
919
|
/**
|
|
919
920
|
* Background color as a hexadecimal value.
|
|
920
921
|
* @format COLOR_HEX
|
|
@@ -947,13 +948,13 @@ interface LinkPreviewDataStyles {
|
|
|
947
948
|
/** Position of thumbnail. Defaults to `START`. */
|
|
948
949
|
thumbnailPosition?: Position;
|
|
949
950
|
}
|
|
950
|
-
interface MapData {
|
|
951
|
+
export interface MapData {
|
|
951
952
|
/** Styling for the map's container. */
|
|
952
953
|
containerData?: PluginContainerData;
|
|
953
954
|
/** Map settings. */
|
|
954
955
|
mapSettings?: MapSettings;
|
|
955
956
|
}
|
|
956
|
-
interface MapSettings {
|
|
957
|
+
export interface MapSettings {
|
|
957
958
|
/** The address to display on the map. */
|
|
958
959
|
address?: string | null;
|
|
959
960
|
/** Sets whether the map is draggable. */
|
|
@@ -977,7 +978,7 @@ interface MapSettings {
|
|
|
977
978
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
978
979
|
mapType?: MapType;
|
|
979
980
|
}
|
|
980
|
-
declare enum MapType {
|
|
981
|
+
export declare enum MapType {
|
|
981
982
|
/** Roadmap map type */
|
|
982
983
|
ROADMAP = "ROADMAP",
|
|
983
984
|
/** Satellite map type */
|
|
@@ -987,7 +988,7 @@ declare enum MapType {
|
|
|
987
988
|
/** Terrain map type */
|
|
988
989
|
TERRAIN = "TERRAIN"
|
|
989
990
|
}
|
|
990
|
-
interface ParagraphData {
|
|
991
|
+
export interface ParagraphData {
|
|
991
992
|
/** Styling for the paragraph text. */
|
|
992
993
|
textStyle?: TextStyle;
|
|
993
994
|
/** Indentation level from 1-4. */
|
|
@@ -995,7 +996,7 @@ interface ParagraphData {
|
|
|
995
996
|
/** Paragraph level */
|
|
996
997
|
level?: number | null;
|
|
997
998
|
}
|
|
998
|
-
interface PollData {
|
|
999
|
+
export interface PollData {
|
|
999
1000
|
/** Styling for the poll's container. */
|
|
1000
1001
|
containerData?: PluginContainerData;
|
|
1001
1002
|
/** Poll data. */
|
|
@@ -1005,7 +1006,7 @@ interface PollData {
|
|
|
1005
1006
|
/** Styling for the poll and voting options. */
|
|
1006
1007
|
design?: Design;
|
|
1007
1008
|
}
|
|
1008
|
-
declare enum ViewRole {
|
|
1009
|
+
export declare enum ViewRole {
|
|
1009
1010
|
/** Only Poll creator can view the results */
|
|
1010
1011
|
CREATOR = "CREATOR",
|
|
1011
1012
|
/** Anyone who voted can see the results */
|
|
@@ -1013,13 +1014,13 @@ declare enum ViewRole {
|
|
|
1013
1014
|
/** Anyone can see the results, even if one didn't vote */
|
|
1014
1015
|
EVERYONE = "EVERYONE"
|
|
1015
1016
|
}
|
|
1016
|
-
declare enum VoteRole {
|
|
1017
|
+
export declare enum VoteRole {
|
|
1017
1018
|
/** Logged in member */
|
|
1018
1019
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1019
1020
|
/** Anyone */
|
|
1020
1021
|
ALL = "ALL"
|
|
1021
1022
|
}
|
|
1022
|
-
interface Permissions {
|
|
1023
|
+
export interface Permissions {
|
|
1023
1024
|
/** Sets who can view the poll results. */
|
|
1024
1025
|
view?: ViewRole;
|
|
1025
1026
|
/** Sets who can vote. */
|
|
@@ -1027,7 +1028,7 @@ interface Permissions {
|
|
|
1027
1028
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1028
1029
|
allowMultipleVotes?: boolean | null;
|
|
1029
1030
|
}
|
|
1030
|
-
interface Option {
|
|
1031
|
+
export interface Option {
|
|
1031
1032
|
/** Option ID. */
|
|
1032
1033
|
_id?: string | null;
|
|
1033
1034
|
/** Option title. */
|
|
@@ -1035,7 +1036,7 @@ interface Option {
|
|
|
1035
1036
|
/** The image displayed with the option. */
|
|
1036
1037
|
image?: Media;
|
|
1037
1038
|
}
|
|
1038
|
-
interface Settings {
|
|
1039
|
+
export interface Settings {
|
|
1039
1040
|
/** Permissions settings for voting. */
|
|
1040
1041
|
permissions?: Permissions;
|
|
1041
1042
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1043,19 +1044,19 @@ interface Settings {
|
|
|
1043
1044
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1044
1045
|
showVotesCount?: boolean | null;
|
|
1045
1046
|
}
|
|
1046
|
-
declare enum PollLayoutType {
|
|
1047
|
+
export declare enum PollLayoutType {
|
|
1047
1048
|
/** List */
|
|
1048
1049
|
LIST = "LIST",
|
|
1049
1050
|
/** Grid */
|
|
1050
1051
|
GRID = "GRID"
|
|
1051
1052
|
}
|
|
1052
|
-
declare enum PollLayoutDirection {
|
|
1053
|
+
export declare enum PollLayoutDirection {
|
|
1053
1054
|
/** Left-to-right */
|
|
1054
1055
|
LTR = "LTR",
|
|
1055
1056
|
/** Right-to-left */
|
|
1056
1057
|
RTL = "RTL"
|
|
1057
1058
|
}
|
|
1058
|
-
interface PollLayout {
|
|
1059
|
+
export interface PollLayout {
|
|
1059
1060
|
/** The layout for displaying the voting options. */
|
|
1060
1061
|
type?: PollLayoutType;
|
|
1061
1062
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1063,11 +1064,11 @@ interface PollLayout {
|
|
|
1063
1064
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1064
1065
|
enableImage?: boolean | null;
|
|
1065
1066
|
}
|
|
1066
|
-
interface OptionLayout {
|
|
1067
|
+
export interface OptionLayout {
|
|
1067
1068
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1068
1069
|
enableImage?: boolean | null;
|
|
1069
1070
|
}
|
|
1070
|
-
declare enum BackgroundType {
|
|
1071
|
+
export declare enum BackgroundType {
|
|
1071
1072
|
/** Color background type */
|
|
1072
1073
|
COLOR = "COLOR",
|
|
1073
1074
|
/** Image background type */
|
|
@@ -1075,7 +1076,7 @@ declare enum BackgroundType {
|
|
|
1075
1076
|
/** Gradiant background type */
|
|
1076
1077
|
GRADIENT = "GRADIENT"
|
|
1077
1078
|
}
|
|
1078
|
-
interface Gradient {
|
|
1079
|
+
export interface Gradient {
|
|
1079
1080
|
/** The gradient angle in degrees. */
|
|
1080
1081
|
angle?: number | null;
|
|
1081
1082
|
/**
|
|
@@ -1089,7 +1090,7 @@ interface Gradient {
|
|
|
1089
1090
|
*/
|
|
1090
1091
|
lastColor?: string | null;
|
|
1091
1092
|
}
|
|
1092
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1093
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1093
1094
|
/**
|
|
1094
1095
|
* The background color as a hexademical value.
|
|
1095
1096
|
* @format COLOR_HEX
|
|
@@ -1103,7 +1104,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1103
1104
|
type?: BackgroundType;
|
|
1104
1105
|
}
|
|
1105
1106
|
/** @oneof */
|
|
1106
|
-
interface BackgroundBackgroundOneOf {
|
|
1107
|
+
export interface BackgroundBackgroundOneOf {
|
|
1107
1108
|
/**
|
|
1108
1109
|
* The background color as a hexademical value.
|
|
1109
1110
|
* @format COLOR_HEX
|
|
@@ -1114,17 +1115,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
1114
1115
|
/** Details for a gradient background. */
|
|
1115
1116
|
gradient?: Gradient;
|
|
1116
1117
|
}
|
|
1117
|
-
interface PollDesign {
|
|
1118
|
+
export interface PollDesign {
|
|
1118
1119
|
/** Background styling. */
|
|
1119
1120
|
background?: Background;
|
|
1120
1121
|
/** Border radius in pixels. */
|
|
1121
1122
|
borderRadius?: number | null;
|
|
1122
1123
|
}
|
|
1123
|
-
interface OptionDesign {
|
|
1124
|
+
export interface OptionDesign {
|
|
1124
1125
|
/** Border radius in pixels. */
|
|
1125
1126
|
borderRadius?: number | null;
|
|
1126
1127
|
}
|
|
1127
|
-
interface Poll {
|
|
1128
|
+
export interface Poll {
|
|
1128
1129
|
/** Poll ID. */
|
|
1129
1130
|
_id?: string | null;
|
|
1130
1131
|
/** Poll title. */
|
|
@@ -1138,26 +1139,26 @@ interface Poll {
|
|
|
1138
1139
|
/** The poll's permissions and display settings. */
|
|
1139
1140
|
settings?: Settings;
|
|
1140
1141
|
}
|
|
1141
|
-
interface PollDataLayout {
|
|
1142
|
+
export interface PollDataLayout {
|
|
1142
1143
|
/** Poll layout settings. */
|
|
1143
1144
|
poll?: PollLayout;
|
|
1144
1145
|
/** Voting otpions layout settings. */
|
|
1145
1146
|
options?: OptionLayout;
|
|
1146
1147
|
}
|
|
1147
|
-
interface Design {
|
|
1148
|
+
export interface Design {
|
|
1148
1149
|
/** Styling for the poll. */
|
|
1149
1150
|
poll?: PollDesign;
|
|
1150
1151
|
/** Styling for voting options. */
|
|
1151
1152
|
options?: OptionDesign;
|
|
1152
1153
|
}
|
|
1153
|
-
interface TextData {
|
|
1154
|
+
export interface TextData {
|
|
1154
1155
|
/** The text to apply decorations to. */
|
|
1155
1156
|
text?: string;
|
|
1156
1157
|
/** The decorations to apply. */
|
|
1157
1158
|
decorations?: Decoration[];
|
|
1158
1159
|
}
|
|
1159
1160
|
/** Adds appearence changes to text */
|
|
1160
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1161
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1161
1162
|
/** Data for an anchor link decoration. */
|
|
1162
1163
|
anchorData?: AnchorData;
|
|
1163
1164
|
/** Data for a color decoration. */
|
|
@@ -1182,7 +1183,7 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1182
1183
|
type?: DecorationType;
|
|
1183
1184
|
}
|
|
1184
1185
|
/** @oneof */
|
|
1185
|
-
interface DecorationDataOneOf {
|
|
1186
|
+
export interface DecorationDataOneOf {
|
|
1186
1187
|
/** Data for an anchor link decoration. */
|
|
1187
1188
|
anchorData?: AnchorData;
|
|
1188
1189
|
/** Data for a color decoration. */
|
|
@@ -1204,7 +1205,7 @@ interface DecorationDataOneOf {
|
|
|
1204
1205
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1205
1206
|
strikethroughData?: boolean | null;
|
|
1206
1207
|
}
|
|
1207
|
-
declare enum DecorationType {
|
|
1208
|
+
export declare enum DecorationType {
|
|
1208
1209
|
BOLD = "BOLD",
|
|
1209
1210
|
ITALIC = "ITALIC",
|
|
1210
1211
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1217,21 +1218,21 @@ declare enum DecorationType {
|
|
|
1217
1218
|
EXTERNAL = "EXTERNAL",
|
|
1218
1219
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1219
1220
|
}
|
|
1220
|
-
interface AnchorData {
|
|
1221
|
+
export interface AnchorData {
|
|
1221
1222
|
/** The target node's ID. */
|
|
1222
1223
|
anchor?: string;
|
|
1223
1224
|
}
|
|
1224
|
-
interface ColorData {
|
|
1225
|
+
export interface ColorData {
|
|
1225
1226
|
/** The text's background color as a hexadecimal value. */
|
|
1226
1227
|
background?: string | null;
|
|
1227
1228
|
/** The text's foreground color as a hexadecimal value. */
|
|
1228
1229
|
foreground?: string | null;
|
|
1229
1230
|
}
|
|
1230
|
-
interface LinkData {
|
|
1231
|
+
export interface LinkData {
|
|
1231
1232
|
/** Link details. */
|
|
1232
1233
|
link?: Link;
|
|
1233
1234
|
}
|
|
1234
|
-
interface MentionData {
|
|
1235
|
+
export interface MentionData {
|
|
1235
1236
|
/** The mentioned user's name. */
|
|
1236
1237
|
name?: string;
|
|
1237
1238
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1239,21 +1240,21 @@ interface MentionData {
|
|
|
1239
1240
|
/** Mentioned user's ID. */
|
|
1240
1241
|
_id?: string | null;
|
|
1241
1242
|
}
|
|
1242
|
-
interface FontSizeData {
|
|
1243
|
+
export interface FontSizeData {
|
|
1243
1244
|
/** The units used for the font size. */
|
|
1244
1245
|
unit?: FontType;
|
|
1245
1246
|
/** Font size value. */
|
|
1246
1247
|
value?: number | null;
|
|
1247
1248
|
}
|
|
1248
|
-
declare enum FontType {
|
|
1249
|
+
export declare enum FontType {
|
|
1249
1250
|
PX = "PX",
|
|
1250
1251
|
EM = "EM"
|
|
1251
1252
|
}
|
|
1252
|
-
interface SpoilerData {
|
|
1253
|
+
export interface SpoilerData {
|
|
1253
1254
|
/** Spoiler ID. */
|
|
1254
1255
|
_id?: string | null;
|
|
1255
1256
|
}
|
|
1256
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1257
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1257
1258
|
/** Data for embedded Wix Bookings content. */
|
|
1258
1259
|
bookingData?: BookingData;
|
|
1259
1260
|
/** Data for embedded Wix Events content. */
|
|
@@ -1275,28 +1276,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1275
1276
|
image?: Media;
|
|
1276
1277
|
}
|
|
1277
1278
|
/** @oneof */
|
|
1278
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1279
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1279
1280
|
/** Data for embedded Wix Bookings content. */
|
|
1280
1281
|
bookingData?: BookingData;
|
|
1281
1282
|
/** Data for embedded Wix Events content. */
|
|
1282
1283
|
eventData?: EventData;
|
|
1283
1284
|
}
|
|
1284
|
-
declare enum AppType {
|
|
1285
|
+
export declare enum AppType {
|
|
1285
1286
|
PRODUCT = "PRODUCT",
|
|
1286
1287
|
EVENT = "EVENT",
|
|
1287
1288
|
BOOKING = "BOOKING"
|
|
1288
1289
|
}
|
|
1289
|
-
interface BookingData {
|
|
1290
|
+
export interface BookingData {
|
|
1290
1291
|
/** Booking duration in minutes. */
|
|
1291
1292
|
durations?: string | null;
|
|
1292
1293
|
}
|
|
1293
|
-
interface EventData {
|
|
1294
|
+
export interface EventData {
|
|
1294
1295
|
/** Event schedule. */
|
|
1295
1296
|
scheduling?: string | null;
|
|
1296
1297
|
/** Event location. */
|
|
1297
1298
|
location?: string | null;
|
|
1298
1299
|
}
|
|
1299
|
-
interface VideoData {
|
|
1300
|
+
export interface VideoData {
|
|
1300
1301
|
/** Styling for the video's container. */
|
|
1301
1302
|
containerData?: PluginContainerData;
|
|
1302
1303
|
/** Video details. */
|
|
@@ -1310,7 +1311,7 @@ interface VideoData {
|
|
|
1310
1311
|
/** Video options. */
|
|
1311
1312
|
options?: PlaybackOptions;
|
|
1312
1313
|
}
|
|
1313
|
-
interface PlaybackOptions {
|
|
1314
|
+
export interface PlaybackOptions {
|
|
1314
1315
|
/** Sets whether the media will automatically start playing. */
|
|
1315
1316
|
autoPlay?: boolean | null;
|
|
1316
1317
|
/** Sets whether media's will be looped. */
|
|
@@ -1318,7 +1319,7 @@ interface PlaybackOptions {
|
|
|
1318
1319
|
/** Sets whether media's controls will be shown. */
|
|
1319
1320
|
showControls?: boolean | null;
|
|
1320
1321
|
}
|
|
1321
|
-
interface EmbedData {
|
|
1322
|
+
export interface EmbedData {
|
|
1322
1323
|
/** Styling for the oEmbed node's container. */
|
|
1323
1324
|
containerData?: PluginContainerData;
|
|
1324
1325
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1326,7 +1327,7 @@ interface EmbedData {
|
|
|
1326
1327
|
/** Origin asset source. */
|
|
1327
1328
|
src?: string | null;
|
|
1328
1329
|
}
|
|
1329
|
-
interface Oembed {
|
|
1330
|
+
export interface Oembed {
|
|
1330
1331
|
/** The resource type. */
|
|
1331
1332
|
type?: string | null;
|
|
1332
1333
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1358,7 +1359,7 @@ interface Oembed {
|
|
|
1358
1359
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1359
1360
|
version?: string | null;
|
|
1360
1361
|
}
|
|
1361
|
-
interface CollapsibleListData {
|
|
1362
|
+
export interface CollapsibleListData {
|
|
1362
1363
|
/** Styling for the collapsible list's container. */
|
|
1363
1364
|
containerData?: PluginContainerData;
|
|
1364
1365
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1370,7 +1371,7 @@ interface CollapsibleListData {
|
|
|
1370
1371
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1371
1372
|
isQapageData?: boolean | null;
|
|
1372
1373
|
}
|
|
1373
|
-
declare enum InitialExpandedItems {
|
|
1374
|
+
export declare enum InitialExpandedItems {
|
|
1374
1375
|
/** First item will be expended initally */
|
|
1375
1376
|
FIRST = "FIRST",
|
|
1376
1377
|
/** All items will expended initally */
|
|
@@ -1378,13 +1379,13 @@ declare enum InitialExpandedItems {
|
|
|
1378
1379
|
/** All items collapsed initally */
|
|
1379
1380
|
NONE = "NONE"
|
|
1380
1381
|
}
|
|
1381
|
-
declare enum Direction {
|
|
1382
|
+
export declare enum Direction {
|
|
1382
1383
|
/** Left-to-right */
|
|
1383
1384
|
LTR = "LTR",
|
|
1384
1385
|
/** Right-to-left */
|
|
1385
1386
|
RTL = "RTL"
|
|
1386
1387
|
}
|
|
1387
|
-
interface TableData {
|
|
1388
|
+
export interface TableData {
|
|
1388
1389
|
/** Styling for the table's container. */
|
|
1389
1390
|
containerData?: PluginContainerData;
|
|
1390
1391
|
/** The table's dimensions. */
|
|
@@ -1399,7 +1400,7 @@ interface TableData {
|
|
|
1399
1400
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1400
1401
|
columnHeader?: boolean | null;
|
|
1401
1402
|
}
|
|
1402
|
-
interface Dimensions {
|
|
1403
|
+
export interface Dimensions {
|
|
1403
1404
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1404
1405
|
colsWidthRatio?: number[];
|
|
1405
1406
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1407,13 +1408,13 @@ interface Dimensions {
|
|
|
1407
1408
|
/** An array representing the minimum width of each column in pixels. */
|
|
1408
1409
|
colsMinWidth?: number[];
|
|
1409
1410
|
}
|
|
1410
|
-
interface TableCellData {
|
|
1411
|
+
export interface TableCellData {
|
|
1411
1412
|
/** Styling for the cell's background color and text alignment. */
|
|
1412
1413
|
cellStyle?: CellStyle;
|
|
1413
1414
|
/** The cell's border colors. */
|
|
1414
1415
|
borderColors?: BorderColors;
|
|
1415
1416
|
}
|
|
1416
|
-
declare enum VerticalAlignment {
|
|
1417
|
+
export declare enum VerticalAlignment {
|
|
1417
1418
|
/** Top alignment */
|
|
1418
1419
|
TOP = "TOP",
|
|
1419
1420
|
/** Middle alignment */
|
|
@@ -1421,7 +1422,7 @@ declare enum VerticalAlignment {
|
|
|
1421
1422
|
/** Bottom alignment */
|
|
1422
1423
|
BOTTOM = "BOTTOM"
|
|
1423
1424
|
}
|
|
1424
|
-
interface CellStyle {
|
|
1425
|
+
export interface CellStyle {
|
|
1425
1426
|
/** Vertical alignment for the cell's text. */
|
|
1426
1427
|
verticalAlignment?: VerticalAlignment;
|
|
1427
1428
|
/**
|
|
@@ -1430,7 +1431,7 @@ interface CellStyle {
|
|
|
1430
1431
|
*/
|
|
1431
1432
|
backgroundColor?: string | null;
|
|
1432
1433
|
}
|
|
1433
|
-
interface BorderColors {
|
|
1434
|
+
export interface BorderColors {
|
|
1434
1435
|
/**
|
|
1435
1436
|
* Left border color as a hexadecimal value.
|
|
1436
1437
|
* @format COLOR_HEX
|
|
@@ -1458,7 +1459,7 @@ interface BorderColors {
|
|
|
1458
1459
|
*
|
|
1459
1460
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1460
1461
|
*/
|
|
1461
|
-
declare enum NullValue {
|
|
1462
|
+
export declare enum NullValue {
|
|
1462
1463
|
/** Null value. */
|
|
1463
1464
|
NULL_VALUE = "NULL_VALUE"
|
|
1464
1465
|
}
|
|
@@ -1467,11 +1468,11 @@ declare enum NullValue {
|
|
|
1467
1468
|
*
|
|
1468
1469
|
* The JSON representation for `ListValue` is JSON array.
|
|
1469
1470
|
*/
|
|
1470
|
-
interface ListValue {
|
|
1471
|
+
export interface ListValue {
|
|
1471
1472
|
/** Repeated field of dynamically typed values. */
|
|
1472
1473
|
values?: any[];
|
|
1473
1474
|
}
|
|
1474
|
-
interface AudioData {
|
|
1475
|
+
export interface AudioData {
|
|
1475
1476
|
/** Styling for the audio node's container. */
|
|
1476
1477
|
containerData?: PluginContainerData;
|
|
1477
1478
|
/** Audio file details. */
|
|
@@ -1487,7 +1488,7 @@ interface AudioData {
|
|
|
1487
1488
|
/** An HTML version of the audio node. */
|
|
1488
1489
|
html?: string | null;
|
|
1489
1490
|
}
|
|
1490
|
-
interface OrderedListData {
|
|
1491
|
+
export interface OrderedListData {
|
|
1491
1492
|
/** Indentation level from 0-4. */
|
|
1492
1493
|
indentation?: number;
|
|
1493
1494
|
/** Offset level from 0-4. */
|
|
@@ -1495,24 +1496,24 @@ interface OrderedListData {
|
|
|
1495
1496
|
/** List start number. */
|
|
1496
1497
|
start?: number | null;
|
|
1497
1498
|
}
|
|
1498
|
-
interface BulletedListData {
|
|
1499
|
+
export interface BulletedListData {
|
|
1499
1500
|
/** Indentation level from 0-4. */
|
|
1500
1501
|
indentation?: number;
|
|
1501
1502
|
/** Offset level from 0-4. */
|
|
1502
1503
|
offset?: number | null;
|
|
1503
1504
|
}
|
|
1504
|
-
interface BlockquoteData {
|
|
1505
|
+
export interface BlockquoteData {
|
|
1505
1506
|
/** Indentation level from 1-4. */
|
|
1506
1507
|
indentation?: number;
|
|
1507
1508
|
}
|
|
1508
|
-
interface CaptionData {
|
|
1509
|
+
export interface CaptionData {
|
|
1509
1510
|
textStyle?: TextStyle;
|
|
1510
1511
|
}
|
|
1511
|
-
interface LayoutCellData {
|
|
1512
|
+
export interface LayoutCellData {
|
|
1512
1513
|
/** Size of the cell in 12 columns grid. */
|
|
1513
1514
|
colSpan?: number | null;
|
|
1514
1515
|
}
|
|
1515
|
-
interface Metadata {
|
|
1516
|
+
export interface Metadata {
|
|
1516
1517
|
/** Schema version. */
|
|
1517
1518
|
version?: number;
|
|
1518
1519
|
/**
|
|
@@ -1529,7 +1530,7 @@ interface Metadata {
|
|
|
1529
1530
|
/** Object ID. */
|
|
1530
1531
|
_id?: string | null;
|
|
1531
1532
|
}
|
|
1532
|
-
interface DocumentStyle {
|
|
1533
|
+
export interface DocumentStyle {
|
|
1533
1534
|
/** Styling for H1 nodes. */
|
|
1534
1535
|
headerOne?: TextNodeStyle;
|
|
1535
1536
|
/** Styling for H2 nodes. */
|
|
@@ -1549,7 +1550,7 @@ interface DocumentStyle {
|
|
|
1549
1550
|
/** Styling for code block nodes. */
|
|
1550
1551
|
codeBlock?: TextNodeStyle;
|
|
1551
1552
|
}
|
|
1552
|
-
interface TextNodeStyle {
|
|
1553
|
+
export interface TextNodeStyle {
|
|
1553
1554
|
/** The decorations to apply to the node. */
|
|
1554
1555
|
decorations?: Decoration[];
|
|
1555
1556
|
/** Padding and background color for the node. */
|
|
@@ -1557,7 +1558,7 @@ interface TextNodeStyle {
|
|
|
1557
1558
|
/** Line height for text in the node. */
|
|
1558
1559
|
lineHeight?: string | null;
|
|
1559
1560
|
}
|
|
1560
|
-
interface Mention extends MentionIdentityOneOf {
|
|
1561
|
+
export interface Mention extends MentionIdentityOneOf {
|
|
1561
1562
|
/**
|
|
1562
1563
|
* Wix user ID.
|
|
1563
1564
|
* @format GUID
|
|
@@ -1580,7 +1581,7 @@ interface Mention extends MentionIdentityOneOf {
|
|
|
1580
1581
|
groupId?: string | null;
|
|
1581
1582
|
}
|
|
1582
1583
|
/** @oneof */
|
|
1583
|
-
interface MentionIdentityOneOf {
|
|
1584
|
+
export interface MentionIdentityOneOf {
|
|
1584
1585
|
/**
|
|
1585
1586
|
* Wix user ID.
|
|
1586
1587
|
* @format GUID
|
|
@@ -1602,7 +1603,7 @@ interface MentionIdentityOneOf {
|
|
|
1602
1603
|
*/
|
|
1603
1604
|
groupId?: string | null;
|
|
1604
1605
|
}
|
|
1605
|
-
interface Attachment extends AttachmentMediaOneOf {
|
|
1606
|
+
export interface Attachment extends AttachmentMediaOneOf {
|
|
1606
1607
|
/** Information about the image. */
|
|
1607
1608
|
image?: string;
|
|
1608
1609
|
/** Information about the video. */
|
|
@@ -1618,7 +1619,7 @@ interface Attachment extends AttachmentMediaOneOf {
|
|
|
1618
1619
|
mimeType?: string | null;
|
|
1619
1620
|
}
|
|
1620
1621
|
/** @oneof */
|
|
1621
|
-
interface AttachmentMediaOneOf {
|
|
1622
|
+
export interface AttachmentMediaOneOf {
|
|
1622
1623
|
/** Information about the image. */
|
|
1623
1624
|
image?: string;
|
|
1624
1625
|
/** Information about the video. */
|
|
@@ -1628,7 +1629,7 @@ interface AttachmentMediaOneOf {
|
|
|
1628
1629
|
/** Information about the document. */
|
|
1629
1630
|
document?: string;
|
|
1630
1631
|
}
|
|
1631
|
-
interface VideoResolution {
|
|
1632
|
+
export interface VideoResolution {
|
|
1632
1633
|
/** Video URL. */
|
|
1633
1634
|
url?: string;
|
|
1634
1635
|
/** Video height. */
|
|
@@ -1667,7 +1668,7 @@ interface VideoResolution {
|
|
|
1667
1668
|
*/
|
|
1668
1669
|
assetKey?: string | null;
|
|
1669
1670
|
}
|
|
1670
|
-
interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1671
|
+
export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1671
1672
|
/**
|
|
1672
1673
|
* Wix user ID.
|
|
1673
1674
|
* @format GUID
|
|
@@ -1690,7 +1691,7 @@ interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
|
1690
1691
|
appId?: string | null;
|
|
1691
1692
|
}
|
|
1692
1693
|
/** @oneof */
|
|
1693
|
-
interface ContentAuthorAuthorOneOf {
|
|
1694
|
+
export interface ContentAuthorAuthorOneOf {
|
|
1694
1695
|
/**
|
|
1695
1696
|
* Wix user ID.
|
|
1696
1697
|
* @format GUID
|
|
@@ -1712,7 +1713,7 @@ interface ContentAuthorAuthorOneOf {
|
|
|
1712
1713
|
*/
|
|
1713
1714
|
appId?: string | null;
|
|
1714
1715
|
}
|
|
1715
|
-
interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1716
|
+
export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1716
1717
|
/**
|
|
1717
1718
|
* Wix user ID.
|
|
1718
1719
|
* @format GUID
|
|
@@ -1730,7 +1731,7 @@ interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1730
1731
|
visitorId?: string | null;
|
|
1731
1732
|
}
|
|
1732
1733
|
/** @oneof */
|
|
1733
|
-
interface CommentAuthorIdentityOneOf {
|
|
1734
|
+
export interface CommentAuthorIdentityOneOf {
|
|
1734
1735
|
/**
|
|
1735
1736
|
* Wix user ID.
|
|
1736
1737
|
* @format GUID
|
|
@@ -1747,7 +1748,7 @@ interface CommentAuthorIdentityOneOf {
|
|
|
1747
1748
|
*/
|
|
1748
1749
|
visitorId?: string | null;
|
|
1749
1750
|
}
|
|
1750
|
-
interface ParentComment {
|
|
1751
|
+
export interface ParentComment {
|
|
1751
1752
|
/**
|
|
1752
1753
|
* Comment ID of the parent comment.
|
|
1753
1754
|
* @format GUID
|
|
@@ -1765,7 +1766,7 @@ interface ParentComment {
|
|
|
1765
1766
|
*/
|
|
1766
1767
|
status?: Status;
|
|
1767
1768
|
}
|
|
1768
|
-
declare enum Status {
|
|
1769
|
+
export declare enum Status {
|
|
1769
1770
|
/** Unknown status. */
|
|
1770
1771
|
UNKNOWN = "UNKNOWN",
|
|
1771
1772
|
/** This comment is published and publicly visible. */
|
|
@@ -1777,7 +1778,7 @@ declare enum Status {
|
|
|
1777
1778
|
/** This comment has been hidden by a site moderator. */
|
|
1778
1779
|
HIDDEN = "HIDDEN"
|
|
1779
1780
|
}
|
|
1780
|
-
interface VoteSummary {
|
|
1781
|
+
export interface VoteSummary {
|
|
1781
1782
|
/** Number of upvotes less downvotes on this comment. */
|
|
1782
1783
|
netVoteCount?: number;
|
|
1783
1784
|
/** Number of upvotes on this comment. */
|
|
@@ -1785,7 +1786,7 @@ interface VoteSummary {
|
|
|
1785
1786
|
/** Number of downvotes on this comment. */
|
|
1786
1787
|
downvoteCount?: number;
|
|
1787
1788
|
}
|
|
1788
|
-
interface CommentReactionSummary {
|
|
1789
|
+
export interface CommentReactionSummary {
|
|
1789
1790
|
/** Total amount of reactions. */
|
|
1790
1791
|
total?: number;
|
|
1791
1792
|
/**
|
|
@@ -1794,7 +1795,7 @@ interface CommentReactionSummary {
|
|
|
1794
1795
|
*/
|
|
1795
1796
|
reactionCodeCount?: Record<string, number>;
|
|
1796
1797
|
}
|
|
1797
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1798
|
+
export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1798
1799
|
/** insert/update documents */
|
|
1799
1800
|
update?: InternalDocumentUpdateOperation;
|
|
1800
1801
|
/** delete by document ids */
|
|
@@ -1835,7 +1836,7 @@ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOpera
|
|
|
1835
1836
|
issuedAt?: Date | null;
|
|
1836
1837
|
}
|
|
1837
1838
|
/** @oneof */
|
|
1838
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1839
|
+
export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1839
1840
|
/** insert/update documents */
|
|
1840
1841
|
update?: InternalDocumentUpdateOperation;
|
|
1841
1842
|
/** delete by document ids */
|
|
@@ -1851,39 +1852,39 @@ interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
1851
1852
|
/** delete by document ids with versioning */
|
|
1852
1853
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1853
1854
|
}
|
|
1854
|
-
interface InternalDocument {
|
|
1855
|
+
export interface InternalDocument {
|
|
1855
1856
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
1856
1857
|
document?: Record<string, any> | null;
|
|
1857
1858
|
}
|
|
1858
|
-
interface InternalDocumentUpdateOperation {
|
|
1859
|
+
export interface InternalDocumentUpdateOperation {
|
|
1859
1860
|
/** documents to index or update */
|
|
1860
1861
|
documents?: InternalDocument[];
|
|
1861
1862
|
}
|
|
1862
|
-
interface DeleteByIdsOperation {
|
|
1863
|
+
export interface DeleteByIdsOperation {
|
|
1863
1864
|
/** ids of the documents to delete */
|
|
1864
1865
|
documentIds?: string[];
|
|
1865
1866
|
}
|
|
1866
|
-
interface DeleteByFilterOperation {
|
|
1867
|
+
export interface DeleteByFilterOperation {
|
|
1867
1868
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
1868
1869
|
filter?: Record<string, any> | null;
|
|
1869
1870
|
}
|
|
1870
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
1871
|
+
export interface InternalDocumentUpdateByFilterOperation {
|
|
1871
1872
|
/** documents matching this filter will be updated */
|
|
1872
1873
|
filter?: Record<string, any> | null;
|
|
1873
1874
|
/** partial document to apply */
|
|
1874
1875
|
document?: InternalDocument;
|
|
1875
1876
|
}
|
|
1876
|
-
interface InternalUpdateExistingOperation {
|
|
1877
|
+
export interface InternalUpdateExistingOperation {
|
|
1877
1878
|
/** documents to update */
|
|
1878
1879
|
documents?: InternalDocument[];
|
|
1879
1880
|
}
|
|
1880
|
-
interface VersionedDocumentUpdateOperation {
|
|
1881
|
+
export interface VersionedDocumentUpdateOperation {
|
|
1881
1882
|
/** documents to create or overwrite */
|
|
1882
1883
|
documents?: InternalDocument[];
|
|
1883
1884
|
/** versioning mode to use instead of default */
|
|
1884
1885
|
versioningMode?: VersioningMode;
|
|
1885
1886
|
}
|
|
1886
|
-
declare enum VersioningMode {
|
|
1887
|
+
export declare enum VersioningMode {
|
|
1887
1888
|
/** use default versioning mode agreed with search team */
|
|
1888
1889
|
DEFAULT = "DEFAULT",
|
|
1889
1890
|
/** execute only if version is greater than existing */
|
|
@@ -1891,11 +1892,11 @@ declare enum VersioningMode {
|
|
|
1891
1892
|
/** execute only if version is greater or equal to existing */
|
|
1892
1893
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
1893
1894
|
}
|
|
1894
|
-
interface VersionedDeleteByIdsOperation {
|
|
1895
|
+
export interface VersionedDeleteByIdsOperation {
|
|
1895
1896
|
/** ids with version of the documents to delete */
|
|
1896
1897
|
documentIds?: VersionedDocumentId[];
|
|
1897
1898
|
}
|
|
1898
|
-
interface VersionedDocumentId {
|
|
1899
|
+
export interface VersionedDocumentId {
|
|
1899
1900
|
/** document id */
|
|
1900
1901
|
documentId?: string;
|
|
1901
1902
|
/** document version */
|
|
@@ -1903,11 +1904,11 @@ interface VersionedDocumentId {
|
|
|
1903
1904
|
/** versioning mode to use instead of default */
|
|
1904
1905
|
versioningMode?: VersioningMode;
|
|
1905
1906
|
}
|
|
1906
|
-
interface CommentModerated {
|
|
1907
|
+
export interface CommentModerated {
|
|
1907
1908
|
comment?: Comment;
|
|
1908
1909
|
moderationAction?: Action;
|
|
1909
1910
|
}
|
|
1910
|
-
declare enum Action {
|
|
1911
|
+
export declare enum Action {
|
|
1911
1912
|
/** Unknown content. */
|
|
1912
1913
|
UNKNOWN = "UNKNOWN",
|
|
1913
1914
|
/** Approve draft content. */
|
|
@@ -1915,17 +1916,17 @@ declare enum Action {
|
|
|
1915
1916
|
/** Reject draft content. */
|
|
1916
1917
|
REJECT = "REJECT"
|
|
1917
1918
|
}
|
|
1918
|
-
interface CreateCommentRequest {
|
|
1919
|
+
export interface CreateCommentRequest {
|
|
1919
1920
|
/** Comment to create. */
|
|
1920
1921
|
comment?: Comment;
|
|
1921
1922
|
}
|
|
1922
|
-
interface ContactDetails {
|
|
1923
|
+
export interface ContactDetails {
|
|
1923
1924
|
}
|
|
1924
|
-
interface CreateCommentResponse {
|
|
1925
|
+
export interface CreateCommentResponse {
|
|
1925
1926
|
/** Created comment. */
|
|
1926
1927
|
comment?: Comment;
|
|
1927
1928
|
}
|
|
1928
|
-
interface ResourceCommentCountChanged {
|
|
1929
|
+
export interface ResourceCommentCountChanged {
|
|
1929
1930
|
/** ID of the app that the comment is added to. */
|
|
1930
1931
|
appId?: string;
|
|
1931
1932
|
/**
|
|
@@ -1943,27 +1944,27 @@ interface ResourceCommentCountChanged {
|
|
|
1943
1944
|
/** How many comments are published for the resource. */
|
|
1944
1945
|
publishedCommentCount?: number;
|
|
1945
1946
|
}
|
|
1946
|
-
interface GetCommentRequest {
|
|
1947
|
+
export interface GetCommentRequest {
|
|
1947
1948
|
/**
|
|
1948
1949
|
* ID of the comment to retrieve.
|
|
1949
1950
|
* @format GUID
|
|
1950
1951
|
*/
|
|
1951
1952
|
commentId: string;
|
|
1952
1953
|
}
|
|
1953
|
-
interface GetCommentResponse {
|
|
1954
|
+
export interface GetCommentResponse {
|
|
1954
1955
|
/** Retrieved comment. */
|
|
1955
1956
|
comment?: Comment;
|
|
1956
1957
|
}
|
|
1957
1958
|
/** Comment info to update. */
|
|
1958
|
-
interface UpdateCommentRequest {
|
|
1959
|
+
export interface UpdateCommentRequest {
|
|
1959
1960
|
/** Comment info to update. */
|
|
1960
1961
|
comment?: Comment;
|
|
1961
1962
|
}
|
|
1962
|
-
interface UpdateCommentResponse {
|
|
1963
|
+
export interface UpdateCommentResponse {
|
|
1963
1964
|
/** Updated comment. */
|
|
1964
1965
|
comment?: Comment;
|
|
1965
1966
|
}
|
|
1966
|
-
interface CommentContentChanged {
|
|
1967
|
+
export interface CommentContentChanged {
|
|
1967
1968
|
/** Comment ID. */
|
|
1968
1969
|
commentId?: string;
|
|
1969
1970
|
/** Content before the update. */
|
|
@@ -1971,19 +1972,19 @@ interface CommentContentChanged {
|
|
|
1971
1972
|
/** Content after the update. */
|
|
1972
1973
|
currentContent?: CommentContent;
|
|
1973
1974
|
}
|
|
1974
|
-
interface DeleteCommentRequest {
|
|
1975
|
+
export interface DeleteCommentRequest {
|
|
1975
1976
|
/**
|
|
1976
1977
|
* ID of the comment to delete.
|
|
1977
1978
|
* @format GUID
|
|
1978
1979
|
*/
|
|
1979
1980
|
commentId: string;
|
|
1980
1981
|
}
|
|
1981
|
-
interface DeleteCommentResponse {
|
|
1982
|
+
export interface DeleteCommentResponse {
|
|
1982
1983
|
}
|
|
1983
|
-
interface CommentDeleted {
|
|
1984
|
+
export interface CommentDeleted {
|
|
1984
1985
|
comment?: Comment;
|
|
1985
1986
|
}
|
|
1986
|
-
interface ModerateDraftContentRequest {
|
|
1987
|
+
export interface ModerateDraftContentRequest {
|
|
1987
1988
|
/**
|
|
1988
1989
|
* ID of the comment to moderate.
|
|
1989
1990
|
* @format GUID
|
|
@@ -1998,20 +1999,20 @@ interface ModerateDraftContentRequest {
|
|
|
1998
1999
|
/** Draft content action. */
|
|
1999
2000
|
draftContentAction?: Action;
|
|
2000
2001
|
}
|
|
2001
|
-
interface ModerateDraftContentResponse {
|
|
2002
|
+
export interface ModerateDraftContentResponse {
|
|
2002
2003
|
/** Moderated comment. */
|
|
2003
2004
|
comment?: Comment;
|
|
2004
2005
|
}
|
|
2005
|
-
interface CommentPublished {
|
|
2006
|
+
export interface CommentPublished {
|
|
2006
2007
|
/** Comment info. */
|
|
2007
2008
|
comment?: Comment;
|
|
2008
2009
|
/** Whether this is the first comment publish. */
|
|
2009
2010
|
firstPublish?: boolean;
|
|
2010
2011
|
}
|
|
2011
|
-
interface CommentHidden {
|
|
2012
|
+
export interface CommentHidden {
|
|
2012
2013
|
comment?: Comment;
|
|
2013
2014
|
}
|
|
2014
|
-
interface QueryCommentsRequest {
|
|
2015
|
+
export interface QueryCommentsRequest {
|
|
2015
2016
|
/**
|
|
2016
2017
|
* App ID to query comments for.
|
|
2017
2018
|
* @format GUID
|
|
@@ -2020,7 +2021,7 @@ interface QueryCommentsRequest {
|
|
|
2020
2021
|
/** Query options. */
|
|
2021
2022
|
query: CursorQuery;
|
|
2022
2023
|
}
|
|
2023
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2024
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2024
2025
|
/**
|
|
2025
2026
|
* Cursor paging options.
|
|
2026
2027
|
*
|
|
@@ -2042,7 +2043,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2042
2043
|
sort?: Sorting[];
|
|
2043
2044
|
}
|
|
2044
2045
|
/** @oneof */
|
|
2045
|
-
interface CursorQueryPagingMethodOneOf {
|
|
2046
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
2046
2047
|
/**
|
|
2047
2048
|
* Cursor paging options.
|
|
2048
2049
|
*
|
|
@@ -2050,7 +2051,7 @@ interface CursorQueryPagingMethodOneOf {
|
|
|
2050
2051
|
*/
|
|
2051
2052
|
cursorPaging?: CursorPaging;
|
|
2052
2053
|
}
|
|
2053
|
-
interface Sorting {
|
|
2054
|
+
export interface Sorting {
|
|
2054
2055
|
/**
|
|
2055
2056
|
* Name of the field to sort by.
|
|
2056
2057
|
* @maxLength 512
|
|
@@ -2059,11 +2060,11 @@ interface Sorting {
|
|
|
2059
2060
|
/** Sort order. */
|
|
2060
2061
|
order?: SortOrder;
|
|
2061
2062
|
}
|
|
2062
|
-
declare enum SortOrder {
|
|
2063
|
+
export declare enum SortOrder {
|
|
2063
2064
|
ASC = "ASC",
|
|
2064
2065
|
DESC = "DESC"
|
|
2065
2066
|
}
|
|
2066
|
-
interface CursorPaging {
|
|
2067
|
+
export interface CursorPaging {
|
|
2067
2068
|
/**
|
|
2068
2069
|
* Maximum number of items to return in the results.
|
|
2069
2070
|
* @max 100
|
|
@@ -2078,13 +2079,13 @@ interface CursorPaging {
|
|
|
2078
2079
|
*/
|
|
2079
2080
|
cursor?: string | null;
|
|
2080
2081
|
}
|
|
2081
|
-
interface QueryCommentsResponse {
|
|
2082
|
+
export interface QueryCommentsResponse {
|
|
2082
2083
|
/** Retrieved comments. */
|
|
2083
2084
|
comments?: Comment[];
|
|
2084
2085
|
/** Paging metadata. */
|
|
2085
2086
|
pagingMetadata?: CursorPagingMetadata;
|
|
2086
2087
|
}
|
|
2087
|
-
interface CursorPagingMetadata {
|
|
2088
|
+
export interface CursorPagingMetadata {
|
|
2088
2089
|
/** Number of items returned in current page. */
|
|
2089
2090
|
count?: number | null;
|
|
2090
2091
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2097,7 +2098,7 @@ interface CursorPagingMetadata {
|
|
|
2097
2098
|
*/
|
|
2098
2099
|
hasNext?: boolean | null;
|
|
2099
2100
|
}
|
|
2100
|
-
interface Cursors {
|
|
2101
|
+
export interface Cursors {
|
|
2101
2102
|
/**
|
|
2102
2103
|
* Cursor string pointing to the next page in the list of results.
|
|
2103
2104
|
* @maxLength 16000
|
|
@@ -2109,58 +2110,58 @@ interface Cursors {
|
|
|
2109
2110
|
*/
|
|
2110
2111
|
prev?: string | null;
|
|
2111
2112
|
}
|
|
2112
|
-
interface MarkCommentRequest {
|
|
2113
|
+
export interface MarkCommentRequest {
|
|
2113
2114
|
/**
|
|
2114
2115
|
* ID of the comment to mark.
|
|
2115
2116
|
* @format GUID
|
|
2116
2117
|
*/
|
|
2117
2118
|
commentId: string;
|
|
2118
2119
|
}
|
|
2119
|
-
interface MarkCommentResponse {
|
|
2120
|
+
export interface MarkCommentResponse {
|
|
2120
2121
|
/** Marked comment. */
|
|
2121
2122
|
comment?: Comment;
|
|
2122
2123
|
}
|
|
2123
|
-
interface CommentMarked {
|
|
2124
|
+
export interface CommentMarked {
|
|
2124
2125
|
comment?: Comment;
|
|
2125
2126
|
}
|
|
2126
|
-
interface UnmarkCommentRequest {
|
|
2127
|
+
export interface UnmarkCommentRequest {
|
|
2127
2128
|
/**
|
|
2128
2129
|
* ID of the comment to unmark.
|
|
2129
2130
|
* @format GUID
|
|
2130
2131
|
*/
|
|
2131
2132
|
commentId: string;
|
|
2132
2133
|
}
|
|
2133
|
-
interface UnmarkCommentResponse {
|
|
2134
|
+
export interface UnmarkCommentResponse {
|
|
2134
2135
|
/** Unmarked comment. */
|
|
2135
2136
|
comment?: Comment;
|
|
2136
2137
|
}
|
|
2137
|
-
interface CommentUnmarked {
|
|
2138
|
+
export interface CommentUnmarked {
|
|
2138
2139
|
comment?: Comment;
|
|
2139
2140
|
}
|
|
2140
|
-
interface HideCommentRequest {
|
|
2141
|
+
export interface HideCommentRequest {
|
|
2141
2142
|
/**
|
|
2142
2143
|
* ID of the comment to hide.
|
|
2143
2144
|
* @format GUID
|
|
2144
2145
|
*/
|
|
2145
2146
|
commentId: string;
|
|
2146
2147
|
}
|
|
2147
|
-
interface HideCommentResponse {
|
|
2148
|
+
export interface HideCommentResponse {
|
|
2148
2149
|
/** Hidden comment. */
|
|
2149
2150
|
comment?: Comment;
|
|
2150
2151
|
}
|
|
2151
|
-
interface PublishCommentRequest {
|
|
2152
|
+
export interface PublishCommentRequest {
|
|
2152
2153
|
/**
|
|
2153
2154
|
* ID of the comment to publish.
|
|
2154
2155
|
* @format GUID
|
|
2155
2156
|
*/
|
|
2156
2157
|
commentId: string;
|
|
2157
2158
|
}
|
|
2158
|
-
interface PublishCommentResponse {
|
|
2159
|
+
export interface PublishCommentResponse {
|
|
2159
2160
|
/** Published comment. */
|
|
2160
2161
|
comment?: Comment;
|
|
2161
2162
|
}
|
|
2162
2163
|
/** Count comments options. */
|
|
2163
|
-
interface CountCommentsRequest {
|
|
2164
|
+
export interface CountCommentsRequest {
|
|
2164
2165
|
/**
|
|
2165
2166
|
* App ID to count the comments of.
|
|
2166
2167
|
* @format GUID
|
|
@@ -2169,11 +2170,11 @@ interface CountCommentsRequest {
|
|
|
2169
2170
|
/** Filter to identify the comments that need to be counted. */
|
|
2170
2171
|
filter?: Record<string, any> | null;
|
|
2171
2172
|
}
|
|
2172
|
-
interface CountCommentsResponse {
|
|
2173
|
+
export interface CountCommentsResponse {
|
|
2173
2174
|
/** Number of comments. */
|
|
2174
2175
|
count?: number;
|
|
2175
2176
|
}
|
|
2176
|
-
interface ListCommentsByResourceRequest {
|
|
2177
|
+
export interface ListCommentsByResourceRequest {
|
|
2177
2178
|
/**
|
|
2178
2179
|
* ID of the app from which the comments are listed.
|
|
2179
2180
|
* @format GUID
|
|
@@ -2205,7 +2206,7 @@ interface ListCommentsByResourceRequest {
|
|
|
2205
2206
|
/** Cursor paging. */
|
|
2206
2207
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2207
2208
|
}
|
|
2208
|
-
interface CommentSort {
|
|
2209
|
+
export interface CommentSort {
|
|
2209
2210
|
/** Sort order. */
|
|
2210
2211
|
order?: Order;
|
|
2211
2212
|
/**
|
|
@@ -2215,7 +2216,7 @@ interface CommentSort {
|
|
|
2215
2216
|
*/
|
|
2216
2217
|
keepMarkedInOriginalOrder?: boolean;
|
|
2217
2218
|
}
|
|
2218
|
-
declare enum Order {
|
|
2219
|
+
export declare enum Order {
|
|
2219
2220
|
/** Unknown order. */
|
|
2220
2221
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2221
2222
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2233,7 +2234,7 @@ declare enum Order {
|
|
|
2233
2234
|
/** Comments with the lowest rating appear at the top of the list. */
|
|
2234
2235
|
RATING_ASC = "RATING_ASC"
|
|
2235
2236
|
}
|
|
2236
|
-
interface ReplySort {
|
|
2237
|
+
export interface ReplySort {
|
|
2237
2238
|
/** Sort order. */
|
|
2238
2239
|
order?: ReplySortOrder;
|
|
2239
2240
|
/**
|
|
@@ -2245,7 +2246,7 @@ interface ReplySort {
|
|
|
2245
2246
|
*/
|
|
2246
2247
|
keepMarkedInOriginalOrder?: boolean;
|
|
2247
2248
|
}
|
|
2248
|
-
declare enum ReplySortOrder {
|
|
2249
|
+
export declare enum ReplySortOrder {
|
|
2249
2250
|
/** Unknown order. */
|
|
2250
2251
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2251
2252
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2255,7 +2256,7 @@ declare enum ReplySortOrder {
|
|
|
2255
2256
|
/** Comments with the highest reaction count appear at the top of the list. */
|
|
2256
2257
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2257
2258
|
}
|
|
2258
|
-
interface ListCommentsByResourceCursorPaging {
|
|
2259
|
+
export interface ListCommentsByResourceCursorPaging {
|
|
2259
2260
|
/** Pointer to the next or previous page in the list of results. */
|
|
2260
2261
|
cursor?: string | null;
|
|
2261
2262
|
/**
|
|
@@ -2270,7 +2271,7 @@ interface ListCommentsByResourceCursorPaging {
|
|
|
2270
2271
|
*/
|
|
2271
2272
|
repliesLimit?: number | null;
|
|
2272
2273
|
}
|
|
2273
|
-
interface ListCommentsByResourceResponse {
|
|
2274
|
+
export interface ListCommentsByResourceResponse {
|
|
2274
2275
|
/** Listed comments. */
|
|
2275
2276
|
comments?: Comment[];
|
|
2276
2277
|
/** Paging metadata. */
|
|
@@ -2278,13 +2279,13 @@ interface ListCommentsByResourceResponse {
|
|
|
2278
2279
|
/** Listed comment replies. */
|
|
2279
2280
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2280
2281
|
}
|
|
2281
|
-
interface RepliesListResponse {
|
|
2282
|
+
export interface RepliesListResponse {
|
|
2282
2283
|
/** Listed comment replies. */
|
|
2283
2284
|
replies?: Comment[];
|
|
2284
2285
|
/** Paging metadata. */
|
|
2285
2286
|
pagingMetadata?: CursorPagingMetadata;
|
|
2286
2287
|
}
|
|
2287
|
-
interface GetCommentThreadRequest {
|
|
2288
|
+
export interface GetCommentThreadRequest {
|
|
2288
2289
|
/**
|
|
2289
2290
|
* App ID.
|
|
2290
2291
|
* @maxLength 128
|
|
@@ -2302,7 +2303,7 @@ interface GetCommentThreadRequest {
|
|
|
2302
2303
|
/** Reply sorting. */
|
|
2303
2304
|
replySort?: ReplySort;
|
|
2304
2305
|
}
|
|
2305
|
-
interface GetCommentThreadResponse {
|
|
2306
|
+
export interface GetCommentThreadResponse {
|
|
2306
2307
|
/** Retrieved replies. */
|
|
2307
2308
|
comments?: Comment[];
|
|
2308
2309
|
/** Paging metadata. */
|
|
@@ -2310,7 +2311,7 @@ interface GetCommentThreadResponse {
|
|
|
2310
2311
|
/** Retrieved replies of a reply. */
|
|
2311
2312
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2312
2313
|
}
|
|
2313
|
-
interface BulkPublishCommentRequest {
|
|
2314
|
+
export interface BulkPublishCommentRequest {
|
|
2314
2315
|
/**
|
|
2315
2316
|
* ID of the app where to publish the comment.
|
|
2316
2317
|
* @format GUID
|
|
@@ -2319,7 +2320,7 @@ interface BulkPublishCommentRequest {
|
|
|
2319
2320
|
/** 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"`}. */
|
|
2320
2321
|
filter: Record<string, any> | null;
|
|
2321
2322
|
}
|
|
2322
|
-
interface BulkPublishCommentResponse {
|
|
2323
|
+
export interface BulkPublishCommentResponse {
|
|
2323
2324
|
/**
|
|
2324
2325
|
* Job ID.
|
|
2325
2326
|
*
|
|
@@ -2328,7 +2329,7 @@ interface BulkPublishCommentResponse {
|
|
|
2328
2329
|
*/
|
|
2329
2330
|
jobId?: string;
|
|
2330
2331
|
}
|
|
2331
|
-
interface BulkHideCommentRequest {
|
|
2332
|
+
export interface BulkHideCommentRequest {
|
|
2332
2333
|
/**
|
|
2333
2334
|
* ID of the app where to hide the comments.
|
|
2334
2335
|
* @format GUID
|
|
@@ -2337,7 +2338,7 @@ interface BulkHideCommentRequest {
|
|
|
2337
2338
|
/** 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"`}. */
|
|
2338
2339
|
filter: Record<string, any> | null;
|
|
2339
2340
|
}
|
|
2340
|
-
interface BulkHideCommentResponse {
|
|
2341
|
+
export interface BulkHideCommentResponse {
|
|
2341
2342
|
/**
|
|
2342
2343
|
* Job ID.
|
|
2343
2344
|
*
|
|
@@ -2346,7 +2347,7 @@ interface BulkHideCommentResponse {
|
|
|
2346
2347
|
*/
|
|
2347
2348
|
jobId?: string;
|
|
2348
2349
|
}
|
|
2349
|
-
interface BulkDeleteCommentRequest {
|
|
2350
|
+
export interface BulkDeleteCommentRequest {
|
|
2350
2351
|
/**
|
|
2351
2352
|
* ID of the app where to delete the comments.
|
|
2352
2353
|
* @format GUID
|
|
@@ -2355,7 +2356,7 @@ interface BulkDeleteCommentRequest {
|
|
|
2355
2356
|
/** 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"`}. */
|
|
2356
2357
|
filter: Record<string, any> | null;
|
|
2357
2358
|
}
|
|
2358
|
-
interface BulkDeleteCommentResponse {
|
|
2359
|
+
export interface BulkDeleteCommentResponse {
|
|
2359
2360
|
/**
|
|
2360
2361
|
* Job ID.
|
|
2361
2362
|
*
|
|
@@ -2364,7 +2365,7 @@ interface BulkDeleteCommentResponse {
|
|
|
2364
2365
|
*/
|
|
2365
2366
|
jobId?: string;
|
|
2366
2367
|
}
|
|
2367
|
-
interface BulkModerateDraftContentRequest {
|
|
2368
|
+
export interface BulkModerateDraftContentRequest {
|
|
2368
2369
|
/**
|
|
2369
2370
|
* ID of the app where to moderate the comments.
|
|
2370
2371
|
* @format GUID
|
|
@@ -2375,7 +2376,7 @@ interface BulkModerateDraftContentRequest {
|
|
|
2375
2376
|
/** Action to do regarding draft content */
|
|
2376
2377
|
draftContentAction: Action;
|
|
2377
2378
|
}
|
|
2378
|
-
interface BulkModerateDraftContentResponse {
|
|
2379
|
+
export interface BulkModerateDraftContentResponse {
|
|
2379
2380
|
/**
|
|
2380
2381
|
* Job ID.
|
|
2381
2382
|
*
|
|
@@ -2384,7 +2385,7 @@ interface BulkModerateDraftContentResponse {
|
|
|
2384
2385
|
*/
|
|
2385
2386
|
jobId?: string;
|
|
2386
2387
|
}
|
|
2387
|
-
interface BulkMoveCommentByFilterRequest {
|
|
2388
|
+
export interface BulkMoveCommentByFilterRequest {
|
|
2388
2389
|
/**
|
|
2389
2390
|
* ID of the app from which to move the comments.
|
|
2390
2391
|
* @format GUID
|
|
@@ -2395,7 +2396,7 @@ interface BulkMoveCommentByFilterRequest {
|
|
|
2395
2396
|
/** Where to move the comment. */
|
|
2396
2397
|
destination?: Destination;
|
|
2397
2398
|
}
|
|
2398
|
-
interface Destination {
|
|
2399
|
+
export interface Destination {
|
|
2399
2400
|
/**
|
|
2400
2401
|
* Context ID of where to move the comment to.
|
|
2401
2402
|
* @maxLength 128
|
|
@@ -2407,7 +2408,7 @@ interface Destination {
|
|
|
2407
2408
|
*/
|
|
2408
2409
|
resourceId?: string;
|
|
2409
2410
|
}
|
|
2410
|
-
interface BulkMoveCommentByFilterResponse {
|
|
2411
|
+
export interface BulkMoveCommentByFilterResponse {
|
|
2411
2412
|
/**
|
|
2412
2413
|
* Job ID.
|
|
2413
2414
|
*
|
|
@@ -2416,11 +2417,11 @@ interface BulkMoveCommentByFilterResponse {
|
|
|
2416
2417
|
*/
|
|
2417
2418
|
jobId?: string;
|
|
2418
2419
|
}
|
|
2419
|
-
interface CommentMoved {
|
|
2420
|
+
export interface CommentMoved {
|
|
2420
2421
|
comment?: Comment;
|
|
2421
2422
|
destination?: Destination;
|
|
2422
2423
|
}
|
|
2423
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2424
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2424
2425
|
createdEvent?: EntityCreatedEvent;
|
|
2425
2426
|
updatedEvent?: EntityUpdatedEvent;
|
|
2426
2427
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2463,19 +2464,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2463
2464
|
entityEventSequence?: string | null;
|
|
2464
2465
|
}
|
|
2465
2466
|
/** @oneof */
|
|
2466
|
-
interface DomainEventBodyOneOf {
|
|
2467
|
+
export interface DomainEventBodyOneOf {
|
|
2467
2468
|
createdEvent?: EntityCreatedEvent;
|
|
2468
2469
|
updatedEvent?: EntityUpdatedEvent;
|
|
2469
2470
|
deletedEvent?: EntityDeletedEvent;
|
|
2470
2471
|
actionEvent?: ActionEvent;
|
|
2471
2472
|
}
|
|
2472
|
-
interface EntityCreatedEvent {
|
|
2473
|
+
export interface EntityCreatedEvent {
|
|
2473
2474
|
entity?: string;
|
|
2474
2475
|
}
|
|
2475
|
-
interface RestoreInfo {
|
|
2476
|
+
export interface RestoreInfo {
|
|
2476
2477
|
deletedDate?: Date | null;
|
|
2477
2478
|
}
|
|
2478
|
-
interface EntityUpdatedEvent {
|
|
2479
|
+
export interface EntityUpdatedEvent {
|
|
2479
2480
|
/**
|
|
2480
2481
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2481
2482
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -2483,14 +2484,14 @@ interface EntityUpdatedEvent {
|
|
|
2483
2484
|
*/
|
|
2484
2485
|
currentEntity?: string;
|
|
2485
2486
|
}
|
|
2486
|
-
interface EntityDeletedEvent {
|
|
2487
|
+
export interface EntityDeletedEvent {
|
|
2487
2488
|
/** Entity that was deleted */
|
|
2488
2489
|
deletedEntity?: string | null;
|
|
2489
2490
|
}
|
|
2490
|
-
interface ActionEvent {
|
|
2491
|
+
export interface ActionEvent {
|
|
2491
2492
|
body?: string;
|
|
2492
2493
|
}
|
|
2493
|
-
interface MessageEnvelope {
|
|
2494
|
+
export interface MessageEnvelope {
|
|
2494
2495
|
/**
|
|
2495
2496
|
* App instance ID.
|
|
2496
2497
|
* @format GUID
|
|
@@ -2506,7 +2507,7 @@ interface MessageEnvelope {
|
|
|
2506
2507
|
/** Stringify payload. */
|
|
2507
2508
|
data?: string;
|
|
2508
2509
|
}
|
|
2509
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2510
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2510
2511
|
/**
|
|
2511
2512
|
* ID of a site visitor that has not logged in to the site.
|
|
2512
2513
|
* @format GUID
|
|
@@ -2531,7 +2532,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2531
2532
|
identityType?: WebhookIdentityType;
|
|
2532
2533
|
}
|
|
2533
2534
|
/** @oneof */
|
|
2534
|
-
interface IdentificationDataIdOneOf {
|
|
2535
|
+
export interface IdentificationDataIdOneOf {
|
|
2535
2536
|
/**
|
|
2536
2537
|
* ID of a site visitor that has not logged in to the site.
|
|
2537
2538
|
* @format GUID
|
|
@@ -2553,14 +2554,14 @@ interface IdentificationDataIdOneOf {
|
|
|
2553
2554
|
*/
|
|
2554
2555
|
appId?: string;
|
|
2555
2556
|
}
|
|
2556
|
-
declare enum WebhookIdentityType {
|
|
2557
|
+
export declare enum WebhookIdentityType {
|
|
2557
2558
|
UNKNOWN = "UNKNOWN",
|
|
2558
2559
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2559
2560
|
MEMBER = "MEMBER",
|
|
2560
2561
|
WIX_USER = "WIX_USER",
|
|
2561
2562
|
APP = "APP"
|
|
2562
2563
|
}
|
|
2563
|
-
interface BaseEventMetadata {
|
|
2564
|
+
export interface BaseEventMetadata {
|
|
2564
2565
|
/**
|
|
2565
2566
|
* App instance ID.
|
|
2566
2567
|
* @format GUID
|
|
@@ -2574,7 +2575,7 @@ interface BaseEventMetadata {
|
|
|
2574
2575
|
/** The identification type and identity data. */
|
|
2575
2576
|
identity?: IdentificationData;
|
|
2576
2577
|
}
|
|
2577
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
2578
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
2578
2579
|
/**
|
|
2579
2580
|
* Unique event ID.
|
|
2580
2581
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -2612,43 +2613,227 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
2612
2613
|
*/
|
|
2613
2614
|
entityEventSequence?: string | null;
|
|
2614
2615
|
}
|
|
2615
|
-
interface CommentContentChangedEnvelope {
|
|
2616
|
+
export interface CommentContentChangedEnvelope {
|
|
2616
2617
|
data: CommentContentChanged;
|
|
2617
2618
|
metadata: EventMetadata;
|
|
2618
2619
|
}
|
|
2619
|
-
|
|
2620
|
+
/**
|
|
2621
|
+
* Triggered when comment content is updated.
|
|
2622
|
+
* @permissionScope Read Comments
|
|
2623
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2624
|
+
* @permissionScope Manage Comments
|
|
2625
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2626
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2627
|
+
* @webhook
|
|
2628
|
+
* @eventType wix.comments.v2.comment_comment_content_changed
|
|
2629
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2630
|
+
* @slug comment_content_changed
|
|
2631
|
+
*/
|
|
2632
|
+
export declare function onCommentContentChanged(handler: (event: CommentContentChangedEnvelope) => void | Promise<void>): void;
|
|
2633
|
+
export interface CommentHiddenEnvelope {
|
|
2620
2634
|
data: CommentHidden;
|
|
2621
2635
|
metadata: EventMetadata;
|
|
2622
2636
|
}
|
|
2623
|
-
|
|
2637
|
+
/**
|
|
2638
|
+
* Triggered when a comment is hidden.
|
|
2639
|
+
* @permissionScope Read Comments
|
|
2640
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2641
|
+
* @permissionScope Manage Comments
|
|
2642
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2643
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2644
|
+
* @webhook
|
|
2645
|
+
* @eventType wix.comments.v2.comment_comment_hidden
|
|
2646
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2647
|
+
* @slug comment_hidden
|
|
2648
|
+
* @documentationMaturity preview
|
|
2649
|
+
*/
|
|
2650
|
+
export declare function onCommentHidden(handler: (event: CommentHiddenEnvelope) => void | Promise<void>): void;
|
|
2651
|
+
export interface CommentMarkedEnvelope {
|
|
2624
2652
|
data: CommentMarked;
|
|
2625
2653
|
metadata: EventMetadata;
|
|
2626
2654
|
}
|
|
2627
|
-
|
|
2655
|
+
/**
|
|
2656
|
+
* Triggered when a comment is marked.
|
|
2657
|
+
* @permissionScope Read Comments
|
|
2658
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2659
|
+
* @permissionScope Manage Comments
|
|
2660
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2661
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2662
|
+
* @webhook
|
|
2663
|
+
* @eventType wix.comments.v2.comment_comment_marked
|
|
2664
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2665
|
+
* @slug comment_marked
|
|
2666
|
+
*/
|
|
2667
|
+
export declare function onCommentMarked(handler: (event: CommentMarkedEnvelope) => void | Promise<void>): void;
|
|
2668
|
+
export interface CommentMovedEnvelope {
|
|
2628
2669
|
data: CommentMoved;
|
|
2629
2670
|
metadata: EventMetadata;
|
|
2630
2671
|
}
|
|
2631
|
-
|
|
2672
|
+
/**
|
|
2673
|
+
* Triggered when a comment is moved.
|
|
2674
|
+
* @permissionScope Read Comments
|
|
2675
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2676
|
+
* @permissionScope Manage Comments
|
|
2677
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2678
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2679
|
+
* @webhook
|
|
2680
|
+
* @eventType wix.comments.v2.comment_comment_moved
|
|
2681
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2682
|
+
* @slug comment_moved
|
|
2683
|
+
* @documentationMaturity preview
|
|
2684
|
+
*/
|
|
2685
|
+
export declare function onCommentMoved(handler: (event: CommentMovedEnvelope) => void | Promise<void>): void;
|
|
2686
|
+
export interface CommentPublishedEnvelope {
|
|
2632
2687
|
data: CommentPublished;
|
|
2633
2688
|
metadata: EventMetadata;
|
|
2634
2689
|
}
|
|
2635
|
-
|
|
2690
|
+
/**
|
|
2691
|
+
* Triggered when a comment is published.
|
|
2692
|
+
* @permissionScope Read Comments
|
|
2693
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2694
|
+
* @permissionScope Manage Comments
|
|
2695
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2696
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2697
|
+
* @webhook
|
|
2698
|
+
* @eventType wix.comments.v2.comment_comment_published
|
|
2699
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2700
|
+
* @slug comment_published
|
|
2701
|
+
* @documentationMaturity preview
|
|
2702
|
+
*/
|
|
2703
|
+
export declare function onCommentPublished(handler: (event: CommentPublishedEnvelope) => void | Promise<void>): void;
|
|
2704
|
+
export interface CommentUnmarkedEnvelope {
|
|
2636
2705
|
data: CommentUnmarked;
|
|
2637
2706
|
metadata: EventMetadata;
|
|
2638
2707
|
}
|
|
2639
|
-
|
|
2708
|
+
/**
|
|
2709
|
+
* Triggered when a comment is unmarked.
|
|
2710
|
+
* @permissionScope Read Comments
|
|
2711
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2712
|
+
* @permissionScope Manage Comments
|
|
2713
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2714
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2715
|
+
* @webhook
|
|
2716
|
+
* @eventType wix.comments.v2.comment_comment_unmarked
|
|
2717
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2718
|
+
* @slug comment_unmarked
|
|
2719
|
+
*/
|
|
2720
|
+
export declare function onCommentUnmarked(handler: (event: CommentUnmarkedEnvelope) => void | Promise<void>): void;
|
|
2721
|
+
export interface CommentCreatedEnvelope {
|
|
2640
2722
|
entity: Comment;
|
|
2641
2723
|
metadata: EventMetadata;
|
|
2642
2724
|
}
|
|
2643
|
-
|
|
2725
|
+
/**
|
|
2726
|
+
* Triggered when a comment is created.
|
|
2727
|
+
* @permissionScope Read Comments
|
|
2728
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2729
|
+
* @permissionScope Manage Comments
|
|
2730
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2731
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2732
|
+
* @webhook
|
|
2733
|
+
* @eventType wix.comments.v2.comment_created
|
|
2734
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2735
|
+
* @slug created
|
|
2736
|
+
*/
|
|
2737
|
+
export declare function onCommentCreated(handler: (event: CommentCreatedEnvelope) => void | Promise<void>): void;
|
|
2738
|
+
export interface CommentResourceCommentCountChangedEnvelope {
|
|
2644
2739
|
data: ResourceCommentCountChanged;
|
|
2645
2740
|
metadata: EventMetadata;
|
|
2646
2741
|
}
|
|
2647
|
-
|
|
2742
|
+
/**
|
|
2743
|
+
* Triggered when the total number of comments has changed in a resource.
|
|
2744
|
+
* @permissionScope Read Comments
|
|
2745
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2746
|
+
* @permissionScope Manage Comments
|
|
2747
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2748
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2749
|
+
* @webhook
|
|
2750
|
+
* @eventType wix.comments.v2.comment_resource_comment_count_changed
|
|
2751
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2752
|
+
* @slug resource_comment_count_changed
|
|
2753
|
+
*/
|
|
2754
|
+
export declare function onCommentResourceCommentCountChanged(handler: (event: CommentResourceCommentCountChangedEnvelope) => void | Promise<void>): void;
|
|
2755
|
+
export interface CommentUpdatedEnvelope {
|
|
2648
2756
|
entity: Comment;
|
|
2649
2757
|
metadata: EventMetadata;
|
|
2650
2758
|
}
|
|
2651
|
-
|
|
2759
|
+
/**
|
|
2760
|
+
* Triggered when a comment is updated.
|
|
2761
|
+
* @permissionScope Read Comments
|
|
2762
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2763
|
+
* @permissionScope Manage Comments
|
|
2764
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2765
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2766
|
+
* @webhook
|
|
2767
|
+
* @eventType wix.comments.v2.comment_updated
|
|
2768
|
+
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2769
|
+
* @slug updated
|
|
2770
|
+
*/
|
|
2771
|
+
export declare function onCommentUpdated(handler: (event: CommentUpdatedEnvelope) => void | Promise<void>): void;
|
|
2772
|
+
type CommentNonNullablePaths = `content.richContent.nodes` | `content.richContent.nodes.${number}.buttonData.containerData.width.size` | `content.richContent.nodes.${number}.buttonData.containerData.alignment` | `content.richContent.nodes.${number}.buttonData.type` | `content.richContent.nodes.${number}.buttonData.link.url` | `content.richContent.nodes.${number}.buttonData.link.anchor` | `content.richContent.nodes.${number}.buttonData.link.target` | `content.richContent.nodes.${number}.codeBlockData.textStyle.textAlignment` | `content.richContent.nodes.${number}.dividerData.lineStyle` | `content.richContent.nodes.${number}.dividerData.width` | `content.richContent.nodes.${number}.dividerData.alignment` | `content.richContent.nodes.${number}.fileData.pdfSettings.viewMode` | `content.richContent.nodes.${number}.galleryData.items` | `content.richContent.nodes.${number}.galleryData.options.layout.type` | `content.richContent.nodes.${number}.galleryData.options.layout.orientation` | `content.richContent.nodes.${number}.galleryData.options.item.crop` | `content.richContent.nodes.${number}.galleryData.options.thumbnails.placement` | `content.richContent.nodes.${number}.gifData.height` | `content.richContent.nodes.${number}.gifData.width` | `content.richContent.nodes.${number}.gifData.gifType` | `content.richContent.nodes.${number}.headingData.level` | `content.richContent.nodes.${number}.htmlData.url` | `content.richContent.nodes.${number}.htmlData.html` | `content.richContent.nodes.${number}.htmlData.source` | `content.richContent.nodes.${number}.linkPreviewData.styles.thumbnailPosition` | `content.richContent.nodes.${number}.mapData.mapSettings.mapType` | `content.richContent.nodes.${number}.pollData.poll.options` | `content.richContent.nodes.${number}.pollData.poll.settings.permissions.view` | `content.richContent.nodes.${number}.pollData.poll.settings.permissions.vote` | `content.richContent.nodes.${number}.pollData.layout.poll.type` | `content.richContent.nodes.${number}.pollData.layout.poll.direction` | `content.richContent.nodes.${number}.pollData.design.poll.background.type` | `content.richContent.nodes.${number}.textData.text` | `content.richContent.nodes.${number}.textData.decorations` | `content.richContent.nodes.${number}.textData.decorations.${number}.anchorData.anchor` | `content.richContent.nodes.${number}.textData.decorations.${number}.mentionData.name` | `content.richContent.nodes.${number}.textData.decorations.${number}.mentionData.slug` | `content.richContent.nodes.${number}.textData.decorations.${number}.fontSizeData.unit` | `content.richContent.nodes.${number}.textData.decorations.${number}.type` | `content.richContent.nodes.${number}.appEmbedData.type` | `content.richContent.nodes.${number}.collapsibleListData.initialExpandedItems` | `content.richContent.nodes.${number}.collapsibleListData.direction` | `content.richContent.nodes.${number}.tableData.dimensions.colsWidthRatio` | `content.richContent.nodes.${number}.tableData.dimensions.rowsHeight` | `content.richContent.nodes.${number}.tableData.dimensions.colsMinWidth` | `content.richContent.nodes.${number}.tableCellData.cellStyle.verticalAlignment` | `content.richContent.nodes.${number}.orderedListData.indentation` | `content.richContent.nodes.${number}.bulletedListData.indentation` | `content.richContent.nodes.${number}.blockquoteData.indentation` | `content.richContent.nodes.${number}.type` | `content.richContent.nodes.${number}._id` | `content.richContent.nodes.${number}.nodes` | `content.richContent.metadata.version` | `content.richContent.documentStyle.headerOne.decorations` | `content.mentions` | `content.attachments` | `parentComment.status` | `replyCount` | `voteSummary.netVoteCount` | `voteSummary.upvoteCount` | `voteSummary.downvoteCount` | `status` | `reactionSummary.total` | `marked`;
|
|
2773
|
+
/**
|
|
2774
|
+
* Creates a new comment and publishes it.
|
|
2775
|
+
*
|
|
2776
|
+
* The `appId`, `contextId`, and `resourceId` are all required and associate the created comment with the specific
|
|
2777
|
+
* resource it responds to. See **Integrations** in the Comments introduction for a list of integrated scopes for these fields.
|
|
2778
|
+
*
|
|
2779
|
+
* If the created comment is a direct response to another comment, the `commentId` of the parent comment should be passed
|
|
2780
|
+
* as `parentComment.id` in this comment's request. See **Terminology** in the Comments introduction for additional information on parent comments and replies.
|
|
2781
|
+
* @param comment - Comment to create.
|
|
2782
|
+
* @public
|
|
2783
|
+
* @requiredField comment
|
|
2784
|
+
* @requiredField comment.appId
|
|
2785
|
+
* @requiredField comment.content
|
|
2786
|
+
* @requiredField comment.contextId
|
|
2787
|
+
* @requiredField comment.resourceId
|
|
2788
|
+
* @permissionId WIX_COMMENTS.COMMENT_CREATE
|
|
2789
|
+
* @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_AUTHOR
|
|
2790
|
+
* @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_COMMENT_DATE
|
|
2791
|
+
* @permissionScope Manage Comments
|
|
2792
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2793
|
+
* @permissionScope Manage Comments
|
|
2794
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2795
|
+
* @permissionScope Manage Comments
|
|
2796
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2797
|
+
* @applicableIdentity APP
|
|
2798
|
+
* @returns Created comment.
|
|
2799
|
+
* @fqn wix.comments.ng.v1.CommentsNg.CreateComment
|
|
2800
|
+
*/
|
|
2801
|
+
export declare function createComment(comment: NonNullablePaths<Comment, `appId` | `content` | `contextId` | `resourceId`>): Promise<NonNullablePaths<Comment, CommentNonNullablePaths>>;
|
|
2802
|
+
/**
|
|
2803
|
+
* Retrieves a comment.
|
|
2804
|
+
* @param commentId - ID of the comment to retrieve.
|
|
2805
|
+
* @public
|
|
2806
|
+
* @requiredField commentId
|
|
2807
|
+
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2808
|
+
* @permissionScope Read Comments
|
|
2809
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2810
|
+
* @permissionScope Manage Comments
|
|
2811
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2812
|
+
* @applicableIdentity APP
|
|
2813
|
+
* @returns Retrieved comment.
|
|
2814
|
+
* @fqn wix.comments.ng.v1.CommentsNg.GetComment
|
|
2815
|
+
*/
|
|
2816
|
+
export declare function getComment(commentId: string): Promise<NonNullablePaths<Comment, CommentNonNullablePaths>>;
|
|
2817
|
+
/**
|
|
2818
|
+
* Updates a comment.
|
|
2819
|
+
*
|
|
2820
|
+
* Each time the comment is updated, `revision` increments by 1. The current `revision` must be
|
|
2821
|
+
* passed when updating the comment. This ensures you're working with the latest comment and
|
|
2822
|
+
* prevents unintended overwrites.
|
|
2823
|
+
* @param _id - Comment ID.
|
|
2824
|
+
* @public
|
|
2825
|
+
* @requiredField _id
|
|
2826
|
+
* @requiredField comment
|
|
2827
|
+
* @requiredField comment.revision
|
|
2828
|
+
* @permissionId WIX_COMMENTS.COMMENT_UPDATE
|
|
2829
|
+
* @permissionScope Manage Comments
|
|
2830
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2831
|
+
* @applicableIdentity APP
|
|
2832
|
+
* @returns Updated comment.
|
|
2833
|
+
* @fqn wix.comments.ng.v1.CommentsNg.UpdateComment
|
|
2834
|
+
*/
|
|
2835
|
+
export declare function updateComment(_id: string, comment: NonNullablePaths<UpdateComment, `revision`>): Promise<NonNullablePaths<Comment, CommentNonNullablePaths>>;
|
|
2836
|
+
export interface UpdateComment {
|
|
2652
2837
|
/**
|
|
2653
2838
|
* Comment ID.
|
|
2654
2839
|
* @format GUID
|
|
@@ -2751,10 +2936,73 @@ interface UpdateComment {
|
|
|
2751
2936
|
*/
|
|
2752
2937
|
contentEdited?: boolean | null;
|
|
2753
2938
|
}
|
|
2754
|
-
|
|
2939
|
+
/**
|
|
2940
|
+
* Deletes a comment.
|
|
2941
|
+
*
|
|
2942
|
+
* This method deletes the `content` of the comment and sets its `status` to `DELETED`.
|
|
2943
|
+
* @param commentId - ID of the comment to delete.
|
|
2944
|
+
* @public
|
|
2945
|
+
* @requiredField commentId
|
|
2946
|
+
* @permissionId WIX_COMMENTS.COMMENT_DELETE
|
|
2947
|
+
* @permissionScope Manage Comments
|
|
2948
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2949
|
+
* @applicableIdentity APP
|
|
2950
|
+
* @fqn wix.comments.ng.v1.CommentsNg.DeleteComment
|
|
2951
|
+
*/
|
|
2952
|
+
export declare function deleteComment(commentId: string): Promise<void>;
|
|
2953
|
+
/**
|
|
2954
|
+
* Moderates the draft content of a comment.
|
|
2955
|
+
*
|
|
2956
|
+
* - `APPROVE`: Moves `draftContent` to `content` and updates the comment `status` to `PUBLISHED`.
|
|
2957
|
+
* - `REJECT`: Clears `draftContent` if comment `status` is `PUBLISHED` or, if comment `status` is `PENDING` it will keep `draftContent` the same and change `status` to `HIDDEN`.
|
|
2958
|
+
* @param commentId - ID of the comment to moderate.
|
|
2959
|
+
* @param revision - Revision number, which increments by `1` each time the comment is updated.
|
|
2960
|
+
*
|
|
2961
|
+
* To prevent conflicting changes, the current `revision` must be passed when updating the comment.
|
|
2962
|
+
* @public
|
|
2963
|
+
* @documentationMaturity preview
|
|
2964
|
+
* @requiredField commentId
|
|
2965
|
+
* @requiredField revision
|
|
2966
|
+
* @permissionId WIX_COMMENTS.COMMENT_MODERATE_DRAFT_CONTENT
|
|
2967
|
+
* @permissionScope Manage Comments
|
|
2968
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2969
|
+
* @applicableIdentity APP
|
|
2970
|
+
* @fqn wix.comments.ng.v1.CommentsNg.ModerateDraftContent
|
|
2971
|
+
*/
|
|
2972
|
+
export declare function moderateDraftContent(commentId: string, revision: string, options?: ModerateDraftContentOptions): Promise<NonNullablePaths<ModerateDraftContentResponse, {
|
|
2973
|
+
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
2974
|
+
}[CommentNonNullablePaths]>>;
|
|
2975
|
+
export interface ModerateDraftContentOptions {
|
|
2755
2976
|
/** Draft content action. */
|
|
2756
2977
|
draftContentAction?: Action;
|
|
2757
2978
|
}
|
|
2979
|
+
/**
|
|
2980
|
+
* Creates a query to retrieve a list of comments.
|
|
2981
|
+
*
|
|
2982
|
+
* The `queryComments()` function builds a query to retrieve a list of comments and returns a [`CommentsQueryBuilder`](#commentsquerybuilder) object.
|
|
2983
|
+
*
|
|
2984
|
+
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](#commentsquerybuilder/find) function.
|
|
2985
|
+
*
|
|
2986
|
+
* You can refine the query by chaining `CommentsQueryBuilder` functions onto the query. `CommentsQueryBuilder` functions enable you to sort, filter, and control the results that `queryComments()` returns.
|
|
2987
|
+
*
|
|
2988
|
+
* `queryComments()` runs with the following `CommentsQueryBuilder` default that you can override:
|
|
2989
|
+
* + `ascending("_id")`
|
|
2990
|
+
*
|
|
2991
|
+
* The functions that are chained to `queryComments()` are applied in the order they are called. For example, if you apply `ascending("voteSummary.netVoteCount")` and then `ascending("replyCount")`, the results are sorted first by the `"voteSummary.netVoteCount"`, and then, if there are multiple results with the same `"voteSummary.netVoteCount"`, the items are sorted by `"replyCount"`.
|
|
2992
|
+
*
|
|
2993
|
+
* The following `CommentsQueryBuilder` functions are supported for the `queryComments()` function. For a full description of the comment object, see the object returned for the [`items`](#commentsqueryresult/items) property in [`CommentsQueryResult`](#commentsqueryresult).
|
|
2994
|
+
* @public
|
|
2995
|
+
* @requiredField appId
|
|
2996
|
+
* @param appId - App ID to query comments for.
|
|
2997
|
+
* @permissionScope Read Comments
|
|
2998
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2999
|
+
* @permissionScope Manage Comments
|
|
3000
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3001
|
+
* @permissionId WIX_COMMENTS.COMMENT_QUERY
|
|
3002
|
+
* @applicableIdentity APP
|
|
3003
|
+
* @fqn wix.comments.ng.v1.CommentsNg.QueryComments
|
|
3004
|
+
*/
|
|
3005
|
+
export declare function queryComments(appId: string): CommentsQueryBuilder;
|
|
2758
3006
|
interface QueryCursorResult {
|
|
2759
3007
|
cursors: Cursors;
|
|
2760
3008
|
hasNext: () => boolean;
|
|
@@ -2762,13 +3010,13 @@ interface QueryCursorResult {
|
|
|
2762
3010
|
length: number;
|
|
2763
3011
|
pageSize: number;
|
|
2764
3012
|
}
|
|
2765
|
-
interface CommentsQueryResult extends QueryCursorResult {
|
|
3013
|
+
export interface CommentsQueryResult extends QueryCursorResult {
|
|
2766
3014
|
items: Comment[];
|
|
2767
3015
|
query: CommentsQueryBuilder;
|
|
2768
3016
|
next: () => Promise<CommentsQueryResult>;
|
|
2769
3017
|
prev: () => Promise<CommentsQueryResult>;
|
|
2770
3018
|
}
|
|
2771
|
-
interface CommentsQueryBuilder {
|
|
3019
|
+
export interface CommentsQueryBuilder {
|
|
2772
3020
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2773
3021
|
* @param value - Value to compare against.
|
|
2774
3022
|
*/
|
|
@@ -2812,11 +3060,105 @@ interface CommentsQueryBuilder {
|
|
|
2812
3060
|
skipTo: (cursor: string) => CommentsQueryBuilder;
|
|
2813
3061
|
find: () => Promise<CommentsQueryResult>;
|
|
2814
3062
|
}
|
|
2815
|
-
|
|
3063
|
+
/**
|
|
3064
|
+
* Sets `marked` to `TRUE` to mark a comment.
|
|
3065
|
+
*
|
|
3066
|
+
* Call Query Comments to filter for marked comments to then apply customization to.
|
|
3067
|
+
* See Sample Flows for an example.
|
|
3068
|
+
* @param commentId - ID of the comment to mark.
|
|
3069
|
+
* @public
|
|
3070
|
+
* @requiredField commentId
|
|
3071
|
+
* @permissionId WIX_COMMENTS.COMMENT_MARK
|
|
3072
|
+
* @permissionScope Manage Comments
|
|
3073
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3074
|
+
* @applicableIdentity APP
|
|
3075
|
+
* @fqn wix.comments.ng.v1.CommentsNg.MarkComment
|
|
3076
|
+
*/
|
|
3077
|
+
export declare function markComment(commentId: string): Promise<NonNullablePaths<MarkCommentResponse, {
|
|
3078
|
+
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3079
|
+
}[CommentNonNullablePaths]>>;
|
|
3080
|
+
/**
|
|
3081
|
+
* Sets `marked` to `FALSE` to unmark a comment.
|
|
3082
|
+
* @param commentId - ID of the comment to unmark.
|
|
3083
|
+
* @public
|
|
3084
|
+
* @requiredField commentId
|
|
3085
|
+
* @permissionId WIX_COMMENTS.COMMENT_MARK
|
|
3086
|
+
* @permissionScope Manage Comments
|
|
3087
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3088
|
+
* @applicableIdentity APP
|
|
3089
|
+
* @fqn wix.comments.ng.v1.CommentsNg.UnmarkComment
|
|
3090
|
+
*/
|
|
3091
|
+
export declare function unmarkComment(commentId: string): Promise<NonNullablePaths<UnmarkCommentResponse, {
|
|
3092
|
+
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3093
|
+
}[CommentNonNullablePaths]>>;
|
|
3094
|
+
/**
|
|
3095
|
+
* Hides a comment in a widget. The comment status becomes `HIDDEN`.
|
|
3096
|
+
* @param commentId - ID of the comment to hide.
|
|
3097
|
+
* @public
|
|
3098
|
+
* @documentationMaturity preview
|
|
3099
|
+
* @requiredField commentId
|
|
3100
|
+
* @permissionId WIX_COMMENTS.COMMENT_HIDE
|
|
3101
|
+
* @permissionScope Manage Comments
|
|
3102
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3103
|
+
* @applicableIdentity APP
|
|
3104
|
+
* @fqn wix.comments.ng.v1.CommentsNg.HideComment
|
|
3105
|
+
*/
|
|
3106
|
+
export declare function hideComment(commentId: string): Promise<NonNullablePaths<HideCommentResponse, {
|
|
3107
|
+
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3108
|
+
}[CommentNonNullablePaths]>>;
|
|
3109
|
+
/**
|
|
3110
|
+
* Publishes a comment with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
|
|
3111
|
+
*
|
|
3112
|
+
* To publish a new comment, call Create Comment.
|
|
3113
|
+
* @param commentId - ID of the comment to publish.
|
|
3114
|
+
* @public
|
|
3115
|
+
* @documentationMaturity preview
|
|
3116
|
+
* @requiredField commentId
|
|
3117
|
+
* @permissionId WIX_COMMENTS.COMMENT_PUBLISH
|
|
3118
|
+
* @permissionScope Manage Comments
|
|
3119
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3120
|
+
* @applicableIdentity APP
|
|
3121
|
+
* @fqn wix.comments.ng.v1.CommentsNg.PublishComment
|
|
3122
|
+
*/
|
|
3123
|
+
export declare function publishComment(commentId: string): Promise<NonNullablePaths<PublishCommentResponse, {
|
|
3124
|
+
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3125
|
+
}[CommentNonNullablePaths]>>;
|
|
3126
|
+
/**
|
|
3127
|
+
* Counts comments, given the specified filtering. Comments with the `HIDDEN` status are not included in the response.
|
|
3128
|
+
* @param appId - App ID to count the comments of.
|
|
3129
|
+
* @public
|
|
3130
|
+
* @requiredField appId
|
|
3131
|
+
* @permissionId WIX_COMMENTS.COMMENT_COUNT
|
|
3132
|
+
* @permissionScope Manage Comments
|
|
3133
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3134
|
+
* @applicableIdentity APP
|
|
3135
|
+
* @fqn wix.comments.ng.v1.CommentsNg.CountComments
|
|
3136
|
+
*/
|
|
3137
|
+
export declare function countComments(appId: string, options?: CountCommentsOptions): Promise<NonNullablePaths<CountCommentsResponse, `count`>>;
|
|
3138
|
+
export interface CountCommentsOptions {
|
|
2816
3139
|
/** Filter to identify the comments that need to be counted. */
|
|
2817
3140
|
filter?: Record<string, any> | null;
|
|
2818
3141
|
}
|
|
2819
|
-
|
|
3142
|
+
/**
|
|
3143
|
+
* Lists published comments and replies from a specified resource, such as a blog post.
|
|
3144
|
+
* @param appId - ID of the app from which the comments are listed.
|
|
3145
|
+
* @public
|
|
3146
|
+
* @documentationMaturity preview
|
|
3147
|
+
* @requiredField appId
|
|
3148
|
+
* @requiredField options.contextId
|
|
3149
|
+
* @requiredField options.resourceId
|
|
3150
|
+
* @permissionId WIX_COMMENTS.COMMENT_LIST
|
|
3151
|
+
* @permissionScope Read Comments
|
|
3152
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
3153
|
+
* @permissionScope Manage Comments
|
|
3154
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3155
|
+
* @applicableIdentity APP
|
|
3156
|
+
* @fqn wix.comments.ng.v1.CommentsNg.ListCommentsByResource
|
|
3157
|
+
*/
|
|
3158
|
+
export declare function listCommentsByResource(appId: string, options?: NonNullablePaths<ListCommentsByResourceOptions, `contextId` | `resourceId`>): Promise<NonNullablePaths<ListCommentsByResourceResponse, {
|
|
3159
|
+
[P in CommentNonNullablePaths]: `comments.${number}.${P}`;
|
|
3160
|
+
}[CommentNonNullablePaths]>>;
|
|
3161
|
+
export interface ListCommentsByResourceOptions {
|
|
2820
3162
|
/**
|
|
2821
3163
|
* ID of the specific context the comment is in response to.
|
|
2822
3164
|
*
|
|
@@ -2843,7 +3185,28 @@ interface ListCommentsByResourceOptions {
|
|
|
2843
3185
|
/** Cursor paging. */
|
|
2844
3186
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2845
3187
|
}
|
|
2846
|
-
|
|
3188
|
+
/**
|
|
3189
|
+
* Returns a thread of a comment or a reply.
|
|
3190
|
+
*
|
|
3191
|
+
* If you request a comment thread, the method returns a single comment with cursors. With cursors (`pagingMetadata.cursors.next` or `pagingMetadata.cursors.prev`) you can load replies by calling the List Comments by Resource method.
|
|
3192
|
+
*
|
|
3193
|
+
* If you request a reply thread, the method returns a reply with its parent comment. With cursors (`pagingMetadata.cursors.next` or `pagingMetadata.cursors.prev`) you can load replies by calling the List Comments by Resource method.
|
|
3194
|
+
* @param commentId - Comment ID.
|
|
3195
|
+
* @public
|
|
3196
|
+
* @documentationMaturity preview
|
|
3197
|
+
* @requiredField commentId
|
|
3198
|
+
* @permissionId WIX_COMMENTS.COMMENT_THREAD
|
|
3199
|
+
* @permissionScope Read Comments
|
|
3200
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
3201
|
+
* @permissionScope Manage Comments
|
|
3202
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3203
|
+
* @applicableIdentity APP
|
|
3204
|
+
* @fqn wix.comments.ng.v1.CommentsNg.GetCommentThread
|
|
3205
|
+
*/
|
|
3206
|
+
export declare function getCommentThread(commentId: string, options?: GetCommentThreadOptions): Promise<NonNullablePaths<GetCommentThreadResponse, {
|
|
3207
|
+
[P in CommentNonNullablePaths]: `comments.${number}.${P}`;
|
|
3208
|
+
}[CommentNonNullablePaths]>>;
|
|
3209
|
+
export interface GetCommentThreadOptions {
|
|
2847
3210
|
/**
|
|
2848
3211
|
* App ID.
|
|
2849
3212
|
* @maxLength 128
|
|
@@ -2856,29 +3219,105 @@ interface GetCommentThreadOptions {
|
|
|
2856
3219
|
/** Reply sorting. */
|
|
2857
3220
|
replySort?: ReplySort;
|
|
2858
3221
|
}
|
|
2859
|
-
|
|
3222
|
+
/**
|
|
3223
|
+
* Publishes multiple comments with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
|
|
3224
|
+
* @param appId - ID of the app where to publish the comment.
|
|
3225
|
+
* @public
|
|
3226
|
+
* @documentationMaturity preview
|
|
3227
|
+
* @requiredField appId
|
|
3228
|
+
* @requiredField options
|
|
3229
|
+
* @requiredField options.filter
|
|
3230
|
+
* @permissionId WIX_COMMENTS.BULK_COMMENT_PUBLISH
|
|
3231
|
+
* @permissionScope Manage Comments
|
|
3232
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3233
|
+
* @applicableIdentity APP
|
|
3234
|
+
* @fqn wix.comments.ng.v1.CommentsNg.BulkPublishComment
|
|
3235
|
+
*/
|
|
3236
|
+
export declare function bulkPublishComment(appId: string, options: NonNullablePaths<BulkPublishCommentOptions, `filter`>): Promise<NonNullablePaths<BulkPublishCommentResponse, `jobId`>>;
|
|
3237
|
+
export interface BulkPublishCommentOptions {
|
|
2860
3238
|
/** Filter to identify the comments that need to be published. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2861
3239
|
filter: Record<string, any> | null;
|
|
2862
3240
|
}
|
|
2863
|
-
|
|
3241
|
+
/**
|
|
3242
|
+
* Hides multiple comments. The comment status becomes `HIDDEN`.
|
|
3243
|
+
* @param appId - ID of the app where to hide the comments.
|
|
3244
|
+
* @public
|
|
3245
|
+
* @documentationMaturity preview
|
|
3246
|
+
* @requiredField appId
|
|
3247
|
+
* @requiredField options
|
|
3248
|
+
* @requiredField options.filter
|
|
3249
|
+
* @permissionId WIX_COMMENTS.BULK_COMMENT_HIDE
|
|
3250
|
+
* @permissionScope Manage Comments
|
|
3251
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3252
|
+
* @applicableIdentity APP
|
|
3253
|
+
* @fqn wix.comments.ng.v1.CommentsNg.BulkHideComment
|
|
3254
|
+
*/
|
|
3255
|
+
export declare function bulkHideComment(appId: string, options: NonNullablePaths<BulkHideCommentOptions, `filter`>): Promise<NonNullablePaths<BulkHideCommentResponse, `jobId`>>;
|
|
3256
|
+
export interface BulkHideCommentOptions {
|
|
2864
3257
|
/** Filter to identify the comments that need to be hidden. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2865
3258
|
filter: Record<string, any> | null;
|
|
2866
3259
|
}
|
|
2867
|
-
|
|
3260
|
+
/**
|
|
3261
|
+
* Deletes multiple comments.
|
|
3262
|
+
* @param appId - ID of the app where to delete the comments.
|
|
3263
|
+
* @public
|
|
3264
|
+
* @documentationMaturity preview
|
|
3265
|
+
* @requiredField appId
|
|
3266
|
+
* @requiredField options
|
|
3267
|
+
* @requiredField options.filter
|
|
3268
|
+
* @permissionId WIX_COMMENTS.BULK_COMMENT_DELETE
|
|
3269
|
+
* @permissionScope Manage Comments
|
|
3270
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3271
|
+
* @applicableIdentity APP
|
|
3272
|
+
* @fqn wix.comments.ng.v1.CommentsNg.BulkDeleteComment
|
|
3273
|
+
*/
|
|
3274
|
+
export declare function bulkDeleteComment(appId: string, options: NonNullablePaths<BulkDeleteCommentOptions, `filter`>): Promise<NonNullablePaths<BulkDeleteCommentResponse, `jobId`>>;
|
|
3275
|
+
export interface BulkDeleteCommentOptions {
|
|
2868
3276
|
/** Filter to identify the comments that need to be deleted. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2869
3277
|
filter: Record<string, any> | null;
|
|
2870
3278
|
}
|
|
2871
|
-
|
|
3279
|
+
/**
|
|
3280
|
+
* Moderates the draft content of multiple comments.
|
|
3281
|
+
* @param appId - ID of the app where to moderate the comments.
|
|
3282
|
+
* @public
|
|
3283
|
+
* @documentationMaturity preview
|
|
3284
|
+
* @requiredField appId
|
|
3285
|
+
* @requiredField options
|
|
3286
|
+
* @requiredField options.draftContentAction
|
|
3287
|
+
* @requiredField options.filter
|
|
3288
|
+
* @permissionId WIX_COMMENTS.BULK_COMMENT_MODERATE_DRAFT_CONTENT
|
|
3289
|
+
* @permissionScope Manage Comments
|
|
3290
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3291
|
+
* @applicableIdentity APP
|
|
3292
|
+
* @fqn wix.comments.ng.v1.CommentsNg.BulkModerateDraftContent
|
|
3293
|
+
*/
|
|
3294
|
+
export declare function bulkModerateDraftContent(appId: string, options: NonNullablePaths<BulkModerateDraftContentOptions, `draftContentAction` | `filter`>): Promise<NonNullablePaths<BulkModerateDraftContentResponse, `jobId`>>;
|
|
3295
|
+
export interface BulkModerateDraftContentOptions {
|
|
2872
3296
|
/** Filter to identify the comment content that needs to be moderated. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2873
3297
|
filter: Record<string, any> | null;
|
|
2874
3298
|
/** Action to do regarding draft content */
|
|
2875
3299
|
draftContentAction: Action;
|
|
2876
3300
|
}
|
|
2877
|
-
|
|
3301
|
+
/**
|
|
3302
|
+
* Moves multiple comments to another resource.
|
|
3303
|
+
* @param appId - ID of the app from which to move the comments.
|
|
3304
|
+
* @public
|
|
3305
|
+
* @documentationMaturity preview
|
|
3306
|
+
* @requiredField appId
|
|
3307
|
+
* @requiredField options.destination.contextId
|
|
3308
|
+
* @requiredField options.destination.resourceId
|
|
3309
|
+
* @requiredField options.filter
|
|
3310
|
+
* @permissionId WIX_COMMENTS.BULK_COMMENT_MOVE
|
|
3311
|
+
* @permissionScope Manage Comments
|
|
3312
|
+
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3313
|
+
* @applicableIdentity APP
|
|
3314
|
+
* @fqn wix.comments.ng.v1.CommentsNg.BulkMoveCommentByFilter
|
|
3315
|
+
*/
|
|
3316
|
+
export declare function bulkMoveCommentByFilter(appId: string, options?: NonNullablePaths<BulkMoveCommentByFilterOptions, `destination.contextId` | `destination.resourceId` | `filter`>): Promise<NonNullablePaths<BulkMoveCommentByFilterResponse, `jobId`>>;
|
|
3317
|
+
export interface BulkMoveCommentByFilterOptions {
|
|
2878
3318
|
/** Filter to identify the comments that need to be moved. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2879
3319
|
filter: Record<string, any> | null;
|
|
2880
3320
|
/** Where to move the comment. */
|
|
2881
3321
|
destination?: Destination;
|
|
2882
3322
|
}
|
|
2883
|
-
|
|
2884
|
-
export { VerticalAlignment as $, Alignment as A, type BulkPublishCommentOptions as B, type Comment as C, Position as D, MapType as E, ViewRole as F, type GetCommentThreadOptions as G, type HideCommentResponse as H, VoteRole as I, PollLayoutType as J, PollLayoutDirection as K, type ListCommentsByResourceOptions as L, type ModerateDraftContentOptions as M, NodeType as N, Orientation as O, type PublishCommentResponse as P, BackgroundType as Q, DecorationType as R, Source as S, Type as T, type UpdateComment as U, ViewMode as V, WidthType as W, FontType as X, AppType as Y, InitialExpandedItems as Z, Direction as _, type ModerateDraftContentResponse as a, type BackgroundBackgroundOneOf as a$, NullValue as a0, Status as a1, VersioningMode as a2, Action as a3, SortOrder as a4, Order as a5, ReplySortOrder as a6, WebhookIdentityType as a7, type CommentContent as a8, type RichContent as a9, type Item as aA, type ItemDataOneOf as aB, type GalleryOptions as aC, type Layout as aD, type ItemStyle as aE, type Thumbnails as aF, type GIFData as aG, type GIF as aH, type HeadingData as aI, type HTMLData as aJ, type HTMLDataDataOneOf as aK, type ImageData as aL, type StylesBorder as aM, type ImageDataStyles as aN, type LinkPreviewData as aO, type LinkPreviewDataStyles as aP, type MapData as aQ, type MapSettings as aR, type ParagraphData as aS, type PollData as aT, type Permissions as aU, type Option as aV, type Settings as aW, type PollLayout as aX, type OptionLayout as aY, type Gradient as aZ, type Background as a_, type Node as aa, type NodeDataOneOf as ab, type NodeStyle as ac, type ButtonData as ad, type Border as ae, type Colors as af, type PluginContainerData as ag, type PluginContainerDataWidth as ah, type PluginContainerDataWidthDataOneOf as ai, type Spoiler as aj, type Height as ak, type Styles as al, type Link as am, type LinkDataOneOf as an, type Rel as ao, type CodeBlockData as ap, type TextStyle as aq, type DividerData as ar, type FileData as as, type FileSource as at, type FileSourceDataOneOf as au, type PDFSettings as av, type GalleryData as aw, type Media as ax, type Image as ay, type Video as az, type CommentsQueryBuilder as b, type ContactDetails as b$, type PollDesign as b0, type OptionDesign as b1, type Poll as b2, type PollDataLayout as b3, type Design as b4, type TextData as b5, type Decoration as b6, type DecorationDataOneOf as b7, type AnchorData as b8, type ColorData as b9, type DocumentStyle as bA, type TextNodeStyle as bB, type Mention as bC, type MentionIdentityOneOf as bD, type Attachment as bE, type AttachmentMediaOneOf as bF, type VideoResolution as bG, type ContentAuthor as bH, type ContentAuthorAuthorOneOf as bI, type CommentAuthor as bJ, type CommentAuthorIdentityOneOf as bK, type ParentComment as bL, type VoteSummary as bM, type CommentReactionSummary as bN, type UpdateInternalDocumentsEvent as bO, type UpdateInternalDocumentsEventOperationOneOf as bP, type InternalDocument as bQ, type InternalDocumentUpdateOperation as bR, type DeleteByIdsOperation as bS, type DeleteByFilterOperation as bT, type InternalDocumentUpdateByFilterOperation as bU, type InternalUpdateExistingOperation as bV, type VersionedDocumentUpdateOperation as bW, type VersionedDeleteByIdsOperation as bX, type VersionedDocumentId as bY, type CommentModerated as bZ, type CreateCommentRequest as b_, type LinkData as ba, type MentionData as bb, type FontSizeData as bc, type SpoilerData as bd, type AppEmbedData as be, type AppEmbedDataAppDataOneOf as bf, type BookingData as bg, type EventData as bh, type VideoData as bi, type PlaybackOptions as bj, type EmbedData as bk, type Oembed as bl, type CollapsibleListData as bm, type TableData as bn, type Dimensions as bo, type TableCellData as bp, type CellStyle as bq, type BorderColors as br, type ListValue as bs, type AudioData as bt, type OrderedListData as bu, type BulletedListData as bv, type BlockquoteData as bw, type CaptionData as bx, type LayoutCellData as by, type Metadata as bz, type MarkCommentResponse as c, type CreateCommentResponse as c0, type ResourceCommentCountChanged as c1, type GetCommentRequest as c2, type GetCommentResponse as c3, type UpdateCommentRequest as c4, type UpdateCommentResponse as c5, type CommentContentChanged as c6, type DeleteCommentRequest as c7, type DeleteCommentResponse as c8, type CommentDeleted as c9, type BulkDeleteCommentRequest as cA, type BulkModerateDraftContentRequest as cB, type BulkMoveCommentByFilterRequest as cC, type Destination as cD, type CommentMoved as cE, type DomainEvent as cF, type DomainEventBodyOneOf as cG, type EntityCreatedEvent as cH, type RestoreInfo as cI, type EntityUpdatedEvent as cJ, type EntityDeletedEvent as cK, type ActionEvent as cL, type MessageEnvelope as cM, type IdentificationData as cN, type IdentificationDataIdOneOf as cO, type BaseEventMetadata as cP, type EventMetadata as cQ, type CommentContentChangedEnvelope as cR, type CommentHiddenEnvelope as cS, type CommentMarkedEnvelope as cT, type CommentMovedEnvelope as cU, type CommentPublishedEnvelope as cV, type CommentUnmarkedEnvelope as cW, type CommentCreatedEnvelope as cX, type CommentResourceCommentCountChangedEnvelope as cY, type CommentUpdatedEnvelope as cZ, type CommentsQueryResult as c_, type ModerateDraftContentRequest as ca, type CommentPublished as cb, type CommentHidden as cc, type QueryCommentsRequest as cd, type CursorQuery as ce, type CursorQueryPagingMethodOneOf as cf, type Sorting as cg, type CursorPaging as ch, type QueryCommentsResponse as ci, type CursorPagingMetadata as cj, type Cursors as ck, type MarkCommentRequest as cl, type CommentMarked as cm, type UnmarkCommentRequest as cn, type CommentUnmarked as co, type HideCommentRequest as cp, type PublishCommentRequest as cq, type CountCommentsRequest as cr, type ListCommentsByResourceRequest as cs, type CommentSort as ct, type ReplySort as cu, type ListCommentsByResourceCursorPaging as cv, type RepliesListResponse as cw, type GetCommentThreadRequest as cx, type BulkPublishCommentRequest as cy, type BulkHideCommentRequest as cz, type UnmarkCommentResponse as d, type CountCommentsOptions as e, type CountCommentsResponse as f, type ListCommentsByResourceResponse as g, type GetCommentThreadResponse as h, type BulkPublishCommentResponse as i, type BulkHideCommentOptions as j, type BulkHideCommentResponse as k, type BulkDeleteCommentOptions as l, type BulkDeleteCommentResponse as m, type BulkModerateDraftContentOptions as n, type BulkModerateDraftContentResponse as o, type BulkMoveCommentByFilterOptions as p, type BulkMoveCommentByFilterResponse as q, PluginContainerDataAlignment as r, Target as s, TextAlignment as t, LineStyle as u, Width as v, LayoutType as w, Crop as x, ThumbnailsAlignment as y, GIFType as z };
|
|
3323
|
+
export {};
|