@wix/auto_sdk_comments_comments 1.0.10 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/cjs/src/comments-v2-comment-comments.context.js +109 -0
- package/build/cjs/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/cjs/src/comments-v2-comment-comments.http.js +2533 -0
- package/build/cjs/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/cjs/src/comments-v2-comment-comments.meta.js +370 -0
- package/build/cjs/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/cjs/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/cjs/src/comments-v2-comment-comments.public.js +1341 -0
- package/build/cjs/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{internal/meta.d.mts → cjs/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/cjs/src/comments-v2-comment-comments.types.js +386 -0
- package/build/cjs/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/{comments-v2-comment-comments.universal-Bt560XJw.d.mts → cjs/src/comments-v2-comment-comments.universal.d.ts} +693 -254
- package/build/cjs/src/comments-v2-comment-comments.universal.js +1574 -0
- package/build/cjs/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/es/src/comments-v2-comment-comments.context.js +68 -0
- package/build/es/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/es/src/comments-v2-comment-comments.http.js +2512 -0
- package/build/es/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/es/src/comments-v2-comment-comments.meta.js +326 -0
- package/build/es/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/es/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/es/src/comments-v2-comment-comments.public.js +1282 -0
- package/build/es/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{internal/meta.d.ts → es/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/es/src/comments-v2-comment-comments.types.js +383 -0
- package/build/es/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/{comments-v2-comment-comments.universal-Bt560XJw.d.ts → es/src/comments-v2-comment-comments.universal.d.ts} +693 -254
- package/build/es/src/comments-v2-comment-comments.universal.js +1529 -0
- package/build/es/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js +109 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js +2533 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js +370 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js +1341 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{meta.d.mts → internal/cjs/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js +386 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/internal/{comments-v2-comment-comments.universal-Bt560XJw.d.ts → cjs/src/comments-v2-comment-comments.universal.d.ts} +693 -254
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +1574 -0
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +68 -0
- package/build/internal/es/src/comments-v2-comment-comments.context.js +68 -0
- package/build/internal/es/src/comments-v2-comment-comments.context.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.http.d.ts +90 -0
- package/build/internal/es/src/comments-v2-comment-comments.http.js +2512 -0
- package/build/internal/es/src/comments-v2-comment-comments.http.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.meta.d.ts +48 -0
- package/build/internal/es/src/comments-v2-comment-comments.meta.js +326 -0
- package/build/internal/es/src/comments-v2-comment-comments.meta.js.map +1 -0
- package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +202 -0
- package/build/internal/es/src/comments-v2-comment-comments.public.js +1282 -0
- package/build/internal/es/src/comments-v2-comment-comments.public.js.map +1 -0
- package/build/{meta.d.ts → internal/es/src/comments-v2-comment-comments.types.d.ts} +558 -240
- package/build/internal/es/src/comments-v2-comment-comments.types.js +383 -0
- package/build/internal/es/src/comments-v2-comment-comments.types.js.map +1 -0
- package/build/internal/{comments-v2-comment-comments.universal-Bt560XJw.d.mts → es/src/comments-v2-comment-comments.universal.d.ts} +693 -254
- package/build/internal/es/src/comments-v2-comment-comments.universal.js +1529 -0
- package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -249
- package/build/index.d.ts +0 -249
- package/build/index.js +0 -5232
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -5145
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -249
- package/build/internal/index.d.ts +0 -249
- package/build/internal/index.js +0 -5232
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -5145
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js +0 -2832
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -2788
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js +0 -2832
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -2788
- package/build/meta.mjs.map +0 -1
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
import { b_ as CreateCommentRequest$1, c0 as CreateCommentResponse$1, c2 as GetCommentRequest$1, c3 as GetCommentResponse$1, c4 as UpdateCommentRequest$1, c5 as UpdateCommentResponse$1, c7 as DeleteCommentRequest$1, c8 as DeleteCommentResponse$1, ca as ModerateDraftContentRequest$1, a as ModerateDraftContentResponse$1, cd as QueryCommentsRequest$1, ci as QueryCommentsResponse$1, cl as MarkCommentRequest$1, c as MarkCommentResponse$1, cn as UnmarkCommentRequest$1, d as UnmarkCommentResponse$1, cp as HideCommentRequest$1, H as HideCommentResponse$1, cq as PublishCommentRequest$1, P as PublishCommentResponse$1, cr as CountCommentsRequest$1, f as CountCommentsResponse$1, cs as ListCommentsByResourceRequest$1, g as ListCommentsByResourceResponse$1, cx as GetCommentThreadRequest$1, h as GetCommentThreadResponse$1, cy as BulkPublishCommentRequest$1, i as BulkPublishCommentResponse$1, cz as BulkHideCommentRequest$1, k as BulkHideCommentResponse$1, cA as BulkDeleteCommentRequest$1, m as BulkDeleteCommentResponse$1, cB as BulkModerateDraftContentRequest$1, o as BulkModerateDraftContentResponse$1, cC as BulkMoveCommentByFilterRequest$1, q as BulkMoveCommentByFilterResponse$1 } from './comments-v2-comment-comments.universal-Bt560XJw.mjs';
|
|
2
|
-
|
|
3
1
|
/**
|
|
4
2
|
* A comment is a user-generated message in response to a specific resource. It allows site visitors
|
|
5
3
|
* to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
|
|
6
4
|
* or other site content. Comments are composed of text, images, videos, or other forms of media.
|
|
7
5
|
*/
|
|
8
|
-
interface Comment {
|
|
6
|
+
export interface Comment {
|
|
9
7
|
/**
|
|
10
8
|
* Comment ID.
|
|
11
9
|
* @format GUID
|
|
@@ -109,7 +107,7 @@ interface Comment {
|
|
|
109
107
|
contentEdited?: boolean | null;
|
|
110
108
|
}
|
|
111
109
|
/** Comment content. */
|
|
112
|
-
interface CommentContent {
|
|
110
|
+
export interface CommentContent {
|
|
113
111
|
/**
|
|
114
112
|
* Comment rich content.
|
|
115
113
|
*
|
|
@@ -131,7 +129,7 @@ interface CommentContent {
|
|
|
131
129
|
*/
|
|
132
130
|
attachments?: Attachment[];
|
|
133
131
|
}
|
|
134
|
-
interface RichContent {
|
|
132
|
+
export interface RichContent {
|
|
135
133
|
/** Node objects representing a rich content document. */
|
|
136
134
|
nodes?: Node[];
|
|
137
135
|
/** Object metadata. */
|
|
@@ -139,7 +137,7 @@ interface RichContent {
|
|
|
139
137
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
140
138
|
documentStyle?: DocumentStyle;
|
|
141
139
|
}
|
|
142
|
-
interface Node extends NodeDataOneOf {
|
|
140
|
+
export interface Node extends NodeDataOneOf {
|
|
143
141
|
/** Data for a button node. */
|
|
144
142
|
buttonData?: ButtonData;
|
|
145
143
|
/** Data for a code block node. */
|
|
@@ -204,7 +202,7 @@ interface Node extends NodeDataOneOf {
|
|
|
204
202
|
style?: NodeStyle;
|
|
205
203
|
}
|
|
206
204
|
/** @oneof */
|
|
207
|
-
interface NodeDataOneOf {
|
|
205
|
+
export interface NodeDataOneOf {
|
|
208
206
|
/** Data for a button node. */
|
|
209
207
|
buttonData?: ButtonData;
|
|
210
208
|
/** Data for a code block node. */
|
|
@@ -260,7 +258,7 @@ interface NodeDataOneOf {
|
|
|
260
258
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
261
259
|
layoutCellData?: LayoutCellData;
|
|
262
260
|
}
|
|
263
|
-
declare enum NodeType {
|
|
261
|
+
export declare enum NodeType {
|
|
264
262
|
PARAGRAPH = "PARAGRAPH",
|
|
265
263
|
TEXT = "TEXT",
|
|
266
264
|
HEADING = "HEADING",
|
|
@@ -296,7 +294,7 @@ declare enum NodeType {
|
|
|
296
294
|
LAYOUT = "LAYOUT",
|
|
297
295
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
298
296
|
}
|
|
299
|
-
interface NodeStyle {
|
|
297
|
+
export interface NodeStyle {
|
|
300
298
|
/** The top padding value in pixels. */
|
|
301
299
|
paddingTop?: string | null;
|
|
302
300
|
/** The bottom padding value in pixels. */
|
|
@@ -304,7 +302,7 @@ interface NodeStyle {
|
|
|
304
302
|
/** The background color as a hexadecimal value. */
|
|
305
303
|
backgroundColor?: string | null;
|
|
306
304
|
}
|
|
307
|
-
interface ButtonData {
|
|
305
|
+
export interface ButtonData {
|
|
308
306
|
/** Styling for the button's container. */
|
|
309
307
|
containerData?: PluginContainerData;
|
|
310
308
|
/** The button type. */
|
|
@@ -316,7 +314,7 @@ interface ButtonData {
|
|
|
316
314
|
/** Button link details. */
|
|
317
315
|
link?: Link;
|
|
318
316
|
}
|
|
319
|
-
interface Border {
|
|
317
|
+
export interface Border {
|
|
320
318
|
/**
|
|
321
319
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
322
320
|
* @deprecated
|
|
@@ -328,7 +326,7 @@ interface Border {
|
|
|
328
326
|
*/
|
|
329
327
|
radius?: number | null;
|
|
330
328
|
}
|
|
331
|
-
interface Colors {
|
|
329
|
+
export interface Colors {
|
|
332
330
|
/**
|
|
333
331
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
334
332
|
* @deprecated
|
|
@@ -345,7 +343,7 @@ interface Colors {
|
|
|
345
343
|
*/
|
|
346
344
|
background?: string | null;
|
|
347
345
|
}
|
|
348
|
-
interface PluginContainerData {
|
|
346
|
+
export interface PluginContainerData {
|
|
349
347
|
/** The width of the node when it's displayed. */
|
|
350
348
|
width?: PluginContainerDataWidth;
|
|
351
349
|
/** The node's alignment within its container. */
|
|
@@ -357,7 +355,7 @@ interface PluginContainerData {
|
|
|
357
355
|
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
358
356
|
textWrap?: boolean | null;
|
|
359
357
|
}
|
|
360
|
-
declare enum WidthType {
|
|
358
|
+
export declare enum WidthType {
|
|
361
359
|
/** Width matches the content width */
|
|
362
360
|
CONTENT = "CONTENT",
|
|
363
361
|
/** Small Width */
|
|
@@ -367,7 +365,7 @@ declare enum WidthType {
|
|
|
367
365
|
/** coast-to-coast display */
|
|
368
366
|
FULL_WIDTH = "FULL_WIDTH"
|
|
369
367
|
}
|
|
370
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
368
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
371
369
|
/**
|
|
372
370
|
* One of the following predefined width options:
|
|
373
371
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -380,7 +378,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
380
378
|
custom?: string | null;
|
|
381
379
|
}
|
|
382
380
|
/** @oneof */
|
|
383
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
381
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
384
382
|
/**
|
|
385
383
|
* One of the following predefined width options:
|
|
386
384
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -392,7 +390,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
392
390
|
/** A custom width value in pixels. */
|
|
393
391
|
custom?: string | null;
|
|
394
392
|
}
|
|
395
|
-
declare enum PluginContainerDataAlignment {
|
|
393
|
+
export declare enum PluginContainerDataAlignment {
|
|
396
394
|
/** Center Alignment */
|
|
397
395
|
CENTER = "CENTER",
|
|
398
396
|
/** Left Alignment */
|
|
@@ -400,7 +398,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
400
398
|
/** Right Alignment */
|
|
401
399
|
RIGHT = "RIGHT"
|
|
402
400
|
}
|
|
403
|
-
interface Spoiler {
|
|
401
|
+
export interface Spoiler {
|
|
404
402
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
405
403
|
enabled?: boolean | null;
|
|
406
404
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -408,17 +406,17 @@ interface Spoiler {
|
|
|
408
406
|
/** The text for the button used to remove the spoiler cover. */
|
|
409
407
|
buttonText?: string | null;
|
|
410
408
|
}
|
|
411
|
-
interface Height {
|
|
409
|
+
export interface Height {
|
|
412
410
|
/** A custom height value in pixels. */
|
|
413
411
|
custom?: string | null;
|
|
414
412
|
}
|
|
415
|
-
declare enum Type {
|
|
413
|
+
export declare enum Type {
|
|
416
414
|
/** Regular link button */
|
|
417
415
|
LINK = "LINK",
|
|
418
416
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
419
417
|
ACTION = "ACTION"
|
|
420
418
|
}
|
|
421
|
-
interface Styles {
|
|
419
|
+
export interface Styles {
|
|
422
420
|
/**
|
|
423
421
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
424
422
|
* @deprecated
|
|
@@ -471,7 +469,7 @@ interface Styles {
|
|
|
471
469
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
472
470
|
buttonSize?: string | null;
|
|
473
471
|
}
|
|
474
|
-
interface Link extends LinkDataOneOf {
|
|
472
|
+
export interface Link extends LinkDataOneOf {
|
|
475
473
|
/** The absolute URL for the linked document. */
|
|
476
474
|
url?: string;
|
|
477
475
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -490,13 +488,13 @@ interface Link extends LinkDataOneOf {
|
|
|
490
488
|
customData?: string | null;
|
|
491
489
|
}
|
|
492
490
|
/** @oneof */
|
|
493
|
-
interface LinkDataOneOf {
|
|
491
|
+
export interface LinkDataOneOf {
|
|
494
492
|
/** The absolute URL for the linked document. */
|
|
495
493
|
url?: string;
|
|
496
494
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
497
495
|
anchor?: string;
|
|
498
496
|
}
|
|
499
|
-
declare enum Target {
|
|
497
|
+
export declare enum Target {
|
|
500
498
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
501
499
|
SELF = "SELF",
|
|
502
500
|
/** Opens the linked document in a new window or tab */
|
|
@@ -506,7 +504,7 @@ declare enum Target {
|
|
|
506
504
|
/** Opens the linked document in the full body of the window */
|
|
507
505
|
TOP = "TOP"
|
|
508
506
|
}
|
|
509
|
-
interface Rel {
|
|
507
|
+
export interface Rel {
|
|
510
508
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
511
509
|
nofollow?: boolean | null;
|
|
512
510
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -516,17 +514,17 @@ interface Rel {
|
|
|
516
514
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
517
515
|
noreferrer?: boolean | null;
|
|
518
516
|
}
|
|
519
|
-
interface CodeBlockData {
|
|
517
|
+
export interface CodeBlockData {
|
|
520
518
|
/** Styling for the code block's text. */
|
|
521
519
|
textStyle?: TextStyle;
|
|
522
520
|
}
|
|
523
|
-
interface TextStyle {
|
|
521
|
+
export interface TextStyle {
|
|
524
522
|
/** Text alignment. Defaults to `AUTO`. */
|
|
525
523
|
textAlignment?: TextAlignment;
|
|
526
524
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
527
525
|
lineHeight?: string | null;
|
|
528
526
|
}
|
|
529
|
-
declare enum TextAlignment {
|
|
527
|
+
export declare enum TextAlignment {
|
|
530
528
|
/** browser default, eqivalent to `initial` */
|
|
531
529
|
AUTO = "AUTO",
|
|
532
530
|
/** Left align */
|
|
@@ -538,7 +536,7 @@ declare enum TextAlignment {
|
|
|
538
536
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
539
537
|
JUSTIFY = "JUSTIFY"
|
|
540
538
|
}
|
|
541
|
-
interface DividerData {
|
|
539
|
+
export interface DividerData {
|
|
542
540
|
/** Styling for the divider's container. */
|
|
543
541
|
containerData?: PluginContainerData;
|
|
544
542
|
/** Divider line style. */
|
|
@@ -548,7 +546,7 @@ interface DividerData {
|
|
|
548
546
|
/** Divider alignment. */
|
|
549
547
|
alignment?: Alignment;
|
|
550
548
|
}
|
|
551
|
-
declare enum LineStyle {
|
|
549
|
+
export declare enum LineStyle {
|
|
552
550
|
/** Single Line */
|
|
553
551
|
SINGLE = "SINGLE",
|
|
554
552
|
/** Double Line */
|
|
@@ -558,7 +556,7 @@ declare enum LineStyle {
|
|
|
558
556
|
/** Dotted Line */
|
|
559
557
|
DOTTED = "DOTTED"
|
|
560
558
|
}
|
|
561
|
-
declare enum Width {
|
|
559
|
+
export declare enum Width {
|
|
562
560
|
/** Large line */
|
|
563
561
|
LARGE = "LARGE",
|
|
564
562
|
/** Medium line */
|
|
@@ -566,7 +564,7 @@ declare enum Width {
|
|
|
566
564
|
/** Small line */
|
|
567
565
|
SMALL = "SMALL"
|
|
568
566
|
}
|
|
569
|
-
declare enum Alignment {
|
|
567
|
+
export declare enum Alignment {
|
|
570
568
|
/** Center alignment */
|
|
571
569
|
CENTER = "CENTER",
|
|
572
570
|
/** Left alignment */
|
|
@@ -574,7 +572,7 @@ declare enum Alignment {
|
|
|
574
572
|
/** Right alignment */
|
|
575
573
|
RIGHT = "RIGHT"
|
|
576
574
|
}
|
|
577
|
-
interface FileData {
|
|
575
|
+
export interface FileData {
|
|
578
576
|
/** Styling for the file's container. */
|
|
579
577
|
containerData?: PluginContainerData;
|
|
580
578
|
/** The source for the file's data. */
|
|
@@ -597,7 +595,7 @@ interface FileData {
|
|
|
597
595
|
/** File size in KB. */
|
|
598
596
|
sizeInKb?: string | null;
|
|
599
597
|
}
|
|
600
|
-
declare enum ViewMode {
|
|
598
|
+
export declare enum ViewMode {
|
|
601
599
|
/** No PDF view */
|
|
602
600
|
NONE = "NONE",
|
|
603
601
|
/** Full PDF view */
|
|
@@ -605,7 +603,7 @@ declare enum ViewMode {
|
|
|
605
603
|
/** Mini PDF view */
|
|
606
604
|
MINI = "MINI"
|
|
607
605
|
}
|
|
608
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
606
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
609
607
|
/** The absolute URL for the file's source. */
|
|
610
608
|
url?: string | null;
|
|
611
609
|
/**
|
|
@@ -619,7 +617,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
619
617
|
private?: boolean | null;
|
|
620
618
|
}
|
|
621
619
|
/** @oneof */
|
|
622
|
-
interface FileSourceDataOneOf {
|
|
620
|
+
export interface FileSourceDataOneOf {
|
|
623
621
|
/** The absolute URL for the file's source. */
|
|
624
622
|
url?: string | null;
|
|
625
623
|
/**
|
|
@@ -630,7 +628,7 @@ interface FileSourceDataOneOf {
|
|
|
630
628
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
631
629
|
id?: string | null;
|
|
632
630
|
}
|
|
633
|
-
interface PDFSettings {
|
|
631
|
+
export interface PDFSettings {
|
|
634
632
|
/**
|
|
635
633
|
* PDF view mode. One of the following:
|
|
636
634
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -643,7 +641,7 @@ interface PDFSettings {
|
|
|
643
641
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
644
642
|
disablePrint?: boolean | null;
|
|
645
643
|
}
|
|
646
|
-
interface GalleryData {
|
|
644
|
+
export interface GalleryData {
|
|
647
645
|
/** Styling for the gallery's container. */
|
|
648
646
|
containerData?: PluginContainerData;
|
|
649
647
|
/** The items in the gallery. */
|
|
@@ -655,7 +653,7 @@ interface GalleryData {
|
|
|
655
653
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
656
654
|
disableDownload?: boolean | null;
|
|
657
655
|
}
|
|
658
|
-
interface Media {
|
|
656
|
+
export interface Media {
|
|
659
657
|
/** The source for the media's data. */
|
|
660
658
|
src?: FileSource;
|
|
661
659
|
/** Media width in pixels. */
|
|
@@ -665,19 +663,19 @@ interface Media {
|
|
|
665
663
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
666
664
|
duration?: number | null;
|
|
667
665
|
}
|
|
668
|
-
interface ItemImage {
|
|
666
|
+
export interface ItemImage {
|
|
669
667
|
/** Image file details. */
|
|
670
668
|
media?: Media;
|
|
671
669
|
/** Link details for images that are links. */
|
|
672
670
|
link?: Link;
|
|
673
671
|
}
|
|
674
|
-
interface Video {
|
|
672
|
+
export interface Video {
|
|
675
673
|
/** Video file details. */
|
|
676
674
|
media?: Media;
|
|
677
675
|
/** Video thumbnail file details. */
|
|
678
676
|
thumbnail?: Media;
|
|
679
677
|
}
|
|
680
|
-
interface Item extends ItemDataOneOf {
|
|
678
|
+
export interface Item extends ItemDataOneOf {
|
|
681
679
|
/** An image item. */
|
|
682
680
|
image?: ItemImage;
|
|
683
681
|
/** A video item. */
|
|
@@ -688,13 +686,13 @@ interface Item extends ItemDataOneOf {
|
|
|
688
686
|
altText?: string | null;
|
|
689
687
|
}
|
|
690
688
|
/** @oneof */
|
|
691
|
-
interface ItemDataOneOf {
|
|
689
|
+
export interface ItemDataOneOf {
|
|
692
690
|
/** An image item. */
|
|
693
691
|
image?: ItemImage;
|
|
694
692
|
/** A video item. */
|
|
695
693
|
video?: Video;
|
|
696
694
|
}
|
|
697
|
-
interface GalleryOptions {
|
|
695
|
+
export interface GalleryOptions {
|
|
698
696
|
/** Gallery layout. */
|
|
699
697
|
layout?: Layout;
|
|
700
698
|
/** Styling for gallery items. */
|
|
@@ -702,7 +700,7 @@ interface GalleryOptions {
|
|
|
702
700
|
/** Styling for gallery thumbnail images. */
|
|
703
701
|
thumbnails?: Thumbnails;
|
|
704
702
|
}
|
|
705
|
-
declare enum LayoutType {
|
|
703
|
+
export declare enum LayoutType {
|
|
706
704
|
/** Collage type */
|
|
707
705
|
COLLAGE = "COLLAGE",
|
|
708
706
|
/** Masonry type */
|
|
@@ -724,19 +722,19 @@ declare enum LayoutType {
|
|
|
724
722
|
/** Fullsize images type */
|
|
725
723
|
FULLSIZE = "FULLSIZE"
|
|
726
724
|
}
|
|
727
|
-
declare enum Orientation {
|
|
725
|
+
export declare enum Orientation {
|
|
728
726
|
/** Rows Orientation */
|
|
729
727
|
ROWS = "ROWS",
|
|
730
728
|
/** Columns Orientation */
|
|
731
729
|
COLUMNS = "COLUMNS"
|
|
732
730
|
}
|
|
733
|
-
declare enum Crop {
|
|
731
|
+
export declare enum Crop {
|
|
734
732
|
/** Crop to fill */
|
|
735
733
|
FILL = "FILL",
|
|
736
734
|
/** Crop to fit */
|
|
737
735
|
FIT = "FIT"
|
|
738
736
|
}
|
|
739
|
-
declare enum ThumbnailsAlignment {
|
|
737
|
+
export declare enum ThumbnailsAlignment {
|
|
740
738
|
/** Top alignment */
|
|
741
739
|
TOP = "TOP",
|
|
742
740
|
/** Right alignment */
|
|
@@ -748,7 +746,7 @@ declare enum ThumbnailsAlignment {
|
|
|
748
746
|
/** No thumbnail */
|
|
749
747
|
NONE = "NONE"
|
|
750
748
|
}
|
|
751
|
-
interface Layout {
|
|
749
|
+
export interface Layout {
|
|
752
750
|
/** Gallery layout type. */
|
|
753
751
|
type?: LayoutType;
|
|
754
752
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -760,7 +758,7 @@ interface Layout {
|
|
|
760
758
|
/** The number of columns to display on mobile screens. */
|
|
761
759
|
mobileNumberOfColumns?: number | null;
|
|
762
760
|
}
|
|
763
|
-
interface ItemStyle {
|
|
761
|
+
export interface ItemStyle {
|
|
764
762
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
765
763
|
targetSize?: number | null;
|
|
766
764
|
/** Item ratio */
|
|
@@ -770,13 +768,13 @@ interface ItemStyle {
|
|
|
770
768
|
/** The spacing between items in pixels. */
|
|
771
769
|
spacing?: number | null;
|
|
772
770
|
}
|
|
773
|
-
interface Thumbnails {
|
|
771
|
+
export interface Thumbnails {
|
|
774
772
|
/** Thumbnail alignment. */
|
|
775
773
|
placement?: ThumbnailsAlignment;
|
|
776
774
|
/** Spacing between thumbnails in pixels. */
|
|
777
775
|
spacing?: number | null;
|
|
778
776
|
}
|
|
779
|
-
interface GIFData {
|
|
777
|
+
export interface GIFData {
|
|
780
778
|
/** Styling for the GIF's container. */
|
|
781
779
|
containerData?: PluginContainerData;
|
|
782
780
|
/** The source of the full size GIF. */
|
|
@@ -790,7 +788,7 @@ interface GIFData {
|
|
|
790
788
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
791
789
|
gifType?: GIFType;
|
|
792
790
|
}
|
|
793
|
-
interface GIF {
|
|
791
|
+
export interface GIF {
|
|
794
792
|
/**
|
|
795
793
|
* GIF format URL.
|
|
796
794
|
* @format WEB_URL
|
|
@@ -807,11 +805,11 @@ interface GIF {
|
|
|
807
805
|
*/
|
|
808
806
|
still?: string | null;
|
|
809
807
|
}
|
|
810
|
-
declare enum GIFType {
|
|
808
|
+
export declare enum GIFType {
|
|
811
809
|
NORMAL = "NORMAL",
|
|
812
810
|
STICKER = "STICKER"
|
|
813
811
|
}
|
|
814
|
-
interface HeadingData {
|
|
812
|
+
export interface HeadingData {
|
|
815
813
|
/** Heading level from 1-6. */
|
|
816
814
|
level?: number;
|
|
817
815
|
/** Styling for the heading text. */
|
|
@@ -819,7 +817,7 @@ interface HeadingData {
|
|
|
819
817
|
/** Indentation level from 1-4. */
|
|
820
818
|
indentation?: number | null;
|
|
821
819
|
}
|
|
822
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
820
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
823
821
|
/** The URL for the HTML code for the node. */
|
|
824
822
|
url?: string;
|
|
825
823
|
/** The HTML code for the node. */
|
|
@@ -837,7 +835,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
837
835
|
autoHeight?: boolean | null;
|
|
838
836
|
}
|
|
839
837
|
/** @oneof */
|
|
840
|
-
interface HTMLDataDataOneOf {
|
|
838
|
+
export interface HTMLDataDataOneOf {
|
|
841
839
|
/** The URL for the HTML code for the node. */
|
|
842
840
|
url?: string;
|
|
843
841
|
/** The HTML code for the node. */
|
|
@@ -848,11 +846,11 @@ interface HTMLDataDataOneOf {
|
|
|
848
846
|
*/
|
|
849
847
|
isAdsense?: boolean | null;
|
|
850
848
|
}
|
|
851
|
-
declare enum Source {
|
|
849
|
+
export declare enum Source {
|
|
852
850
|
HTML = "HTML",
|
|
853
851
|
ADSENSE = "ADSENSE"
|
|
854
852
|
}
|
|
855
|
-
interface ImageData {
|
|
853
|
+
export interface ImageData {
|
|
856
854
|
/** Styling for the image's container. */
|
|
857
855
|
containerData?: PluginContainerData;
|
|
858
856
|
/** Image file details. */
|
|
@@ -875,7 +873,7 @@ interface ImageData {
|
|
|
875
873
|
/** Styling for the image. */
|
|
876
874
|
styles?: ImageDataStyles;
|
|
877
875
|
}
|
|
878
|
-
interface StylesBorder {
|
|
876
|
+
export interface StylesBorder {
|
|
879
877
|
/** Border width in pixels. */
|
|
880
878
|
width?: number | null;
|
|
881
879
|
/**
|
|
@@ -886,11 +884,11 @@ interface StylesBorder {
|
|
|
886
884
|
/** Border radius in pixels. */
|
|
887
885
|
radius?: number | null;
|
|
888
886
|
}
|
|
889
|
-
interface ImageDataStyles {
|
|
887
|
+
export interface ImageDataStyles {
|
|
890
888
|
/** Border attributes. */
|
|
891
889
|
border?: StylesBorder;
|
|
892
890
|
}
|
|
893
|
-
interface LinkPreviewData {
|
|
891
|
+
export interface LinkPreviewData {
|
|
894
892
|
/** Styling for the link preview's container. */
|
|
895
893
|
containerData?: PluginContainerData;
|
|
896
894
|
/** Link details. */
|
|
@@ -906,7 +904,7 @@ interface LinkPreviewData {
|
|
|
906
904
|
/** Styling for the link preview. */
|
|
907
905
|
styles?: LinkPreviewDataStyles;
|
|
908
906
|
}
|
|
909
|
-
declare enum Position {
|
|
907
|
+
export declare enum Position {
|
|
910
908
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
911
909
|
START = "START",
|
|
912
910
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -916,7 +914,7 @@ declare enum Position {
|
|
|
916
914
|
/** Thumbnail hidden and not displayed */
|
|
917
915
|
HIDDEN = "HIDDEN"
|
|
918
916
|
}
|
|
919
|
-
interface LinkPreviewDataStyles {
|
|
917
|
+
export interface LinkPreviewDataStyles {
|
|
920
918
|
/**
|
|
921
919
|
* Background color as a hexadecimal value.
|
|
922
920
|
* @format COLOR_HEX
|
|
@@ -949,13 +947,13 @@ interface LinkPreviewDataStyles {
|
|
|
949
947
|
/** Position of thumbnail. Defaults to `START`. */
|
|
950
948
|
thumbnailPosition?: Position;
|
|
951
949
|
}
|
|
952
|
-
interface MapData {
|
|
950
|
+
export interface MapData {
|
|
953
951
|
/** Styling for the map's container. */
|
|
954
952
|
containerData?: PluginContainerData;
|
|
955
953
|
/** Map settings. */
|
|
956
954
|
mapSettings?: MapSettings;
|
|
957
955
|
}
|
|
958
|
-
interface MapSettings {
|
|
956
|
+
export interface MapSettings {
|
|
959
957
|
/** The address to display on the map. */
|
|
960
958
|
address?: string | null;
|
|
961
959
|
/** Sets whether the map is draggable. */
|
|
@@ -979,7 +977,7 @@ interface MapSettings {
|
|
|
979
977
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
980
978
|
mapType?: MapType;
|
|
981
979
|
}
|
|
982
|
-
declare enum MapType {
|
|
980
|
+
export declare enum MapType {
|
|
983
981
|
/** Roadmap map type */
|
|
984
982
|
ROADMAP = "ROADMAP",
|
|
985
983
|
/** Satellite map type */
|
|
@@ -989,7 +987,7 @@ declare enum MapType {
|
|
|
989
987
|
/** Terrain map type */
|
|
990
988
|
TERRAIN = "TERRAIN"
|
|
991
989
|
}
|
|
992
|
-
interface ParagraphData {
|
|
990
|
+
export interface ParagraphData {
|
|
993
991
|
/** Styling for the paragraph text. */
|
|
994
992
|
textStyle?: TextStyle;
|
|
995
993
|
/** Indentation level from 1-4. */
|
|
@@ -997,7 +995,7 @@ interface ParagraphData {
|
|
|
997
995
|
/** Paragraph level */
|
|
998
996
|
level?: number | null;
|
|
999
997
|
}
|
|
1000
|
-
interface PollData {
|
|
998
|
+
export interface PollData {
|
|
1001
999
|
/** Styling for the poll's container. */
|
|
1002
1000
|
containerData?: PluginContainerData;
|
|
1003
1001
|
/** Poll data. */
|
|
@@ -1007,7 +1005,7 @@ interface PollData {
|
|
|
1007
1005
|
/** Styling for the poll and voting options. */
|
|
1008
1006
|
design?: Design;
|
|
1009
1007
|
}
|
|
1010
|
-
declare enum ViewRole {
|
|
1008
|
+
export declare enum ViewRole {
|
|
1011
1009
|
/** Only Poll creator can view the results */
|
|
1012
1010
|
CREATOR = "CREATOR",
|
|
1013
1011
|
/** Anyone who voted can see the results */
|
|
@@ -1015,13 +1013,13 @@ declare enum ViewRole {
|
|
|
1015
1013
|
/** Anyone can see the results, even if one didn't vote */
|
|
1016
1014
|
EVERYONE = "EVERYONE"
|
|
1017
1015
|
}
|
|
1018
|
-
declare enum VoteRole {
|
|
1016
|
+
export declare enum VoteRole {
|
|
1019
1017
|
/** Logged in member */
|
|
1020
1018
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1021
1019
|
/** Anyone */
|
|
1022
1020
|
ALL = "ALL"
|
|
1023
1021
|
}
|
|
1024
|
-
interface Permissions {
|
|
1022
|
+
export interface Permissions {
|
|
1025
1023
|
/** Sets who can view the poll results. */
|
|
1026
1024
|
view?: ViewRole;
|
|
1027
1025
|
/** Sets who can vote. */
|
|
@@ -1029,7 +1027,7 @@ interface Permissions {
|
|
|
1029
1027
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1030
1028
|
allowMultipleVotes?: boolean | null;
|
|
1031
1029
|
}
|
|
1032
|
-
interface Option {
|
|
1030
|
+
export interface Option {
|
|
1033
1031
|
/** Option ID. */
|
|
1034
1032
|
id?: string | null;
|
|
1035
1033
|
/** Option title. */
|
|
@@ -1037,7 +1035,7 @@ interface Option {
|
|
|
1037
1035
|
/** The image displayed with the option. */
|
|
1038
1036
|
image?: Media;
|
|
1039
1037
|
}
|
|
1040
|
-
interface Settings {
|
|
1038
|
+
export interface Settings {
|
|
1041
1039
|
/** Permissions settings for voting. */
|
|
1042
1040
|
permissions?: Permissions;
|
|
1043
1041
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1045,19 +1043,19 @@ interface Settings {
|
|
|
1045
1043
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1046
1044
|
showVotesCount?: boolean | null;
|
|
1047
1045
|
}
|
|
1048
|
-
declare enum PollLayoutType {
|
|
1046
|
+
export declare enum PollLayoutType {
|
|
1049
1047
|
/** List */
|
|
1050
1048
|
LIST = "LIST",
|
|
1051
1049
|
/** Grid */
|
|
1052
1050
|
GRID = "GRID"
|
|
1053
1051
|
}
|
|
1054
|
-
declare enum PollLayoutDirection {
|
|
1052
|
+
export declare enum PollLayoutDirection {
|
|
1055
1053
|
/** Left-to-right */
|
|
1056
1054
|
LTR = "LTR",
|
|
1057
1055
|
/** Right-to-left */
|
|
1058
1056
|
RTL = "RTL"
|
|
1059
1057
|
}
|
|
1060
|
-
interface PollLayout {
|
|
1058
|
+
export interface PollLayout {
|
|
1061
1059
|
/** The layout for displaying the voting options. */
|
|
1062
1060
|
type?: PollLayoutType;
|
|
1063
1061
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1065,11 +1063,11 @@ interface PollLayout {
|
|
|
1065
1063
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1066
1064
|
enableImage?: boolean | null;
|
|
1067
1065
|
}
|
|
1068
|
-
interface OptionLayout {
|
|
1066
|
+
export interface OptionLayout {
|
|
1069
1067
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1070
1068
|
enableImage?: boolean | null;
|
|
1071
1069
|
}
|
|
1072
|
-
declare enum BackgroundType {
|
|
1070
|
+
export declare enum BackgroundType {
|
|
1073
1071
|
/** Color background type */
|
|
1074
1072
|
COLOR = "COLOR",
|
|
1075
1073
|
/** Image background type */
|
|
@@ -1077,7 +1075,7 @@ declare enum BackgroundType {
|
|
|
1077
1075
|
/** Gradiant background type */
|
|
1078
1076
|
GRADIENT = "GRADIENT"
|
|
1079
1077
|
}
|
|
1080
|
-
interface Gradient {
|
|
1078
|
+
export interface Gradient {
|
|
1081
1079
|
/** The gradient angle in degrees. */
|
|
1082
1080
|
angle?: number | null;
|
|
1083
1081
|
/**
|
|
@@ -1091,7 +1089,7 @@ interface Gradient {
|
|
|
1091
1089
|
*/
|
|
1092
1090
|
lastColor?: string | null;
|
|
1093
1091
|
}
|
|
1094
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1092
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1095
1093
|
/**
|
|
1096
1094
|
* The background color as a hexademical value.
|
|
1097
1095
|
* @format COLOR_HEX
|
|
@@ -1105,7 +1103,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1105
1103
|
type?: BackgroundType;
|
|
1106
1104
|
}
|
|
1107
1105
|
/** @oneof */
|
|
1108
|
-
interface BackgroundBackgroundOneOf {
|
|
1106
|
+
export interface BackgroundBackgroundOneOf {
|
|
1109
1107
|
/**
|
|
1110
1108
|
* The background color as a hexademical value.
|
|
1111
1109
|
* @format COLOR_HEX
|
|
@@ -1116,17 +1114,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
1116
1114
|
/** Details for a gradient background. */
|
|
1117
1115
|
gradient?: Gradient;
|
|
1118
1116
|
}
|
|
1119
|
-
interface PollDesign {
|
|
1117
|
+
export interface PollDesign {
|
|
1120
1118
|
/** Background styling. */
|
|
1121
1119
|
background?: Background;
|
|
1122
1120
|
/** Border radius in pixels. */
|
|
1123
1121
|
borderRadius?: number | null;
|
|
1124
1122
|
}
|
|
1125
|
-
interface OptionDesign {
|
|
1123
|
+
export interface OptionDesign {
|
|
1126
1124
|
/** Border radius in pixels. */
|
|
1127
1125
|
borderRadius?: number | null;
|
|
1128
1126
|
}
|
|
1129
|
-
interface Poll {
|
|
1127
|
+
export interface Poll {
|
|
1130
1128
|
/** Poll ID. */
|
|
1131
1129
|
id?: string | null;
|
|
1132
1130
|
/** Poll title. */
|
|
@@ -1140,26 +1138,26 @@ interface Poll {
|
|
|
1140
1138
|
/** The poll's permissions and display settings. */
|
|
1141
1139
|
settings?: Settings;
|
|
1142
1140
|
}
|
|
1143
|
-
interface PollDataLayout {
|
|
1141
|
+
export interface PollDataLayout {
|
|
1144
1142
|
/** Poll layout settings. */
|
|
1145
1143
|
poll?: PollLayout;
|
|
1146
1144
|
/** Voting otpions layout settings. */
|
|
1147
1145
|
options?: OptionLayout;
|
|
1148
1146
|
}
|
|
1149
|
-
interface Design {
|
|
1147
|
+
export interface Design {
|
|
1150
1148
|
/** Styling for the poll. */
|
|
1151
1149
|
poll?: PollDesign;
|
|
1152
1150
|
/** Styling for voting options. */
|
|
1153
1151
|
options?: OptionDesign;
|
|
1154
1152
|
}
|
|
1155
|
-
interface TextData {
|
|
1153
|
+
export interface TextData {
|
|
1156
1154
|
/** The text to apply decorations to. */
|
|
1157
1155
|
text?: string;
|
|
1158
1156
|
/** The decorations to apply. */
|
|
1159
1157
|
decorations?: Decoration[];
|
|
1160
1158
|
}
|
|
1161
1159
|
/** Adds appearence changes to text */
|
|
1162
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1160
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1163
1161
|
/** Data for an anchor link decoration. */
|
|
1164
1162
|
anchorData?: AnchorData;
|
|
1165
1163
|
/** Data for a color decoration. */
|
|
@@ -1184,7 +1182,7 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1184
1182
|
type?: DecorationType;
|
|
1185
1183
|
}
|
|
1186
1184
|
/** @oneof */
|
|
1187
|
-
interface DecorationDataOneOf {
|
|
1185
|
+
export interface DecorationDataOneOf {
|
|
1188
1186
|
/** Data for an anchor link decoration. */
|
|
1189
1187
|
anchorData?: AnchorData;
|
|
1190
1188
|
/** Data for a color decoration. */
|
|
@@ -1206,7 +1204,7 @@ interface DecorationDataOneOf {
|
|
|
1206
1204
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1207
1205
|
strikethroughData?: boolean | null;
|
|
1208
1206
|
}
|
|
1209
|
-
declare enum DecorationType {
|
|
1207
|
+
export declare enum DecorationType {
|
|
1210
1208
|
BOLD = "BOLD",
|
|
1211
1209
|
ITALIC = "ITALIC",
|
|
1212
1210
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1219,21 +1217,21 @@ declare enum DecorationType {
|
|
|
1219
1217
|
EXTERNAL = "EXTERNAL",
|
|
1220
1218
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1221
1219
|
}
|
|
1222
|
-
interface AnchorData {
|
|
1220
|
+
export interface AnchorData {
|
|
1223
1221
|
/** The target node's ID. */
|
|
1224
1222
|
anchor?: string;
|
|
1225
1223
|
}
|
|
1226
|
-
interface ColorData {
|
|
1224
|
+
export interface ColorData {
|
|
1227
1225
|
/** The text's background color as a hexadecimal value. */
|
|
1228
1226
|
background?: string | null;
|
|
1229
1227
|
/** The text's foreground color as a hexadecimal value. */
|
|
1230
1228
|
foreground?: string | null;
|
|
1231
1229
|
}
|
|
1232
|
-
interface LinkData {
|
|
1230
|
+
export interface LinkData {
|
|
1233
1231
|
/** Link details. */
|
|
1234
1232
|
link?: Link;
|
|
1235
1233
|
}
|
|
1236
|
-
interface MentionData {
|
|
1234
|
+
export interface MentionData {
|
|
1237
1235
|
/** The mentioned user's name. */
|
|
1238
1236
|
name?: string;
|
|
1239
1237
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1241,21 +1239,21 @@ interface MentionData {
|
|
|
1241
1239
|
/** Mentioned user's ID. */
|
|
1242
1240
|
id?: string | null;
|
|
1243
1241
|
}
|
|
1244
|
-
interface FontSizeData {
|
|
1242
|
+
export interface FontSizeData {
|
|
1245
1243
|
/** The units used for the font size. */
|
|
1246
1244
|
unit?: FontType;
|
|
1247
1245
|
/** Font size value. */
|
|
1248
1246
|
value?: number | null;
|
|
1249
1247
|
}
|
|
1250
|
-
declare enum FontType {
|
|
1248
|
+
export declare enum FontType {
|
|
1251
1249
|
PX = "PX",
|
|
1252
1250
|
EM = "EM"
|
|
1253
1251
|
}
|
|
1254
|
-
interface SpoilerData {
|
|
1252
|
+
export interface SpoilerData {
|
|
1255
1253
|
/** Spoiler ID. */
|
|
1256
1254
|
id?: string | null;
|
|
1257
1255
|
}
|
|
1258
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1256
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1259
1257
|
/** Data for embedded Wix Bookings content. */
|
|
1260
1258
|
bookingData?: BookingData;
|
|
1261
1259
|
/** Data for embedded Wix Events content. */
|
|
@@ -1277,28 +1275,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1277
1275
|
image?: Media;
|
|
1278
1276
|
}
|
|
1279
1277
|
/** @oneof */
|
|
1280
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1278
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1281
1279
|
/** Data for embedded Wix Bookings content. */
|
|
1282
1280
|
bookingData?: BookingData;
|
|
1283
1281
|
/** Data for embedded Wix Events content. */
|
|
1284
1282
|
eventData?: EventData;
|
|
1285
1283
|
}
|
|
1286
|
-
declare enum AppType {
|
|
1284
|
+
export declare enum AppType {
|
|
1287
1285
|
PRODUCT = "PRODUCT",
|
|
1288
1286
|
EVENT = "EVENT",
|
|
1289
1287
|
BOOKING = "BOOKING"
|
|
1290
1288
|
}
|
|
1291
|
-
interface BookingData {
|
|
1289
|
+
export interface BookingData {
|
|
1292
1290
|
/** Booking duration in minutes. */
|
|
1293
1291
|
durations?: string | null;
|
|
1294
1292
|
}
|
|
1295
|
-
interface EventData {
|
|
1293
|
+
export interface EventData {
|
|
1296
1294
|
/** Event schedule. */
|
|
1297
1295
|
scheduling?: string | null;
|
|
1298
1296
|
/** Event location. */
|
|
1299
1297
|
location?: string | null;
|
|
1300
1298
|
}
|
|
1301
|
-
interface VideoData {
|
|
1299
|
+
export interface VideoData {
|
|
1302
1300
|
/** Styling for the video's container. */
|
|
1303
1301
|
containerData?: PluginContainerData;
|
|
1304
1302
|
/** Video details. */
|
|
@@ -1312,7 +1310,7 @@ interface VideoData {
|
|
|
1312
1310
|
/** Video options. */
|
|
1313
1311
|
options?: PlaybackOptions;
|
|
1314
1312
|
}
|
|
1315
|
-
interface PlaybackOptions {
|
|
1313
|
+
export interface PlaybackOptions {
|
|
1316
1314
|
/** Sets whether the media will automatically start playing. */
|
|
1317
1315
|
autoPlay?: boolean | null;
|
|
1318
1316
|
/** Sets whether media's will be looped. */
|
|
@@ -1320,7 +1318,7 @@ interface PlaybackOptions {
|
|
|
1320
1318
|
/** Sets whether media's controls will be shown. */
|
|
1321
1319
|
showControls?: boolean | null;
|
|
1322
1320
|
}
|
|
1323
|
-
interface EmbedData {
|
|
1321
|
+
export interface EmbedData {
|
|
1324
1322
|
/** Styling for the oEmbed node's container. */
|
|
1325
1323
|
containerData?: PluginContainerData;
|
|
1326
1324
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1328,7 +1326,7 @@ interface EmbedData {
|
|
|
1328
1326
|
/** Origin asset source. */
|
|
1329
1327
|
src?: string | null;
|
|
1330
1328
|
}
|
|
1331
|
-
interface Oembed {
|
|
1329
|
+
export interface Oembed {
|
|
1332
1330
|
/** The resource type. */
|
|
1333
1331
|
type?: string | null;
|
|
1334
1332
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1360,7 +1358,7 @@ interface Oembed {
|
|
|
1360
1358
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1361
1359
|
version?: string | null;
|
|
1362
1360
|
}
|
|
1363
|
-
interface CollapsibleListData {
|
|
1361
|
+
export interface CollapsibleListData {
|
|
1364
1362
|
/** Styling for the collapsible list's container. */
|
|
1365
1363
|
containerData?: PluginContainerData;
|
|
1366
1364
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1372,7 +1370,7 @@ interface CollapsibleListData {
|
|
|
1372
1370
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1373
1371
|
isQapageData?: boolean | null;
|
|
1374
1372
|
}
|
|
1375
|
-
declare enum InitialExpandedItems {
|
|
1373
|
+
export declare enum InitialExpandedItems {
|
|
1376
1374
|
/** First item will be expended initally */
|
|
1377
1375
|
FIRST = "FIRST",
|
|
1378
1376
|
/** All items will expended initally */
|
|
@@ -1380,13 +1378,13 @@ declare enum InitialExpandedItems {
|
|
|
1380
1378
|
/** All items collapsed initally */
|
|
1381
1379
|
NONE = "NONE"
|
|
1382
1380
|
}
|
|
1383
|
-
declare enum Direction {
|
|
1381
|
+
export declare enum Direction {
|
|
1384
1382
|
/** Left-to-right */
|
|
1385
1383
|
LTR = "LTR",
|
|
1386
1384
|
/** Right-to-left */
|
|
1387
1385
|
RTL = "RTL"
|
|
1388
1386
|
}
|
|
1389
|
-
interface TableData {
|
|
1387
|
+
export interface TableData {
|
|
1390
1388
|
/** Styling for the table's container. */
|
|
1391
1389
|
containerData?: PluginContainerData;
|
|
1392
1390
|
/** The table's dimensions. */
|
|
@@ -1401,7 +1399,7 @@ interface TableData {
|
|
|
1401
1399
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1402
1400
|
columnHeader?: boolean | null;
|
|
1403
1401
|
}
|
|
1404
|
-
interface Dimensions {
|
|
1402
|
+
export interface Dimensions {
|
|
1405
1403
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1406
1404
|
colsWidthRatio?: number[];
|
|
1407
1405
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1409,13 +1407,13 @@ interface Dimensions {
|
|
|
1409
1407
|
/** An array representing the minimum width of each column in pixels. */
|
|
1410
1408
|
colsMinWidth?: number[];
|
|
1411
1409
|
}
|
|
1412
|
-
interface TableCellData {
|
|
1410
|
+
export interface TableCellData {
|
|
1413
1411
|
/** Styling for the cell's background color and text alignment. */
|
|
1414
1412
|
cellStyle?: CellStyle;
|
|
1415
1413
|
/** The cell's border colors. */
|
|
1416
1414
|
borderColors?: BorderColors;
|
|
1417
1415
|
}
|
|
1418
|
-
declare enum VerticalAlignment {
|
|
1416
|
+
export declare enum VerticalAlignment {
|
|
1419
1417
|
/** Top alignment */
|
|
1420
1418
|
TOP = "TOP",
|
|
1421
1419
|
/** Middle alignment */
|
|
@@ -1423,7 +1421,7 @@ declare enum VerticalAlignment {
|
|
|
1423
1421
|
/** Bottom alignment */
|
|
1424
1422
|
BOTTOM = "BOTTOM"
|
|
1425
1423
|
}
|
|
1426
|
-
interface CellStyle {
|
|
1424
|
+
export interface CellStyle {
|
|
1427
1425
|
/** Vertical alignment for the cell's text. */
|
|
1428
1426
|
verticalAlignment?: VerticalAlignment;
|
|
1429
1427
|
/**
|
|
@@ -1432,7 +1430,7 @@ interface CellStyle {
|
|
|
1432
1430
|
*/
|
|
1433
1431
|
backgroundColor?: string | null;
|
|
1434
1432
|
}
|
|
1435
|
-
interface BorderColors {
|
|
1433
|
+
export interface BorderColors {
|
|
1436
1434
|
/**
|
|
1437
1435
|
* Left border color as a hexadecimal value.
|
|
1438
1436
|
* @format COLOR_HEX
|
|
@@ -1454,7 +1452,26 @@ interface BorderColors {
|
|
|
1454
1452
|
*/
|
|
1455
1453
|
bottom?: string | null;
|
|
1456
1454
|
}
|
|
1457
|
-
|
|
1455
|
+
/**
|
|
1456
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1457
|
+
* `Value` type union.
|
|
1458
|
+
*
|
|
1459
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
|
1460
|
+
*/
|
|
1461
|
+
export declare enum NullValue {
|
|
1462
|
+
/** Null value. */
|
|
1463
|
+
NULL_VALUE = "NULL_VALUE"
|
|
1464
|
+
}
|
|
1465
|
+
/**
|
|
1466
|
+
* `ListValue` is a wrapper around a repeated field of values.
|
|
1467
|
+
*
|
|
1468
|
+
* The JSON representation for `ListValue` is JSON array.
|
|
1469
|
+
*/
|
|
1470
|
+
export interface ListValue {
|
|
1471
|
+
/** Repeated field of dynamically typed values. */
|
|
1472
|
+
values?: any[];
|
|
1473
|
+
}
|
|
1474
|
+
export interface AudioData {
|
|
1458
1475
|
/** Styling for the audio node's container. */
|
|
1459
1476
|
containerData?: PluginContainerData;
|
|
1460
1477
|
/** Audio file details. */
|
|
@@ -1470,7 +1487,7 @@ interface AudioData {
|
|
|
1470
1487
|
/** An HTML version of the audio node. */
|
|
1471
1488
|
html?: string | null;
|
|
1472
1489
|
}
|
|
1473
|
-
interface OrderedListData {
|
|
1490
|
+
export interface OrderedListData {
|
|
1474
1491
|
/** Indentation level from 0-4. */
|
|
1475
1492
|
indentation?: number;
|
|
1476
1493
|
/** Offset level from 0-4. */
|
|
@@ -1478,24 +1495,24 @@ interface OrderedListData {
|
|
|
1478
1495
|
/** List start number. */
|
|
1479
1496
|
start?: number | null;
|
|
1480
1497
|
}
|
|
1481
|
-
interface BulletedListData {
|
|
1498
|
+
export interface BulletedListData {
|
|
1482
1499
|
/** Indentation level from 0-4. */
|
|
1483
1500
|
indentation?: number;
|
|
1484
1501
|
/** Offset level from 0-4. */
|
|
1485
1502
|
offset?: number | null;
|
|
1486
1503
|
}
|
|
1487
|
-
interface BlockquoteData {
|
|
1504
|
+
export interface BlockquoteData {
|
|
1488
1505
|
/** Indentation level from 1-4. */
|
|
1489
1506
|
indentation?: number;
|
|
1490
1507
|
}
|
|
1491
|
-
interface CaptionData {
|
|
1508
|
+
export interface CaptionData {
|
|
1492
1509
|
textStyle?: TextStyle;
|
|
1493
1510
|
}
|
|
1494
|
-
interface LayoutCellData {
|
|
1511
|
+
export interface LayoutCellData {
|
|
1495
1512
|
/** Size of the cell in 12 columns grid. */
|
|
1496
1513
|
colSpan?: number | null;
|
|
1497
1514
|
}
|
|
1498
|
-
interface Metadata {
|
|
1515
|
+
export interface Metadata {
|
|
1499
1516
|
/** Schema version. */
|
|
1500
1517
|
version?: number;
|
|
1501
1518
|
/**
|
|
@@ -1512,7 +1529,7 @@ interface Metadata {
|
|
|
1512
1529
|
/** Object ID. */
|
|
1513
1530
|
id?: string | null;
|
|
1514
1531
|
}
|
|
1515
|
-
interface DocumentStyle {
|
|
1532
|
+
export interface DocumentStyle {
|
|
1516
1533
|
/** Styling for H1 nodes. */
|
|
1517
1534
|
headerOne?: TextNodeStyle;
|
|
1518
1535
|
/** Styling for H2 nodes. */
|
|
@@ -1532,7 +1549,7 @@ interface DocumentStyle {
|
|
|
1532
1549
|
/** Styling for code block nodes. */
|
|
1533
1550
|
codeBlock?: TextNodeStyle;
|
|
1534
1551
|
}
|
|
1535
|
-
interface TextNodeStyle {
|
|
1552
|
+
export interface TextNodeStyle {
|
|
1536
1553
|
/** The decorations to apply to the node. */
|
|
1537
1554
|
decorations?: Decoration[];
|
|
1538
1555
|
/** Padding and background color for the node. */
|
|
@@ -1540,7 +1557,7 @@ interface TextNodeStyle {
|
|
|
1540
1557
|
/** Line height for text in the node. */
|
|
1541
1558
|
lineHeight?: string | null;
|
|
1542
1559
|
}
|
|
1543
|
-
interface Mention extends MentionIdentityOneOf {
|
|
1560
|
+
export interface Mention extends MentionIdentityOneOf {
|
|
1544
1561
|
/**
|
|
1545
1562
|
* Wix user ID.
|
|
1546
1563
|
* @format GUID
|
|
@@ -1563,7 +1580,7 @@ interface Mention extends MentionIdentityOneOf {
|
|
|
1563
1580
|
groupId?: string | null;
|
|
1564
1581
|
}
|
|
1565
1582
|
/** @oneof */
|
|
1566
|
-
interface MentionIdentityOneOf {
|
|
1583
|
+
export interface MentionIdentityOneOf {
|
|
1567
1584
|
/**
|
|
1568
1585
|
* Wix user ID.
|
|
1569
1586
|
* @format GUID
|
|
@@ -1585,7 +1602,7 @@ interface MentionIdentityOneOf {
|
|
|
1585
1602
|
*/
|
|
1586
1603
|
groupId?: string | null;
|
|
1587
1604
|
}
|
|
1588
|
-
interface Attachment extends AttachmentMediaOneOf {
|
|
1605
|
+
export interface Attachment extends AttachmentMediaOneOf {
|
|
1589
1606
|
/** Information about the image. */
|
|
1590
1607
|
image?: Image;
|
|
1591
1608
|
/** Information about the video. */
|
|
@@ -1601,7 +1618,7 @@ interface Attachment extends AttachmentMediaOneOf {
|
|
|
1601
1618
|
mimeType?: string | null;
|
|
1602
1619
|
}
|
|
1603
1620
|
/** @oneof */
|
|
1604
|
-
interface AttachmentMediaOneOf {
|
|
1621
|
+
export interface AttachmentMediaOneOf {
|
|
1605
1622
|
/** Information about the image. */
|
|
1606
1623
|
image?: Image;
|
|
1607
1624
|
/** Information about the video. */
|
|
@@ -1611,7 +1628,7 @@ interface AttachmentMediaOneOf {
|
|
|
1611
1628
|
/** Information about the document. */
|
|
1612
1629
|
document?: Document;
|
|
1613
1630
|
}
|
|
1614
|
-
interface Image {
|
|
1631
|
+
export interface Image {
|
|
1615
1632
|
/** WixMedia image ID. */
|
|
1616
1633
|
id?: string;
|
|
1617
1634
|
/** Image URL. */
|
|
@@ -1648,7 +1665,7 @@ interface Image {
|
|
|
1648
1665
|
*/
|
|
1649
1666
|
sizeInBytes?: string | null;
|
|
1650
1667
|
}
|
|
1651
|
-
interface VideoV2 {
|
|
1668
|
+
export interface VideoV2 {
|
|
1652
1669
|
/** WixMedia ID. */
|
|
1653
1670
|
id?: string;
|
|
1654
1671
|
/** Original video URL. */
|
|
@@ -1681,7 +1698,7 @@ interface VideoV2 {
|
|
|
1681
1698
|
*/
|
|
1682
1699
|
urlExpirationDate?: Date | null;
|
|
1683
1700
|
}
|
|
1684
|
-
interface VideoResolution {
|
|
1701
|
+
export interface VideoResolution {
|
|
1685
1702
|
/** Video URL. */
|
|
1686
1703
|
url?: string;
|
|
1687
1704
|
/** Video height. */
|
|
@@ -1720,7 +1737,7 @@ interface VideoResolution {
|
|
|
1720
1737
|
*/
|
|
1721
1738
|
assetKey?: string | null;
|
|
1722
1739
|
}
|
|
1723
|
-
interface Audio {
|
|
1740
|
+
export interface Audio {
|
|
1724
1741
|
/** WixMedia ID. */
|
|
1725
1742
|
id?: string;
|
|
1726
1743
|
/** Audio URL. */
|
|
@@ -1771,7 +1788,7 @@ interface Audio {
|
|
|
1771
1788
|
*/
|
|
1772
1789
|
quality?: string | null;
|
|
1773
1790
|
}
|
|
1774
|
-
interface Document {
|
|
1791
|
+
export interface Document {
|
|
1775
1792
|
/** WixMedia ID. */
|
|
1776
1793
|
id?: string;
|
|
1777
1794
|
/** Document URL. */
|
|
@@ -1793,7 +1810,52 @@ interface Document {
|
|
|
1793
1810
|
*/
|
|
1794
1811
|
filename?: string | null;
|
|
1795
1812
|
}
|
|
1796
|
-
interface
|
|
1813
|
+
export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
1814
|
+
/**
|
|
1815
|
+
* Wix user ID.
|
|
1816
|
+
* @format GUID
|
|
1817
|
+
*/
|
|
1818
|
+
userId?: string | null;
|
|
1819
|
+
/**
|
|
1820
|
+
* Member ID. See the Members API for more details.
|
|
1821
|
+
* @format GUID
|
|
1822
|
+
*/
|
|
1823
|
+
memberId?: string | null;
|
|
1824
|
+
/**
|
|
1825
|
+
* Visitor ID.
|
|
1826
|
+
* @format GUID
|
|
1827
|
+
*/
|
|
1828
|
+
visitorId?: string | null;
|
|
1829
|
+
/**
|
|
1830
|
+
* Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance).
|
|
1831
|
+
* @format GUID
|
|
1832
|
+
*/
|
|
1833
|
+
appId?: string | null;
|
|
1834
|
+
}
|
|
1835
|
+
/** @oneof */
|
|
1836
|
+
export interface ContentAuthorAuthorOneOf {
|
|
1837
|
+
/**
|
|
1838
|
+
* Wix user ID.
|
|
1839
|
+
* @format GUID
|
|
1840
|
+
*/
|
|
1841
|
+
userId?: string | null;
|
|
1842
|
+
/**
|
|
1843
|
+
* Member ID. See the Members API for more details.
|
|
1844
|
+
* @format GUID
|
|
1845
|
+
*/
|
|
1846
|
+
memberId?: string | null;
|
|
1847
|
+
/**
|
|
1848
|
+
* Visitor ID.
|
|
1849
|
+
* @format GUID
|
|
1850
|
+
*/
|
|
1851
|
+
visitorId?: string | null;
|
|
1852
|
+
/**
|
|
1853
|
+
* Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance).
|
|
1854
|
+
* @format GUID
|
|
1855
|
+
*/
|
|
1856
|
+
appId?: string | null;
|
|
1857
|
+
}
|
|
1858
|
+
export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1797
1859
|
/**
|
|
1798
1860
|
* Wix user ID.
|
|
1799
1861
|
* @format GUID
|
|
@@ -1811,7 +1873,7 @@ interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1811
1873
|
visitorId?: string | null;
|
|
1812
1874
|
}
|
|
1813
1875
|
/** @oneof */
|
|
1814
|
-
interface CommentAuthorIdentityOneOf {
|
|
1876
|
+
export interface CommentAuthorIdentityOneOf {
|
|
1815
1877
|
/**
|
|
1816
1878
|
* Wix user ID.
|
|
1817
1879
|
* @format GUID
|
|
@@ -1828,7 +1890,7 @@ interface CommentAuthorIdentityOneOf {
|
|
|
1828
1890
|
*/
|
|
1829
1891
|
visitorId?: string | null;
|
|
1830
1892
|
}
|
|
1831
|
-
interface ParentComment {
|
|
1893
|
+
export interface ParentComment {
|
|
1832
1894
|
/**
|
|
1833
1895
|
* Comment ID of the parent comment.
|
|
1834
1896
|
* @format GUID
|
|
@@ -1846,7 +1908,7 @@ interface ParentComment {
|
|
|
1846
1908
|
*/
|
|
1847
1909
|
status?: Status;
|
|
1848
1910
|
}
|
|
1849
|
-
declare enum Status {
|
|
1911
|
+
export declare enum Status {
|
|
1850
1912
|
/** Unknown status. */
|
|
1851
1913
|
UNKNOWN = "UNKNOWN",
|
|
1852
1914
|
/** This comment is published and publicly visible. */
|
|
@@ -1858,7 +1920,7 @@ declare enum Status {
|
|
|
1858
1920
|
/** This comment has been hidden by a site moderator. */
|
|
1859
1921
|
HIDDEN = "HIDDEN"
|
|
1860
1922
|
}
|
|
1861
|
-
interface VoteSummary {
|
|
1923
|
+
export interface VoteSummary {
|
|
1862
1924
|
/** Number of upvotes less downvotes on this comment. */
|
|
1863
1925
|
netVoteCount?: number;
|
|
1864
1926
|
/** Number of upvotes on this comment. */
|
|
@@ -1866,7 +1928,7 @@ interface VoteSummary {
|
|
|
1866
1928
|
/** Number of downvotes on this comment. */
|
|
1867
1929
|
downvoteCount?: number;
|
|
1868
1930
|
}
|
|
1869
|
-
interface CommentReactionSummary {
|
|
1931
|
+
export interface CommentReactionSummary {
|
|
1870
1932
|
/** Total amount of reactions. */
|
|
1871
1933
|
total?: number;
|
|
1872
1934
|
/**
|
|
@@ -1875,7 +1937,120 @@ interface CommentReactionSummary {
|
|
|
1875
1937
|
*/
|
|
1876
1938
|
reactionCodeCount?: Record<string, number>;
|
|
1877
1939
|
}
|
|
1878
|
-
|
|
1940
|
+
export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
1941
|
+
/** insert/update documents */
|
|
1942
|
+
update?: InternalDocumentUpdateOperation;
|
|
1943
|
+
/** delete by document ids */
|
|
1944
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
1945
|
+
/** delete documents matching filter */
|
|
1946
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
1947
|
+
/** update internal documents matching filter */
|
|
1948
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
1949
|
+
/** update only existing documents */
|
|
1950
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
1951
|
+
/** insert/update documents with versioning */
|
|
1952
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
1953
|
+
/** delete by document ids with versioning */
|
|
1954
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1955
|
+
/**
|
|
1956
|
+
* type of the documents
|
|
1957
|
+
* @minLength 2
|
|
1958
|
+
*/
|
|
1959
|
+
documentType?: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* language of the documents (mandatory)
|
|
1962
|
+
* @minLength 2
|
|
1963
|
+
*/
|
|
1964
|
+
language?: string | null;
|
|
1965
|
+
/**
|
|
1966
|
+
* one or more search documents
|
|
1967
|
+
* @deprecated
|
|
1968
|
+
*/
|
|
1969
|
+
addDocuments?: InternalDocument[];
|
|
1970
|
+
/**
|
|
1971
|
+
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
1972
|
+
* @deprecated
|
|
1973
|
+
*/
|
|
1974
|
+
removeDocumentIds?: string[];
|
|
1975
|
+
/** id to pass to processing notification */
|
|
1976
|
+
correlationId?: string | null;
|
|
1977
|
+
/** when event was created / issued */
|
|
1978
|
+
issuedAt?: Date | null;
|
|
1979
|
+
}
|
|
1980
|
+
/** @oneof */
|
|
1981
|
+
export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
1982
|
+
/** insert/update documents */
|
|
1983
|
+
update?: InternalDocumentUpdateOperation;
|
|
1984
|
+
/** delete by document ids */
|
|
1985
|
+
deleteByIds?: DeleteByIdsOperation;
|
|
1986
|
+
/** delete documents matching filter */
|
|
1987
|
+
deleteByFilter?: DeleteByFilterOperation;
|
|
1988
|
+
/** update internal documents matching filter */
|
|
1989
|
+
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
1990
|
+
/** update only existing documents */
|
|
1991
|
+
updateExisting?: InternalUpdateExistingOperation;
|
|
1992
|
+
/** insert/update documents with versioning */
|
|
1993
|
+
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
1994
|
+
/** delete by document ids with versioning */
|
|
1995
|
+
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
1996
|
+
}
|
|
1997
|
+
export interface InternalDocument {
|
|
1998
|
+
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
1999
|
+
document?: Record<string, any> | null;
|
|
2000
|
+
}
|
|
2001
|
+
export interface InternalDocumentUpdateOperation {
|
|
2002
|
+
/** documents to index or update */
|
|
2003
|
+
documents?: InternalDocument[];
|
|
2004
|
+
}
|
|
2005
|
+
export interface DeleteByIdsOperation {
|
|
2006
|
+
/** ids of the documents to delete */
|
|
2007
|
+
documentIds?: string[];
|
|
2008
|
+
}
|
|
2009
|
+
export interface DeleteByFilterOperation {
|
|
2010
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2011
|
+
filter?: Record<string, any> | null;
|
|
2012
|
+
}
|
|
2013
|
+
export interface InternalDocumentUpdateByFilterOperation {
|
|
2014
|
+
/** documents matching this filter will be updated */
|
|
2015
|
+
filter?: Record<string, any> | null;
|
|
2016
|
+
/** partial document to apply */
|
|
2017
|
+
document?: InternalDocument;
|
|
2018
|
+
}
|
|
2019
|
+
export interface InternalUpdateExistingOperation {
|
|
2020
|
+
/** documents to update */
|
|
2021
|
+
documents?: InternalDocument[];
|
|
2022
|
+
}
|
|
2023
|
+
export interface VersionedDocumentUpdateOperation {
|
|
2024
|
+
/** documents to create or overwrite */
|
|
2025
|
+
documents?: InternalDocument[];
|
|
2026
|
+
/** versioning mode to use instead of default */
|
|
2027
|
+
versioningMode?: VersioningMode;
|
|
2028
|
+
}
|
|
2029
|
+
export declare enum VersioningMode {
|
|
2030
|
+
/** use default versioning mode agreed with search team */
|
|
2031
|
+
DEFAULT = "DEFAULT",
|
|
2032
|
+
/** execute only if version is greater than existing */
|
|
2033
|
+
GREATER_THAN = "GREATER_THAN",
|
|
2034
|
+
/** execute only if version is greater or equal to existing */
|
|
2035
|
+
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2036
|
+
}
|
|
2037
|
+
export interface VersionedDeleteByIdsOperation {
|
|
2038
|
+
/** ids with version of the documents to delete */
|
|
2039
|
+
documentIds?: VersionedDocumentId[];
|
|
2040
|
+
}
|
|
2041
|
+
export interface VersionedDocumentId {
|
|
2042
|
+
/** document id */
|
|
2043
|
+
documentId?: string;
|
|
2044
|
+
/** document version */
|
|
2045
|
+
version?: string;
|
|
2046
|
+
/** versioning mode to use instead of default */
|
|
2047
|
+
versioningMode?: VersioningMode;
|
|
2048
|
+
}
|
|
2049
|
+
export interface CommentModerated {
|
|
2050
|
+
comment?: Comment;
|
|
2051
|
+
moderationAction?: Action;
|
|
2052
|
+
}
|
|
2053
|
+
export declare enum Action {
|
|
1879
2054
|
/** Unknown content. */
|
|
1880
2055
|
UNKNOWN = "UNKNOWN",
|
|
1881
2056
|
/** Approve draft content. */
|
|
@@ -1883,44 +2058,75 @@ declare enum Action {
|
|
|
1883
2058
|
/** Reject draft content. */
|
|
1884
2059
|
REJECT = "REJECT"
|
|
1885
2060
|
}
|
|
1886
|
-
interface CreateCommentRequest {
|
|
2061
|
+
export interface CreateCommentRequest {
|
|
1887
2062
|
/** Comment to create. */
|
|
1888
2063
|
comment?: Comment;
|
|
1889
2064
|
}
|
|
1890
|
-
interface
|
|
2065
|
+
export interface ContactDetails {
|
|
2066
|
+
}
|
|
2067
|
+
export interface CreateCommentResponse {
|
|
1891
2068
|
/** Created comment. */
|
|
1892
2069
|
comment?: Comment;
|
|
1893
2070
|
}
|
|
1894
|
-
interface
|
|
2071
|
+
export interface ResourceCommentCountChanged {
|
|
2072
|
+
/** ID of the app that the comment is added to. */
|
|
2073
|
+
appId?: string;
|
|
2074
|
+
/**
|
|
2075
|
+
* ID of the specific context the comment is in response to.
|
|
2076
|
+
*
|
|
2077
|
+
* Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum, the `forumPostId` is used as both the `contextId` and the `resourceId`.
|
|
2078
|
+
*/
|
|
2079
|
+
contextId?: string;
|
|
2080
|
+
/**
|
|
2081
|
+
* ID of the specific resource that the comment is in response to.
|
|
2082
|
+
*
|
|
2083
|
+
* Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum, the `forumPostId` is used as both the `resourceId` and the `contextId`.
|
|
2084
|
+
*/
|
|
2085
|
+
resourceId?: string;
|
|
2086
|
+
/** How many comments are published for the resource. */
|
|
2087
|
+
publishedCommentCount?: number;
|
|
2088
|
+
}
|
|
2089
|
+
export interface GetCommentRequest {
|
|
1895
2090
|
/**
|
|
1896
2091
|
* ID of the comment to retrieve.
|
|
1897
2092
|
* @format GUID
|
|
1898
2093
|
*/
|
|
1899
2094
|
commentId: string;
|
|
1900
2095
|
}
|
|
1901
|
-
interface GetCommentResponse {
|
|
2096
|
+
export interface GetCommentResponse {
|
|
1902
2097
|
/** Retrieved comment. */
|
|
1903
2098
|
comment?: Comment;
|
|
1904
2099
|
}
|
|
1905
2100
|
/** Comment info to update. */
|
|
1906
|
-
interface UpdateCommentRequest {
|
|
2101
|
+
export interface UpdateCommentRequest {
|
|
1907
2102
|
/** Comment info to update. */
|
|
1908
2103
|
comment?: Comment;
|
|
1909
2104
|
}
|
|
1910
|
-
interface UpdateCommentResponse {
|
|
2105
|
+
export interface UpdateCommentResponse {
|
|
1911
2106
|
/** Updated comment. */
|
|
1912
2107
|
comment?: Comment;
|
|
1913
2108
|
}
|
|
1914
|
-
interface
|
|
2109
|
+
export interface CommentContentChanged {
|
|
2110
|
+
/** Comment ID. */
|
|
2111
|
+
commentId?: string;
|
|
2112
|
+
/** Content before the update. */
|
|
2113
|
+
previousContent?: CommentContent;
|
|
2114
|
+
/** Content after the update. */
|
|
2115
|
+
currentContent?: CommentContent;
|
|
2116
|
+
}
|
|
2117
|
+
export interface DeleteCommentRequest {
|
|
1915
2118
|
/**
|
|
1916
2119
|
* ID of the comment to delete.
|
|
1917
2120
|
* @format GUID
|
|
1918
2121
|
*/
|
|
1919
2122
|
commentId: string;
|
|
1920
2123
|
}
|
|
1921
|
-
interface DeleteCommentResponse {
|
|
2124
|
+
export interface DeleteCommentResponse {
|
|
2125
|
+
}
|
|
2126
|
+
export interface CommentDeleted {
|
|
2127
|
+
comment?: Comment;
|
|
1922
2128
|
}
|
|
1923
|
-
interface ModerateDraftContentRequest {
|
|
2129
|
+
export interface ModerateDraftContentRequest {
|
|
1924
2130
|
/**
|
|
1925
2131
|
* ID of the comment to moderate.
|
|
1926
2132
|
* @format GUID
|
|
@@ -1935,11 +2141,20 @@ interface ModerateDraftContentRequest {
|
|
|
1935
2141
|
/** Draft content action. */
|
|
1936
2142
|
draftContentAction?: Action;
|
|
1937
2143
|
}
|
|
1938
|
-
interface ModerateDraftContentResponse {
|
|
2144
|
+
export interface ModerateDraftContentResponse {
|
|
1939
2145
|
/** Moderated comment. */
|
|
1940
2146
|
comment?: Comment;
|
|
1941
2147
|
}
|
|
1942
|
-
interface
|
|
2148
|
+
export interface CommentPublished {
|
|
2149
|
+
/** Comment info. */
|
|
2150
|
+
comment?: Comment;
|
|
2151
|
+
/** Whether this is the first comment publish. */
|
|
2152
|
+
firstPublish?: boolean;
|
|
2153
|
+
}
|
|
2154
|
+
export interface CommentHidden {
|
|
2155
|
+
comment?: Comment;
|
|
2156
|
+
}
|
|
2157
|
+
export interface QueryCommentsRequest {
|
|
1943
2158
|
/**
|
|
1944
2159
|
* App ID to query comments for.
|
|
1945
2160
|
* @format GUID
|
|
@@ -1948,7 +2163,7 @@ interface QueryCommentsRequest {
|
|
|
1948
2163
|
/** Query options. */
|
|
1949
2164
|
query: CursorQuery;
|
|
1950
2165
|
}
|
|
1951
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2166
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1952
2167
|
/**
|
|
1953
2168
|
* Cursor paging options.
|
|
1954
2169
|
*
|
|
@@ -1970,7 +2185,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1970
2185
|
sort?: Sorting[];
|
|
1971
2186
|
}
|
|
1972
2187
|
/** @oneof */
|
|
1973
|
-
interface CursorQueryPagingMethodOneOf {
|
|
2188
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1974
2189
|
/**
|
|
1975
2190
|
* Cursor paging options.
|
|
1976
2191
|
*
|
|
@@ -1978,7 +2193,7 @@ interface CursorQueryPagingMethodOneOf {
|
|
|
1978
2193
|
*/
|
|
1979
2194
|
cursorPaging?: CursorPaging;
|
|
1980
2195
|
}
|
|
1981
|
-
interface Sorting {
|
|
2196
|
+
export interface Sorting {
|
|
1982
2197
|
/**
|
|
1983
2198
|
* Name of the field to sort by.
|
|
1984
2199
|
* @maxLength 512
|
|
@@ -1987,11 +2202,11 @@ interface Sorting {
|
|
|
1987
2202
|
/** Sort order. */
|
|
1988
2203
|
order?: SortOrder;
|
|
1989
2204
|
}
|
|
1990
|
-
declare enum SortOrder {
|
|
2205
|
+
export declare enum SortOrder {
|
|
1991
2206
|
ASC = "ASC",
|
|
1992
2207
|
DESC = "DESC"
|
|
1993
2208
|
}
|
|
1994
|
-
interface CursorPaging {
|
|
2209
|
+
export interface CursorPaging {
|
|
1995
2210
|
/**
|
|
1996
2211
|
* Maximum number of items to return in the results.
|
|
1997
2212
|
* @max 100
|
|
@@ -2006,13 +2221,13 @@ interface CursorPaging {
|
|
|
2006
2221
|
*/
|
|
2007
2222
|
cursor?: string | null;
|
|
2008
2223
|
}
|
|
2009
|
-
interface QueryCommentsResponse {
|
|
2224
|
+
export interface QueryCommentsResponse {
|
|
2010
2225
|
/** Retrieved comments. */
|
|
2011
2226
|
comments?: Comment[];
|
|
2012
2227
|
/** Paging metadata. */
|
|
2013
2228
|
pagingMetadata?: CursorPagingMetadata;
|
|
2014
2229
|
}
|
|
2015
|
-
interface CursorPagingMetadata {
|
|
2230
|
+
export interface CursorPagingMetadata {
|
|
2016
2231
|
/** Number of items returned in current page. */
|
|
2017
2232
|
count?: number | null;
|
|
2018
2233
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2025,7 +2240,7 @@ interface CursorPagingMetadata {
|
|
|
2025
2240
|
*/
|
|
2026
2241
|
hasNext?: boolean | null;
|
|
2027
2242
|
}
|
|
2028
|
-
interface Cursors {
|
|
2243
|
+
export interface Cursors {
|
|
2029
2244
|
/**
|
|
2030
2245
|
* Cursor string pointing to the next page in the list of results.
|
|
2031
2246
|
* @maxLength 16000
|
|
@@ -2037,52 +2252,58 @@ interface Cursors {
|
|
|
2037
2252
|
*/
|
|
2038
2253
|
prev?: string | null;
|
|
2039
2254
|
}
|
|
2040
|
-
interface MarkCommentRequest {
|
|
2255
|
+
export interface MarkCommentRequest {
|
|
2041
2256
|
/**
|
|
2042
2257
|
* ID of the comment to mark.
|
|
2043
2258
|
* @format GUID
|
|
2044
2259
|
*/
|
|
2045
2260
|
commentId: string;
|
|
2046
2261
|
}
|
|
2047
|
-
interface MarkCommentResponse {
|
|
2262
|
+
export interface MarkCommentResponse {
|
|
2048
2263
|
/** Marked comment. */
|
|
2049
2264
|
comment?: Comment;
|
|
2050
2265
|
}
|
|
2051
|
-
interface
|
|
2266
|
+
export interface CommentMarked {
|
|
2267
|
+
comment?: Comment;
|
|
2268
|
+
}
|
|
2269
|
+
export interface UnmarkCommentRequest {
|
|
2052
2270
|
/**
|
|
2053
2271
|
* ID of the comment to unmark.
|
|
2054
2272
|
* @format GUID
|
|
2055
2273
|
*/
|
|
2056
2274
|
commentId: string;
|
|
2057
2275
|
}
|
|
2058
|
-
interface UnmarkCommentResponse {
|
|
2276
|
+
export interface UnmarkCommentResponse {
|
|
2059
2277
|
/** Unmarked comment. */
|
|
2060
2278
|
comment?: Comment;
|
|
2061
2279
|
}
|
|
2062
|
-
interface
|
|
2280
|
+
export interface CommentUnmarked {
|
|
2281
|
+
comment?: Comment;
|
|
2282
|
+
}
|
|
2283
|
+
export interface HideCommentRequest {
|
|
2063
2284
|
/**
|
|
2064
2285
|
* ID of the comment to hide.
|
|
2065
2286
|
* @format GUID
|
|
2066
2287
|
*/
|
|
2067
2288
|
commentId: string;
|
|
2068
2289
|
}
|
|
2069
|
-
interface HideCommentResponse {
|
|
2290
|
+
export interface HideCommentResponse {
|
|
2070
2291
|
/** Hidden comment. */
|
|
2071
2292
|
comment?: Comment;
|
|
2072
2293
|
}
|
|
2073
|
-
interface PublishCommentRequest {
|
|
2294
|
+
export interface PublishCommentRequest {
|
|
2074
2295
|
/**
|
|
2075
2296
|
* ID of the comment to publish.
|
|
2076
2297
|
* @format GUID
|
|
2077
2298
|
*/
|
|
2078
2299
|
commentId: string;
|
|
2079
2300
|
}
|
|
2080
|
-
interface PublishCommentResponse {
|
|
2301
|
+
export interface PublishCommentResponse {
|
|
2081
2302
|
/** Published comment. */
|
|
2082
2303
|
comment?: Comment;
|
|
2083
2304
|
}
|
|
2084
2305
|
/** Count comments options. */
|
|
2085
|
-
interface CountCommentsRequest {
|
|
2306
|
+
export interface CountCommentsRequest {
|
|
2086
2307
|
/**
|
|
2087
2308
|
* App ID to count the comments of.
|
|
2088
2309
|
* @format GUID
|
|
@@ -2091,11 +2312,11 @@ interface CountCommentsRequest {
|
|
|
2091
2312
|
/** Filter to identify the comments that need to be counted. */
|
|
2092
2313
|
filter?: Record<string, any> | null;
|
|
2093
2314
|
}
|
|
2094
|
-
interface CountCommentsResponse {
|
|
2315
|
+
export interface CountCommentsResponse {
|
|
2095
2316
|
/** Number of comments. */
|
|
2096
2317
|
count?: number;
|
|
2097
2318
|
}
|
|
2098
|
-
interface ListCommentsByResourceRequest {
|
|
2319
|
+
export interface ListCommentsByResourceRequest {
|
|
2099
2320
|
/**
|
|
2100
2321
|
* ID of the app from which the comments are listed.
|
|
2101
2322
|
* @format GUID
|
|
@@ -2127,7 +2348,7 @@ interface ListCommentsByResourceRequest {
|
|
|
2127
2348
|
/** Cursor paging. */
|
|
2128
2349
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2129
2350
|
}
|
|
2130
|
-
interface CommentSort {
|
|
2351
|
+
export interface CommentSort {
|
|
2131
2352
|
/** Sort order. */
|
|
2132
2353
|
order?: Order;
|
|
2133
2354
|
/**
|
|
@@ -2137,7 +2358,7 @@ interface CommentSort {
|
|
|
2137
2358
|
*/
|
|
2138
2359
|
keepMarkedInOriginalOrder?: boolean;
|
|
2139
2360
|
}
|
|
2140
|
-
declare enum Order {
|
|
2361
|
+
export declare enum Order {
|
|
2141
2362
|
/** Unknown order. */
|
|
2142
2363
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2143
2364
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2155,7 +2376,7 @@ declare enum Order {
|
|
|
2155
2376
|
/** Comments with the lowest rating appear at the top of the list. */
|
|
2156
2377
|
RATING_ASC = "RATING_ASC"
|
|
2157
2378
|
}
|
|
2158
|
-
interface ReplySort {
|
|
2379
|
+
export interface ReplySort {
|
|
2159
2380
|
/** Sort order. */
|
|
2160
2381
|
order?: ReplySortOrder;
|
|
2161
2382
|
/**
|
|
@@ -2167,7 +2388,7 @@ interface ReplySort {
|
|
|
2167
2388
|
*/
|
|
2168
2389
|
keepMarkedInOriginalOrder?: boolean;
|
|
2169
2390
|
}
|
|
2170
|
-
declare enum ReplySortOrder {
|
|
2391
|
+
export declare enum ReplySortOrder {
|
|
2171
2392
|
/** Unknown order. */
|
|
2172
2393
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2173
2394
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2177,7 +2398,7 @@ declare enum ReplySortOrder {
|
|
|
2177
2398
|
/** Comments with the highest reaction count appear at the top of the list. */
|
|
2178
2399
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2179
2400
|
}
|
|
2180
|
-
interface ListCommentsByResourceCursorPaging {
|
|
2401
|
+
export interface ListCommentsByResourceCursorPaging {
|
|
2181
2402
|
/** Pointer to the next or previous page in the list of results. */
|
|
2182
2403
|
cursor?: string | null;
|
|
2183
2404
|
/**
|
|
@@ -2192,7 +2413,7 @@ interface ListCommentsByResourceCursorPaging {
|
|
|
2192
2413
|
*/
|
|
2193
2414
|
repliesLimit?: number | null;
|
|
2194
2415
|
}
|
|
2195
|
-
interface ListCommentsByResourceResponse {
|
|
2416
|
+
export interface ListCommentsByResourceResponse {
|
|
2196
2417
|
/** Listed comments. */
|
|
2197
2418
|
comments?: Comment[];
|
|
2198
2419
|
/** Paging metadata. */
|
|
@@ -2200,13 +2421,13 @@ interface ListCommentsByResourceResponse {
|
|
|
2200
2421
|
/** Listed comment replies. */
|
|
2201
2422
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2202
2423
|
}
|
|
2203
|
-
interface RepliesListResponse {
|
|
2424
|
+
export interface RepliesListResponse {
|
|
2204
2425
|
/** Listed comment replies. */
|
|
2205
2426
|
replies?: Comment[];
|
|
2206
2427
|
/** Paging metadata. */
|
|
2207
2428
|
pagingMetadata?: CursorPagingMetadata;
|
|
2208
2429
|
}
|
|
2209
|
-
interface GetCommentThreadRequest {
|
|
2430
|
+
export interface GetCommentThreadRequest {
|
|
2210
2431
|
/**
|
|
2211
2432
|
* App ID.
|
|
2212
2433
|
* @maxLength 128
|
|
@@ -2224,7 +2445,7 @@ interface GetCommentThreadRequest {
|
|
|
2224
2445
|
/** Reply sorting. */
|
|
2225
2446
|
replySort?: ReplySort;
|
|
2226
2447
|
}
|
|
2227
|
-
interface GetCommentThreadResponse {
|
|
2448
|
+
export interface GetCommentThreadResponse {
|
|
2228
2449
|
/** Retrieved replies. */
|
|
2229
2450
|
comments?: Comment[];
|
|
2230
2451
|
/** Paging metadata. */
|
|
@@ -2232,7 +2453,7 @@ interface GetCommentThreadResponse {
|
|
|
2232
2453
|
/** Retrieved replies of a reply. */
|
|
2233
2454
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2234
2455
|
}
|
|
2235
|
-
interface BulkPublishCommentRequest {
|
|
2456
|
+
export interface BulkPublishCommentRequest {
|
|
2236
2457
|
/**
|
|
2237
2458
|
* ID of the app where to publish the comment.
|
|
2238
2459
|
* @format GUID
|
|
@@ -2241,7 +2462,7 @@ interface BulkPublishCommentRequest {
|
|
|
2241
2462
|
/** 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"`}. */
|
|
2242
2463
|
filter: Record<string, any> | null;
|
|
2243
2464
|
}
|
|
2244
|
-
interface BulkPublishCommentResponse {
|
|
2465
|
+
export interface BulkPublishCommentResponse {
|
|
2245
2466
|
/**
|
|
2246
2467
|
* Job ID.
|
|
2247
2468
|
*
|
|
@@ -2250,7 +2471,7 @@ interface BulkPublishCommentResponse {
|
|
|
2250
2471
|
*/
|
|
2251
2472
|
jobId?: string;
|
|
2252
2473
|
}
|
|
2253
|
-
interface BulkHideCommentRequest {
|
|
2474
|
+
export interface BulkHideCommentRequest {
|
|
2254
2475
|
/**
|
|
2255
2476
|
* ID of the app where to hide the comments.
|
|
2256
2477
|
* @format GUID
|
|
@@ -2259,7 +2480,7 @@ interface BulkHideCommentRequest {
|
|
|
2259
2480
|
/** 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"`}. */
|
|
2260
2481
|
filter: Record<string, any> | null;
|
|
2261
2482
|
}
|
|
2262
|
-
interface BulkHideCommentResponse {
|
|
2483
|
+
export interface BulkHideCommentResponse {
|
|
2263
2484
|
/**
|
|
2264
2485
|
* Job ID.
|
|
2265
2486
|
*
|
|
@@ -2268,7 +2489,7 @@ interface BulkHideCommentResponse {
|
|
|
2268
2489
|
*/
|
|
2269
2490
|
jobId?: string;
|
|
2270
2491
|
}
|
|
2271
|
-
interface BulkDeleteCommentRequest {
|
|
2492
|
+
export interface BulkDeleteCommentRequest {
|
|
2272
2493
|
/**
|
|
2273
2494
|
* ID of the app where to delete the comments.
|
|
2274
2495
|
* @format GUID
|
|
@@ -2277,7 +2498,7 @@ interface BulkDeleteCommentRequest {
|
|
|
2277
2498
|
/** 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"`}. */
|
|
2278
2499
|
filter: Record<string, any> | null;
|
|
2279
2500
|
}
|
|
2280
|
-
interface BulkDeleteCommentResponse {
|
|
2501
|
+
export interface BulkDeleteCommentResponse {
|
|
2281
2502
|
/**
|
|
2282
2503
|
* Job ID.
|
|
2283
2504
|
*
|
|
@@ -2286,7 +2507,7 @@ interface BulkDeleteCommentResponse {
|
|
|
2286
2507
|
*/
|
|
2287
2508
|
jobId?: string;
|
|
2288
2509
|
}
|
|
2289
|
-
interface BulkModerateDraftContentRequest {
|
|
2510
|
+
export interface BulkModerateDraftContentRequest {
|
|
2290
2511
|
/**
|
|
2291
2512
|
* ID of the app where to moderate the comments.
|
|
2292
2513
|
* @format GUID
|
|
@@ -2297,7 +2518,7 @@ interface BulkModerateDraftContentRequest {
|
|
|
2297
2518
|
/** Action to do regarding draft content */
|
|
2298
2519
|
draftContentAction: Action;
|
|
2299
2520
|
}
|
|
2300
|
-
interface BulkModerateDraftContentResponse {
|
|
2521
|
+
export interface BulkModerateDraftContentResponse {
|
|
2301
2522
|
/**
|
|
2302
2523
|
* Job ID.
|
|
2303
2524
|
*
|
|
@@ -2306,7 +2527,7 @@ interface BulkModerateDraftContentResponse {
|
|
|
2306
2527
|
*/
|
|
2307
2528
|
jobId?: string;
|
|
2308
2529
|
}
|
|
2309
|
-
interface BulkMoveCommentByFilterRequest {
|
|
2530
|
+
export interface BulkMoveCommentByFilterRequest {
|
|
2310
2531
|
/**
|
|
2311
2532
|
* ID of the app from which to move the comments.
|
|
2312
2533
|
* @format GUID
|
|
@@ -2317,7 +2538,7 @@ interface BulkMoveCommentByFilterRequest {
|
|
|
2317
2538
|
/** Where to move the comment. */
|
|
2318
2539
|
destination?: Destination;
|
|
2319
2540
|
}
|
|
2320
|
-
interface Destination {
|
|
2541
|
+
export interface Destination {
|
|
2321
2542
|
/**
|
|
2322
2543
|
* Context ID of where to move the comment to.
|
|
2323
2544
|
* @maxLength 128
|
|
@@ -2329,7 +2550,7 @@ interface Destination {
|
|
|
2329
2550
|
*/
|
|
2330
2551
|
resourceId?: string;
|
|
2331
2552
|
}
|
|
2332
|
-
interface BulkMoveCommentByFilterResponse {
|
|
2553
|
+
export interface BulkMoveCommentByFilterResponse {
|
|
2333
2554
|
/**
|
|
2334
2555
|
* Job ID.
|
|
2335
2556
|
*
|
|
@@ -2338,52 +2559,149 @@ interface BulkMoveCommentByFilterResponse {
|
|
|
2338
2559
|
*/
|
|
2339
2560
|
jobId?: string;
|
|
2340
2561
|
}
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2562
|
+
export interface CommentMoved {
|
|
2563
|
+
comment?: Comment;
|
|
2564
|
+
destination?: Destination;
|
|
2565
|
+
}
|
|
2566
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2567
|
+
createdEvent?: EntityCreatedEvent;
|
|
2568
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2569
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2570
|
+
actionEvent?: ActionEvent;
|
|
2571
|
+
/**
|
|
2572
|
+
* Unique event ID.
|
|
2573
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2574
|
+
*/
|
|
2575
|
+
id?: string;
|
|
2576
|
+
/**
|
|
2577
|
+
* Assumes actions are also always typed to an entity_type
|
|
2578
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2579
|
+
*/
|
|
2580
|
+
entityFqdn?: string;
|
|
2581
|
+
/**
|
|
2582
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2583
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2584
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2585
|
+
*/
|
|
2586
|
+
slug?: string;
|
|
2587
|
+
/** ID of the entity associated with the event. */
|
|
2588
|
+
entityId?: string;
|
|
2589
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2590
|
+
eventTime?: Date | null;
|
|
2591
|
+
/**
|
|
2592
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2593
|
+
* (for example, GDPR).
|
|
2594
|
+
*/
|
|
2595
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2596
|
+
/** If present, indicates the action that triggered the event. */
|
|
2597
|
+
originatedFrom?: string | null;
|
|
2598
|
+
/**
|
|
2599
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2600
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2601
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2602
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2603
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2604
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2605
|
+
*/
|
|
2606
|
+
entityEventSequence?: string | null;
|
|
2607
|
+
}
|
|
2608
|
+
/** @oneof */
|
|
2609
|
+
export interface DomainEventBodyOneOf {
|
|
2610
|
+
createdEvent?: EntityCreatedEvent;
|
|
2611
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2612
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2613
|
+
actionEvent?: ActionEvent;
|
|
2614
|
+
}
|
|
2615
|
+
export interface EntityCreatedEvent {
|
|
2616
|
+
entityAsJson?: string;
|
|
2617
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2618
|
+
restoreInfo?: RestoreInfo;
|
|
2619
|
+
}
|
|
2620
|
+
export interface RestoreInfo {
|
|
2621
|
+
deletedDate?: Date | null;
|
|
2622
|
+
}
|
|
2623
|
+
export interface EntityUpdatedEvent {
|
|
2624
|
+
/**
|
|
2625
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2626
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2627
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2628
|
+
*/
|
|
2629
|
+
currentEntityAsJson?: string;
|
|
2630
|
+
}
|
|
2631
|
+
export interface EntityDeletedEvent {
|
|
2632
|
+
/** Entity that was deleted */
|
|
2633
|
+
deletedEntityAsJson?: string | null;
|
|
2634
|
+
}
|
|
2635
|
+
export interface ActionEvent {
|
|
2636
|
+
bodyAsJson?: string;
|
|
2637
|
+
}
|
|
2638
|
+
export interface MessageEnvelope {
|
|
2639
|
+
/**
|
|
2640
|
+
* App instance ID.
|
|
2641
|
+
* @format GUID
|
|
2642
|
+
*/
|
|
2643
|
+
instanceId?: string | null;
|
|
2644
|
+
/**
|
|
2645
|
+
* Event type.
|
|
2646
|
+
* @maxLength 150
|
|
2647
|
+
*/
|
|
2648
|
+
eventType?: string;
|
|
2649
|
+
/** The identification type and identity data. */
|
|
2650
|
+
identity?: IdentificationData;
|
|
2651
|
+
/** Stringify payload. */
|
|
2652
|
+
data?: string;
|
|
2653
|
+
}
|
|
2654
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2655
|
+
/**
|
|
2656
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2657
|
+
* @format GUID
|
|
2658
|
+
*/
|
|
2659
|
+
anonymousVisitorId?: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* ID of a site visitor that has logged in to the site.
|
|
2662
|
+
* @format GUID
|
|
2663
|
+
*/
|
|
2664
|
+
memberId?: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2667
|
+
* @format GUID
|
|
2668
|
+
*/
|
|
2669
|
+
wixUserId?: string;
|
|
2670
|
+
/**
|
|
2671
|
+
* ID of an app.
|
|
2672
|
+
* @format GUID
|
|
2673
|
+
*/
|
|
2674
|
+
appId?: string;
|
|
2675
|
+
/** @readonly */
|
|
2676
|
+
identityType?: WebhookIdentityType;
|
|
2677
|
+
}
|
|
2678
|
+
/** @oneof */
|
|
2679
|
+
export interface IdentificationDataIdOneOf {
|
|
2680
|
+
/**
|
|
2681
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2682
|
+
* @format GUID
|
|
2683
|
+
*/
|
|
2684
|
+
anonymousVisitorId?: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* ID of a site visitor that has logged in to the site.
|
|
2687
|
+
* @format GUID
|
|
2688
|
+
*/
|
|
2689
|
+
memberId?: string;
|
|
2690
|
+
/**
|
|
2691
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2692
|
+
* @format GUID
|
|
2693
|
+
*/
|
|
2694
|
+
wixUserId?: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* ID of an app.
|
|
2697
|
+
* @format GUID
|
|
2698
|
+
*/
|
|
2699
|
+
appId?: string;
|
|
2700
|
+
}
|
|
2701
|
+
export declare enum WebhookIdentityType {
|
|
2702
|
+
UNKNOWN = "UNKNOWN",
|
|
2703
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2704
|
+
MEMBER = "MEMBER",
|
|
2705
|
+
WIX_USER = "WIX_USER",
|
|
2706
|
+
APP = "APP"
|
|
2707
|
+
}
|