@wix/auto_sdk_comments_comments 1.0.16 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/comments-v2-comment-comments.universal.d.ts → comments-v2-comment-comments.universal-kzUoSqmO.d.mts} +315 -774
- package/build/{es/src/comments-v2-comment-comments.universal.d.ts → comments-v2-comment-comments.universal-kzUoSqmO.d.ts} +315 -774
- package/build/index.d.mts +257 -0
- package/build/index.d.ts +257 -0
- package/build/index.js +5269 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +5182 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/comments-v2-comment-comments.universal.d.ts → comments-v2-comment-comments.universal-kzUoSqmO.d.mts} +315 -774
- package/build/{cjs/src/comments-v2-comment-comments.universal.d.ts → internal/comments-v2-comment-comments.universal-kzUoSqmO.d.ts} +315 -774
- package/build/internal/index.d.mts +257 -0
- package/build/internal/index.d.ts +257 -0
- package/build/internal/index.js +5269 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +5182 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/comments-v2-comment-comments.types.d.ts → internal/meta.d.mts} +274 -590
- package/build/internal/{cjs/src/comments-v2-comment-comments.types.d.ts → meta.d.ts} +274 -590
- package/build/internal/meta.js +2832 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +2788 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/comments-v2-comment-comments.types.d.ts → meta.d.mts} +274 -590
- package/build/{internal/es/src/comments-v2-comment-comments.types.d.ts → meta.d.ts} +274 -590
- package/build/meta.js +2832 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +2788 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/cjs/src/comments-v2-comment-comments.context.js +0 -109
- package/build/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/cjs/src/comments-v2-comment-comments.http.js +0 -2533
- package/build/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/cjs/src/comments-v2-comment-comments.meta.js +0 -370
- package/build/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/cjs/src/comments-v2-comment-comments.public.js +0 -1341
- package/build/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.types.js +0 -386
- package/build/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.universal.js +0 -1606
- package/build/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/es/src/comments-v2-comment-comments.context.js +0 -68
- package/build/es/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/es/src/comments-v2-comment-comments.http.js +0 -2512
- package/build/es/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/es/src/comments-v2-comment-comments.meta.js +0 -326
- package/build/es/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/es/src/comments-v2-comment-comments.public.js +0 -1282
- package/build/es/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.types.js +0 -383
- package/build/es/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.universal.js +0 -1561
- package/build/es/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js +0 -109
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js +0 -2533
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js +0 -370
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js +0 -1341
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js +0 -386
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +0 -1606
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/internal/es/src/comments-v2-comment-comments.context.js +0 -68
- package/build/internal/es/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/internal/es/src/comments-v2-comment-comments.http.js +0 -2512
- package/build/internal/es/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/internal/es/src/comments-v2-comment-comments.meta.js +0 -326
- package/build/internal/es/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/internal/es/src/comments-v2-comment-comments.public.js +0 -1282
- package/build/internal/es/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.types.js +0 -383
- package/build/internal/es/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.universal.js +0 -1561
- package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +0 -1
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* A comment is a user-generated message in response to a specific resource. It allows site visitors
|
|
4
3
|
* to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
|
|
5
4
|
* or other site content. Comments are composed of text, images, videos, or other forms of media.
|
|
6
5
|
*/
|
|
7
|
-
|
|
6
|
+
interface Comment {
|
|
8
7
|
/**
|
|
9
8
|
* Comment ID.
|
|
10
9
|
* @format GUID
|
|
@@ -108,7 +107,7 @@ export interface Comment {
|
|
|
108
107
|
contentEdited?: boolean | null;
|
|
109
108
|
}
|
|
110
109
|
/** Comment content. */
|
|
111
|
-
|
|
110
|
+
interface CommentContent {
|
|
112
111
|
/**
|
|
113
112
|
* Comment rich content.
|
|
114
113
|
*
|
|
@@ -130,7 +129,7 @@ export interface CommentContent {
|
|
|
130
129
|
*/
|
|
131
130
|
attachments?: Attachment[];
|
|
132
131
|
}
|
|
133
|
-
|
|
132
|
+
interface RichContent {
|
|
134
133
|
/** Node objects representing a rich content document. */
|
|
135
134
|
nodes?: Node[];
|
|
136
135
|
/** Object metadata. */
|
|
@@ -138,7 +137,7 @@ export interface RichContent {
|
|
|
138
137
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
139
138
|
documentStyle?: DocumentStyle;
|
|
140
139
|
}
|
|
141
|
-
|
|
140
|
+
interface Node extends NodeDataOneOf {
|
|
142
141
|
/** Data for a button node. */
|
|
143
142
|
buttonData?: ButtonData;
|
|
144
143
|
/** Data for a code block node. */
|
|
@@ -203,7 +202,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
203
202
|
style?: NodeStyle;
|
|
204
203
|
}
|
|
205
204
|
/** @oneof */
|
|
206
|
-
|
|
205
|
+
interface NodeDataOneOf {
|
|
207
206
|
/** Data for a button node. */
|
|
208
207
|
buttonData?: ButtonData;
|
|
209
208
|
/** Data for a code block node. */
|
|
@@ -259,7 +258,7 @@ export interface NodeDataOneOf {
|
|
|
259
258
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
260
259
|
layoutCellData?: LayoutCellData;
|
|
261
260
|
}
|
|
262
|
-
|
|
261
|
+
declare enum NodeType {
|
|
263
262
|
PARAGRAPH = "PARAGRAPH",
|
|
264
263
|
TEXT = "TEXT",
|
|
265
264
|
HEADING = "HEADING",
|
|
@@ -296,8 +295,8 @@ export declare enum NodeType {
|
|
|
296
295
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
297
296
|
}
|
|
298
297
|
/** @enumType */
|
|
299
|
-
|
|
300
|
-
|
|
298
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
299
|
+
interface NodeStyle {
|
|
301
300
|
/** The top padding value in pixels. */
|
|
302
301
|
paddingTop?: string | null;
|
|
303
302
|
/** The bottom padding value in pixels. */
|
|
@@ -305,7 +304,7 @@ export interface NodeStyle {
|
|
|
305
304
|
/** The background color as a hexadecimal value. */
|
|
306
305
|
backgroundColor?: string | null;
|
|
307
306
|
}
|
|
308
|
-
|
|
307
|
+
interface ButtonData {
|
|
309
308
|
/** Styling for the button's container. */
|
|
310
309
|
containerData?: PluginContainerData;
|
|
311
310
|
/** The button type. */
|
|
@@ -317,7 +316,7 @@ export interface ButtonData {
|
|
|
317
316
|
/** Button link details. */
|
|
318
317
|
link?: Link;
|
|
319
318
|
}
|
|
320
|
-
|
|
319
|
+
interface Border {
|
|
321
320
|
/**
|
|
322
321
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
323
322
|
* @deprecated
|
|
@@ -329,7 +328,7 @@ export interface Border {
|
|
|
329
328
|
*/
|
|
330
329
|
radius?: number | null;
|
|
331
330
|
}
|
|
332
|
-
|
|
331
|
+
interface Colors {
|
|
333
332
|
/**
|
|
334
333
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
335
334
|
* @deprecated
|
|
@@ -346,7 +345,7 @@ export interface Colors {
|
|
|
346
345
|
*/
|
|
347
346
|
background?: string | null;
|
|
348
347
|
}
|
|
349
|
-
|
|
348
|
+
interface PluginContainerData {
|
|
350
349
|
/** The width of the node when it's displayed. */
|
|
351
350
|
width?: PluginContainerDataWidth;
|
|
352
351
|
/** The node's alignment within its container. */
|
|
@@ -358,7 +357,7 @@ export interface PluginContainerData {
|
|
|
358
357
|
/** 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`. */
|
|
359
358
|
textWrap?: boolean | null;
|
|
360
359
|
}
|
|
361
|
-
|
|
360
|
+
declare enum WidthType {
|
|
362
361
|
/** Width matches the content width */
|
|
363
362
|
CONTENT = "CONTENT",
|
|
364
363
|
/** Small Width */
|
|
@@ -369,8 +368,8 @@ export declare enum WidthType {
|
|
|
369
368
|
FULL_WIDTH = "FULL_WIDTH"
|
|
370
369
|
}
|
|
371
370
|
/** @enumType */
|
|
372
|
-
|
|
373
|
-
|
|
371
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
372
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
374
373
|
/**
|
|
375
374
|
* One of the following predefined width options:
|
|
376
375
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -383,7 +382,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
383
382
|
custom?: string | null;
|
|
384
383
|
}
|
|
385
384
|
/** @oneof */
|
|
386
|
-
|
|
385
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
387
386
|
/**
|
|
388
387
|
* One of the following predefined width options:
|
|
389
388
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -395,7 +394,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
395
394
|
/** A custom width value in pixels. */
|
|
396
395
|
custom?: string | null;
|
|
397
396
|
}
|
|
398
|
-
|
|
397
|
+
declare enum PluginContainerDataAlignment {
|
|
399
398
|
/** Center Alignment */
|
|
400
399
|
CENTER = "CENTER",
|
|
401
400
|
/** Left Alignment */
|
|
@@ -404,8 +403,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
404
403
|
RIGHT = "RIGHT"
|
|
405
404
|
}
|
|
406
405
|
/** @enumType */
|
|
407
|
-
|
|
408
|
-
|
|
406
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
407
|
+
interface Spoiler {
|
|
409
408
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
410
409
|
enabled?: boolean | null;
|
|
411
410
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -413,19 +412,19 @@ export interface Spoiler {
|
|
|
413
412
|
/** The text for the button used to remove the spoiler cover. */
|
|
414
413
|
buttonText?: string | null;
|
|
415
414
|
}
|
|
416
|
-
|
|
415
|
+
interface Height {
|
|
417
416
|
/** A custom height value in pixels. */
|
|
418
417
|
custom?: string | null;
|
|
419
418
|
}
|
|
420
|
-
|
|
419
|
+
declare enum Type {
|
|
421
420
|
/** Regular link button */
|
|
422
421
|
LINK = "LINK",
|
|
423
422
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
424
423
|
ACTION = "ACTION"
|
|
425
424
|
}
|
|
426
425
|
/** @enumType */
|
|
427
|
-
|
|
428
|
-
|
|
426
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
427
|
+
interface Styles {
|
|
429
428
|
/**
|
|
430
429
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
431
430
|
* @deprecated
|
|
@@ -478,7 +477,7 @@ export interface Styles {
|
|
|
478
477
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
479
478
|
buttonSize?: string | null;
|
|
480
479
|
}
|
|
481
|
-
|
|
480
|
+
interface Link extends LinkDataOneOf {
|
|
482
481
|
/** The absolute URL for the linked document. */
|
|
483
482
|
url?: string;
|
|
484
483
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -497,13 +496,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
497
496
|
customData?: string | null;
|
|
498
497
|
}
|
|
499
498
|
/** @oneof */
|
|
500
|
-
|
|
499
|
+
interface LinkDataOneOf {
|
|
501
500
|
/** The absolute URL for the linked document. */
|
|
502
501
|
url?: string;
|
|
503
502
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
504
503
|
anchor?: string;
|
|
505
504
|
}
|
|
506
|
-
|
|
505
|
+
declare enum Target {
|
|
507
506
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
508
507
|
SELF = "SELF",
|
|
509
508
|
/** Opens the linked document in a new window or tab */
|
|
@@ -514,8 +513,8 @@ export declare enum Target {
|
|
|
514
513
|
TOP = "TOP"
|
|
515
514
|
}
|
|
516
515
|
/** @enumType */
|
|
517
|
-
|
|
518
|
-
|
|
516
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
517
|
+
interface Rel {
|
|
519
518
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
520
519
|
nofollow?: boolean | null;
|
|
521
520
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -525,17 +524,17 @@ export interface Rel {
|
|
|
525
524
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
526
525
|
noreferrer?: boolean | null;
|
|
527
526
|
}
|
|
528
|
-
|
|
527
|
+
interface CodeBlockData {
|
|
529
528
|
/** Styling for the code block's text. */
|
|
530
529
|
textStyle?: TextStyle;
|
|
531
530
|
}
|
|
532
|
-
|
|
531
|
+
interface TextStyle {
|
|
533
532
|
/** Text alignment. Defaults to `AUTO`. */
|
|
534
533
|
textAlignment?: TextAlignmentWithLiterals;
|
|
535
534
|
/** 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. */
|
|
536
535
|
lineHeight?: string | null;
|
|
537
536
|
}
|
|
538
|
-
|
|
537
|
+
declare enum TextAlignment {
|
|
539
538
|
/** browser default, eqivalent to `initial` */
|
|
540
539
|
AUTO = "AUTO",
|
|
541
540
|
/** Left align */
|
|
@@ -548,8 +547,8 @@ export declare enum TextAlignment {
|
|
|
548
547
|
JUSTIFY = "JUSTIFY"
|
|
549
548
|
}
|
|
550
549
|
/** @enumType */
|
|
551
|
-
|
|
552
|
-
|
|
550
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
551
|
+
interface DividerData {
|
|
553
552
|
/** Styling for the divider's container. */
|
|
554
553
|
containerData?: PluginContainerData;
|
|
555
554
|
/** Divider line style. */
|
|
@@ -559,7 +558,7 @@ export interface DividerData {
|
|
|
559
558
|
/** Divider alignment. */
|
|
560
559
|
alignment?: AlignmentWithLiterals;
|
|
561
560
|
}
|
|
562
|
-
|
|
561
|
+
declare enum LineStyle {
|
|
563
562
|
/** Single Line */
|
|
564
563
|
SINGLE = "SINGLE",
|
|
565
564
|
/** Double Line */
|
|
@@ -570,8 +569,8 @@ export declare enum LineStyle {
|
|
|
570
569
|
DOTTED = "DOTTED"
|
|
571
570
|
}
|
|
572
571
|
/** @enumType */
|
|
573
|
-
|
|
574
|
-
|
|
572
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
573
|
+
declare enum Width {
|
|
575
574
|
/** Large line */
|
|
576
575
|
LARGE = "LARGE",
|
|
577
576
|
/** Medium line */
|
|
@@ -580,8 +579,8 @@ export declare enum Width {
|
|
|
580
579
|
SMALL = "SMALL"
|
|
581
580
|
}
|
|
582
581
|
/** @enumType */
|
|
583
|
-
|
|
584
|
-
|
|
582
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
583
|
+
declare enum Alignment {
|
|
585
584
|
/** Center alignment */
|
|
586
585
|
CENTER = "CENTER",
|
|
587
586
|
/** Left alignment */
|
|
@@ -590,8 +589,8 @@ export declare enum Alignment {
|
|
|
590
589
|
RIGHT = "RIGHT"
|
|
591
590
|
}
|
|
592
591
|
/** @enumType */
|
|
593
|
-
|
|
594
|
-
|
|
592
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
593
|
+
interface FileData {
|
|
595
594
|
/** Styling for the file's container. */
|
|
596
595
|
containerData?: PluginContainerData;
|
|
597
596
|
/** The source for the file's data. */
|
|
@@ -614,7 +613,7 @@ export interface FileData {
|
|
|
614
613
|
/** File size in KB. */
|
|
615
614
|
sizeInKb?: string | null;
|
|
616
615
|
}
|
|
617
|
-
|
|
616
|
+
declare enum ViewMode {
|
|
618
617
|
/** No PDF view */
|
|
619
618
|
NONE = "NONE",
|
|
620
619
|
/** Full PDF view */
|
|
@@ -623,8 +622,8 @@ export declare enum ViewMode {
|
|
|
623
622
|
MINI = "MINI"
|
|
624
623
|
}
|
|
625
624
|
/** @enumType */
|
|
626
|
-
|
|
627
|
-
|
|
625
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
626
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
628
627
|
/** The absolute URL for the file's source. */
|
|
629
628
|
url?: string | null;
|
|
630
629
|
/**
|
|
@@ -638,7 +637,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
638
637
|
private?: boolean | null;
|
|
639
638
|
}
|
|
640
639
|
/** @oneof */
|
|
641
|
-
|
|
640
|
+
interface FileSourceDataOneOf {
|
|
642
641
|
/** The absolute URL for the file's source. */
|
|
643
642
|
url?: string | null;
|
|
644
643
|
/**
|
|
@@ -649,7 +648,7 @@ export interface FileSourceDataOneOf {
|
|
|
649
648
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
650
649
|
id?: string | null;
|
|
651
650
|
}
|
|
652
|
-
|
|
651
|
+
interface PDFSettings {
|
|
653
652
|
/**
|
|
654
653
|
* PDF view mode. One of the following:
|
|
655
654
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -662,7 +661,7 @@ export interface PDFSettings {
|
|
|
662
661
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
663
662
|
disablePrint?: boolean | null;
|
|
664
663
|
}
|
|
665
|
-
|
|
664
|
+
interface GalleryData {
|
|
666
665
|
/** Styling for the gallery's container. */
|
|
667
666
|
containerData?: PluginContainerData;
|
|
668
667
|
/** The items in the gallery. */
|
|
@@ -674,7 +673,7 @@ export interface GalleryData {
|
|
|
674
673
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
675
674
|
disableDownload?: boolean | null;
|
|
676
675
|
}
|
|
677
|
-
|
|
676
|
+
interface Media {
|
|
678
677
|
/** The source for the media's data. */
|
|
679
678
|
src?: FileSource;
|
|
680
679
|
/** Media width in pixels. */
|
|
@@ -684,19 +683,19 @@ export interface Media {
|
|
|
684
683
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
685
684
|
duration?: number | null;
|
|
686
685
|
}
|
|
687
|
-
|
|
686
|
+
interface Image {
|
|
688
687
|
/** Image file details. */
|
|
689
688
|
media?: Media;
|
|
690
689
|
/** Link details for images that are links. */
|
|
691
690
|
link?: Link;
|
|
692
691
|
}
|
|
693
|
-
|
|
692
|
+
interface Video {
|
|
694
693
|
/** Video file details. */
|
|
695
694
|
media?: Media;
|
|
696
695
|
/** Video thumbnail file details. */
|
|
697
696
|
thumbnail?: Media;
|
|
698
697
|
}
|
|
699
|
-
|
|
698
|
+
interface Item extends ItemDataOneOf {
|
|
700
699
|
/** An image item. */
|
|
701
700
|
image?: Image;
|
|
702
701
|
/** A video item. */
|
|
@@ -707,13 +706,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
707
706
|
altText?: string | null;
|
|
708
707
|
}
|
|
709
708
|
/** @oneof */
|
|
710
|
-
|
|
709
|
+
interface ItemDataOneOf {
|
|
711
710
|
/** An image item. */
|
|
712
711
|
image?: Image;
|
|
713
712
|
/** A video item. */
|
|
714
713
|
video?: Video;
|
|
715
714
|
}
|
|
716
|
-
|
|
715
|
+
interface GalleryOptions {
|
|
717
716
|
/** Gallery layout. */
|
|
718
717
|
layout?: Layout;
|
|
719
718
|
/** Styling for gallery items. */
|
|
@@ -721,7 +720,7 @@ export interface GalleryOptions {
|
|
|
721
720
|
/** Styling for gallery thumbnail images. */
|
|
722
721
|
thumbnails?: Thumbnails;
|
|
723
722
|
}
|
|
724
|
-
|
|
723
|
+
declare enum LayoutType {
|
|
725
724
|
/** Collage type */
|
|
726
725
|
COLLAGE = "COLLAGE",
|
|
727
726
|
/** Masonry type */
|
|
@@ -744,24 +743,24 @@ export declare enum LayoutType {
|
|
|
744
743
|
FULLSIZE = "FULLSIZE"
|
|
745
744
|
}
|
|
746
745
|
/** @enumType */
|
|
747
|
-
|
|
748
|
-
|
|
746
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
747
|
+
declare enum Orientation {
|
|
749
748
|
/** Rows Orientation */
|
|
750
749
|
ROWS = "ROWS",
|
|
751
750
|
/** Columns Orientation */
|
|
752
751
|
COLUMNS = "COLUMNS"
|
|
753
752
|
}
|
|
754
753
|
/** @enumType */
|
|
755
|
-
|
|
756
|
-
|
|
754
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
755
|
+
declare enum Crop {
|
|
757
756
|
/** Crop to fill */
|
|
758
757
|
FILL = "FILL",
|
|
759
758
|
/** Crop to fit */
|
|
760
759
|
FIT = "FIT"
|
|
761
760
|
}
|
|
762
761
|
/** @enumType */
|
|
763
|
-
|
|
764
|
-
|
|
762
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
763
|
+
declare enum ThumbnailsAlignment {
|
|
765
764
|
/** Top alignment */
|
|
766
765
|
TOP = "TOP",
|
|
767
766
|
/** Right alignment */
|
|
@@ -774,8 +773,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
774
773
|
NONE = "NONE"
|
|
775
774
|
}
|
|
776
775
|
/** @enumType */
|
|
777
|
-
|
|
778
|
-
|
|
776
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
777
|
+
interface Layout {
|
|
779
778
|
/** Gallery layout type. */
|
|
780
779
|
type?: LayoutTypeWithLiterals;
|
|
781
780
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -787,7 +786,7 @@ export interface Layout {
|
|
|
787
786
|
/** The number of columns to display on mobile screens. */
|
|
788
787
|
mobileNumberOfColumns?: number | null;
|
|
789
788
|
}
|
|
790
|
-
|
|
789
|
+
interface ItemStyle {
|
|
791
790
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
792
791
|
targetSize?: number | null;
|
|
793
792
|
/** Item ratio */
|
|
@@ -797,13 +796,13 @@ export interface ItemStyle {
|
|
|
797
796
|
/** The spacing between items in pixels. */
|
|
798
797
|
spacing?: number | null;
|
|
799
798
|
}
|
|
800
|
-
|
|
799
|
+
interface Thumbnails {
|
|
801
800
|
/** Thumbnail alignment. */
|
|
802
801
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
803
802
|
/** Spacing between thumbnails in pixels. */
|
|
804
803
|
spacing?: number | null;
|
|
805
804
|
}
|
|
806
|
-
|
|
805
|
+
interface GIFData {
|
|
807
806
|
/** Styling for the GIF's container. */
|
|
808
807
|
containerData?: PluginContainerData;
|
|
809
808
|
/** The source of the full size GIF. */
|
|
@@ -817,7 +816,7 @@ export interface GIFData {
|
|
|
817
816
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
818
817
|
gifType?: GIFTypeWithLiterals;
|
|
819
818
|
}
|
|
820
|
-
|
|
819
|
+
interface GIF {
|
|
821
820
|
/**
|
|
822
821
|
* GIF format URL.
|
|
823
822
|
* @format WEB_URL
|
|
@@ -834,13 +833,13 @@ export interface GIF {
|
|
|
834
833
|
*/
|
|
835
834
|
still?: string | null;
|
|
836
835
|
}
|
|
837
|
-
|
|
836
|
+
declare enum GIFType {
|
|
838
837
|
NORMAL = "NORMAL",
|
|
839
838
|
STICKER = "STICKER"
|
|
840
839
|
}
|
|
841
840
|
/** @enumType */
|
|
842
|
-
|
|
843
|
-
|
|
841
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
842
|
+
interface HeadingData {
|
|
844
843
|
/** Heading level from 1-6. */
|
|
845
844
|
level?: number;
|
|
846
845
|
/** Styling for the heading text. */
|
|
@@ -848,7 +847,7 @@ export interface HeadingData {
|
|
|
848
847
|
/** Indentation level from 1-4. */
|
|
849
848
|
indentation?: number | null;
|
|
850
849
|
}
|
|
851
|
-
|
|
850
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
852
851
|
/** The URL for the HTML code for the node. */
|
|
853
852
|
url?: string;
|
|
854
853
|
/** The HTML code for the node. */
|
|
@@ -866,7 +865,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
866
865
|
autoHeight?: boolean | null;
|
|
867
866
|
}
|
|
868
867
|
/** @oneof */
|
|
869
|
-
|
|
868
|
+
interface HTMLDataDataOneOf {
|
|
870
869
|
/** The URL for the HTML code for the node. */
|
|
871
870
|
url?: string;
|
|
872
871
|
/** The HTML code for the node. */
|
|
@@ -877,13 +876,13 @@ export interface HTMLDataDataOneOf {
|
|
|
877
876
|
*/
|
|
878
877
|
isAdsense?: boolean | null;
|
|
879
878
|
}
|
|
880
|
-
|
|
879
|
+
declare enum Source {
|
|
881
880
|
HTML = "HTML",
|
|
882
881
|
ADSENSE = "ADSENSE"
|
|
883
882
|
}
|
|
884
883
|
/** @enumType */
|
|
885
|
-
|
|
886
|
-
|
|
884
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
885
|
+
interface ImageData {
|
|
887
886
|
/** Styling for the image's container. */
|
|
888
887
|
containerData?: PluginContainerData;
|
|
889
888
|
/** Image file details. */
|
|
@@ -906,7 +905,7 @@ export interface ImageData {
|
|
|
906
905
|
/** Styling for the image. */
|
|
907
906
|
styles?: ImageDataStyles;
|
|
908
907
|
}
|
|
909
|
-
|
|
908
|
+
interface StylesBorder {
|
|
910
909
|
/** Border width in pixels. */
|
|
911
910
|
width?: number | null;
|
|
912
911
|
/**
|
|
@@ -917,11 +916,11 @@ export interface StylesBorder {
|
|
|
917
916
|
/** Border radius in pixels. */
|
|
918
917
|
radius?: number | null;
|
|
919
918
|
}
|
|
920
|
-
|
|
919
|
+
interface ImageDataStyles {
|
|
921
920
|
/** Border attributes. */
|
|
922
921
|
border?: StylesBorder;
|
|
923
922
|
}
|
|
924
|
-
|
|
923
|
+
interface LinkPreviewData {
|
|
925
924
|
/** Styling for the link preview's container. */
|
|
926
925
|
containerData?: PluginContainerData;
|
|
927
926
|
/** Link details. */
|
|
@@ -937,7 +936,7 @@ export interface LinkPreviewData {
|
|
|
937
936
|
/** Styling for the link preview. */
|
|
938
937
|
styles?: LinkPreviewDataStyles;
|
|
939
938
|
}
|
|
940
|
-
|
|
939
|
+
declare enum Position {
|
|
941
940
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
942
941
|
START = "START",
|
|
943
942
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -948,8 +947,8 @@ export declare enum Position {
|
|
|
948
947
|
HIDDEN = "HIDDEN"
|
|
949
948
|
}
|
|
950
949
|
/** @enumType */
|
|
951
|
-
|
|
952
|
-
|
|
950
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
951
|
+
interface LinkPreviewDataStyles {
|
|
953
952
|
/**
|
|
954
953
|
* Background color as a hexadecimal value.
|
|
955
954
|
* @format COLOR_HEX
|
|
@@ -982,13 +981,13 @@ export interface LinkPreviewDataStyles {
|
|
|
982
981
|
/** Position of thumbnail. Defaults to `START`. */
|
|
983
982
|
thumbnailPosition?: PositionWithLiterals;
|
|
984
983
|
}
|
|
985
|
-
|
|
984
|
+
interface MapData {
|
|
986
985
|
/** Styling for the map's container. */
|
|
987
986
|
containerData?: PluginContainerData;
|
|
988
987
|
/** Map settings. */
|
|
989
988
|
mapSettings?: MapSettings;
|
|
990
989
|
}
|
|
991
|
-
|
|
990
|
+
interface MapSettings {
|
|
992
991
|
/** The address to display on the map. */
|
|
993
992
|
address?: string | null;
|
|
994
993
|
/** Sets whether the map is draggable. */
|
|
@@ -1012,7 +1011,7 @@ export interface MapSettings {
|
|
|
1012
1011
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1013
1012
|
mapType?: MapTypeWithLiterals;
|
|
1014
1013
|
}
|
|
1015
|
-
|
|
1014
|
+
declare enum MapType {
|
|
1016
1015
|
/** Roadmap map type */
|
|
1017
1016
|
ROADMAP = "ROADMAP",
|
|
1018
1017
|
/** Satellite map type */
|
|
@@ -1023,8 +1022,8 @@ export declare enum MapType {
|
|
|
1023
1022
|
TERRAIN = "TERRAIN"
|
|
1024
1023
|
}
|
|
1025
1024
|
/** @enumType */
|
|
1026
|
-
|
|
1027
|
-
|
|
1025
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1026
|
+
interface ParagraphData {
|
|
1028
1027
|
/** Styling for the paragraph text. */
|
|
1029
1028
|
textStyle?: TextStyle;
|
|
1030
1029
|
/** Indentation level from 1-4. */
|
|
@@ -1032,7 +1031,7 @@ export interface ParagraphData {
|
|
|
1032
1031
|
/** Paragraph level */
|
|
1033
1032
|
level?: number | null;
|
|
1034
1033
|
}
|
|
1035
|
-
|
|
1034
|
+
interface PollData {
|
|
1036
1035
|
/** Styling for the poll's container. */
|
|
1037
1036
|
containerData?: PluginContainerData;
|
|
1038
1037
|
/** Poll data. */
|
|
@@ -1042,7 +1041,7 @@ export interface PollData {
|
|
|
1042
1041
|
/** Styling for the poll and voting options. */
|
|
1043
1042
|
design?: Design;
|
|
1044
1043
|
}
|
|
1045
|
-
|
|
1044
|
+
declare enum ViewRole {
|
|
1046
1045
|
/** Only Poll creator can view the results */
|
|
1047
1046
|
CREATOR = "CREATOR",
|
|
1048
1047
|
/** Anyone who voted can see the results */
|
|
@@ -1051,16 +1050,16 @@ export declare enum ViewRole {
|
|
|
1051
1050
|
EVERYONE = "EVERYONE"
|
|
1052
1051
|
}
|
|
1053
1052
|
/** @enumType */
|
|
1054
|
-
|
|
1055
|
-
|
|
1053
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1054
|
+
declare enum VoteRole {
|
|
1056
1055
|
/** Logged in member */
|
|
1057
1056
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1058
1057
|
/** Anyone */
|
|
1059
1058
|
ALL = "ALL"
|
|
1060
1059
|
}
|
|
1061
1060
|
/** @enumType */
|
|
1062
|
-
|
|
1063
|
-
|
|
1061
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1062
|
+
interface Permissions {
|
|
1064
1063
|
/** Sets who can view the poll results. */
|
|
1065
1064
|
view?: ViewRoleWithLiterals;
|
|
1066
1065
|
/** Sets who can vote. */
|
|
@@ -1068,7 +1067,7 @@ export interface Permissions {
|
|
|
1068
1067
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1069
1068
|
allowMultipleVotes?: boolean | null;
|
|
1070
1069
|
}
|
|
1071
|
-
|
|
1070
|
+
interface Option {
|
|
1072
1071
|
/** Option ID. */
|
|
1073
1072
|
id?: string | null;
|
|
1074
1073
|
/** Option title. */
|
|
@@ -1076,7 +1075,7 @@ export interface Option {
|
|
|
1076
1075
|
/** The image displayed with the option. */
|
|
1077
1076
|
image?: Media;
|
|
1078
1077
|
}
|
|
1079
|
-
|
|
1078
|
+
interface Settings {
|
|
1080
1079
|
/** Permissions settings for voting. */
|
|
1081
1080
|
permissions?: Permissions;
|
|
1082
1081
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1084,23 +1083,23 @@ export interface Settings {
|
|
|
1084
1083
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1085
1084
|
showVotesCount?: boolean | null;
|
|
1086
1085
|
}
|
|
1087
|
-
|
|
1086
|
+
declare enum PollLayoutType {
|
|
1088
1087
|
/** List */
|
|
1089
1088
|
LIST = "LIST",
|
|
1090
1089
|
/** Grid */
|
|
1091
1090
|
GRID = "GRID"
|
|
1092
1091
|
}
|
|
1093
1092
|
/** @enumType */
|
|
1094
|
-
|
|
1095
|
-
|
|
1093
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1094
|
+
declare enum PollLayoutDirection {
|
|
1096
1095
|
/** Left-to-right */
|
|
1097
1096
|
LTR = "LTR",
|
|
1098
1097
|
/** Right-to-left */
|
|
1099
1098
|
RTL = "RTL"
|
|
1100
1099
|
}
|
|
1101
1100
|
/** @enumType */
|
|
1102
|
-
|
|
1103
|
-
|
|
1101
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1102
|
+
interface PollLayout {
|
|
1104
1103
|
/** The layout for displaying the voting options. */
|
|
1105
1104
|
type?: PollLayoutTypeWithLiterals;
|
|
1106
1105
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1108,11 +1107,11 @@ export interface PollLayout {
|
|
|
1108
1107
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1109
1108
|
enableImage?: boolean | null;
|
|
1110
1109
|
}
|
|
1111
|
-
|
|
1110
|
+
interface OptionLayout {
|
|
1112
1111
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1113
1112
|
enableImage?: boolean | null;
|
|
1114
1113
|
}
|
|
1115
|
-
|
|
1114
|
+
declare enum BackgroundType {
|
|
1116
1115
|
/** Color background type */
|
|
1117
1116
|
COLOR = "COLOR",
|
|
1118
1117
|
/** Image background type */
|
|
@@ -1121,8 +1120,8 @@ export declare enum BackgroundType {
|
|
|
1121
1120
|
GRADIENT = "GRADIENT"
|
|
1122
1121
|
}
|
|
1123
1122
|
/** @enumType */
|
|
1124
|
-
|
|
1125
|
-
|
|
1123
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1124
|
+
interface Gradient {
|
|
1126
1125
|
/** The gradient angle in degrees. */
|
|
1127
1126
|
angle?: number | null;
|
|
1128
1127
|
/**
|
|
@@ -1136,7 +1135,7 @@ export interface Gradient {
|
|
|
1136
1135
|
*/
|
|
1137
1136
|
lastColor?: string | null;
|
|
1138
1137
|
}
|
|
1139
|
-
|
|
1138
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1140
1139
|
/**
|
|
1141
1140
|
* The background color as a hexademical value.
|
|
1142
1141
|
* @format COLOR_HEX
|
|
@@ -1150,7 +1149,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1150
1149
|
type?: BackgroundTypeWithLiterals;
|
|
1151
1150
|
}
|
|
1152
1151
|
/** @oneof */
|
|
1153
|
-
|
|
1152
|
+
interface BackgroundBackgroundOneOf {
|
|
1154
1153
|
/**
|
|
1155
1154
|
* The background color as a hexademical value.
|
|
1156
1155
|
* @format COLOR_HEX
|
|
@@ -1161,17 +1160,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1161
1160
|
/** Details for a gradient background. */
|
|
1162
1161
|
gradient?: Gradient;
|
|
1163
1162
|
}
|
|
1164
|
-
|
|
1163
|
+
interface PollDesign {
|
|
1165
1164
|
/** Background styling. */
|
|
1166
1165
|
background?: Background;
|
|
1167
1166
|
/** Border radius in pixels. */
|
|
1168
1167
|
borderRadius?: number | null;
|
|
1169
1168
|
}
|
|
1170
|
-
|
|
1169
|
+
interface OptionDesign {
|
|
1171
1170
|
/** Border radius in pixels. */
|
|
1172
1171
|
borderRadius?: number | null;
|
|
1173
1172
|
}
|
|
1174
|
-
|
|
1173
|
+
interface Poll {
|
|
1175
1174
|
/** Poll ID. */
|
|
1176
1175
|
id?: string | null;
|
|
1177
1176
|
/** Poll title. */
|
|
@@ -1185,26 +1184,26 @@ export interface Poll {
|
|
|
1185
1184
|
/** The poll's permissions and display settings. */
|
|
1186
1185
|
settings?: Settings;
|
|
1187
1186
|
}
|
|
1188
|
-
|
|
1187
|
+
interface PollDataLayout {
|
|
1189
1188
|
/** Poll layout settings. */
|
|
1190
1189
|
poll?: PollLayout;
|
|
1191
1190
|
/** Voting otpions layout settings. */
|
|
1192
1191
|
options?: OptionLayout;
|
|
1193
1192
|
}
|
|
1194
|
-
|
|
1193
|
+
interface Design {
|
|
1195
1194
|
/** Styling for the poll. */
|
|
1196
1195
|
poll?: PollDesign;
|
|
1197
1196
|
/** Styling for voting options. */
|
|
1198
1197
|
options?: OptionDesign;
|
|
1199
1198
|
}
|
|
1200
|
-
|
|
1199
|
+
interface TextData {
|
|
1201
1200
|
/** The text to apply decorations to. */
|
|
1202
1201
|
text?: string;
|
|
1203
1202
|
/** The decorations to apply. */
|
|
1204
1203
|
decorations?: Decoration[];
|
|
1205
1204
|
}
|
|
1206
1205
|
/** Adds appearence changes to text */
|
|
1207
|
-
|
|
1206
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1208
1207
|
/** Data for an anchor link decoration. */
|
|
1209
1208
|
anchorData?: AnchorData;
|
|
1210
1209
|
/** Data for a color decoration. */
|
|
@@ -1229,7 +1228,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1229
1228
|
type?: DecorationTypeWithLiterals;
|
|
1230
1229
|
}
|
|
1231
1230
|
/** @oneof */
|
|
1232
|
-
|
|
1231
|
+
interface DecorationDataOneOf {
|
|
1233
1232
|
/** Data for an anchor link decoration. */
|
|
1234
1233
|
anchorData?: AnchorData;
|
|
1235
1234
|
/** Data for a color decoration. */
|
|
@@ -1251,7 +1250,7 @@ export interface DecorationDataOneOf {
|
|
|
1251
1250
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1252
1251
|
strikethroughData?: boolean | null;
|
|
1253
1252
|
}
|
|
1254
|
-
|
|
1253
|
+
declare enum DecorationType {
|
|
1255
1254
|
BOLD = "BOLD",
|
|
1256
1255
|
ITALIC = "ITALIC",
|
|
1257
1256
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1265,22 +1264,22 @@ export declare enum DecorationType {
|
|
|
1265
1264
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1266
1265
|
}
|
|
1267
1266
|
/** @enumType */
|
|
1268
|
-
|
|
1269
|
-
|
|
1267
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1268
|
+
interface AnchorData {
|
|
1270
1269
|
/** The target node's ID. */
|
|
1271
1270
|
anchor?: string;
|
|
1272
1271
|
}
|
|
1273
|
-
|
|
1272
|
+
interface ColorData {
|
|
1274
1273
|
/** The text's background color as a hexadecimal value. */
|
|
1275
1274
|
background?: string | null;
|
|
1276
1275
|
/** The text's foreground color as a hexadecimal value. */
|
|
1277
1276
|
foreground?: string | null;
|
|
1278
1277
|
}
|
|
1279
|
-
|
|
1278
|
+
interface LinkData {
|
|
1280
1279
|
/** Link details. */
|
|
1281
1280
|
link?: Link;
|
|
1282
1281
|
}
|
|
1283
|
-
|
|
1282
|
+
interface MentionData {
|
|
1284
1283
|
/** The mentioned user's name. */
|
|
1285
1284
|
name?: string;
|
|
1286
1285
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1288,23 +1287,23 @@ export interface MentionData {
|
|
|
1288
1287
|
/** Mentioned user's ID. */
|
|
1289
1288
|
id?: string | null;
|
|
1290
1289
|
}
|
|
1291
|
-
|
|
1290
|
+
interface FontSizeData {
|
|
1292
1291
|
/** The units used for the font size. */
|
|
1293
1292
|
unit?: FontTypeWithLiterals;
|
|
1294
1293
|
/** Font size value. */
|
|
1295
1294
|
value?: number | null;
|
|
1296
1295
|
}
|
|
1297
|
-
|
|
1296
|
+
declare enum FontType {
|
|
1298
1297
|
PX = "PX",
|
|
1299
1298
|
EM = "EM"
|
|
1300
1299
|
}
|
|
1301
1300
|
/** @enumType */
|
|
1302
|
-
|
|
1303
|
-
|
|
1301
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1302
|
+
interface SpoilerData {
|
|
1304
1303
|
/** Spoiler ID. */
|
|
1305
1304
|
id?: string | null;
|
|
1306
1305
|
}
|
|
1307
|
-
|
|
1306
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1308
1307
|
/** Data for embedded Wix Bookings content. */
|
|
1309
1308
|
bookingData?: BookingData;
|
|
1310
1309
|
/** Data for embedded Wix Events content. */
|
|
@@ -1326,30 +1325,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1326
1325
|
image?: Media;
|
|
1327
1326
|
}
|
|
1328
1327
|
/** @oneof */
|
|
1329
|
-
|
|
1328
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1330
1329
|
/** Data for embedded Wix Bookings content. */
|
|
1331
1330
|
bookingData?: BookingData;
|
|
1332
1331
|
/** Data for embedded Wix Events content. */
|
|
1333
1332
|
eventData?: EventData;
|
|
1334
1333
|
}
|
|
1335
|
-
|
|
1334
|
+
declare enum AppType {
|
|
1336
1335
|
PRODUCT = "PRODUCT",
|
|
1337
1336
|
EVENT = "EVENT",
|
|
1338
1337
|
BOOKING = "BOOKING"
|
|
1339
1338
|
}
|
|
1340
1339
|
/** @enumType */
|
|
1341
|
-
|
|
1342
|
-
|
|
1340
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1341
|
+
interface BookingData {
|
|
1343
1342
|
/** Booking duration in minutes. */
|
|
1344
1343
|
durations?: string | null;
|
|
1345
1344
|
}
|
|
1346
|
-
|
|
1345
|
+
interface EventData {
|
|
1347
1346
|
/** Event schedule. */
|
|
1348
1347
|
scheduling?: string | null;
|
|
1349
1348
|
/** Event location. */
|
|
1350
1349
|
location?: string | null;
|
|
1351
1350
|
}
|
|
1352
|
-
|
|
1351
|
+
interface VideoData {
|
|
1353
1352
|
/** Styling for the video's container. */
|
|
1354
1353
|
containerData?: PluginContainerData;
|
|
1355
1354
|
/** Video details. */
|
|
@@ -1363,7 +1362,7 @@ export interface VideoData {
|
|
|
1363
1362
|
/** Video options. */
|
|
1364
1363
|
options?: PlaybackOptions;
|
|
1365
1364
|
}
|
|
1366
|
-
|
|
1365
|
+
interface PlaybackOptions {
|
|
1367
1366
|
/** Sets whether the media will automatically start playing. */
|
|
1368
1367
|
autoPlay?: boolean | null;
|
|
1369
1368
|
/** Sets whether media's will be looped. */
|
|
@@ -1371,7 +1370,7 @@ export interface PlaybackOptions {
|
|
|
1371
1370
|
/** Sets whether media's controls will be shown. */
|
|
1372
1371
|
showControls?: boolean | null;
|
|
1373
1372
|
}
|
|
1374
|
-
|
|
1373
|
+
interface EmbedData {
|
|
1375
1374
|
/** Styling for the oEmbed node's container. */
|
|
1376
1375
|
containerData?: PluginContainerData;
|
|
1377
1376
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1379,7 +1378,7 @@ export interface EmbedData {
|
|
|
1379
1378
|
/** Origin asset source. */
|
|
1380
1379
|
src?: string | null;
|
|
1381
1380
|
}
|
|
1382
|
-
|
|
1381
|
+
interface Oembed {
|
|
1383
1382
|
/** The resource type. */
|
|
1384
1383
|
type?: string | null;
|
|
1385
1384
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1411,7 +1410,7 @@ export interface Oembed {
|
|
|
1411
1410
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1412
1411
|
version?: string | null;
|
|
1413
1412
|
}
|
|
1414
|
-
|
|
1413
|
+
interface CollapsibleListData {
|
|
1415
1414
|
/** Styling for the collapsible list's container. */
|
|
1416
1415
|
containerData?: PluginContainerData;
|
|
1417
1416
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1423,7 +1422,7 @@ export interface CollapsibleListData {
|
|
|
1423
1422
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1424
1423
|
isQapageData?: boolean | null;
|
|
1425
1424
|
}
|
|
1426
|
-
|
|
1425
|
+
declare enum InitialExpandedItems {
|
|
1427
1426
|
/** First item will be expended initally */
|
|
1428
1427
|
FIRST = "FIRST",
|
|
1429
1428
|
/** All items will expended initally */
|
|
@@ -1432,16 +1431,16 @@ export declare enum InitialExpandedItems {
|
|
|
1432
1431
|
NONE = "NONE"
|
|
1433
1432
|
}
|
|
1434
1433
|
/** @enumType */
|
|
1435
|
-
|
|
1436
|
-
|
|
1434
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1435
|
+
declare enum Direction {
|
|
1437
1436
|
/** Left-to-right */
|
|
1438
1437
|
LTR = "LTR",
|
|
1439
1438
|
/** Right-to-left */
|
|
1440
1439
|
RTL = "RTL"
|
|
1441
1440
|
}
|
|
1442
1441
|
/** @enumType */
|
|
1443
|
-
|
|
1444
|
-
|
|
1442
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1443
|
+
interface TableData {
|
|
1445
1444
|
/** Styling for the table's container. */
|
|
1446
1445
|
containerData?: PluginContainerData;
|
|
1447
1446
|
/** The table's dimensions. */
|
|
@@ -1456,7 +1455,7 @@ export interface TableData {
|
|
|
1456
1455
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1457
1456
|
columnHeader?: boolean | null;
|
|
1458
1457
|
}
|
|
1459
|
-
|
|
1458
|
+
interface Dimensions {
|
|
1460
1459
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1461
1460
|
colsWidthRatio?: number[];
|
|
1462
1461
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1464,13 +1463,13 @@ export interface Dimensions {
|
|
|
1464
1463
|
/** An array representing the minimum width of each column in pixels. */
|
|
1465
1464
|
colsMinWidth?: number[];
|
|
1466
1465
|
}
|
|
1467
|
-
|
|
1466
|
+
interface TableCellData {
|
|
1468
1467
|
/** Styling for the cell's background color and text alignment. */
|
|
1469
1468
|
cellStyle?: CellStyle;
|
|
1470
1469
|
/** The cell's border colors. */
|
|
1471
1470
|
borderColors?: BorderColors;
|
|
1472
1471
|
}
|
|
1473
|
-
|
|
1472
|
+
declare enum VerticalAlignment {
|
|
1474
1473
|
/** Top alignment */
|
|
1475
1474
|
TOP = "TOP",
|
|
1476
1475
|
/** Middle alignment */
|
|
@@ -1479,8 +1478,8 @@ export declare enum VerticalAlignment {
|
|
|
1479
1478
|
BOTTOM = "BOTTOM"
|
|
1480
1479
|
}
|
|
1481
1480
|
/** @enumType */
|
|
1482
|
-
|
|
1483
|
-
|
|
1481
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1482
|
+
interface CellStyle {
|
|
1484
1483
|
/** Vertical alignment for the cell's text. */
|
|
1485
1484
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1486
1485
|
/**
|
|
@@ -1489,7 +1488,7 @@ export interface CellStyle {
|
|
|
1489
1488
|
*/
|
|
1490
1489
|
backgroundColor?: string | null;
|
|
1491
1490
|
}
|
|
1492
|
-
|
|
1491
|
+
interface BorderColors {
|
|
1493
1492
|
/**
|
|
1494
1493
|
* Left border color as a hexadecimal value.
|
|
1495
1494
|
* @format COLOR_HEX
|
|
@@ -1517,22 +1516,20 @@ export interface BorderColors {
|
|
|
1517
1516
|
*
|
|
1518
1517
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1519
1518
|
*/
|
|
1520
|
-
|
|
1519
|
+
declare enum NullValue {
|
|
1521
1520
|
/** Null value. */
|
|
1522
1521
|
NULL_VALUE = "NULL_VALUE"
|
|
1523
1522
|
}
|
|
1524
|
-
/** @enumType */
|
|
1525
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1526
1523
|
/**
|
|
1527
1524
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1528
1525
|
*
|
|
1529
1526
|
* The JSON representation for `ListValue` is JSON array.
|
|
1530
1527
|
*/
|
|
1531
|
-
|
|
1528
|
+
interface ListValue {
|
|
1532
1529
|
/** Repeated field of dynamically typed values. */
|
|
1533
1530
|
values?: any[];
|
|
1534
1531
|
}
|
|
1535
|
-
|
|
1532
|
+
interface AudioData {
|
|
1536
1533
|
/** Styling for the audio node's container. */
|
|
1537
1534
|
containerData?: PluginContainerData;
|
|
1538
1535
|
/** Audio file details. */
|
|
@@ -1548,7 +1545,7 @@ export interface AudioData {
|
|
|
1548
1545
|
/** An HTML version of the audio node. */
|
|
1549
1546
|
html?: string | null;
|
|
1550
1547
|
}
|
|
1551
|
-
|
|
1548
|
+
interface OrderedListData {
|
|
1552
1549
|
/** Indentation level from 0-4. */
|
|
1553
1550
|
indentation?: number;
|
|
1554
1551
|
/** Offset level from 0-4. */
|
|
@@ -1556,24 +1553,24 @@ export interface OrderedListData {
|
|
|
1556
1553
|
/** List start number. */
|
|
1557
1554
|
start?: number | null;
|
|
1558
1555
|
}
|
|
1559
|
-
|
|
1556
|
+
interface BulletedListData {
|
|
1560
1557
|
/** Indentation level from 0-4. */
|
|
1561
1558
|
indentation?: number;
|
|
1562
1559
|
/** Offset level from 0-4. */
|
|
1563
1560
|
offset?: number | null;
|
|
1564
1561
|
}
|
|
1565
|
-
|
|
1562
|
+
interface BlockquoteData {
|
|
1566
1563
|
/** Indentation level from 1-4. */
|
|
1567
1564
|
indentation?: number;
|
|
1568
1565
|
}
|
|
1569
|
-
|
|
1566
|
+
interface CaptionData {
|
|
1570
1567
|
textStyle?: TextStyle;
|
|
1571
1568
|
}
|
|
1572
|
-
|
|
1569
|
+
interface LayoutCellData {
|
|
1573
1570
|
/** Size of the cell in 12 columns grid. */
|
|
1574
1571
|
colSpan?: number | null;
|
|
1575
1572
|
}
|
|
1576
|
-
|
|
1573
|
+
interface Metadata {
|
|
1577
1574
|
/** Schema version. */
|
|
1578
1575
|
version?: number;
|
|
1579
1576
|
/**
|
|
@@ -1590,7 +1587,7 @@ export interface Metadata {
|
|
|
1590
1587
|
/** Object ID. */
|
|
1591
1588
|
_id?: string | null;
|
|
1592
1589
|
}
|
|
1593
|
-
|
|
1590
|
+
interface DocumentStyle {
|
|
1594
1591
|
/** Styling for H1 nodes. */
|
|
1595
1592
|
headerOne?: TextNodeStyle;
|
|
1596
1593
|
/** Styling for H2 nodes. */
|
|
@@ -1610,7 +1607,7 @@ export interface DocumentStyle {
|
|
|
1610
1607
|
/** Styling for code block nodes. */
|
|
1611
1608
|
codeBlock?: TextNodeStyle;
|
|
1612
1609
|
}
|
|
1613
|
-
|
|
1610
|
+
interface TextNodeStyle {
|
|
1614
1611
|
/** The decorations to apply to the node. */
|
|
1615
1612
|
decorations?: Decoration[];
|
|
1616
1613
|
/** Padding and background color for the node. */
|
|
@@ -1618,7 +1615,7 @@ export interface TextNodeStyle {
|
|
|
1618
1615
|
/** Line height for text in the node. */
|
|
1619
1616
|
lineHeight?: string | null;
|
|
1620
1617
|
}
|
|
1621
|
-
|
|
1618
|
+
interface Mention extends MentionIdentityOneOf {
|
|
1622
1619
|
/**
|
|
1623
1620
|
* Wix user ID.
|
|
1624
1621
|
* @format GUID
|
|
@@ -1641,7 +1638,7 @@ export interface Mention extends MentionIdentityOneOf {
|
|
|
1641
1638
|
groupId?: string | null;
|
|
1642
1639
|
}
|
|
1643
1640
|
/** @oneof */
|
|
1644
|
-
|
|
1641
|
+
interface MentionIdentityOneOf {
|
|
1645
1642
|
/**
|
|
1646
1643
|
* Wix user ID.
|
|
1647
1644
|
* @format GUID
|
|
@@ -1663,7 +1660,7 @@ export interface MentionIdentityOneOf {
|
|
|
1663
1660
|
*/
|
|
1664
1661
|
groupId?: string | null;
|
|
1665
1662
|
}
|
|
1666
|
-
|
|
1663
|
+
interface Attachment extends AttachmentMediaOneOf {
|
|
1667
1664
|
/** Information about the image. */
|
|
1668
1665
|
image?: string;
|
|
1669
1666
|
/** Information about the video. */
|
|
@@ -1679,7 +1676,7 @@ export interface Attachment extends AttachmentMediaOneOf {
|
|
|
1679
1676
|
mimeType?: string | null;
|
|
1680
1677
|
}
|
|
1681
1678
|
/** @oneof */
|
|
1682
|
-
|
|
1679
|
+
interface AttachmentMediaOneOf {
|
|
1683
1680
|
/** Information about the image. */
|
|
1684
1681
|
image?: string;
|
|
1685
1682
|
/** Information about the video. */
|
|
@@ -1689,7 +1686,7 @@ export interface AttachmentMediaOneOf {
|
|
|
1689
1686
|
/** Information about the document. */
|
|
1690
1687
|
document?: string;
|
|
1691
1688
|
}
|
|
1692
|
-
|
|
1689
|
+
interface VideoResolution {
|
|
1693
1690
|
/** Video URL. */
|
|
1694
1691
|
url?: string;
|
|
1695
1692
|
/** Video height. */
|
|
@@ -1728,7 +1725,7 @@ export interface VideoResolution {
|
|
|
1728
1725
|
*/
|
|
1729
1726
|
assetKey?: string | null;
|
|
1730
1727
|
}
|
|
1731
|
-
|
|
1728
|
+
interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1732
1729
|
/**
|
|
1733
1730
|
* Wix user ID.
|
|
1734
1731
|
* @format GUID
|
|
@@ -1751,7 +1748,7 @@ export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
|
1751
1748
|
appId?: string | null;
|
|
1752
1749
|
}
|
|
1753
1750
|
/** @oneof */
|
|
1754
|
-
|
|
1751
|
+
interface ContentAuthorAuthorOneOf {
|
|
1755
1752
|
/**
|
|
1756
1753
|
* Wix user ID.
|
|
1757
1754
|
* @format GUID
|
|
@@ -1773,7 +1770,7 @@ export interface ContentAuthorAuthorOneOf {
|
|
|
1773
1770
|
*/
|
|
1774
1771
|
appId?: string | null;
|
|
1775
1772
|
}
|
|
1776
|
-
|
|
1773
|
+
interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1777
1774
|
/**
|
|
1778
1775
|
* Wix user ID.
|
|
1779
1776
|
* @format GUID
|
|
@@ -1791,7 +1788,7 @@ export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1791
1788
|
visitorId?: string | null;
|
|
1792
1789
|
}
|
|
1793
1790
|
/** @oneof */
|
|
1794
|
-
|
|
1791
|
+
interface CommentAuthorIdentityOneOf {
|
|
1795
1792
|
/**
|
|
1796
1793
|
* Wix user ID.
|
|
1797
1794
|
* @format GUID
|
|
@@ -1808,7 +1805,7 @@ export interface CommentAuthorIdentityOneOf {
|
|
|
1808
1805
|
*/
|
|
1809
1806
|
visitorId?: string | null;
|
|
1810
1807
|
}
|
|
1811
|
-
|
|
1808
|
+
interface ParentComment {
|
|
1812
1809
|
/**
|
|
1813
1810
|
* Comment ID of the parent comment.
|
|
1814
1811
|
* @format GUID
|
|
@@ -1826,7 +1823,7 @@ export interface ParentComment {
|
|
|
1826
1823
|
*/
|
|
1827
1824
|
status?: StatusWithLiterals;
|
|
1828
1825
|
}
|
|
1829
|
-
|
|
1826
|
+
declare enum Status {
|
|
1830
1827
|
/** Unknown status. */
|
|
1831
1828
|
UNKNOWN = "UNKNOWN",
|
|
1832
1829
|
/** This comment is published and publicly visible. */
|
|
@@ -1839,8 +1836,8 @@ export declare enum Status {
|
|
|
1839
1836
|
HIDDEN = "HIDDEN"
|
|
1840
1837
|
}
|
|
1841
1838
|
/** @enumType */
|
|
1842
|
-
|
|
1843
|
-
|
|
1839
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'DELETED' | 'PENDING' | 'HIDDEN';
|
|
1840
|
+
interface VoteSummary {
|
|
1844
1841
|
/** Number of upvotes less downvotes on this comment. */
|
|
1845
1842
|
netVoteCount?: number;
|
|
1846
1843
|
/** Number of upvotes on this comment. */
|
|
@@ -1848,7 +1845,7 @@ export interface VoteSummary {
|
|
|
1848
1845
|
/** Number of downvotes on this comment. */
|
|
1849
1846
|
downvoteCount?: number;
|
|
1850
1847
|
}
|
|
1851
|
-
|
|
1848
|
+
interface CommentReactionSummary {
|
|
1852
1849
|
/** Total amount of reactions. */
|
|
1853
1850
|
total?: number;
|
|
1854
1851
|
/**
|
|
@@ -1857,7 +1854,7 @@ export interface CommentReactionSummary {
|
|
|
1857
1854
|
*/
|
|
1858
1855
|
reactionCodeCount?: Record<string, number>;
|
|
1859
1856
|
}
|
|
1860
|
-
|
|
1857
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1861
1858
|
/** insert/update documents */
|
|
1862
1859
|
update?: InternalDocumentUpdateOperation;
|
|
1863
1860
|
/** delete by document ids */
|
|
@@ -1898,7 +1895,7 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
|
|
|
1898
1895
|
issuedAt?: Date | null;
|
|
1899
1896
|
}
|
|
1900
1897
|
/** @oneof */
|
|
1901
|
-
|
|
1898
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1902
1899
|
/** insert/update documents */
|
|
1903
1900
|
update?: InternalDocumentUpdateOperation;
|
|
1904
1901
|
/** delete by document ids */
|
|
@@ -1914,39 +1911,57 @@ export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
1914
1911
|
/** delete by document ids with versioning */
|
|
1915
1912
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1916
1913
|
}
|
|
1917
|
-
|
|
1914
|
+
interface InternalDocument {
|
|
1918
1915
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
1919
1916
|
document?: Record<string, any> | null;
|
|
1920
1917
|
}
|
|
1921
|
-
|
|
1918
|
+
interface InternalDocumentUpdateOperation {
|
|
1922
1919
|
/** documents to index or update */
|
|
1923
1920
|
documents?: InternalDocument[];
|
|
1924
1921
|
}
|
|
1925
|
-
|
|
1922
|
+
interface DeleteByIdsOperation {
|
|
1926
1923
|
/** ids of the documents to delete */
|
|
1927
1924
|
documentIds?: string[];
|
|
1925
|
+
/**
|
|
1926
|
+
* tenant id for custom tenancy strategy
|
|
1927
|
+
* @minLength 2
|
|
1928
|
+
* @maxLength 300
|
|
1929
|
+
*/
|
|
1930
|
+
tenantId?: string | null;
|
|
1928
1931
|
}
|
|
1929
|
-
|
|
1932
|
+
interface DeleteByFilterOperation {
|
|
1930
1933
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
1931
1934
|
filter?: Record<string, any> | null;
|
|
1935
|
+
/**
|
|
1936
|
+
* tenant id for custom tenancy strategy
|
|
1937
|
+
* @minLength 2
|
|
1938
|
+
* @maxLength 300
|
|
1939
|
+
*/
|
|
1940
|
+
tenantId?: string | null;
|
|
1932
1941
|
}
|
|
1933
|
-
|
|
1942
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
1934
1943
|
/** documents matching this filter will be updated */
|
|
1935
1944
|
filter?: Record<string, any> | null;
|
|
1936
1945
|
/** partial document to apply */
|
|
1937
1946
|
document?: InternalDocument;
|
|
1947
|
+
/**
|
|
1948
|
+
* tenant id for custom tenancy strategy
|
|
1949
|
+
* @minLength 2
|
|
1950
|
+
* @maxLength 300
|
|
1951
|
+
*/
|
|
1952
|
+
tenantId?: string | null;
|
|
1938
1953
|
}
|
|
1939
|
-
|
|
1954
|
+
interface InternalUpdateExistingOperation {
|
|
1940
1955
|
/** documents to update */
|
|
1941
1956
|
documents?: InternalDocument[];
|
|
1942
1957
|
}
|
|
1943
|
-
|
|
1958
|
+
interface VersionedDocumentUpdateOperation {
|
|
1944
1959
|
/** documents to create or overwrite */
|
|
1945
1960
|
documents?: InternalDocument[];
|
|
1946
1961
|
/** versioning mode to use instead of default */
|
|
1947
1962
|
versioningMode?: VersioningModeWithLiterals;
|
|
1948
1963
|
}
|
|
1949
|
-
|
|
1964
|
+
declare enum VersioningMode {
|
|
1950
1965
|
/** use default versioning mode agreed with search team */
|
|
1951
1966
|
DEFAULT = "DEFAULT",
|
|
1952
1967
|
/** execute only if version is greater than existing */
|
|
@@ -1955,12 +1970,18 @@ export declare enum VersioningMode {
|
|
|
1955
1970
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
1956
1971
|
}
|
|
1957
1972
|
/** @enumType */
|
|
1958
|
-
|
|
1959
|
-
|
|
1973
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
1974
|
+
interface VersionedDeleteByIdsOperation {
|
|
1960
1975
|
/** ids with version of the documents to delete */
|
|
1961
1976
|
documentIds?: VersionedDocumentId[];
|
|
1977
|
+
/**
|
|
1978
|
+
* tenant id for custom tenancy strategy
|
|
1979
|
+
* @minLength 2
|
|
1980
|
+
* @maxLength 300
|
|
1981
|
+
*/
|
|
1982
|
+
tenantId?: string | null;
|
|
1962
1983
|
}
|
|
1963
|
-
|
|
1984
|
+
interface VersionedDocumentId {
|
|
1964
1985
|
/** document id */
|
|
1965
1986
|
documentId?: string;
|
|
1966
1987
|
/** document version */
|
|
@@ -1968,11 +1989,11 @@ export interface VersionedDocumentId {
|
|
|
1968
1989
|
/** versioning mode to use instead of default */
|
|
1969
1990
|
versioningMode?: VersioningModeWithLiterals;
|
|
1970
1991
|
}
|
|
1971
|
-
|
|
1992
|
+
interface CommentModerated {
|
|
1972
1993
|
comment?: Comment;
|
|
1973
1994
|
moderationAction?: ActionWithLiterals;
|
|
1974
1995
|
}
|
|
1975
|
-
|
|
1996
|
+
declare enum Action {
|
|
1976
1997
|
/** Unknown content. */
|
|
1977
1998
|
UNKNOWN = "UNKNOWN",
|
|
1978
1999
|
/** Approve draft content. */
|
|
@@ -1981,18 +2002,18 @@ export declare enum Action {
|
|
|
1981
2002
|
REJECT = "REJECT"
|
|
1982
2003
|
}
|
|
1983
2004
|
/** @enumType */
|
|
1984
|
-
|
|
1985
|
-
|
|
2005
|
+
type ActionWithLiterals = Action | 'UNKNOWN' | 'APPROVE' | 'REJECT';
|
|
2006
|
+
interface CreateCommentRequest {
|
|
1986
2007
|
/** Comment to create. */
|
|
1987
2008
|
comment?: Comment;
|
|
1988
2009
|
}
|
|
1989
|
-
|
|
2010
|
+
interface ContactDetails {
|
|
1990
2011
|
}
|
|
1991
|
-
|
|
2012
|
+
interface CreateCommentResponse {
|
|
1992
2013
|
/** Created comment. */
|
|
1993
2014
|
comment?: Comment;
|
|
1994
2015
|
}
|
|
1995
|
-
|
|
2016
|
+
interface ResourceCommentCountChanged {
|
|
1996
2017
|
/** ID of the app that the comment is added to. */
|
|
1997
2018
|
appId?: string;
|
|
1998
2019
|
/**
|
|
@@ -2010,27 +2031,27 @@ export interface ResourceCommentCountChanged {
|
|
|
2010
2031
|
/** How many comments are published for the resource. */
|
|
2011
2032
|
publishedCommentCount?: number;
|
|
2012
2033
|
}
|
|
2013
|
-
|
|
2034
|
+
interface GetCommentRequest {
|
|
2014
2035
|
/**
|
|
2015
2036
|
* ID of the comment to retrieve.
|
|
2016
2037
|
* @format GUID
|
|
2017
2038
|
*/
|
|
2018
2039
|
commentId: string;
|
|
2019
2040
|
}
|
|
2020
|
-
|
|
2041
|
+
interface GetCommentResponse {
|
|
2021
2042
|
/** Retrieved comment. */
|
|
2022
2043
|
comment?: Comment;
|
|
2023
2044
|
}
|
|
2024
2045
|
/** Comment info to update. */
|
|
2025
|
-
|
|
2046
|
+
interface UpdateCommentRequest {
|
|
2026
2047
|
/** Comment info to update. */
|
|
2027
2048
|
comment?: Comment;
|
|
2028
2049
|
}
|
|
2029
|
-
|
|
2050
|
+
interface UpdateCommentResponse {
|
|
2030
2051
|
/** Updated comment. */
|
|
2031
2052
|
comment?: Comment;
|
|
2032
2053
|
}
|
|
2033
|
-
|
|
2054
|
+
interface CommentContentChanged {
|
|
2034
2055
|
/** Comment ID. */
|
|
2035
2056
|
commentId?: string;
|
|
2036
2057
|
/** Content before the update. */
|
|
@@ -2038,19 +2059,19 @@ export interface CommentContentChanged {
|
|
|
2038
2059
|
/** Content after the update. */
|
|
2039
2060
|
currentContent?: CommentContent;
|
|
2040
2061
|
}
|
|
2041
|
-
|
|
2062
|
+
interface DeleteCommentRequest {
|
|
2042
2063
|
/**
|
|
2043
2064
|
* ID of the comment to delete.
|
|
2044
2065
|
* @format GUID
|
|
2045
2066
|
*/
|
|
2046
2067
|
commentId: string;
|
|
2047
2068
|
}
|
|
2048
|
-
|
|
2069
|
+
interface DeleteCommentResponse {
|
|
2049
2070
|
}
|
|
2050
|
-
|
|
2071
|
+
interface CommentDeleted {
|
|
2051
2072
|
comment?: Comment;
|
|
2052
2073
|
}
|
|
2053
|
-
|
|
2074
|
+
interface ModerateDraftContentRequest {
|
|
2054
2075
|
/**
|
|
2055
2076
|
* ID of the comment to moderate.
|
|
2056
2077
|
* @format GUID
|
|
@@ -2065,20 +2086,20 @@ export interface ModerateDraftContentRequest {
|
|
|
2065
2086
|
/** Draft content action. */
|
|
2066
2087
|
draftContentAction?: ActionWithLiterals;
|
|
2067
2088
|
}
|
|
2068
|
-
|
|
2089
|
+
interface ModerateDraftContentResponse {
|
|
2069
2090
|
/** Moderated comment. */
|
|
2070
2091
|
comment?: Comment;
|
|
2071
2092
|
}
|
|
2072
|
-
|
|
2093
|
+
interface CommentPublished {
|
|
2073
2094
|
/** Comment info. */
|
|
2074
2095
|
comment?: Comment;
|
|
2075
2096
|
/** Whether this is the first comment publish. */
|
|
2076
2097
|
firstPublish?: boolean;
|
|
2077
2098
|
}
|
|
2078
|
-
|
|
2099
|
+
interface CommentHidden {
|
|
2079
2100
|
comment?: Comment;
|
|
2080
2101
|
}
|
|
2081
|
-
|
|
2102
|
+
interface QueryCommentsRequest {
|
|
2082
2103
|
/**
|
|
2083
2104
|
* App ID to query comments for.
|
|
2084
2105
|
* @format GUID
|
|
@@ -2087,7 +2108,7 @@ export interface QueryCommentsRequest {
|
|
|
2087
2108
|
/** Query options. */
|
|
2088
2109
|
query: CursorQuery;
|
|
2089
2110
|
}
|
|
2090
|
-
|
|
2111
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2091
2112
|
/**
|
|
2092
2113
|
* Cursor paging options.
|
|
2093
2114
|
*
|
|
@@ -2109,7 +2130,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2109
2130
|
sort?: Sorting[];
|
|
2110
2131
|
}
|
|
2111
2132
|
/** @oneof */
|
|
2112
|
-
|
|
2133
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2113
2134
|
/**
|
|
2114
2135
|
* Cursor paging options.
|
|
2115
2136
|
*
|
|
@@ -2117,7 +2138,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2117
2138
|
*/
|
|
2118
2139
|
cursorPaging?: CursorPaging;
|
|
2119
2140
|
}
|
|
2120
|
-
|
|
2141
|
+
interface Sorting {
|
|
2121
2142
|
/**
|
|
2122
2143
|
* Name of the field to sort by.
|
|
2123
2144
|
* @maxLength 512
|
|
@@ -2126,13 +2147,13 @@ export interface Sorting {
|
|
|
2126
2147
|
/** Sort order. */
|
|
2127
2148
|
order?: SortOrderWithLiterals;
|
|
2128
2149
|
}
|
|
2129
|
-
|
|
2150
|
+
declare enum SortOrder {
|
|
2130
2151
|
ASC = "ASC",
|
|
2131
2152
|
DESC = "DESC"
|
|
2132
2153
|
}
|
|
2133
2154
|
/** @enumType */
|
|
2134
|
-
|
|
2135
|
-
|
|
2155
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2156
|
+
interface CursorPaging {
|
|
2136
2157
|
/**
|
|
2137
2158
|
* Maximum number of items to return in the results.
|
|
2138
2159
|
* @max 100
|
|
@@ -2147,13 +2168,13 @@ export interface CursorPaging {
|
|
|
2147
2168
|
*/
|
|
2148
2169
|
cursor?: string | null;
|
|
2149
2170
|
}
|
|
2150
|
-
|
|
2171
|
+
interface QueryCommentsResponse {
|
|
2151
2172
|
/** Retrieved comments. */
|
|
2152
2173
|
comments?: Comment[];
|
|
2153
2174
|
/** Paging metadata. */
|
|
2154
2175
|
pagingMetadata?: CursorPagingMetadata;
|
|
2155
2176
|
}
|
|
2156
|
-
|
|
2177
|
+
interface CursorPagingMetadata {
|
|
2157
2178
|
/** Number of items returned in current page. */
|
|
2158
2179
|
count?: number | null;
|
|
2159
2180
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2166,7 +2187,7 @@ export interface CursorPagingMetadata {
|
|
|
2166
2187
|
*/
|
|
2167
2188
|
hasNext?: boolean | null;
|
|
2168
2189
|
}
|
|
2169
|
-
|
|
2190
|
+
interface Cursors {
|
|
2170
2191
|
/**
|
|
2171
2192
|
* Cursor string pointing to the next page in the list of results.
|
|
2172
2193
|
* @maxLength 16000
|
|
@@ -2178,58 +2199,58 @@ export interface Cursors {
|
|
|
2178
2199
|
*/
|
|
2179
2200
|
prev?: string | null;
|
|
2180
2201
|
}
|
|
2181
|
-
|
|
2202
|
+
interface MarkCommentRequest {
|
|
2182
2203
|
/**
|
|
2183
2204
|
* ID of the comment to mark.
|
|
2184
2205
|
* @format GUID
|
|
2185
2206
|
*/
|
|
2186
2207
|
commentId: string;
|
|
2187
2208
|
}
|
|
2188
|
-
|
|
2209
|
+
interface MarkCommentResponse {
|
|
2189
2210
|
/** Marked comment. */
|
|
2190
2211
|
comment?: Comment;
|
|
2191
2212
|
}
|
|
2192
|
-
|
|
2213
|
+
interface CommentMarked {
|
|
2193
2214
|
comment?: Comment;
|
|
2194
2215
|
}
|
|
2195
|
-
|
|
2216
|
+
interface UnmarkCommentRequest {
|
|
2196
2217
|
/**
|
|
2197
2218
|
* ID of the comment to unmark.
|
|
2198
2219
|
* @format GUID
|
|
2199
2220
|
*/
|
|
2200
2221
|
commentId: string;
|
|
2201
2222
|
}
|
|
2202
|
-
|
|
2223
|
+
interface UnmarkCommentResponse {
|
|
2203
2224
|
/** Unmarked comment. */
|
|
2204
2225
|
comment?: Comment;
|
|
2205
2226
|
}
|
|
2206
|
-
|
|
2227
|
+
interface CommentUnmarked {
|
|
2207
2228
|
comment?: Comment;
|
|
2208
2229
|
}
|
|
2209
|
-
|
|
2230
|
+
interface HideCommentRequest {
|
|
2210
2231
|
/**
|
|
2211
2232
|
* ID of the comment to hide.
|
|
2212
2233
|
* @format GUID
|
|
2213
2234
|
*/
|
|
2214
2235
|
commentId: string;
|
|
2215
2236
|
}
|
|
2216
|
-
|
|
2237
|
+
interface HideCommentResponse {
|
|
2217
2238
|
/** Hidden comment. */
|
|
2218
2239
|
comment?: Comment;
|
|
2219
2240
|
}
|
|
2220
|
-
|
|
2241
|
+
interface PublishCommentRequest {
|
|
2221
2242
|
/**
|
|
2222
2243
|
* ID of the comment to publish.
|
|
2223
2244
|
* @format GUID
|
|
2224
2245
|
*/
|
|
2225
2246
|
commentId: string;
|
|
2226
2247
|
}
|
|
2227
|
-
|
|
2248
|
+
interface PublishCommentResponse {
|
|
2228
2249
|
/** Published comment. */
|
|
2229
2250
|
comment?: Comment;
|
|
2230
2251
|
}
|
|
2231
2252
|
/** Count comments options. */
|
|
2232
|
-
|
|
2253
|
+
interface CountCommentsRequest {
|
|
2233
2254
|
/**
|
|
2234
2255
|
* App ID to count the comments of.
|
|
2235
2256
|
* @format GUID
|
|
@@ -2238,11 +2259,11 @@ export interface CountCommentsRequest {
|
|
|
2238
2259
|
/** Filter to identify the comments that need to be counted. */
|
|
2239
2260
|
filter?: Record<string, any> | null;
|
|
2240
2261
|
}
|
|
2241
|
-
|
|
2262
|
+
interface CountCommentsResponse {
|
|
2242
2263
|
/** Number of comments. */
|
|
2243
2264
|
count?: number;
|
|
2244
2265
|
}
|
|
2245
|
-
|
|
2266
|
+
interface ListCommentsByResourceRequest {
|
|
2246
2267
|
/**
|
|
2247
2268
|
* ID of the app from which the comments are listed.
|
|
2248
2269
|
* @format GUID
|
|
@@ -2274,7 +2295,7 @@ export interface ListCommentsByResourceRequest {
|
|
|
2274
2295
|
/** Cursor paging. */
|
|
2275
2296
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2276
2297
|
}
|
|
2277
|
-
|
|
2298
|
+
interface CommentSort {
|
|
2278
2299
|
/** Sort order. */
|
|
2279
2300
|
order?: OrderWithLiterals;
|
|
2280
2301
|
/**
|
|
@@ -2284,7 +2305,7 @@ export interface CommentSort {
|
|
|
2284
2305
|
*/
|
|
2285
2306
|
keepMarkedInOriginalOrder?: boolean;
|
|
2286
2307
|
}
|
|
2287
|
-
|
|
2308
|
+
declare enum Order {
|
|
2288
2309
|
/** Unknown order. */
|
|
2289
2310
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2290
2311
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2303,8 +2324,8 @@ export declare enum Order {
|
|
|
2303
2324
|
RATING_ASC = "RATING_ASC"
|
|
2304
2325
|
}
|
|
2305
2326
|
/** @enumType */
|
|
2306
|
-
|
|
2307
|
-
|
|
2327
|
+
type OrderWithLiterals = Order | 'UNKNOWN_ORDER' | 'OLDEST_FIRST' | 'NEWEST_FIRST' | 'REACTION_COUNT' | 'NET_VOTE_COUNT' | 'RATING' | 'NET_VOTE_COUNT_ASC' | 'RATING_ASC';
|
|
2328
|
+
interface ReplySort {
|
|
2308
2329
|
/** Sort order. */
|
|
2309
2330
|
order?: ReplySortOrderWithLiterals;
|
|
2310
2331
|
/**
|
|
@@ -2316,7 +2337,7 @@ export interface ReplySort {
|
|
|
2316
2337
|
*/
|
|
2317
2338
|
keepMarkedInOriginalOrder?: boolean;
|
|
2318
2339
|
}
|
|
2319
|
-
|
|
2340
|
+
declare enum ReplySortOrder {
|
|
2320
2341
|
/** Unknown order. */
|
|
2321
2342
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2322
2343
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2327,8 +2348,8 @@ export declare enum ReplySortOrder {
|
|
|
2327
2348
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2328
2349
|
}
|
|
2329
2350
|
/** @enumType */
|
|
2330
|
-
|
|
2331
|
-
|
|
2351
|
+
type ReplySortOrderWithLiterals = ReplySortOrder | 'UNKNOWN_ORDER' | 'OLDEST_FIRST' | 'NEWEST_FIRST' | 'REACTION_COUNT';
|
|
2352
|
+
interface ListCommentsByResourceCursorPaging {
|
|
2332
2353
|
/** Pointer to the next or previous page in the list of results. */
|
|
2333
2354
|
cursor?: string | null;
|
|
2334
2355
|
/**
|
|
@@ -2343,7 +2364,7 @@ export interface ListCommentsByResourceCursorPaging {
|
|
|
2343
2364
|
*/
|
|
2344
2365
|
repliesLimit?: number | null;
|
|
2345
2366
|
}
|
|
2346
|
-
|
|
2367
|
+
interface ListCommentsByResourceResponse {
|
|
2347
2368
|
/** Listed comments. */
|
|
2348
2369
|
comments?: Comment[];
|
|
2349
2370
|
/** Paging metadata. */
|
|
@@ -2351,13 +2372,13 @@ export interface ListCommentsByResourceResponse {
|
|
|
2351
2372
|
/** Listed comment replies. */
|
|
2352
2373
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2353
2374
|
}
|
|
2354
|
-
|
|
2375
|
+
interface RepliesListResponse {
|
|
2355
2376
|
/** Listed comment replies. */
|
|
2356
2377
|
replies?: Comment[];
|
|
2357
2378
|
/** Paging metadata. */
|
|
2358
2379
|
pagingMetadata?: CursorPagingMetadata;
|
|
2359
2380
|
}
|
|
2360
|
-
|
|
2381
|
+
interface GetCommentThreadRequest {
|
|
2361
2382
|
/**
|
|
2362
2383
|
* App ID.
|
|
2363
2384
|
* @maxLength 128
|
|
@@ -2375,7 +2396,7 @@ export interface GetCommentThreadRequest {
|
|
|
2375
2396
|
/** Reply sorting. */
|
|
2376
2397
|
replySort?: ReplySort;
|
|
2377
2398
|
}
|
|
2378
|
-
|
|
2399
|
+
interface GetCommentThreadResponse {
|
|
2379
2400
|
/** Retrieved replies. */
|
|
2380
2401
|
comments?: Comment[];
|
|
2381
2402
|
/** Paging metadata. */
|
|
@@ -2383,7 +2404,7 @@ export interface GetCommentThreadResponse {
|
|
|
2383
2404
|
/** Retrieved replies of a reply. */
|
|
2384
2405
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2385
2406
|
}
|
|
2386
|
-
|
|
2407
|
+
interface BulkPublishCommentRequest {
|
|
2387
2408
|
/**
|
|
2388
2409
|
* ID of the app where to publish the comment.
|
|
2389
2410
|
* @format GUID
|
|
@@ -2392,7 +2413,7 @@ export interface BulkPublishCommentRequest {
|
|
|
2392
2413
|
/** 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"`}. */
|
|
2393
2414
|
filter: Record<string, any> | null;
|
|
2394
2415
|
}
|
|
2395
|
-
|
|
2416
|
+
interface BulkPublishCommentResponse {
|
|
2396
2417
|
/**
|
|
2397
2418
|
* Job ID.
|
|
2398
2419
|
*
|
|
@@ -2401,7 +2422,7 @@ export interface BulkPublishCommentResponse {
|
|
|
2401
2422
|
*/
|
|
2402
2423
|
jobId?: string;
|
|
2403
2424
|
}
|
|
2404
|
-
|
|
2425
|
+
interface BulkHideCommentRequest {
|
|
2405
2426
|
/**
|
|
2406
2427
|
* ID of the app where to hide the comments.
|
|
2407
2428
|
* @format GUID
|
|
@@ -2410,7 +2431,7 @@ export interface BulkHideCommentRequest {
|
|
|
2410
2431
|
/** 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"`}. */
|
|
2411
2432
|
filter: Record<string, any> | null;
|
|
2412
2433
|
}
|
|
2413
|
-
|
|
2434
|
+
interface BulkHideCommentResponse {
|
|
2414
2435
|
/**
|
|
2415
2436
|
* Job ID.
|
|
2416
2437
|
*
|
|
@@ -2419,7 +2440,7 @@ export interface BulkHideCommentResponse {
|
|
|
2419
2440
|
*/
|
|
2420
2441
|
jobId?: string;
|
|
2421
2442
|
}
|
|
2422
|
-
|
|
2443
|
+
interface BulkDeleteCommentRequest {
|
|
2423
2444
|
/**
|
|
2424
2445
|
* ID of the app where to delete the comments.
|
|
2425
2446
|
* @format GUID
|
|
@@ -2428,7 +2449,7 @@ export interface BulkDeleteCommentRequest {
|
|
|
2428
2449
|
/** 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"`}. */
|
|
2429
2450
|
filter: Record<string, any> | null;
|
|
2430
2451
|
}
|
|
2431
|
-
|
|
2452
|
+
interface BulkDeleteCommentResponse {
|
|
2432
2453
|
/**
|
|
2433
2454
|
* Job ID.
|
|
2434
2455
|
*
|
|
@@ -2437,7 +2458,7 @@ export interface BulkDeleteCommentResponse {
|
|
|
2437
2458
|
*/
|
|
2438
2459
|
jobId?: string;
|
|
2439
2460
|
}
|
|
2440
|
-
|
|
2461
|
+
interface BulkModerateDraftContentRequest {
|
|
2441
2462
|
/**
|
|
2442
2463
|
* ID of the app where to moderate the comments.
|
|
2443
2464
|
* @format GUID
|
|
@@ -2448,7 +2469,7 @@ export interface BulkModerateDraftContentRequest {
|
|
|
2448
2469
|
/** Action to do regarding draft content */
|
|
2449
2470
|
draftContentAction: ActionWithLiterals;
|
|
2450
2471
|
}
|
|
2451
|
-
|
|
2472
|
+
interface BulkModerateDraftContentResponse {
|
|
2452
2473
|
/**
|
|
2453
2474
|
* Job ID.
|
|
2454
2475
|
*
|
|
@@ -2457,7 +2478,7 @@ export interface BulkModerateDraftContentResponse {
|
|
|
2457
2478
|
*/
|
|
2458
2479
|
jobId?: string;
|
|
2459
2480
|
}
|
|
2460
|
-
|
|
2481
|
+
interface BulkMoveCommentByFilterRequest {
|
|
2461
2482
|
/**
|
|
2462
2483
|
* ID of the app from which to move the comments.
|
|
2463
2484
|
* @format GUID
|
|
@@ -2468,7 +2489,7 @@ export interface BulkMoveCommentByFilterRequest {
|
|
|
2468
2489
|
/** Where to move the comment. */
|
|
2469
2490
|
destination?: Destination;
|
|
2470
2491
|
}
|
|
2471
|
-
|
|
2492
|
+
interface Destination {
|
|
2472
2493
|
/**
|
|
2473
2494
|
* Context ID of where to move the comment to.
|
|
2474
2495
|
* @maxLength 128
|
|
@@ -2480,7 +2501,7 @@ export interface Destination {
|
|
|
2480
2501
|
*/
|
|
2481
2502
|
resourceId?: string;
|
|
2482
2503
|
}
|
|
2483
|
-
|
|
2504
|
+
interface BulkMoveCommentByFilterResponse {
|
|
2484
2505
|
/**
|
|
2485
2506
|
* Job ID.
|
|
2486
2507
|
*
|
|
@@ -2489,11 +2510,11 @@ export interface BulkMoveCommentByFilterResponse {
|
|
|
2489
2510
|
*/
|
|
2490
2511
|
jobId?: string;
|
|
2491
2512
|
}
|
|
2492
|
-
|
|
2513
|
+
interface CommentMoved {
|
|
2493
2514
|
comment?: Comment;
|
|
2494
2515
|
destination?: Destination;
|
|
2495
2516
|
}
|
|
2496
|
-
|
|
2517
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2497
2518
|
createdEvent?: EntityCreatedEvent;
|
|
2498
2519
|
updatedEvent?: EntityUpdatedEvent;
|
|
2499
2520
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2528,19 +2549,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2528
2549
|
entityEventSequence?: string | null;
|
|
2529
2550
|
}
|
|
2530
2551
|
/** @oneof */
|
|
2531
|
-
|
|
2552
|
+
interface DomainEventBodyOneOf {
|
|
2532
2553
|
createdEvent?: EntityCreatedEvent;
|
|
2533
2554
|
updatedEvent?: EntityUpdatedEvent;
|
|
2534
2555
|
deletedEvent?: EntityDeletedEvent;
|
|
2535
2556
|
actionEvent?: ActionEvent;
|
|
2536
2557
|
}
|
|
2537
|
-
|
|
2558
|
+
interface EntityCreatedEvent {
|
|
2538
2559
|
entity?: string;
|
|
2539
2560
|
}
|
|
2540
|
-
|
|
2561
|
+
interface RestoreInfo {
|
|
2541
2562
|
deletedDate?: Date | null;
|
|
2542
2563
|
}
|
|
2543
|
-
|
|
2564
|
+
interface EntityUpdatedEvent {
|
|
2544
2565
|
/**
|
|
2545
2566
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2546
2567
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -2548,14 +2569,14 @@ export interface EntityUpdatedEvent {
|
|
|
2548
2569
|
*/
|
|
2549
2570
|
currentEntity?: string;
|
|
2550
2571
|
}
|
|
2551
|
-
|
|
2572
|
+
interface EntityDeletedEvent {
|
|
2552
2573
|
/** Entity that was deleted. */
|
|
2553
2574
|
deletedEntity?: string | null;
|
|
2554
2575
|
}
|
|
2555
|
-
|
|
2576
|
+
interface ActionEvent {
|
|
2556
2577
|
body?: string;
|
|
2557
2578
|
}
|
|
2558
|
-
|
|
2579
|
+
interface MessageEnvelope {
|
|
2559
2580
|
/**
|
|
2560
2581
|
* App instance ID.
|
|
2561
2582
|
* @format GUID
|
|
@@ -2571,7 +2592,7 @@ export interface MessageEnvelope {
|
|
|
2571
2592
|
/** Stringify payload. */
|
|
2572
2593
|
data?: string;
|
|
2573
2594
|
}
|
|
2574
|
-
|
|
2595
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2575
2596
|
/**
|
|
2576
2597
|
* ID of a site visitor that has not logged in to the site.
|
|
2577
2598
|
* @format GUID
|
|
@@ -2596,7 +2617,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2596
2617
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2597
2618
|
}
|
|
2598
2619
|
/** @oneof */
|
|
2599
|
-
|
|
2620
|
+
interface IdentificationDataIdOneOf {
|
|
2600
2621
|
/**
|
|
2601
2622
|
* ID of a site visitor that has not logged in to the site.
|
|
2602
2623
|
* @format GUID
|
|
@@ -2618,7 +2639,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
2618
2639
|
*/
|
|
2619
2640
|
appId?: string;
|
|
2620
2641
|
}
|
|
2621
|
-
|
|
2642
|
+
declare enum WebhookIdentityType {
|
|
2622
2643
|
UNKNOWN = "UNKNOWN",
|
|
2623
2644
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2624
2645
|
MEMBER = "MEMBER",
|
|
@@ -2626,8 +2647,8 @@ export declare enum WebhookIdentityType {
|
|
|
2626
2647
|
APP = "APP"
|
|
2627
2648
|
}
|
|
2628
2649
|
/** @enumType */
|
|
2629
|
-
|
|
2630
|
-
|
|
2650
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2651
|
+
interface BaseEventMetadata {
|
|
2631
2652
|
/**
|
|
2632
2653
|
* App instance ID.
|
|
2633
2654
|
* @format GUID
|
|
@@ -2641,7 +2662,7 @@ export interface BaseEventMetadata {
|
|
|
2641
2662
|
/** The identification type and identity data. */
|
|
2642
2663
|
identity?: IdentificationData;
|
|
2643
2664
|
}
|
|
2644
|
-
|
|
2665
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2645
2666
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2646
2667
|
_id?: string;
|
|
2647
2668
|
/**
|
|
@@ -2671,251 +2692,43 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
2671
2692
|
*/
|
|
2672
2693
|
entityEventSequence?: string | null;
|
|
2673
2694
|
}
|
|
2674
|
-
|
|
2695
|
+
interface CommentContentChangedEnvelope {
|
|
2675
2696
|
data: CommentContentChanged;
|
|
2676
2697
|
metadata: EventMetadata;
|
|
2677
2698
|
}
|
|
2678
|
-
|
|
2679
|
-
* Triggered when comment content is updated.
|
|
2680
|
-
* @permissionScope Read Comments
|
|
2681
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2682
|
-
* @permissionScope Manage Blog
|
|
2683
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2684
|
-
* @permissionScope Manage Comments
|
|
2685
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2686
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2687
|
-
* @webhook
|
|
2688
|
-
* @eventType wix.comments.v2.comment_comment_content_changed
|
|
2689
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2690
|
-
* @slug comment_content_changed
|
|
2691
|
-
*/
|
|
2692
|
-
export declare function onCommentContentChanged(handler: (event: CommentContentChangedEnvelope) => void | Promise<void>): void;
|
|
2693
|
-
export interface CommentHiddenEnvelope {
|
|
2699
|
+
interface CommentHiddenEnvelope {
|
|
2694
2700
|
data: CommentHidden;
|
|
2695
2701
|
metadata: EventMetadata;
|
|
2696
2702
|
}
|
|
2697
|
-
|
|
2698
|
-
* Triggered when a comment is hidden.
|
|
2699
|
-
* @permissionScope Read Comments
|
|
2700
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2701
|
-
* @permissionScope Manage Blog
|
|
2702
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2703
|
-
* @permissionScope Manage Comments
|
|
2704
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2705
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2706
|
-
* @webhook
|
|
2707
|
-
* @eventType wix.comments.v2.comment_comment_hidden
|
|
2708
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2709
|
-
* @slug comment_hidden
|
|
2710
|
-
* @documentationMaturity preview
|
|
2711
|
-
*/
|
|
2712
|
-
export declare function onCommentHidden(handler: (event: CommentHiddenEnvelope) => void | Promise<void>): void;
|
|
2713
|
-
export interface CommentMarkedEnvelope {
|
|
2703
|
+
interface CommentMarkedEnvelope {
|
|
2714
2704
|
data: CommentMarked;
|
|
2715
2705
|
metadata: EventMetadata;
|
|
2716
2706
|
}
|
|
2717
|
-
|
|
2718
|
-
* Triggered when a comment is marked.
|
|
2719
|
-
* @permissionScope Read Comments
|
|
2720
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2721
|
-
* @permissionScope Manage Blog
|
|
2722
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2723
|
-
* @permissionScope Manage Comments
|
|
2724
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2725
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2726
|
-
* @webhook
|
|
2727
|
-
* @eventType wix.comments.v2.comment_comment_marked
|
|
2728
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2729
|
-
* @slug comment_marked
|
|
2730
|
-
*/
|
|
2731
|
-
export declare function onCommentMarked(handler: (event: CommentMarkedEnvelope) => void | Promise<void>): void;
|
|
2732
|
-
export interface CommentMovedEnvelope {
|
|
2707
|
+
interface CommentMovedEnvelope {
|
|
2733
2708
|
data: CommentMoved;
|
|
2734
2709
|
metadata: EventMetadata;
|
|
2735
2710
|
}
|
|
2736
|
-
|
|
2737
|
-
* Triggered when a comment is moved.
|
|
2738
|
-
* @permissionScope Read Comments
|
|
2739
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2740
|
-
* @permissionScope Manage Blog
|
|
2741
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2742
|
-
* @permissionScope Manage Comments
|
|
2743
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2744
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2745
|
-
* @webhook
|
|
2746
|
-
* @eventType wix.comments.v2.comment_comment_moved
|
|
2747
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2748
|
-
* @slug comment_moved
|
|
2749
|
-
* @documentationMaturity preview
|
|
2750
|
-
*/
|
|
2751
|
-
export declare function onCommentMoved(handler: (event: CommentMovedEnvelope) => void | Promise<void>): void;
|
|
2752
|
-
export interface CommentPublishedEnvelope {
|
|
2711
|
+
interface CommentPublishedEnvelope {
|
|
2753
2712
|
data: CommentPublished;
|
|
2754
2713
|
metadata: EventMetadata;
|
|
2755
2714
|
}
|
|
2756
|
-
|
|
2757
|
-
* Triggered when a comment is published.
|
|
2758
|
-
* @permissionScope Read Comments
|
|
2759
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2760
|
-
* @permissionScope Manage Blog
|
|
2761
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2762
|
-
* @permissionScope Manage Comments
|
|
2763
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2764
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2765
|
-
* @webhook
|
|
2766
|
-
* @eventType wix.comments.v2.comment_comment_published
|
|
2767
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2768
|
-
* @slug comment_published
|
|
2769
|
-
* @documentationMaturity preview
|
|
2770
|
-
*/
|
|
2771
|
-
export declare function onCommentPublished(handler: (event: CommentPublishedEnvelope) => void | Promise<void>): void;
|
|
2772
|
-
export interface CommentUnmarkedEnvelope {
|
|
2715
|
+
interface CommentUnmarkedEnvelope {
|
|
2773
2716
|
data: CommentUnmarked;
|
|
2774
2717
|
metadata: EventMetadata;
|
|
2775
2718
|
}
|
|
2776
|
-
|
|
2777
|
-
* Triggered when a comment is unmarked.
|
|
2778
|
-
* @permissionScope Read Comments
|
|
2779
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2780
|
-
* @permissionScope Manage Blog
|
|
2781
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2782
|
-
* @permissionScope Manage Comments
|
|
2783
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2784
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2785
|
-
* @webhook
|
|
2786
|
-
* @eventType wix.comments.v2.comment_comment_unmarked
|
|
2787
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2788
|
-
* @slug comment_unmarked
|
|
2789
|
-
*/
|
|
2790
|
-
export declare function onCommentUnmarked(handler: (event: CommentUnmarkedEnvelope) => void | Promise<void>): void;
|
|
2791
|
-
export interface CommentCreatedEnvelope {
|
|
2719
|
+
interface CommentCreatedEnvelope {
|
|
2792
2720
|
entity: Comment;
|
|
2793
2721
|
metadata: EventMetadata;
|
|
2794
2722
|
}
|
|
2795
|
-
|
|
2796
|
-
* Triggered when a comment is created.
|
|
2797
|
-
* @permissionScope Read Comments
|
|
2798
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2799
|
-
* @permissionScope Manage Blog
|
|
2800
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2801
|
-
* @permissionScope Manage Comments
|
|
2802
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2803
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2804
|
-
* @webhook
|
|
2805
|
-
* @eventType wix.comments.v2.comment_created
|
|
2806
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2807
|
-
* @slug created
|
|
2808
|
-
*/
|
|
2809
|
-
export declare function onCommentCreated(handler: (event: CommentCreatedEnvelope) => void | Promise<void>): void;
|
|
2810
|
-
export interface CommentResourceCommentCountChangedEnvelope {
|
|
2723
|
+
interface CommentResourceCommentCountChangedEnvelope {
|
|
2811
2724
|
data: ResourceCommentCountChanged;
|
|
2812
2725
|
metadata: EventMetadata;
|
|
2813
2726
|
}
|
|
2814
|
-
|
|
2815
|
-
* Triggered when the total number of comments has changed in a resource.
|
|
2816
|
-
* @permissionScope Read Comments
|
|
2817
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2818
|
-
* @permissionScope Manage Blog
|
|
2819
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2820
|
-
* @permissionScope Manage Comments
|
|
2821
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2822
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2823
|
-
* @webhook
|
|
2824
|
-
* @eventType wix.comments.v2.comment_resource_comment_count_changed
|
|
2825
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2826
|
-
* @slug resource_comment_count_changed
|
|
2827
|
-
*/
|
|
2828
|
-
export declare function onCommentResourceCommentCountChanged(handler: (event: CommentResourceCommentCountChangedEnvelope) => void | Promise<void>): void;
|
|
2829
|
-
export interface CommentUpdatedEnvelope {
|
|
2727
|
+
interface CommentUpdatedEnvelope {
|
|
2830
2728
|
entity: Comment;
|
|
2831
2729
|
metadata: EventMetadata;
|
|
2832
2730
|
}
|
|
2833
|
-
|
|
2834
|
-
* Triggered when a comment is updated.
|
|
2835
|
-
* @permissionScope Read Comments
|
|
2836
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2837
|
-
* @permissionScope Manage Blog
|
|
2838
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2839
|
-
* @permissionScope Manage Comments
|
|
2840
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2841
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2842
|
-
* @webhook
|
|
2843
|
-
* @eventType wix.comments.v2.comment_updated
|
|
2844
|
-
* @serviceIdentifier wix.comments.ng.v1.CommentsNg
|
|
2845
|
-
* @slug updated
|
|
2846
|
-
*/
|
|
2847
|
-
export declare function onCommentUpdated(handler: (event: CommentUpdatedEnvelope) => void | Promise<void>): void;
|
|
2848
|
-
type CommentNonNullablePaths = `content.mentions` | `content.attachments` | `parentComment.status` | `replyCount` | `voteSummary.netVoteCount` | `voteSummary.upvoteCount` | `voteSummary.downvoteCount` | `status` | `reactionSummary.total` | `marked`;
|
|
2849
|
-
/**
|
|
2850
|
-
* Creates a new comment and publishes it.
|
|
2851
|
-
*
|
|
2852
|
-
* The `appId`, `contextId`, and `resourceId` are all required and associate the created comment with the specific
|
|
2853
|
-
* resource it responds to. See **Integrations** in the Comments introduction for a list of integrated scopes for these fields.
|
|
2854
|
-
*
|
|
2855
|
-
* If the created comment is a direct response to another comment, the `commentId` of the parent comment should be passed
|
|
2856
|
-
* as `parentComment.id` in this comment's request. See **Terminology** in the Comments introduction for additional information on parent comments and replies.
|
|
2857
|
-
* @param comment - Comment to create.
|
|
2858
|
-
* @public
|
|
2859
|
-
* @requiredField comment
|
|
2860
|
-
* @requiredField comment.appId
|
|
2861
|
-
* @requiredField comment.content
|
|
2862
|
-
* @requiredField comment.contextId
|
|
2863
|
-
* @requiredField comment.resourceId
|
|
2864
|
-
* @permissionId WIX_COMMENTS.COMMENT_CREATE
|
|
2865
|
-
* @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_AUTHOR
|
|
2866
|
-
* @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_COMMENT_DATE
|
|
2867
|
-
* @permissionScope Manage Blog
|
|
2868
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2869
|
-
* @permissionScope Manage Comments
|
|
2870
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2871
|
-
* @permissionScope Manage Comments
|
|
2872
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2873
|
-
* @permissionScope Manage Comments
|
|
2874
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2875
|
-
* @applicableIdentity APP
|
|
2876
|
-
* @returns Created comment.
|
|
2877
|
-
* @fqn wix.comments.ng.v1.CommentsNg.CreateComment
|
|
2878
|
-
*/
|
|
2879
|
-
export declare function createComment(comment: NonNullablePaths<Comment, `appId` | `content` | `contextId` | `resourceId`>): Promise<NonNullablePaths<Comment, CommentNonNullablePaths>>;
|
|
2880
|
-
/**
|
|
2881
|
-
* Retrieves a comment.
|
|
2882
|
-
* @param commentId - ID of the comment to retrieve.
|
|
2883
|
-
* @public
|
|
2884
|
-
* @requiredField commentId
|
|
2885
|
-
* @permissionId WIX_COMMENTS.COMMENT_READ
|
|
2886
|
-
* @permissionScope Read Comments
|
|
2887
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
2888
|
-
* @permissionScope Manage Blog
|
|
2889
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2890
|
-
* @permissionScope Manage Comments
|
|
2891
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2892
|
-
* @applicableIdentity APP
|
|
2893
|
-
* @returns Retrieved comment.
|
|
2894
|
-
* @fqn wix.comments.ng.v1.CommentsNg.GetComment
|
|
2895
|
-
*/
|
|
2896
|
-
export declare function getComment(commentId: string): Promise<NonNullablePaths<Comment, CommentNonNullablePaths>>;
|
|
2897
|
-
/**
|
|
2898
|
-
* Updates a comment.
|
|
2899
|
-
*
|
|
2900
|
-
* Each time the comment is updated, `revision` increments by 1. The current `revision` must be
|
|
2901
|
-
* passed when updating the comment. This ensures you're working with the latest comment and
|
|
2902
|
-
* prevents unintended overwrites.
|
|
2903
|
-
* @param _id - Comment ID.
|
|
2904
|
-
* @public
|
|
2905
|
-
* @requiredField _id
|
|
2906
|
-
* @requiredField comment
|
|
2907
|
-
* @requiredField comment.revision
|
|
2908
|
-
* @permissionId WIX_COMMENTS.COMMENT_UPDATE
|
|
2909
|
-
* @permissionScope Manage Blog
|
|
2910
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
2911
|
-
* @permissionScope Manage Comments
|
|
2912
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
2913
|
-
* @applicableIdentity APP
|
|
2914
|
-
* @returns Updated comment.
|
|
2915
|
-
* @fqn wix.comments.ng.v1.CommentsNg.UpdateComment
|
|
2916
|
-
*/
|
|
2917
|
-
export declare function updateComment(_id: string, comment: NonNullablePaths<UpdateComment, `revision`>): Promise<NonNullablePaths<Comment, CommentNonNullablePaths>>;
|
|
2918
|
-
export interface UpdateComment {
|
|
2731
|
+
interface UpdateComment {
|
|
2919
2732
|
/**
|
|
2920
2733
|
* Comment ID.
|
|
2921
2734
|
* @format GUID
|
|
@@ -3018,79 +2831,10 @@ export interface UpdateComment {
|
|
|
3018
2831
|
*/
|
|
3019
2832
|
contentEdited?: boolean | null;
|
|
3020
2833
|
}
|
|
3021
|
-
|
|
3022
|
-
* Deletes a comment.
|
|
3023
|
-
*
|
|
3024
|
-
* This method deletes the `content` of the comment and sets its `status` to `DELETED`.
|
|
3025
|
-
* @param commentId - ID of the comment to delete.
|
|
3026
|
-
* @public
|
|
3027
|
-
* @requiredField commentId
|
|
3028
|
-
* @permissionId WIX_COMMENTS.COMMENT_DELETE
|
|
3029
|
-
* @permissionScope Manage Blog
|
|
3030
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3031
|
-
* @permissionScope Manage Comments
|
|
3032
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3033
|
-
* @applicableIdentity APP
|
|
3034
|
-
* @fqn wix.comments.ng.v1.CommentsNg.DeleteComment
|
|
3035
|
-
*/
|
|
3036
|
-
export declare function deleteComment(commentId: string): Promise<void>;
|
|
3037
|
-
/**
|
|
3038
|
-
* Moderates the draft content of a comment.
|
|
3039
|
-
*
|
|
3040
|
-
* - `APPROVE`: Moves `draftContent` to `content` and updates the comment `status` to `PUBLISHED`.
|
|
3041
|
-
* - `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`.
|
|
3042
|
-
* @param commentId - ID of the comment to moderate.
|
|
3043
|
-
* @param revision - Revision number, which increments by `1` each time the comment is updated.
|
|
3044
|
-
*
|
|
3045
|
-
* To prevent conflicting changes, the current `revision` must be passed when updating the comment.
|
|
3046
|
-
* @public
|
|
3047
|
-
* @documentationMaturity preview
|
|
3048
|
-
* @requiredField commentId
|
|
3049
|
-
* @requiredField revision
|
|
3050
|
-
* @permissionId WIX_COMMENTS.COMMENT_MODERATE_DRAFT_CONTENT
|
|
3051
|
-
* @permissionScope Manage Blog
|
|
3052
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3053
|
-
* @permissionScope Manage Comments
|
|
3054
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3055
|
-
* @applicableIdentity APP
|
|
3056
|
-
* @fqn wix.comments.ng.v1.CommentsNg.ModerateDraftContent
|
|
3057
|
-
*/
|
|
3058
|
-
export declare function moderateDraftContent(commentId: string, revision: string, options?: ModerateDraftContentOptions): Promise<NonNullablePaths<ModerateDraftContentResponse, {
|
|
3059
|
-
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3060
|
-
}[CommentNonNullablePaths]>>;
|
|
3061
|
-
export interface ModerateDraftContentOptions {
|
|
2834
|
+
interface ModerateDraftContentOptions {
|
|
3062
2835
|
/** Draft content action. */
|
|
3063
2836
|
draftContentAction?: ActionWithLiterals;
|
|
3064
2837
|
}
|
|
3065
|
-
/**
|
|
3066
|
-
* Creates a query to retrieve a list of comments.
|
|
3067
|
-
*
|
|
3068
|
-
* The `queryComments()` function builds a query to retrieve a list of comments and returns a [`CommentsQueryBuilder`](#commentsquerybuilder) object.
|
|
3069
|
-
*
|
|
3070
|
-
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](#commentsquerybuilder/find) function.
|
|
3071
|
-
*
|
|
3072
|
-
* 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.
|
|
3073
|
-
*
|
|
3074
|
-
* `queryComments()` runs with the following `CommentsQueryBuilder` default that you can override:
|
|
3075
|
-
* + `ascending("_id")`
|
|
3076
|
-
*
|
|
3077
|
-
* 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"`.
|
|
3078
|
-
*
|
|
3079
|
-
* 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).
|
|
3080
|
-
* @public
|
|
3081
|
-
* @requiredField appId
|
|
3082
|
-
* @param appId - App ID to query comments for.
|
|
3083
|
-
* @permissionScope Read Comments
|
|
3084
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
3085
|
-
* @permissionScope Manage Blog
|
|
3086
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3087
|
-
* @permissionScope Manage Comments
|
|
3088
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3089
|
-
* @permissionId WIX_COMMENTS.COMMENT_QUERY
|
|
3090
|
-
* @applicableIdentity APP
|
|
3091
|
-
* @fqn wix.comments.ng.v1.CommentsNg.QueryComments
|
|
3092
|
-
*/
|
|
3093
|
-
export declare function queryComments(appId: string): CommentsQueryBuilder;
|
|
3094
2838
|
interface QueryCursorResult {
|
|
3095
2839
|
cursors: Cursors;
|
|
3096
2840
|
hasNext: () => boolean;
|
|
@@ -3098,13 +2842,13 @@ interface QueryCursorResult {
|
|
|
3098
2842
|
length: number;
|
|
3099
2843
|
pageSize: number;
|
|
3100
2844
|
}
|
|
3101
|
-
|
|
2845
|
+
interface CommentsQueryResult extends QueryCursorResult {
|
|
3102
2846
|
items: Comment[];
|
|
3103
2847
|
query: CommentsQueryBuilder;
|
|
3104
2848
|
next: () => Promise<CommentsQueryResult>;
|
|
3105
2849
|
prev: () => Promise<CommentsQueryResult>;
|
|
3106
2850
|
}
|
|
3107
|
-
|
|
2851
|
+
interface CommentsQueryBuilder {
|
|
3108
2852
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3109
2853
|
* @param value - Value to compare against.
|
|
3110
2854
|
*/
|
|
@@ -3129,6 +2873,14 @@ export interface CommentsQueryBuilder {
|
|
|
3129
2873
|
* @param value - Value to compare against.
|
|
3130
2874
|
*/
|
|
3131
2875
|
lt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
|
|
2876
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2877
|
+
* @param values - List of values to compare against.
|
|
2878
|
+
*/
|
|
2879
|
+
hasSome: (propertyName: string, value: any[]) => CommentsQueryBuilder;
|
|
2880
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2881
|
+
* @param values - List of values to compare against.
|
|
2882
|
+
*/
|
|
2883
|
+
hasAll: (propertyName: string, value: any[]) => CommentsQueryBuilder;
|
|
3132
2884
|
in: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'status', value: any) => CommentsQueryBuilder;
|
|
3133
2885
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
3134
2886
|
ascending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
|
|
@@ -3140,115 +2892,11 @@ export interface CommentsQueryBuilder {
|
|
|
3140
2892
|
skipTo: (cursor: string) => CommentsQueryBuilder;
|
|
3141
2893
|
find: () => Promise<CommentsQueryResult>;
|
|
3142
2894
|
}
|
|
3143
|
-
|
|
3144
|
-
* Sets `marked` to `TRUE` to mark a comment.
|
|
3145
|
-
*
|
|
3146
|
-
* Call Query Comments to filter for marked comments to then apply customization to.
|
|
3147
|
-
* See Sample Flows for an example.
|
|
3148
|
-
* @param commentId - ID of the comment to mark.
|
|
3149
|
-
* @public
|
|
3150
|
-
* @requiredField commentId
|
|
3151
|
-
* @permissionId WIX_COMMENTS.COMMENT_MARK
|
|
3152
|
-
* @permissionScope Manage Blog
|
|
3153
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3154
|
-
* @permissionScope Manage Comments
|
|
3155
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3156
|
-
* @applicableIdentity APP
|
|
3157
|
-
* @fqn wix.comments.ng.v1.CommentsNg.MarkComment
|
|
3158
|
-
*/
|
|
3159
|
-
export declare function markComment(commentId: string): Promise<NonNullablePaths<MarkCommentResponse, {
|
|
3160
|
-
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3161
|
-
}[CommentNonNullablePaths]>>;
|
|
3162
|
-
/**
|
|
3163
|
-
* Sets `marked` to `FALSE` to unmark a comment.
|
|
3164
|
-
* @param commentId - ID of the comment to unmark.
|
|
3165
|
-
* @public
|
|
3166
|
-
* @requiredField commentId
|
|
3167
|
-
* @permissionId WIX_COMMENTS.COMMENT_MARK
|
|
3168
|
-
* @permissionScope Manage Blog
|
|
3169
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3170
|
-
* @permissionScope Manage Comments
|
|
3171
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3172
|
-
* @applicableIdentity APP
|
|
3173
|
-
* @fqn wix.comments.ng.v1.CommentsNg.UnmarkComment
|
|
3174
|
-
*/
|
|
3175
|
-
export declare function unmarkComment(commentId: string): Promise<NonNullablePaths<UnmarkCommentResponse, {
|
|
3176
|
-
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3177
|
-
}[CommentNonNullablePaths]>>;
|
|
3178
|
-
/**
|
|
3179
|
-
* Hides a comment in a widget. The comment status becomes `HIDDEN`.
|
|
3180
|
-
* @param commentId - ID of the comment to hide.
|
|
3181
|
-
* @public
|
|
3182
|
-
* @documentationMaturity preview
|
|
3183
|
-
* @requiredField commentId
|
|
3184
|
-
* @permissionId WIX_COMMENTS.COMMENT_HIDE
|
|
3185
|
-
* @permissionScope Manage Blog
|
|
3186
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3187
|
-
* @permissionScope Manage Comments
|
|
3188
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3189
|
-
* @applicableIdentity APP
|
|
3190
|
-
* @fqn wix.comments.ng.v1.CommentsNg.HideComment
|
|
3191
|
-
*/
|
|
3192
|
-
export declare function hideComment(commentId: string): Promise<NonNullablePaths<HideCommentResponse, {
|
|
3193
|
-
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3194
|
-
}[CommentNonNullablePaths]>>;
|
|
3195
|
-
/**
|
|
3196
|
-
* Publishes a comment with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
|
|
3197
|
-
*
|
|
3198
|
-
* To publish a new comment, call Create Comment.
|
|
3199
|
-
* @param commentId - ID of the comment to publish.
|
|
3200
|
-
* @public
|
|
3201
|
-
* @documentationMaturity preview
|
|
3202
|
-
* @requiredField commentId
|
|
3203
|
-
* @permissionId WIX_COMMENTS.COMMENT_PUBLISH
|
|
3204
|
-
* @permissionScope Manage Blog
|
|
3205
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3206
|
-
* @permissionScope Manage Comments
|
|
3207
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3208
|
-
* @applicableIdentity APP
|
|
3209
|
-
* @fqn wix.comments.ng.v1.CommentsNg.PublishComment
|
|
3210
|
-
*/
|
|
3211
|
-
export declare function publishComment(commentId: string): Promise<NonNullablePaths<PublishCommentResponse, {
|
|
3212
|
-
[P in CommentNonNullablePaths]: `comment.${P}`;
|
|
3213
|
-
}[CommentNonNullablePaths]>>;
|
|
3214
|
-
/**
|
|
3215
|
-
* Counts comments, given the specified filtering. Comments with the `HIDDEN` status are not included in the response.
|
|
3216
|
-
* @param appId - App ID to count the comments of.
|
|
3217
|
-
* @public
|
|
3218
|
-
* @requiredField appId
|
|
3219
|
-
* @permissionId WIX_COMMENTS.COMMENT_COUNT
|
|
3220
|
-
* @permissionScope Manage Blog
|
|
3221
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3222
|
-
* @permissionScope Manage Comments
|
|
3223
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3224
|
-
* @applicableIdentity APP
|
|
3225
|
-
* @fqn wix.comments.ng.v1.CommentsNg.CountComments
|
|
3226
|
-
*/
|
|
3227
|
-
export declare function countComments(appId: string, options?: CountCommentsOptions): Promise<NonNullablePaths<CountCommentsResponse, `count`>>;
|
|
3228
|
-
export interface CountCommentsOptions {
|
|
2895
|
+
interface CountCommentsOptions {
|
|
3229
2896
|
/** Filter to identify the comments that need to be counted. */
|
|
3230
2897
|
filter?: Record<string, any> | null;
|
|
3231
2898
|
}
|
|
3232
|
-
|
|
3233
|
-
* Lists published comments and replies from a specified resource, such as a blog post.
|
|
3234
|
-
* @param appId - ID of the app from which the comments are listed.
|
|
3235
|
-
* @public
|
|
3236
|
-
* @documentationMaturity preview
|
|
3237
|
-
* @requiredField appId
|
|
3238
|
-
* @requiredField options.contextId
|
|
3239
|
-
* @requiredField options.resourceId
|
|
3240
|
-
* @permissionId WIX_COMMENTS.COMMENT_LIST
|
|
3241
|
-
* @permissionScope Read Comments
|
|
3242
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
3243
|
-
* @permissionScope Manage Comments
|
|
3244
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3245
|
-
* @applicableIdentity APP
|
|
3246
|
-
* @fqn wix.comments.ng.v1.CommentsNg.ListCommentsByResource
|
|
3247
|
-
*/
|
|
3248
|
-
export declare function listCommentsByResource(appId: string, options?: NonNullablePaths<ListCommentsByResourceOptions, `contextId` | `resourceId`>): Promise<NonNullablePaths<ListCommentsByResourceResponse, {
|
|
3249
|
-
[P in CommentNonNullablePaths]: `comments.${number}.${P}`;
|
|
3250
|
-
}[CommentNonNullablePaths]>>;
|
|
3251
|
-
export interface ListCommentsByResourceOptions {
|
|
2899
|
+
interface ListCommentsByResourceOptions {
|
|
3252
2900
|
/**
|
|
3253
2901
|
* ID of the specific context the comment is in response to.
|
|
3254
2902
|
*
|
|
@@ -3275,28 +2923,7 @@ export interface ListCommentsByResourceOptions {
|
|
|
3275
2923
|
/** Cursor paging. */
|
|
3276
2924
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
3277
2925
|
}
|
|
3278
|
-
|
|
3279
|
-
* Returns a thread of a comment or a reply.
|
|
3280
|
-
*
|
|
3281
|
-
* 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.
|
|
3282
|
-
*
|
|
3283
|
-
* 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.
|
|
3284
|
-
* @param commentId - Comment ID.
|
|
3285
|
-
* @public
|
|
3286
|
-
* @documentationMaturity preview
|
|
3287
|
-
* @requiredField commentId
|
|
3288
|
-
* @permissionId WIX_COMMENTS.COMMENT_THREAD
|
|
3289
|
-
* @permissionScope Read Comments
|
|
3290
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
|
|
3291
|
-
* @permissionScope Manage Comments
|
|
3292
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3293
|
-
* @applicableIdentity APP
|
|
3294
|
-
* @fqn wix.comments.ng.v1.CommentsNg.GetCommentThread
|
|
3295
|
-
*/
|
|
3296
|
-
export declare function getCommentThread(commentId: string, options?: GetCommentThreadOptions): Promise<NonNullablePaths<GetCommentThreadResponse, {
|
|
3297
|
-
[P in CommentNonNullablePaths]: `comments.${number}.${P}`;
|
|
3298
|
-
}[CommentNonNullablePaths]>>;
|
|
3299
|
-
export interface GetCommentThreadOptions {
|
|
2926
|
+
interface GetCommentThreadOptions {
|
|
3300
2927
|
/**
|
|
3301
2928
|
* App ID.
|
|
3302
2929
|
* @maxLength 128
|
|
@@ -3309,115 +2936,29 @@ export interface GetCommentThreadOptions {
|
|
|
3309
2936
|
/** Reply sorting. */
|
|
3310
2937
|
replySort?: ReplySort;
|
|
3311
2938
|
}
|
|
3312
|
-
|
|
3313
|
-
* Publishes multiple comments with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
|
|
3314
|
-
* @param appId - ID of the app where to publish the comment.
|
|
3315
|
-
* @public
|
|
3316
|
-
* @documentationMaturity preview
|
|
3317
|
-
* @requiredField appId
|
|
3318
|
-
* @requiredField options
|
|
3319
|
-
* @requiredField options.filter
|
|
3320
|
-
* @permissionId WIX_COMMENTS.BULK_COMMENT_PUBLISH
|
|
3321
|
-
* @permissionScope Manage Blog
|
|
3322
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3323
|
-
* @permissionScope Manage Comments
|
|
3324
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3325
|
-
* @applicableIdentity APP
|
|
3326
|
-
* @fqn wix.comments.ng.v1.CommentsNg.BulkPublishComment
|
|
3327
|
-
*/
|
|
3328
|
-
export declare function bulkPublishComment(appId: string, options: NonNullablePaths<BulkPublishCommentOptions, `filter`>): Promise<NonNullablePaths<BulkPublishCommentResponse, `jobId`>>;
|
|
3329
|
-
export interface BulkPublishCommentOptions {
|
|
2939
|
+
interface BulkPublishCommentOptions {
|
|
3330
2940
|
/** 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"`}. */
|
|
3331
2941
|
filter: Record<string, any> | null;
|
|
3332
2942
|
}
|
|
3333
|
-
|
|
3334
|
-
* Hides multiple comments. The comment status becomes `HIDDEN`.
|
|
3335
|
-
* @param appId - ID of the app where to hide the comments.
|
|
3336
|
-
* @public
|
|
3337
|
-
* @documentationMaturity preview
|
|
3338
|
-
* @requiredField appId
|
|
3339
|
-
* @requiredField options
|
|
3340
|
-
* @requiredField options.filter
|
|
3341
|
-
* @permissionId WIX_COMMENTS.BULK_COMMENT_HIDE
|
|
3342
|
-
* @permissionScope Manage Blog
|
|
3343
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3344
|
-
* @permissionScope Manage Comments
|
|
3345
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3346
|
-
* @applicableIdentity APP
|
|
3347
|
-
* @fqn wix.comments.ng.v1.CommentsNg.BulkHideComment
|
|
3348
|
-
*/
|
|
3349
|
-
export declare function bulkHideComment(appId: string, options: NonNullablePaths<BulkHideCommentOptions, `filter`>): Promise<NonNullablePaths<BulkHideCommentResponse, `jobId`>>;
|
|
3350
|
-
export interface BulkHideCommentOptions {
|
|
2943
|
+
interface BulkHideCommentOptions {
|
|
3351
2944
|
/** 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"`}. */
|
|
3352
2945
|
filter: Record<string, any> | null;
|
|
3353
2946
|
}
|
|
3354
|
-
|
|
3355
|
-
* Deletes multiple comments.
|
|
3356
|
-
* @param appId - ID of the app where to delete the comments.
|
|
3357
|
-
* @public
|
|
3358
|
-
* @documentationMaturity preview
|
|
3359
|
-
* @requiredField appId
|
|
3360
|
-
* @requiredField options
|
|
3361
|
-
* @requiredField options.filter
|
|
3362
|
-
* @permissionId WIX_COMMENTS.BULK_COMMENT_DELETE
|
|
3363
|
-
* @permissionScope Manage Blog
|
|
3364
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3365
|
-
* @permissionScope Manage Comments
|
|
3366
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3367
|
-
* @applicableIdentity APP
|
|
3368
|
-
* @fqn wix.comments.ng.v1.CommentsNg.BulkDeleteComment
|
|
3369
|
-
*/
|
|
3370
|
-
export declare function bulkDeleteComment(appId: string, options: NonNullablePaths<BulkDeleteCommentOptions, `filter`>): Promise<NonNullablePaths<BulkDeleteCommentResponse, `jobId`>>;
|
|
3371
|
-
export interface BulkDeleteCommentOptions {
|
|
2947
|
+
interface BulkDeleteCommentOptions {
|
|
3372
2948
|
/** 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"`}. */
|
|
3373
2949
|
filter: Record<string, any> | null;
|
|
3374
2950
|
}
|
|
3375
|
-
|
|
3376
|
-
* Moderates the draft content of multiple comments.
|
|
3377
|
-
* @param appId - ID of the app where to moderate the comments.
|
|
3378
|
-
* @public
|
|
3379
|
-
* @documentationMaturity preview
|
|
3380
|
-
* @requiredField appId
|
|
3381
|
-
* @requiredField options
|
|
3382
|
-
* @requiredField options.draftContentAction
|
|
3383
|
-
* @requiredField options.filter
|
|
3384
|
-
* @permissionId WIX_COMMENTS.BULK_COMMENT_MODERATE_DRAFT_CONTENT
|
|
3385
|
-
* @permissionScope Manage Blog
|
|
3386
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3387
|
-
* @permissionScope Manage Comments
|
|
3388
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3389
|
-
* @applicableIdentity APP
|
|
3390
|
-
* @fqn wix.comments.ng.v1.CommentsNg.BulkModerateDraftContent
|
|
3391
|
-
*/
|
|
3392
|
-
export declare function bulkModerateDraftContent(appId: string, options: NonNullablePaths<BulkModerateDraftContentOptions, `draftContentAction` | `filter`>): Promise<NonNullablePaths<BulkModerateDraftContentResponse, `jobId`>>;
|
|
3393
|
-
export interface BulkModerateDraftContentOptions {
|
|
2951
|
+
interface BulkModerateDraftContentOptions {
|
|
3394
2952
|
/** 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"`}. */
|
|
3395
2953
|
filter: Record<string, any> | null;
|
|
3396
2954
|
/** Action to do regarding draft content */
|
|
3397
2955
|
draftContentAction: ActionWithLiterals;
|
|
3398
2956
|
}
|
|
3399
|
-
|
|
3400
|
-
* Moves multiple comments to another resource.
|
|
3401
|
-
* @param appId - ID of the app from which to move the comments.
|
|
3402
|
-
* @public
|
|
3403
|
-
* @documentationMaturity preview
|
|
3404
|
-
* @requiredField appId
|
|
3405
|
-
* @requiredField options.destination.contextId
|
|
3406
|
-
* @requiredField options.destination.resourceId
|
|
3407
|
-
* @requiredField options.filter
|
|
3408
|
-
* @permissionId WIX_COMMENTS.BULK_COMMENT_MOVE
|
|
3409
|
-
* @permissionScope Manage Blog
|
|
3410
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3411
|
-
* @permissionScope Manage Comments
|
|
3412
|
-
* @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
|
|
3413
|
-
* @applicableIdentity APP
|
|
3414
|
-
* @fqn wix.comments.ng.v1.CommentsNg.BulkMoveCommentByFilter
|
|
3415
|
-
*/
|
|
3416
|
-
export declare function bulkMoveCommentByFilter(appId: string, options?: NonNullablePaths<BulkMoveCommentByFilterOptions, `destination.contextId` | `destination.resourceId` | `filter`>): Promise<NonNullablePaths<BulkMoveCommentByFilterResponse, `jobId`>>;
|
|
3417
|
-
export interface BulkMoveCommentByFilterOptions {
|
|
2957
|
+
interface BulkMoveCommentByFilterOptions {
|
|
3418
2958
|
/** 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"`}. */
|
|
3419
2959
|
filter: Record<string, any> | null;
|
|
3420
2960
|
/** Where to move the comment. */
|
|
3421
2961
|
destination?: Destination;
|
|
3422
2962
|
}
|
|
3423
|
-
|
|
2963
|
+
|
|
2964
|
+
export { VoteRole as $, PluginContainerDataAlignment as A, type BulkPublishCommentOptions as B, type Comment as C, Target as D, TextAlignment as E, LineStyle as F, type GetCommentThreadOptions as G, type HideCommentResponse as H, Width as I, Alignment as J, LayoutType as K, type ListCommentsByResourceOptions as L, type ModerateDraftContentOptions as M, NodeType as N, Orientation as O, type PublishCommentResponse as P, Crop as Q, ThumbnailsAlignment as R, GIFType as S, Type as T, type UpdateComment as U, ViewMode as V, WidthType as W, Source as X, Position as Y, MapType as Z, ViewRole as _, type ModerateDraftContentResponse as a, type ParagraphData as a$, PollLayoutType as a0, PollLayoutDirection as a1, BackgroundType as a2, DecorationType as a3, FontType as a4, AppType as a5, InitialExpandedItems as a6, Direction as a7, VerticalAlignment as a8, NullValue as a9, type DividerData as aA, type FileData as aB, type FileSource as aC, type FileSourceDataOneOf as aD, type PDFSettings as aE, type GalleryData as aF, type Media as aG, type Image as aH, type Video as aI, type Item as aJ, type ItemDataOneOf as aK, type GalleryOptions as aL, type Layout as aM, type ItemStyle as aN, type Thumbnails as aO, type GIFData as aP, type GIF as aQ, type HeadingData as aR, type HTMLData as aS, type HTMLDataDataOneOf as aT, type ImageData as aU, type StylesBorder as aV, type ImageDataStyles as aW, type LinkPreviewData as aX, type LinkPreviewDataStyles as aY, type MapData as aZ, type MapSettings as a_, Status as aa, VersioningMode as ab, Action as ac, SortOrder as ad, Order as ae, ReplySortOrder as af, WebhookIdentityType as ag, type CommentContent as ah, type RichContent as ai, type Node as aj, type NodeDataOneOf as ak, type NodeStyle as al, type ButtonData as am, type Border as an, type Colors as ao, type PluginContainerData as ap, type PluginContainerDataWidth as aq, type PluginContainerDataWidthDataOneOf as ar, type Spoiler as as, type Height as at, type Styles as au, type Link as av, type LinkDataOneOf as aw, type Rel as ax, type CodeBlockData as ay, type TextStyle as az, type CommentsQueryBuilder as b, type DeleteByIdsOperation as b$, type PollData as b0, type Permissions as b1, type Option as b2, type Settings as b3, type PollLayout as b4, type OptionLayout as b5, type Gradient as b6, type Background as b7, type BackgroundBackgroundOneOf as b8, type PollDesign as b9, type BorderColors as bA, type ListValue as bB, type AudioData as bC, type OrderedListData as bD, type BulletedListData as bE, type BlockquoteData as bF, type CaptionData as bG, type LayoutCellData as bH, type Metadata as bI, type DocumentStyle as bJ, type TextNodeStyle as bK, type Mention as bL, type MentionIdentityOneOf as bM, type Attachment as bN, type AttachmentMediaOneOf as bO, type VideoResolution as bP, type ContentAuthor as bQ, type ContentAuthorAuthorOneOf as bR, type CommentAuthor as bS, type CommentAuthorIdentityOneOf as bT, type ParentComment as bU, type VoteSummary as bV, type CommentReactionSummary as bW, type UpdateInternalDocumentsEvent as bX, type UpdateInternalDocumentsEventOperationOneOf as bY, type InternalDocument as bZ, type InternalDocumentUpdateOperation as b_, type OptionDesign as ba, type Poll as bb, type PollDataLayout as bc, type Design as bd, type TextData as be, type Decoration as bf, type DecorationDataOneOf as bg, type AnchorData as bh, type ColorData as bi, type LinkData as bj, type MentionData as bk, type FontSizeData as bl, type SpoilerData as bm, type AppEmbedData as bn, type AppEmbedDataAppDataOneOf as bo, type BookingData as bp, type EventData as bq, type VideoData as br, type PlaybackOptions as bs, type EmbedData as bt, type Oembed as bu, type CollapsibleListData as bv, type TableData as bw, type Dimensions as bx, type TableCellData as by, type CellStyle as bz, type MarkCommentResponse as c, type DeleteByFilterOperation as c0, type InternalDocumentUpdateByFilterOperation as c1, type InternalUpdateExistingOperation as c2, type VersionedDocumentUpdateOperation as c3, type VersionedDeleteByIdsOperation as c4, type VersionedDocumentId as c5, type CommentModerated as c6, type CreateCommentRequest as c7, type ContactDetails as c8, type CreateCommentResponse as c9, type CountCommentsRequest as cA, type ListCommentsByResourceRequest as cB, type CommentSort as cC, type ReplySort as cD, type ListCommentsByResourceCursorPaging as cE, type RepliesListResponse as cF, type GetCommentThreadRequest as cG, type BulkPublishCommentRequest as cH, type BulkHideCommentRequest as cI, type BulkDeleteCommentRequest as cJ, type BulkModerateDraftContentRequest as cK, type BulkMoveCommentByFilterRequest as cL, type Destination as cM, type CommentMoved as cN, type DomainEvent as cO, type DomainEventBodyOneOf as cP, type EntityCreatedEvent as cQ, type RestoreInfo as cR, type EntityUpdatedEvent as cS, type EntityDeletedEvent as cT, type ActionEvent as cU, type MessageEnvelope as cV, type IdentificationData as cW, type IdentificationDataIdOneOf as cX, type BaseEventMetadata as cY, type EventMetadata as cZ, type CommentsQueryResult as c_, type ResourceCommentCountChanged as ca, type GetCommentRequest as cb, type GetCommentResponse as cc, type UpdateCommentRequest as cd, type UpdateCommentResponse as ce, type CommentContentChanged as cf, type DeleteCommentRequest as cg, type DeleteCommentResponse as ch, type CommentDeleted as ci, type ModerateDraftContentRequest as cj, type CommentPublished as ck, type CommentHidden as cl, type QueryCommentsRequest as cm, type CursorQuery as cn, type CursorQueryPagingMethodOneOf as co, type Sorting as cp, type CursorPaging as cq, type QueryCommentsResponse as cr, type CursorPagingMetadata as cs, type Cursors as ct, type MarkCommentRequest as cu, type CommentMarked as cv, type UnmarkCommentRequest as cw, type CommentUnmarked as cx, type HideCommentRequest as cy, type PublishCommentRequest 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, type CommentContentChangedEnvelope as r, type CommentHiddenEnvelope as s, type CommentMarkedEnvelope as t, type CommentMovedEnvelope as u, type CommentPublishedEnvelope as v, type CommentUnmarkedEnvelope as w, type CommentCreatedEnvelope as x, type CommentResourceCommentCountChangedEnvelope as y, type CommentUpdatedEnvelope as z };
|