@wix/auto_sdk_comments_comments 1.0.7 → 1.0.9

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.
Files changed (134) hide show
  1. package/build/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-Bt560XJw.d.mts} +556 -736
  2. package/build/{internal/cjs/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-Bt560XJw.d.ts} +556 -736
  3. package/build/index.d.mts +249 -0
  4. package/build/index.d.ts +249 -0
  5. package/build/index.js +5232 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +5145 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/comments-v2-comment-comments.types.d.ts → internal/comments-v2-comment-comments.universal-Bt560XJw.d.mts} +556 -736
  10. package/build/internal/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-Bt560XJw.d.ts} +556 -736
  11. package/build/internal/index.d.mts +249 -0
  12. package/build/internal/index.d.ts +249 -0
  13. package/build/internal/index.js +5232 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +5145 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2389 -0
  18. package/build/internal/meta.d.ts +2389 -0
  19. package/build/internal/meta.js +2832 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +2788 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2389 -0
  24. package/build/meta.d.ts +2389 -0
  25. package/build/meta.js +2832 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +2788 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
  40. package/build/cjs/src/comments-v2-comment-comments.context.js +0 -109
  41. package/build/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
  42. package/build/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
  43. package/build/cjs/src/comments-v2-comment-comments.http.js +0 -2533
  44. package/build/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
  45. package/build/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
  46. package/build/cjs/src/comments-v2-comment-comments.meta.js +0 -370
  47. package/build/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
  48. package/build/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
  49. package/build/cjs/src/comments-v2-comment-comments.public.js +0 -1341
  50. package/build/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
  51. package/build/cjs/src/comments-v2-comment-comments.types.js +0 -385
  52. package/build/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
  53. package/build/cjs/src/comments-v2-comment-comments.universal.d.ts +0 -3629
  54. package/build/cjs/src/comments-v2-comment-comments.universal.js +0 -1598
  55. package/build/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/comments-v2-comment-comments.context.d.ts +0 -68
  67. package/build/es/src/comments-v2-comment-comments.context.js +0 -68
  68. package/build/es/src/comments-v2-comment-comments.context.js.map +0 -1
  69. package/build/es/src/comments-v2-comment-comments.http.d.ts +0 -90
  70. package/build/es/src/comments-v2-comment-comments.http.js +0 -2512
  71. package/build/es/src/comments-v2-comment-comments.http.js.map +0 -1
  72. package/build/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
  73. package/build/es/src/comments-v2-comment-comments.meta.js +0 -326
  74. package/build/es/src/comments-v2-comment-comments.meta.js.map +0 -1
  75. package/build/es/src/comments-v2-comment-comments.public.d.ts +0 -202
  76. package/build/es/src/comments-v2-comment-comments.public.js +0 -1282
  77. package/build/es/src/comments-v2-comment-comments.public.js.map +0 -1
  78. package/build/es/src/comments-v2-comment-comments.types.js +0 -382
  79. package/build/es/src/comments-v2-comment-comments.types.js.map +0 -1
  80. package/build/es/src/comments-v2-comment-comments.universal.d.ts +0 -3629
  81. package/build/es/src/comments-v2-comment-comments.universal.js +0 -1553
  82. package/build/es/src/comments-v2-comment-comments.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
  93. package/build/internal/cjs/src/comments-v2-comment-comments.context.js +0 -109
  94. package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
  95. package/build/internal/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
  96. package/build/internal/cjs/src/comments-v2-comment-comments.http.js +0 -2533
  97. package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
  98. package/build/internal/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
  99. package/build/internal/cjs/src/comments-v2-comment-comments.meta.js +0 -370
  100. package/build/internal/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
  101. package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
  102. package/build/internal/cjs/src/comments-v2-comment-comments.public.js +0 -1341
  103. package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
  104. package/build/internal/cjs/src/comments-v2-comment-comments.types.js +0 -385
  105. package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
  106. package/build/internal/cjs/src/comments-v2-comment-comments.universal.d.ts +0 -3629
  107. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +0 -1598
  108. package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +0 -68
  119. package/build/internal/es/src/comments-v2-comment-comments.context.js +0 -68
  120. package/build/internal/es/src/comments-v2-comment-comments.context.js.map +0 -1
  121. package/build/internal/es/src/comments-v2-comment-comments.http.d.ts +0 -90
  122. package/build/internal/es/src/comments-v2-comment-comments.http.js +0 -2512
  123. package/build/internal/es/src/comments-v2-comment-comments.http.js.map +0 -1
  124. package/build/internal/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
  125. package/build/internal/es/src/comments-v2-comment-comments.meta.js +0 -326
  126. package/build/internal/es/src/comments-v2-comment-comments.meta.js.map +0 -1
  127. package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +0 -202
  128. package/build/internal/es/src/comments-v2-comment-comments.public.js +0 -1282
  129. package/build/internal/es/src/comments-v2-comment-comments.public.js.map +0 -1
  130. package/build/internal/es/src/comments-v2-comment-comments.types.js +0 -382
  131. package/build/internal/es/src/comments-v2-comment-comments.types.js.map +0 -1
  132. package/build/internal/es/src/comments-v2-comment-comments.universal.d.ts +0 -3629
  133. package/build/internal/es/src/comments-v2-comment-comments.universal.js +0 -1553
  134. package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +0 -1
@@ -0,0 +1,2389 @@
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.js';
2
+
3
+ /**
4
+ * A comment is a user-generated message in response to a specific resource. It allows site visitors
5
+ * to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
6
+ * or other site content. Comments are composed of text, images, videos, or other forms of media.
7
+ */
8
+ interface Comment {
9
+ /**
10
+ * Comment ID.
11
+ * @format GUID
12
+ * @readonly
13
+ */
14
+ id?: string | null;
15
+ /**
16
+ * Revision number, which increments by 1 each time the comment is updated.
17
+ *
18
+ * To prevent conflicting changes, the current `revision` must be passed when updating the comment.
19
+ * @readonly
20
+ */
21
+ revision?: string | null;
22
+ /**
23
+ * Date and time the comment was created.
24
+ *
25
+ * **Note:** This is the date from the system database, not the actual date when the comment was created. For example, if you migrate comments created in 2016, the `createdDate` field will show the current year. For the actual creation date, see the `commentDate` field.
26
+ * @readonly
27
+ */
28
+ createdDate?: Date | null;
29
+ /**
30
+ * Date and time the comment was last updated.
31
+ * @readonly
32
+ */
33
+ updatedDate?: Date | null;
34
+ /**
35
+ * ID of the app that the comment is added to.
36
+ * @format GUID
37
+ * @immutable
38
+ */
39
+ appId?: string | null;
40
+ /**
41
+ * ID of the specific context the comment is in response to.
42
+ *
43
+ * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
44
+ * the `forumPostId` is used as both the `contextId` and the `resourceId`.
45
+ * @immutable
46
+ * @maxLength 128
47
+ */
48
+ contextId?: string | null;
49
+ /**
50
+ * ID of the specific resource that the comment is in response to.
51
+ *
52
+ * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
53
+ * the `forumPostId` is used as both the `resourceId` and the `contextId`.
54
+ * @immutable
55
+ * @maxLength 128
56
+ */
57
+ resourceId?: string | null;
58
+ /** Published comment content. */
59
+ content?: CommentContent;
60
+ /**
61
+ * Comment's author.
62
+ * @immutable
63
+ */
64
+ author?: CommentAuthor;
65
+ /**
66
+ * Parent comment information.
67
+ *
68
+ * Only present if this comment is in a direct reply to another comment.
69
+ * See **Terminology** in the Comments introduction
70
+ * for more information about parent comments.
71
+ */
72
+ parentComment?: ParentComment;
73
+ /**
74
+ * Number of comments that reply to this comment.
75
+ * @readonly
76
+ */
77
+ replyCount?: number;
78
+ /**
79
+ * Summary of votes.
80
+ * @readonly
81
+ */
82
+ voteSummary?: VoteSummary;
83
+ /**
84
+ * Comment status.
85
+ * @readonly
86
+ */
87
+ status?: Status;
88
+ /**
89
+ * Comment rating.
90
+ * @readonly
91
+ */
92
+ rating?: number | null;
93
+ /**
94
+ * Summary of reactions.
95
+ * @readonly
96
+ */
97
+ reactionSummary?: CommentReactionSummary;
98
+ /** Whether the comment is marked. */
99
+ marked?: boolean;
100
+ /**
101
+ * Date and time when the comment was actually created.
102
+ * @immutable
103
+ */
104
+ commentDate?: Date | null;
105
+ /**
106
+ * Whether the comment has the updated content.
107
+ * @readonly
108
+ */
109
+ contentEdited?: boolean | null;
110
+ }
111
+ /** Comment content. */
112
+ interface CommentContent {
113
+ /**
114
+ * Comment rich content.
115
+ *
116
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" exampleid="5693ba57-d141-42bf-a0d6-1eb11c73bddf" plugins="emoji.heading.indent.lineSpacing.actionButton.audio.codeBlock.collapsibleList.divider.file.gallery.giphy.hashtag.html.image.link.linkButton.linkPreview.mentions.poll.spoiler.table.textColor.textHighlight.verticalEmbed.video">
117
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
118
+ * </widget>
119
+ */
120
+ richContent?: RichContent;
121
+ /**
122
+ * People to tag with this comment.
123
+ *
124
+ * People can include users, members, visitors, or groups.
125
+ * @maxSize 10
126
+ */
127
+ mentions?: Mention[];
128
+ /**
129
+ * Content attachments.
130
+ * @maxSize 10
131
+ */
132
+ attachments?: Attachment[];
133
+ }
134
+ interface RichContent {
135
+ /** Node objects representing a rich content document. */
136
+ nodes?: Node[];
137
+ /** Object metadata. */
138
+ metadata?: Metadata;
139
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
140
+ documentStyle?: DocumentStyle;
141
+ }
142
+ interface Node extends NodeDataOneOf {
143
+ /** Data for a button node. */
144
+ buttonData?: ButtonData;
145
+ /** Data for a code block node. */
146
+ codeBlockData?: CodeBlockData;
147
+ /** Data for a divider node. */
148
+ dividerData?: DividerData;
149
+ /** Data for a file node. */
150
+ fileData?: FileData;
151
+ /** Data for a gallery node. */
152
+ galleryData?: GalleryData;
153
+ /** Data for a GIF node. */
154
+ gifData?: GIFData;
155
+ /** Data for a heading node. */
156
+ headingData?: HeadingData;
157
+ /** Data for an embedded HTML node. */
158
+ htmlData?: HTMLData;
159
+ /** Data for an image node. */
160
+ imageData?: ImageData;
161
+ /** Data for a link preview node. */
162
+ linkPreviewData?: LinkPreviewData;
163
+ /** @deprecated */
164
+ mapData?: MapData;
165
+ /** Data for a paragraph node. */
166
+ paragraphData?: ParagraphData;
167
+ /** Data for a poll node. */
168
+ pollData?: PollData;
169
+ /** Data for a text node. Used to apply decorations to text. */
170
+ textData?: TextData;
171
+ /** Data for an app embed node. */
172
+ appEmbedData?: AppEmbedData;
173
+ /** Data for a video node. */
174
+ videoData?: VideoData;
175
+ /** Data for an oEmbed node. */
176
+ embedData?: EmbedData;
177
+ /** Data for a collapsible list node. */
178
+ collapsibleListData?: CollapsibleListData;
179
+ /** Data for a table node. */
180
+ tableData?: TableData;
181
+ /** Data for a table cell node. */
182
+ tableCellData?: TableCellData;
183
+ /** Data for a custom external node. */
184
+ externalData?: Record<string, any> | null;
185
+ /** Data for an audio node. */
186
+ audioData?: AudioData;
187
+ /** Data for an ordered list node. */
188
+ orderedListData?: OrderedListData;
189
+ /** Data for a bulleted list node. */
190
+ bulletedListData?: BulletedListData;
191
+ /** Data for a block quote node. */
192
+ blockquoteData?: BlockquoteData;
193
+ /** Data for a caption node. */
194
+ captionData?: CaptionData;
195
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
196
+ layoutCellData?: LayoutCellData;
197
+ /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
198
+ type?: NodeType;
199
+ /** Node ID. */
200
+ id?: string;
201
+ /** A list of child nodes. */
202
+ nodes?: Node[];
203
+ /** Padding and background color styling for the node. */
204
+ style?: NodeStyle;
205
+ }
206
+ /** @oneof */
207
+ interface NodeDataOneOf {
208
+ /** Data for a button node. */
209
+ buttonData?: ButtonData;
210
+ /** Data for a code block node. */
211
+ codeBlockData?: CodeBlockData;
212
+ /** Data for a divider node. */
213
+ dividerData?: DividerData;
214
+ /** Data for a file node. */
215
+ fileData?: FileData;
216
+ /** Data for a gallery node. */
217
+ galleryData?: GalleryData;
218
+ /** Data for a GIF node. */
219
+ gifData?: GIFData;
220
+ /** Data for a heading node. */
221
+ headingData?: HeadingData;
222
+ /** Data for an embedded HTML node. */
223
+ htmlData?: HTMLData;
224
+ /** Data for an image node. */
225
+ imageData?: ImageData;
226
+ /** Data for a link preview node. */
227
+ linkPreviewData?: LinkPreviewData;
228
+ /** @deprecated */
229
+ mapData?: MapData;
230
+ /** Data for a paragraph node. */
231
+ paragraphData?: ParagraphData;
232
+ /** Data for a poll node. */
233
+ pollData?: PollData;
234
+ /** Data for a text node. Used to apply decorations to text. */
235
+ textData?: TextData;
236
+ /** Data for an app embed node. */
237
+ appEmbedData?: AppEmbedData;
238
+ /** Data for a video node. */
239
+ videoData?: VideoData;
240
+ /** Data for an oEmbed node. */
241
+ embedData?: EmbedData;
242
+ /** Data for a collapsible list node. */
243
+ collapsibleListData?: CollapsibleListData;
244
+ /** Data for a table node. */
245
+ tableData?: TableData;
246
+ /** Data for a table cell node. */
247
+ tableCellData?: TableCellData;
248
+ /** Data for a custom external node. */
249
+ externalData?: Record<string, any> | null;
250
+ /** Data for an audio node. */
251
+ audioData?: AudioData;
252
+ /** Data for an ordered list node. */
253
+ orderedListData?: OrderedListData;
254
+ /** Data for a bulleted list node. */
255
+ bulletedListData?: BulletedListData;
256
+ /** Data for a block quote node. */
257
+ blockquoteData?: BlockquoteData;
258
+ /** Data for a caption node. */
259
+ captionData?: CaptionData;
260
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
261
+ layoutCellData?: LayoutCellData;
262
+ }
263
+ declare enum NodeType {
264
+ PARAGRAPH = "PARAGRAPH",
265
+ TEXT = "TEXT",
266
+ HEADING = "HEADING",
267
+ BULLETED_LIST = "BULLETED_LIST",
268
+ ORDERED_LIST = "ORDERED_LIST",
269
+ LIST_ITEM = "LIST_ITEM",
270
+ BLOCKQUOTE = "BLOCKQUOTE",
271
+ CODE_BLOCK = "CODE_BLOCK",
272
+ VIDEO = "VIDEO",
273
+ DIVIDER = "DIVIDER",
274
+ FILE = "FILE",
275
+ GALLERY = "GALLERY",
276
+ GIF = "GIF",
277
+ HTML = "HTML",
278
+ IMAGE = "IMAGE",
279
+ LINK_PREVIEW = "LINK_PREVIEW",
280
+ /** @deprecated */
281
+ MAP = "MAP",
282
+ POLL = "POLL",
283
+ APP_EMBED = "APP_EMBED",
284
+ BUTTON = "BUTTON",
285
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
286
+ TABLE = "TABLE",
287
+ EMBED = "EMBED",
288
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
289
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
290
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
291
+ TABLE_CELL = "TABLE_CELL",
292
+ TABLE_ROW = "TABLE_ROW",
293
+ EXTERNAL = "EXTERNAL",
294
+ AUDIO = "AUDIO",
295
+ CAPTION = "CAPTION",
296
+ LAYOUT = "LAYOUT",
297
+ LAYOUT_CELL = "LAYOUT_CELL"
298
+ }
299
+ interface NodeStyle {
300
+ /** The top padding value in pixels. */
301
+ paddingTop?: string | null;
302
+ /** The bottom padding value in pixels. */
303
+ paddingBottom?: string | null;
304
+ /** The background color as a hexadecimal value. */
305
+ backgroundColor?: string | null;
306
+ }
307
+ interface ButtonData {
308
+ /** Styling for the button's container. */
309
+ containerData?: PluginContainerData;
310
+ /** The button type. */
311
+ type?: Type;
312
+ /** Styling for the button. */
313
+ styles?: Styles;
314
+ /** The text to display on the button. */
315
+ text?: string | null;
316
+ /** Button link details. */
317
+ link?: Link;
318
+ }
319
+ interface Border {
320
+ /**
321
+ * Deprecated: Use `borderWidth` in `styles` instead.
322
+ * @deprecated
323
+ */
324
+ width?: number | null;
325
+ /**
326
+ * Deprecated: Use `borderRadius` in `styles` instead.
327
+ * @deprecated
328
+ */
329
+ radius?: number | null;
330
+ }
331
+ interface Colors {
332
+ /**
333
+ * Deprecated: Use `textColor` in `styles` instead.
334
+ * @deprecated
335
+ */
336
+ text?: string | null;
337
+ /**
338
+ * Deprecated: Use `borderColor` in `styles` instead.
339
+ * @deprecated
340
+ */
341
+ border?: string | null;
342
+ /**
343
+ * Deprecated: Use `backgroundColor` in `styles` instead.
344
+ * @deprecated
345
+ */
346
+ background?: string | null;
347
+ }
348
+ interface PluginContainerData {
349
+ /** The width of the node when it's displayed. */
350
+ width?: PluginContainerDataWidth;
351
+ /** The node's alignment within its container. */
352
+ alignment?: PluginContainerDataAlignment;
353
+ /** Spoiler cover settings for the node. */
354
+ spoiler?: Spoiler;
355
+ /** The height of the node when it's displayed. */
356
+ height?: Height;
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`. */
358
+ textWrap?: boolean | null;
359
+ }
360
+ declare enum WidthType {
361
+ /** Width matches the content width */
362
+ CONTENT = "CONTENT",
363
+ /** Small Width */
364
+ SMALL = "SMALL",
365
+ /** Width will match the original asset width */
366
+ ORIGINAL = "ORIGINAL",
367
+ /** coast-to-coast display */
368
+ FULL_WIDTH = "FULL_WIDTH"
369
+ }
370
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
371
+ /**
372
+ * One of the following predefined width options:
373
+ * `CONTENT`: The width of the container matches the content width.
374
+ * `SMALL`: A small width.
375
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
376
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
377
+ */
378
+ size?: WidthType;
379
+ /** A custom width value in pixels. */
380
+ custom?: string | null;
381
+ }
382
+ /** @oneof */
383
+ interface PluginContainerDataWidthDataOneOf {
384
+ /**
385
+ * One of the following predefined width options:
386
+ * `CONTENT`: The width of the container matches the content width.
387
+ * `SMALL`: A small width.
388
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
389
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
390
+ */
391
+ size?: WidthType;
392
+ /** A custom width value in pixels. */
393
+ custom?: string | null;
394
+ }
395
+ declare enum PluginContainerDataAlignment {
396
+ /** Center Alignment */
397
+ CENTER = "CENTER",
398
+ /** Left Alignment */
399
+ LEFT = "LEFT",
400
+ /** Right Alignment */
401
+ RIGHT = "RIGHT"
402
+ }
403
+ interface Spoiler {
404
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
405
+ enabled?: boolean | null;
406
+ /** The description displayed on top of the spoiler cover. */
407
+ description?: string | null;
408
+ /** The text for the button used to remove the spoiler cover. */
409
+ buttonText?: string | null;
410
+ }
411
+ interface Height {
412
+ /** A custom height value in pixels. */
413
+ custom?: string | null;
414
+ }
415
+ declare enum Type {
416
+ /** Regular link button */
417
+ LINK = "LINK",
418
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
419
+ ACTION = "ACTION"
420
+ }
421
+ interface Styles {
422
+ /**
423
+ * Deprecated: Use `borderWidth` and `borderRadius` instead.
424
+ * @deprecated
425
+ */
426
+ border?: Border;
427
+ /**
428
+ * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
429
+ * @deprecated
430
+ */
431
+ colors?: Colors;
432
+ /** Border width in pixels. */
433
+ borderWidth?: number | null;
434
+ /**
435
+ * Deprecated: Use `borderWidth` for normal/hover states instead.
436
+ * @deprecated
437
+ */
438
+ borderWidthHover?: number | null;
439
+ /** Border radius in pixels. */
440
+ borderRadius?: number | null;
441
+ /**
442
+ * Border color as a hexadecimal value.
443
+ * @format COLOR_HEX
444
+ */
445
+ borderColor?: string | null;
446
+ /**
447
+ * Border color as a hexadecimal value (hover state).
448
+ * @format COLOR_HEX
449
+ */
450
+ borderColorHover?: string | null;
451
+ /**
452
+ * Text color as a hexadecimal value.
453
+ * @format COLOR_HEX
454
+ */
455
+ textColor?: string | null;
456
+ /**
457
+ * Text color as a hexadecimal value (hover state).
458
+ * @format COLOR_HEX
459
+ */
460
+ textColorHover?: string | null;
461
+ /**
462
+ * Background color as a hexadecimal value.
463
+ * @format COLOR_HEX
464
+ */
465
+ backgroundColor?: string | null;
466
+ /**
467
+ * Background color as a hexadecimal value (hover state).
468
+ * @format COLOR_HEX
469
+ */
470
+ backgroundColorHover?: string | null;
471
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
472
+ buttonSize?: string | null;
473
+ }
474
+ interface Link extends LinkDataOneOf {
475
+ /** The absolute URL for the linked document. */
476
+ url?: string;
477
+ /** The target node's ID. Used for linking to another node in this object. */
478
+ anchor?: string;
479
+ /**
480
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
481
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
482
+ * `BLANK` - Opens the linked document in a new browser tab or window.
483
+ * `PARENT` - Opens the linked document in the link's parent frame.
484
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
485
+ */
486
+ target?: Target;
487
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
488
+ rel?: Rel;
489
+ /** A serialized object used for a custom or external link panel. */
490
+ customData?: string | null;
491
+ }
492
+ /** @oneof */
493
+ interface LinkDataOneOf {
494
+ /** The absolute URL for the linked document. */
495
+ url?: string;
496
+ /** The target node's ID. Used for linking to another node in this object. */
497
+ anchor?: string;
498
+ }
499
+ declare enum Target {
500
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
501
+ SELF = "SELF",
502
+ /** Opens the linked document in a new window or tab */
503
+ BLANK = "BLANK",
504
+ /** Opens the linked document in the parent frame */
505
+ PARENT = "PARENT",
506
+ /** Opens the linked document in the full body of the window */
507
+ TOP = "TOP"
508
+ }
509
+ interface Rel {
510
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
511
+ nofollow?: boolean | null;
512
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
513
+ sponsored?: boolean | null;
514
+ /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
515
+ ugc?: boolean | null;
516
+ /** Indicates that this link protect referral information from being passed to the target website. */
517
+ noreferrer?: boolean | null;
518
+ }
519
+ interface CodeBlockData {
520
+ /** Styling for the code block's text. */
521
+ textStyle?: TextStyle;
522
+ }
523
+ interface TextStyle {
524
+ /** Text alignment. Defaults to `AUTO`. */
525
+ textAlignment?: TextAlignment;
526
+ /** 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
+ lineHeight?: string | null;
528
+ }
529
+ declare enum TextAlignment {
530
+ /** browser default, eqivalent to `initial` */
531
+ AUTO = "AUTO",
532
+ /** Left align */
533
+ LEFT = "LEFT",
534
+ /** Right align */
535
+ RIGHT = "RIGHT",
536
+ /** Center align */
537
+ CENTER = "CENTER",
538
+ /** 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
+ JUSTIFY = "JUSTIFY"
540
+ }
541
+ interface DividerData {
542
+ /** Styling for the divider's container. */
543
+ containerData?: PluginContainerData;
544
+ /** Divider line style. */
545
+ lineStyle?: LineStyle;
546
+ /** Divider width. */
547
+ width?: Width;
548
+ /** Divider alignment. */
549
+ alignment?: Alignment;
550
+ }
551
+ declare enum LineStyle {
552
+ /** Single Line */
553
+ SINGLE = "SINGLE",
554
+ /** Double Line */
555
+ DOUBLE = "DOUBLE",
556
+ /** Dashed Line */
557
+ DASHED = "DASHED",
558
+ /** Dotted Line */
559
+ DOTTED = "DOTTED"
560
+ }
561
+ declare enum Width {
562
+ /** Large line */
563
+ LARGE = "LARGE",
564
+ /** Medium line */
565
+ MEDIUM = "MEDIUM",
566
+ /** Small line */
567
+ SMALL = "SMALL"
568
+ }
569
+ declare enum Alignment {
570
+ /** Center alignment */
571
+ CENTER = "CENTER",
572
+ /** Left alignment */
573
+ LEFT = "LEFT",
574
+ /** Right alignment */
575
+ RIGHT = "RIGHT"
576
+ }
577
+ interface FileData {
578
+ /** Styling for the file's container. */
579
+ containerData?: PluginContainerData;
580
+ /** The source for the file's data. */
581
+ src?: FileSource;
582
+ /** File name. */
583
+ name?: string | null;
584
+ /** File type. */
585
+ type?: string | null;
586
+ /**
587
+ * Use `sizeInKb` instead.
588
+ * @deprecated
589
+ */
590
+ size?: number | null;
591
+ /** Settings for PDF files. */
592
+ pdfSettings?: PDFSettings;
593
+ /** File MIME type. */
594
+ mimeType?: string | null;
595
+ /** File path. */
596
+ path?: string | null;
597
+ /** File size in KB. */
598
+ sizeInKb?: string | null;
599
+ }
600
+ declare enum ViewMode {
601
+ /** No PDF view */
602
+ NONE = "NONE",
603
+ /** Full PDF view */
604
+ FULL = "FULL",
605
+ /** Mini PDF view */
606
+ MINI = "MINI"
607
+ }
608
+ interface FileSource extends FileSourceDataOneOf {
609
+ /** The absolute URL for the file's source. */
610
+ url?: string | null;
611
+ /**
612
+ * Custom ID. Use `id` instead.
613
+ * @deprecated
614
+ */
615
+ custom?: string | null;
616
+ /** An ID that's resolved to a URL by a resolver function. */
617
+ id?: string | null;
618
+ /** Indicates whether the file's source is private. Defaults to `false`. */
619
+ private?: boolean | null;
620
+ }
621
+ /** @oneof */
622
+ interface FileSourceDataOneOf {
623
+ /** The absolute URL for the file's source. */
624
+ url?: string | null;
625
+ /**
626
+ * Custom ID. Use `id` instead.
627
+ * @deprecated
628
+ */
629
+ custom?: string | null;
630
+ /** An ID that's resolved to a URL by a resolver function. */
631
+ id?: string | null;
632
+ }
633
+ interface PDFSettings {
634
+ /**
635
+ * PDF view mode. One of the following:
636
+ * `NONE` : The PDF isn't displayed.
637
+ * `FULL` : A full page view of the PDF is displayed.
638
+ * `MINI` : A mini view of the PDF is displayed.
639
+ */
640
+ viewMode?: ViewMode;
641
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
642
+ disableDownload?: boolean | null;
643
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
644
+ disablePrint?: boolean | null;
645
+ }
646
+ interface GalleryData {
647
+ /** Styling for the gallery's container. */
648
+ containerData?: PluginContainerData;
649
+ /** The items in the gallery. */
650
+ items?: Item[];
651
+ /** Options for defining the gallery's appearance. */
652
+ options?: GalleryOptions;
653
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
654
+ disableExpand?: boolean | null;
655
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
656
+ disableDownload?: boolean | null;
657
+ }
658
+ interface Media {
659
+ /** The source for the media's data. */
660
+ src?: FileSource;
661
+ /** Media width in pixels. */
662
+ width?: number | null;
663
+ /** Media height in pixels. */
664
+ height?: number | null;
665
+ /** Media duration in seconds. Only relevant for audio and video files. */
666
+ duration?: number | null;
667
+ }
668
+ interface ItemImage {
669
+ /** Image file details. */
670
+ media?: Media;
671
+ /** Link details for images that are links. */
672
+ link?: Link;
673
+ }
674
+ interface Video {
675
+ /** Video file details. */
676
+ media?: Media;
677
+ /** Video thumbnail file details. */
678
+ thumbnail?: Media;
679
+ }
680
+ interface Item extends ItemDataOneOf {
681
+ /** An image item. */
682
+ image?: ItemImage;
683
+ /** A video item. */
684
+ video?: Video;
685
+ /** Item title. */
686
+ title?: string | null;
687
+ /** Item's alternative text. */
688
+ altText?: string | null;
689
+ }
690
+ /** @oneof */
691
+ interface ItemDataOneOf {
692
+ /** An image item. */
693
+ image?: ItemImage;
694
+ /** A video item. */
695
+ video?: Video;
696
+ }
697
+ interface GalleryOptions {
698
+ /** Gallery layout. */
699
+ layout?: Layout;
700
+ /** Styling for gallery items. */
701
+ item?: ItemStyle;
702
+ /** Styling for gallery thumbnail images. */
703
+ thumbnails?: Thumbnails;
704
+ }
705
+ declare enum LayoutType {
706
+ /** Collage type */
707
+ COLLAGE = "COLLAGE",
708
+ /** Masonry type */
709
+ MASONRY = "MASONRY",
710
+ /** Grid type */
711
+ GRID = "GRID",
712
+ /** Thumbnail type */
713
+ THUMBNAIL = "THUMBNAIL",
714
+ /** Slider type */
715
+ SLIDER = "SLIDER",
716
+ /** Slideshow type */
717
+ SLIDESHOW = "SLIDESHOW",
718
+ /** Panorama type */
719
+ PANORAMA = "PANORAMA",
720
+ /** Column type */
721
+ COLUMN = "COLUMN",
722
+ /** Magic type */
723
+ MAGIC = "MAGIC",
724
+ /** Fullsize images type */
725
+ FULLSIZE = "FULLSIZE"
726
+ }
727
+ declare enum Orientation {
728
+ /** Rows Orientation */
729
+ ROWS = "ROWS",
730
+ /** Columns Orientation */
731
+ COLUMNS = "COLUMNS"
732
+ }
733
+ declare enum Crop {
734
+ /** Crop to fill */
735
+ FILL = "FILL",
736
+ /** Crop to fit */
737
+ FIT = "FIT"
738
+ }
739
+ declare enum ThumbnailsAlignment {
740
+ /** Top alignment */
741
+ TOP = "TOP",
742
+ /** Right alignment */
743
+ RIGHT = "RIGHT",
744
+ /** Bottom alignment */
745
+ BOTTOM = "BOTTOM",
746
+ /** Left alignment */
747
+ LEFT = "LEFT",
748
+ /** No thumbnail */
749
+ NONE = "NONE"
750
+ }
751
+ interface Layout {
752
+ /** Gallery layout type. */
753
+ type?: LayoutType;
754
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
755
+ horizontalScroll?: boolean | null;
756
+ /** Gallery orientation. */
757
+ orientation?: Orientation;
758
+ /** The number of columns to display on full size screens. */
759
+ numberOfColumns?: number | null;
760
+ /** The number of columns to display on mobile screens. */
761
+ mobileNumberOfColumns?: number | null;
762
+ }
763
+ interface ItemStyle {
764
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
765
+ targetSize?: number | null;
766
+ /** Item ratio */
767
+ ratio?: number | null;
768
+ /** Sets how item images are cropped. */
769
+ crop?: Crop;
770
+ /** The spacing between items in pixels. */
771
+ spacing?: number | null;
772
+ }
773
+ interface Thumbnails {
774
+ /** Thumbnail alignment. */
775
+ placement?: ThumbnailsAlignment;
776
+ /** Spacing between thumbnails in pixels. */
777
+ spacing?: number | null;
778
+ }
779
+ interface GIFData {
780
+ /** Styling for the GIF's container. */
781
+ containerData?: PluginContainerData;
782
+ /** The source of the full size GIF. */
783
+ original?: GIF;
784
+ /** The source of the downsized GIF. */
785
+ downsized?: GIF;
786
+ /** Height in pixels. */
787
+ height?: number;
788
+ /** Width in pixels. */
789
+ width?: number;
790
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
791
+ gifType?: GIFType;
792
+ }
793
+ interface GIF {
794
+ /**
795
+ * GIF format URL.
796
+ * @format WEB_URL
797
+ */
798
+ gif?: string | null;
799
+ /**
800
+ * MP4 format URL.
801
+ * @format WEB_URL
802
+ */
803
+ mp4?: string | null;
804
+ /**
805
+ * Thumbnail URL.
806
+ * @format WEB_URL
807
+ */
808
+ still?: string | null;
809
+ }
810
+ declare enum GIFType {
811
+ NORMAL = "NORMAL",
812
+ STICKER = "STICKER"
813
+ }
814
+ interface HeadingData {
815
+ /** Heading level from 1-6. */
816
+ level?: number;
817
+ /** Styling for the heading text. */
818
+ textStyle?: TextStyle;
819
+ /** Indentation level from 1-4. */
820
+ indentation?: number | null;
821
+ }
822
+ interface HTMLData extends HTMLDataDataOneOf {
823
+ /** The URL for the HTML code for the node. */
824
+ url?: string;
825
+ /** The HTML code for the node. */
826
+ html?: string;
827
+ /**
828
+ * Whether this is an AdSense element. Use `source` instead.
829
+ * @deprecated
830
+ */
831
+ isAdsense?: boolean | null;
832
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
833
+ containerData?: PluginContainerData;
834
+ /** The type of HTML code. */
835
+ source?: Source;
836
+ /** If container height is aligned with its content height. Defaults to `true`. */
837
+ autoHeight?: boolean | null;
838
+ }
839
+ /** @oneof */
840
+ interface HTMLDataDataOneOf {
841
+ /** The URL for the HTML code for the node. */
842
+ url?: string;
843
+ /** The HTML code for the node. */
844
+ html?: string;
845
+ /**
846
+ * Whether this is an AdSense element. Use `source` instead.
847
+ * @deprecated
848
+ */
849
+ isAdsense?: boolean | null;
850
+ }
851
+ declare enum Source {
852
+ HTML = "HTML",
853
+ ADSENSE = "ADSENSE"
854
+ }
855
+ interface ImageData {
856
+ /** Styling for the image's container. */
857
+ containerData?: PluginContainerData;
858
+ /** Image file details. */
859
+ image?: Media;
860
+ /** Link details for images that are links. */
861
+ link?: Link;
862
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
863
+ disableExpand?: boolean | null;
864
+ /** Image's alternative text. */
865
+ altText?: string | null;
866
+ /**
867
+ * Deprecated: use Caption node instead.
868
+ * @deprecated
869
+ */
870
+ caption?: string | null;
871
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
872
+ disableDownload?: boolean | null;
873
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
874
+ decorative?: boolean | null;
875
+ /** Styling for the image. */
876
+ styles?: ImageDataStyles;
877
+ }
878
+ interface StylesBorder {
879
+ /** Border width in pixels. */
880
+ width?: number | null;
881
+ /**
882
+ * Border color as a hexadecimal value.
883
+ * @format COLOR_HEX
884
+ */
885
+ color?: string | null;
886
+ /** Border radius in pixels. */
887
+ radius?: number | null;
888
+ }
889
+ interface ImageDataStyles {
890
+ /** Border attributes. */
891
+ border?: StylesBorder;
892
+ }
893
+ interface LinkPreviewData {
894
+ /** Styling for the link preview's container. */
895
+ containerData?: PluginContainerData;
896
+ /** Link details. */
897
+ link?: Link;
898
+ /** Preview title. */
899
+ title?: string | null;
900
+ /** Preview thumbnail URL. */
901
+ thumbnailUrl?: string | null;
902
+ /** Preview description. */
903
+ description?: string | null;
904
+ /** The preview content as HTML. */
905
+ html?: string | null;
906
+ /** Styling for the link preview. */
907
+ styles?: LinkPreviewDataStyles;
908
+ }
909
+ declare enum Position {
910
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
911
+ START = "START",
912
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
913
+ END = "END",
914
+ /** Thumbnail positioned at the top */
915
+ TOP = "TOP",
916
+ /** Thumbnail hidden and not displayed */
917
+ HIDDEN = "HIDDEN"
918
+ }
919
+ interface LinkPreviewDataStyles {
920
+ /**
921
+ * Background color as a hexadecimal value.
922
+ * @format COLOR_HEX
923
+ */
924
+ backgroundColor?: string | null;
925
+ /**
926
+ * Title color as a hexadecimal value.
927
+ * @format COLOR_HEX
928
+ */
929
+ titleColor?: string | null;
930
+ /**
931
+ * Subtitle color as a hexadecimal value.
932
+ * @format COLOR_HEX
933
+ */
934
+ subtitleColor?: string | null;
935
+ /**
936
+ * Link color as a hexadecimal value.
937
+ * @format COLOR_HEX
938
+ */
939
+ linkColor?: string | null;
940
+ /** Border width in pixels. */
941
+ borderWidth?: number | null;
942
+ /** Border radius in pixels. */
943
+ borderRadius?: number | null;
944
+ /**
945
+ * Border color as a hexadecimal value.
946
+ * @format COLOR_HEX
947
+ */
948
+ borderColor?: string | null;
949
+ /** Position of thumbnail. Defaults to `START`. */
950
+ thumbnailPosition?: Position;
951
+ }
952
+ interface MapData {
953
+ /** Styling for the map's container. */
954
+ containerData?: PluginContainerData;
955
+ /** Map settings. */
956
+ mapSettings?: MapSettings;
957
+ }
958
+ interface MapSettings {
959
+ /** The address to display on the map. */
960
+ address?: string | null;
961
+ /** Sets whether the map is draggable. */
962
+ draggable?: boolean | null;
963
+ /** Sets whether the location marker is visible. */
964
+ marker?: boolean | null;
965
+ /** Sets whether street view control is enabled. */
966
+ streetViewControl?: boolean | null;
967
+ /** Sets whether zoom control is enabled. */
968
+ zoomControl?: boolean | null;
969
+ /** Location latitude. */
970
+ lat?: number | null;
971
+ /** Location longitude. */
972
+ lng?: number | null;
973
+ /** Location name. */
974
+ locationName?: string | null;
975
+ /** Sets whether view mode control is enabled. */
976
+ viewModeControl?: boolean | null;
977
+ /** Initial zoom value. */
978
+ initialZoom?: number | null;
979
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
980
+ mapType?: MapType;
981
+ }
982
+ declare enum MapType {
983
+ /** Roadmap map type */
984
+ ROADMAP = "ROADMAP",
985
+ /** Satellite map type */
986
+ SATELITE = "SATELITE",
987
+ /** Hybrid map type */
988
+ HYBRID = "HYBRID",
989
+ /** Terrain map type */
990
+ TERRAIN = "TERRAIN"
991
+ }
992
+ interface ParagraphData {
993
+ /** Styling for the paragraph text. */
994
+ textStyle?: TextStyle;
995
+ /** Indentation level from 1-4. */
996
+ indentation?: number | null;
997
+ /** Paragraph level */
998
+ level?: number | null;
999
+ }
1000
+ interface PollData {
1001
+ /** Styling for the poll's container. */
1002
+ containerData?: PluginContainerData;
1003
+ /** Poll data. */
1004
+ poll?: Poll;
1005
+ /** Layout settings for the poll and voting options. */
1006
+ layout?: PollDataLayout;
1007
+ /** Styling for the poll and voting options. */
1008
+ design?: Design;
1009
+ }
1010
+ declare enum ViewRole {
1011
+ /** Only Poll creator can view the results */
1012
+ CREATOR = "CREATOR",
1013
+ /** Anyone who voted can see the results */
1014
+ VOTERS = "VOTERS",
1015
+ /** Anyone can see the results, even if one didn't vote */
1016
+ EVERYONE = "EVERYONE"
1017
+ }
1018
+ declare enum VoteRole {
1019
+ /** Logged in member */
1020
+ SITE_MEMBERS = "SITE_MEMBERS",
1021
+ /** Anyone */
1022
+ ALL = "ALL"
1023
+ }
1024
+ interface Permissions {
1025
+ /** Sets who can view the poll results. */
1026
+ view?: ViewRole;
1027
+ /** Sets who can vote. */
1028
+ vote?: VoteRole;
1029
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1030
+ allowMultipleVotes?: boolean | null;
1031
+ }
1032
+ interface Option {
1033
+ /** Option ID. */
1034
+ id?: string | null;
1035
+ /** Option title. */
1036
+ title?: string | null;
1037
+ /** The image displayed with the option. */
1038
+ image?: Media;
1039
+ }
1040
+ interface Settings {
1041
+ /** Permissions settings for voting. */
1042
+ permissions?: Permissions;
1043
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1044
+ showVoters?: boolean | null;
1045
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
1046
+ showVotesCount?: boolean | null;
1047
+ }
1048
+ declare enum PollLayoutType {
1049
+ /** List */
1050
+ LIST = "LIST",
1051
+ /** Grid */
1052
+ GRID = "GRID"
1053
+ }
1054
+ declare enum PollLayoutDirection {
1055
+ /** Left-to-right */
1056
+ LTR = "LTR",
1057
+ /** Right-to-left */
1058
+ RTL = "RTL"
1059
+ }
1060
+ interface PollLayout {
1061
+ /** The layout for displaying the voting options. */
1062
+ type?: PollLayoutType;
1063
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1064
+ direction?: PollLayoutDirection;
1065
+ /** Sets whether to display the main poll image. Defaults to `false`. */
1066
+ enableImage?: boolean | null;
1067
+ }
1068
+ interface OptionLayout {
1069
+ /** Sets whether to display option images. Defaults to `false`. */
1070
+ enableImage?: boolean | null;
1071
+ }
1072
+ declare enum BackgroundType {
1073
+ /** Color background type */
1074
+ COLOR = "COLOR",
1075
+ /** Image background type */
1076
+ IMAGE = "IMAGE",
1077
+ /** Gradiant background type */
1078
+ GRADIENT = "GRADIENT"
1079
+ }
1080
+ interface Gradient {
1081
+ /** The gradient angle in degrees. */
1082
+ angle?: number | null;
1083
+ /**
1084
+ * The start color as a hexademical value.
1085
+ * @format COLOR_HEX
1086
+ */
1087
+ startColor?: string | null;
1088
+ /**
1089
+ * The end color as a hexademical value.
1090
+ * @format COLOR_HEX
1091
+ */
1092
+ lastColor?: string | null;
1093
+ }
1094
+ interface Background extends BackgroundBackgroundOneOf {
1095
+ /**
1096
+ * The background color as a hexademical value.
1097
+ * @format COLOR_HEX
1098
+ */
1099
+ color?: string | null;
1100
+ /** An image to use for the background. */
1101
+ image?: Media;
1102
+ /** Details for a gradient background. */
1103
+ gradient?: Gradient;
1104
+ /** Background type. For each option, include the relevant details. */
1105
+ type?: BackgroundType;
1106
+ }
1107
+ /** @oneof */
1108
+ interface BackgroundBackgroundOneOf {
1109
+ /**
1110
+ * The background color as a hexademical value.
1111
+ * @format COLOR_HEX
1112
+ */
1113
+ color?: string | null;
1114
+ /** An image to use for the background. */
1115
+ image?: Media;
1116
+ /** Details for a gradient background. */
1117
+ gradient?: Gradient;
1118
+ }
1119
+ interface PollDesign {
1120
+ /** Background styling. */
1121
+ background?: Background;
1122
+ /** Border radius in pixels. */
1123
+ borderRadius?: number | null;
1124
+ }
1125
+ interface OptionDesign {
1126
+ /** Border radius in pixels. */
1127
+ borderRadius?: number | null;
1128
+ }
1129
+ interface Poll {
1130
+ /** Poll ID. */
1131
+ id?: string | null;
1132
+ /** Poll title. */
1133
+ title?: string | null;
1134
+ /** Poll creator ID. */
1135
+ creatorId?: string | null;
1136
+ /** Main poll image. */
1137
+ image?: Media;
1138
+ /** Voting options. */
1139
+ options?: Option[];
1140
+ /** The poll's permissions and display settings. */
1141
+ settings?: Settings;
1142
+ }
1143
+ interface PollDataLayout {
1144
+ /** Poll layout settings. */
1145
+ poll?: PollLayout;
1146
+ /** Voting otpions layout settings. */
1147
+ options?: OptionLayout;
1148
+ }
1149
+ interface Design {
1150
+ /** Styling for the poll. */
1151
+ poll?: PollDesign;
1152
+ /** Styling for voting options. */
1153
+ options?: OptionDesign;
1154
+ }
1155
+ interface TextData {
1156
+ /** The text to apply decorations to. */
1157
+ text?: string;
1158
+ /** The decorations to apply. */
1159
+ decorations?: Decoration[];
1160
+ }
1161
+ /** Adds appearence changes to text */
1162
+ interface Decoration extends DecorationDataOneOf {
1163
+ /** Data for an anchor link decoration. */
1164
+ anchorData?: AnchorData;
1165
+ /** Data for a color decoration. */
1166
+ colorData?: ColorData;
1167
+ /** Data for an external link decoration. */
1168
+ linkData?: LinkData;
1169
+ /** Data for a mention decoration. */
1170
+ mentionData?: MentionData;
1171
+ /** Data for a font size decoration. */
1172
+ fontSizeData?: FontSizeData;
1173
+ /** Font weight for a bold decoration. */
1174
+ fontWeightValue?: number | null;
1175
+ /** Data for an italic decoration. Defaults to `true`. */
1176
+ italicData?: boolean | null;
1177
+ /** Data for an underline decoration. Defaults to `true`. */
1178
+ underlineData?: boolean | null;
1179
+ /** Data for a spoiler decoration. */
1180
+ spoilerData?: SpoilerData;
1181
+ /** Data for a strikethrough decoration. Defaults to `true`. */
1182
+ strikethroughData?: boolean | null;
1183
+ /** The type of decoration to apply. */
1184
+ type?: DecorationType;
1185
+ }
1186
+ /** @oneof */
1187
+ interface DecorationDataOneOf {
1188
+ /** Data for an anchor link decoration. */
1189
+ anchorData?: AnchorData;
1190
+ /** Data for a color decoration. */
1191
+ colorData?: ColorData;
1192
+ /** Data for an external link decoration. */
1193
+ linkData?: LinkData;
1194
+ /** Data for a mention decoration. */
1195
+ mentionData?: MentionData;
1196
+ /** Data for a font size decoration. */
1197
+ fontSizeData?: FontSizeData;
1198
+ /** Font weight for a bold decoration. */
1199
+ fontWeightValue?: number | null;
1200
+ /** Data for an italic decoration. Defaults to `true`. */
1201
+ italicData?: boolean | null;
1202
+ /** Data for an underline decoration. Defaults to `true`. */
1203
+ underlineData?: boolean | null;
1204
+ /** Data for a spoiler decoration. */
1205
+ spoilerData?: SpoilerData;
1206
+ /** Data for a strikethrough decoration. Defaults to `true`. */
1207
+ strikethroughData?: boolean | null;
1208
+ }
1209
+ declare enum DecorationType {
1210
+ BOLD = "BOLD",
1211
+ ITALIC = "ITALIC",
1212
+ UNDERLINE = "UNDERLINE",
1213
+ SPOILER = "SPOILER",
1214
+ ANCHOR = "ANCHOR",
1215
+ MENTION = "MENTION",
1216
+ LINK = "LINK",
1217
+ COLOR = "COLOR",
1218
+ FONT_SIZE = "FONT_SIZE",
1219
+ EXTERNAL = "EXTERNAL",
1220
+ STRIKETHROUGH = "STRIKETHROUGH"
1221
+ }
1222
+ interface AnchorData {
1223
+ /** The target node's ID. */
1224
+ anchor?: string;
1225
+ }
1226
+ interface ColorData {
1227
+ /** The text's background color as a hexadecimal value. */
1228
+ background?: string | null;
1229
+ /** The text's foreground color as a hexadecimal value. */
1230
+ foreground?: string | null;
1231
+ }
1232
+ interface LinkData {
1233
+ /** Link details. */
1234
+ link?: Link;
1235
+ }
1236
+ interface MentionData {
1237
+ /** The mentioned user's name. */
1238
+ name?: string;
1239
+ /** The version of the user's name that appears after the `@` character in the mention. */
1240
+ slug?: string;
1241
+ /** Mentioned user's ID. */
1242
+ id?: string | null;
1243
+ }
1244
+ interface FontSizeData {
1245
+ /** The units used for the font size. */
1246
+ unit?: FontType;
1247
+ /** Font size value. */
1248
+ value?: number | null;
1249
+ }
1250
+ declare enum FontType {
1251
+ PX = "PX",
1252
+ EM = "EM"
1253
+ }
1254
+ interface SpoilerData {
1255
+ /** Spoiler ID. */
1256
+ id?: string | null;
1257
+ }
1258
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1259
+ /** Data for embedded Wix Bookings content. */
1260
+ bookingData?: BookingData;
1261
+ /** Data for embedded Wix Events content. */
1262
+ eventData?: EventData;
1263
+ /** The type of Wix App content being embedded. */
1264
+ type?: AppType;
1265
+ /** The ID of the embedded content. */
1266
+ itemId?: string | null;
1267
+ /** The name of the embedded content. */
1268
+ name?: string | null;
1269
+ /**
1270
+ * Deprecated: Use `image` instead.
1271
+ * @deprecated
1272
+ */
1273
+ imageSrc?: string | null;
1274
+ /** The URL for the embedded content. */
1275
+ url?: string | null;
1276
+ /** An image for the embedded content. */
1277
+ image?: Media;
1278
+ }
1279
+ /** @oneof */
1280
+ interface AppEmbedDataAppDataOneOf {
1281
+ /** Data for embedded Wix Bookings content. */
1282
+ bookingData?: BookingData;
1283
+ /** Data for embedded Wix Events content. */
1284
+ eventData?: EventData;
1285
+ }
1286
+ declare enum AppType {
1287
+ PRODUCT = "PRODUCT",
1288
+ EVENT = "EVENT",
1289
+ BOOKING = "BOOKING"
1290
+ }
1291
+ interface BookingData {
1292
+ /** Booking duration in minutes. */
1293
+ durations?: string | null;
1294
+ }
1295
+ interface EventData {
1296
+ /** Event schedule. */
1297
+ scheduling?: string | null;
1298
+ /** Event location. */
1299
+ location?: string | null;
1300
+ }
1301
+ interface VideoData {
1302
+ /** Styling for the video's container. */
1303
+ containerData?: PluginContainerData;
1304
+ /** Video details. */
1305
+ video?: Media;
1306
+ /** Video thumbnail details. */
1307
+ thumbnail?: Media;
1308
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1309
+ disableDownload?: boolean | null;
1310
+ /** Video title. */
1311
+ title?: string | null;
1312
+ /** Video options. */
1313
+ options?: PlaybackOptions;
1314
+ }
1315
+ interface PlaybackOptions {
1316
+ /** Sets whether the media will automatically start playing. */
1317
+ autoPlay?: boolean | null;
1318
+ /** Sets whether media's will be looped. */
1319
+ playInLoop?: boolean | null;
1320
+ /** Sets whether media's controls will be shown. */
1321
+ showControls?: boolean | null;
1322
+ }
1323
+ interface EmbedData {
1324
+ /** Styling for the oEmbed node's container. */
1325
+ containerData?: PluginContainerData;
1326
+ /** An [oEmbed](https://www.oembed.com) object. */
1327
+ oembed?: Oembed;
1328
+ /** Origin asset source. */
1329
+ src?: string | null;
1330
+ }
1331
+ interface Oembed {
1332
+ /** The resource type. */
1333
+ type?: string | null;
1334
+ /** The width of the resource specified in the `url` property in pixels. */
1335
+ width?: number | null;
1336
+ /** The height of the resource specified in the `url` property in pixels. */
1337
+ height?: number | null;
1338
+ /** Resource title. */
1339
+ title?: string | null;
1340
+ /** The source URL for the resource. */
1341
+ url?: string | null;
1342
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1343
+ html?: string | null;
1344
+ /** The name of the author or owner of the resource. */
1345
+ authorName?: string | null;
1346
+ /** The URL for the author or owner of the resource. */
1347
+ authorUrl?: string | null;
1348
+ /** The name of the resource provider. */
1349
+ providerName?: string | null;
1350
+ /** The URL for the resource provider. */
1351
+ providerUrl?: string | null;
1352
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1353
+ thumbnailUrl?: string | null;
1354
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1355
+ thumbnailWidth?: string | null;
1356
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1357
+ thumbnailHeight?: string | null;
1358
+ /** The URL for an embedded viedo. */
1359
+ videoUrl?: string | null;
1360
+ /** The oEmbed version number. This value must be `1.0`. */
1361
+ version?: string | null;
1362
+ }
1363
+ interface CollapsibleListData {
1364
+ /** Styling for the collapsible list's container. */
1365
+ containerData?: PluginContainerData;
1366
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1367
+ expandOnlyOne?: boolean | null;
1368
+ /** Sets which items are expanded when the page loads. */
1369
+ initialExpandedItems?: InitialExpandedItems;
1370
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1371
+ direction?: Direction;
1372
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1373
+ isQapageData?: boolean | null;
1374
+ }
1375
+ declare enum InitialExpandedItems {
1376
+ /** First item will be expended initally */
1377
+ FIRST = "FIRST",
1378
+ /** All items will expended initally */
1379
+ ALL = "ALL",
1380
+ /** All items collapsed initally */
1381
+ NONE = "NONE"
1382
+ }
1383
+ declare enum Direction {
1384
+ /** Left-to-right */
1385
+ LTR = "LTR",
1386
+ /** Right-to-left */
1387
+ RTL = "RTL"
1388
+ }
1389
+ interface TableData {
1390
+ /** Styling for the table's container. */
1391
+ containerData?: PluginContainerData;
1392
+ /** The table's dimensions. */
1393
+ dimensions?: Dimensions;
1394
+ /**
1395
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1396
+ * @deprecated
1397
+ */
1398
+ header?: boolean | null;
1399
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1400
+ rowHeader?: boolean | null;
1401
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1402
+ columnHeader?: boolean | null;
1403
+ }
1404
+ interface Dimensions {
1405
+ /** An array representing relative width of each column in relation to the other columns. */
1406
+ colsWidthRatio?: number[];
1407
+ /** An array representing the height of each row in pixels. */
1408
+ rowsHeight?: number[];
1409
+ /** An array representing the minimum width of each column in pixels. */
1410
+ colsMinWidth?: number[];
1411
+ }
1412
+ interface TableCellData {
1413
+ /** Styling for the cell's background color and text alignment. */
1414
+ cellStyle?: CellStyle;
1415
+ /** The cell's border colors. */
1416
+ borderColors?: BorderColors;
1417
+ }
1418
+ declare enum VerticalAlignment {
1419
+ /** Top alignment */
1420
+ TOP = "TOP",
1421
+ /** Middle alignment */
1422
+ MIDDLE = "MIDDLE",
1423
+ /** Bottom alignment */
1424
+ BOTTOM = "BOTTOM"
1425
+ }
1426
+ interface CellStyle {
1427
+ /** Vertical alignment for the cell's text. */
1428
+ verticalAlignment?: VerticalAlignment;
1429
+ /**
1430
+ * Cell background color as a hexadecimal value.
1431
+ * @format COLOR_HEX
1432
+ */
1433
+ backgroundColor?: string | null;
1434
+ }
1435
+ interface BorderColors {
1436
+ /**
1437
+ * Left border color as a hexadecimal value.
1438
+ * @format COLOR_HEX
1439
+ */
1440
+ left?: string | null;
1441
+ /**
1442
+ * Right border color as a hexadecimal value.
1443
+ * @format COLOR_HEX
1444
+ */
1445
+ right?: string | null;
1446
+ /**
1447
+ * Top border color as a hexadecimal value.
1448
+ * @format COLOR_HEX
1449
+ */
1450
+ top?: string | null;
1451
+ /**
1452
+ * Bottom border color as a hexadecimal value.
1453
+ * @format COLOR_HEX
1454
+ */
1455
+ bottom?: string | null;
1456
+ }
1457
+ interface AudioData {
1458
+ /** Styling for the audio node's container. */
1459
+ containerData?: PluginContainerData;
1460
+ /** Audio file details. */
1461
+ audio?: Media;
1462
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1463
+ disableDownload?: boolean | null;
1464
+ /** Cover image. */
1465
+ coverImage?: Media;
1466
+ /** Track name. */
1467
+ name?: string | null;
1468
+ /** Author name. */
1469
+ authorName?: string | null;
1470
+ /** An HTML version of the audio node. */
1471
+ html?: string | null;
1472
+ }
1473
+ interface OrderedListData {
1474
+ /** Indentation level from 0-4. */
1475
+ indentation?: number;
1476
+ /** Offset level from 0-4. */
1477
+ offset?: number | null;
1478
+ /** List start number. */
1479
+ start?: number | null;
1480
+ }
1481
+ interface BulletedListData {
1482
+ /** Indentation level from 0-4. */
1483
+ indentation?: number;
1484
+ /** Offset level from 0-4. */
1485
+ offset?: number | null;
1486
+ }
1487
+ interface BlockquoteData {
1488
+ /** Indentation level from 1-4. */
1489
+ indentation?: number;
1490
+ }
1491
+ interface CaptionData {
1492
+ textStyle?: TextStyle;
1493
+ }
1494
+ interface LayoutCellData {
1495
+ /** Size of the cell in 12 columns grid. */
1496
+ colSpan?: number | null;
1497
+ }
1498
+ interface Metadata {
1499
+ /** Schema version. */
1500
+ version?: number;
1501
+ /**
1502
+ * When the object was created.
1503
+ * @readonly
1504
+ * @deprecated
1505
+ */
1506
+ createdTimestamp?: Date | null;
1507
+ /**
1508
+ * When the object was most recently updated.
1509
+ * @deprecated
1510
+ */
1511
+ updatedTimestamp?: Date | null;
1512
+ /** Object ID. */
1513
+ id?: string | null;
1514
+ }
1515
+ interface DocumentStyle {
1516
+ /** Styling for H1 nodes. */
1517
+ headerOne?: TextNodeStyle;
1518
+ /** Styling for H2 nodes. */
1519
+ headerTwo?: TextNodeStyle;
1520
+ /** Styling for H3 nodes. */
1521
+ headerThree?: TextNodeStyle;
1522
+ /** Styling for H4 nodes. */
1523
+ headerFour?: TextNodeStyle;
1524
+ /** Styling for H5 nodes. */
1525
+ headerFive?: TextNodeStyle;
1526
+ /** Styling for H6 nodes. */
1527
+ headerSix?: TextNodeStyle;
1528
+ /** Styling for paragraph nodes. */
1529
+ paragraph?: TextNodeStyle;
1530
+ /** Styling for block quote nodes. */
1531
+ blockquote?: TextNodeStyle;
1532
+ /** Styling for code block nodes. */
1533
+ codeBlock?: TextNodeStyle;
1534
+ }
1535
+ interface TextNodeStyle {
1536
+ /** The decorations to apply to the node. */
1537
+ decorations?: Decoration[];
1538
+ /** Padding and background color for the node. */
1539
+ nodeStyle?: NodeStyle;
1540
+ /** Line height for text in the node. */
1541
+ lineHeight?: string | null;
1542
+ }
1543
+ interface Mention extends MentionIdentityOneOf {
1544
+ /**
1545
+ * Wix user ID.
1546
+ * @format GUID
1547
+ */
1548
+ userId?: string | null;
1549
+ /**
1550
+ * Member ID. See the Members API for more details.
1551
+ * @format GUID
1552
+ */
1553
+ memberId?: string | null;
1554
+ /**
1555
+ * Visitor ID.
1556
+ * @format GUID
1557
+ */
1558
+ visitorId?: string | null;
1559
+ /**
1560
+ * Group ID. See the Groups API for more details.
1561
+ * @format GUID
1562
+ */
1563
+ groupId?: string | null;
1564
+ }
1565
+ /** @oneof */
1566
+ interface MentionIdentityOneOf {
1567
+ /**
1568
+ * Wix user ID.
1569
+ * @format GUID
1570
+ */
1571
+ userId?: string | null;
1572
+ /**
1573
+ * Member ID. See the Members API for more details.
1574
+ * @format GUID
1575
+ */
1576
+ memberId?: string | null;
1577
+ /**
1578
+ * Visitor ID.
1579
+ * @format GUID
1580
+ */
1581
+ visitorId?: string | null;
1582
+ /**
1583
+ * Group ID. See the Groups API for more details.
1584
+ * @format GUID
1585
+ */
1586
+ groupId?: string | null;
1587
+ }
1588
+ interface Attachment extends AttachmentMediaOneOf {
1589
+ /** Information about the image. */
1590
+ image?: Image;
1591
+ /** Information about the video. */
1592
+ video?: VideoV2;
1593
+ /** Information about the audio. */
1594
+ audio?: Audio;
1595
+ /** Information about the document. */
1596
+ document?: Document;
1597
+ /**
1598
+ * Mime type of attachment.
1599
+ * @maxLength 3000
1600
+ */
1601
+ mimeType?: string | null;
1602
+ }
1603
+ /** @oneof */
1604
+ interface AttachmentMediaOneOf {
1605
+ /** Information about the image. */
1606
+ image?: Image;
1607
+ /** Information about the video. */
1608
+ video?: VideoV2;
1609
+ /** Information about the audio. */
1610
+ audio?: Audio;
1611
+ /** Information about the document. */
1612
+ document?: Document;
1613
+ }
1614
+ interface Image {
1615
+ /** WixMedia image ID. */
1616
+ id?: string;
1617
+ /** Image URL. */
1618
+ url?: string;
1619
+ /**
1620
+ * Original image height.
1621
+ * @readonly
1622
+ */
1623
+ height?: number;
1624
+ /**
1625
+ * Original image width.
1626
+ * @readonly
1627
+ */
1628
+ width?: number;
1629
+ /**
1630
+ * Image alt text.
1631
+ * @readonly
1632
+ */
1633
+ altText?: string | null;
1634
+ /**
1635
+ * Image URL expiration date (when relevant).
1636
+ * @readonly
1637
+ */
1638
+ urlExpirationDate?: Date | null;
1639
+ /**
1640
+ * Image filename.
1641
+ * @readonly
1642
+ */
1643
+ filename?: string | null;
1644
+ /**
1645
+ * Image size in bytes.
1646
+ * @readonly
1647
+ * @format DECIMAL_VALUE
1648
+ */
1649
+ sizeInBytes?: string | null;
1650
+ }
1651
+ interface VideoV2 {
1652
+ /** WixMedia ID. */
1653
+ id?: string;
1654
+ /** Original video URL. */
1655
+ url?: string;
1656
+ /**
1657
+ * Available resolutions for the video, starting with the optimal resolution.
1658
+ * @readonly
1659
+ * @maxSize 100
1660
+ */
1661
+ resolutions?: VideoResolution[];
1662
+ /**
1663
+ * Video filename.
1664
+ * @readonly
1665
+ */
1666
+ filename?: string | null;
1667
+ /**
1668
+ * Video posters.
1669
+ * @readonly
1670
+ */
1671
+ posters?: Image[];
1672
+ /**
1673
+ * Original video size in bytes.
1674
+ * @readonly
1675
+ * @format DECIMAL_VALUE
1676
+ */
1677
+ sizeInBytes?: string | null;
1678
+ /**
1679
+ * Video URL expiration date (when relevant).
1680
+ * @readonly
1681
+ */
1682
+ urlExpirationDate?: Date | null;
1683
+ }
1684
+ interface VideoResolution {
1685
+ /** Video URL. */
1686
+ url?: string;
1687
+ /** Video height. */
1688
+ height?: number;
1689
+ /** Video width. */
1690
+ width?: number;
1691
+ /** Video format for example, mp4, hls. */
1692
+ format?: string;
1693
+ /**
1694
+ * Video quality. For example: 480p, 720p.
1695
+ * @readonly
1696
+ */
1697
+ quality?: string | null;
1698
+ /**
1699
+ * Video filename.
1700
+ * @readonly
1701
+ */
1702
+ filename?: string | null;
1703
+ /**
1704
+ * Video duration in seconds.
1705
+ * @readonly
1706
+ */
1707
+ durationInSeconds?: number | null;
1708
+ /**
1709
+ * When true, this is a protected asset, and calling the URL will return a 403 error.
1710
+ * In order to access private assets, make a request to:
1711
+ * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
1712
+ * @readonly
1713
+ */
1714
+ private?: boolean | null;
1715
+ /**
1716
+ * Key to identify the video resolution's relationship to the original media in WixMedia.
1717
+ * Can be used to request a download for the specific video resolution.
1718
+ * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
1719
+ * @readonly
1720
+ */
1721
+ assetKey?: string | null;
1722
+ }
1723
+ interface Audio {
1724
+ /** WixMedia ID. */
1725
+ id?: string;
1726
+ /** Audio URL. */
1727
+ url?: string;
1728
+ /**
1729
+ * Audio URL expiration date (when relevant).
1730
+ * @readonly
1731
+ */
1732
+ urlExpirationDate?: Date | null;
1733
+ /**
1734
+ * Audio size in bytes.
1735
+ * @readonly
1736
+ * @format DECIMAL_VALUE
1737
+ */
1738
+ sizeInBytes?: string | null;
1739
+ /**
1740
+ * Audio filename.
1741
+ * @readonly
1742
+ */
1743
+ filename?: string | null;
1744
+ /**
1745
+ * Audio duration in seconds.
1746
+ * @readonly
1747
+ */
1748
+ duration?: number | null;
1749
+ /**
1750
+ * When true, this is a protected asset, and calling the URL will return a 403 error.
1751
+ * In order to access private assets, make a request to:
1752
+ * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
1753
+ * @readonly
1754
+ */
1755
+ private?: boolean | null;
1756
+ /**
1757
+ * Key to identify the object relationship to the original media in WixMedia.
1758
+ * Can be used to request a download for the specific asset.
1759
+ * For example: 128-30kbs.mp3, 320kbs.mp3, 128kbs.mp3
1760
+ * @readonly
1761
+ */
1762
+ assetKey?: string | null;
1763
+ /**
1764
+ * Audio format.
1765
+ * @readonly
1766
+ */
1767
+ format?: string | null;
1768
+ /**
1769
+ * Audio quality.
1770
+ * @readonly
1771
+ */
1772
+ quality?: string | null;
1773
+ }
1774
+ interface Document {
1775
+ /** WixMedia ID. */
1776
+ id?: string;
1777
+ /** Document URL. */
1778
+ url?: string;
1779
+ /**
1780
+ * Document URL expiration date (when relevant).
1781
+ * @readonly
1782
+ */
1783
+ urlExpirationDate?: Date | null;
1784
+ /**
1785
+ * Document size in bytes.
1786
+ * @readonly
1787
+ * @format DECIMAL_VALUE
1788
+ */
1789
+ sizeInBytes?: string | null;
1790
+ /**
1791
+ * Document filename.
1792
+ * @readonly
1793
+ */
1794
+ filename?: string | null;
1795
+ }
1796
+ interface CommentAuthor extends CommentAuthorIdentityOneOf {
1797
+ /**
1798
+ * Wix user ID.
1799
+ * @format GUID
1800
+ */
1801
+ userId?: string | null;
1802
+ /**
1803
+ * Member ID. See the Members API for more details.
1804
+ * @format GUID
1805
+ */
1806
+ memberId?: string | null;
1807
+ /**
1808
+ * Visitor ID.
1809
+ * @format GUID
1810
+ */
1811
+ visitorId?: string | null;
1812
+ }
1813
+ /** @oneof */
1814
+ interface CommentAuthorIdentityOneOf {
1815
+ /**
1816
+ * Wix user ID.
1817
+ * @format GUID
1818
+ */
1819
+ userId?: string | null;
1820
+ /**
1821
+ * Member ID. See the Members API for more details.
1822
+ * @format GUID
1823
+ */
1824
+ memberId?: string | null;
1825
+ /**
1826
+ * Visitor ID.
1827
+ * @format GUID
1828
+ */
1829
+ visitorId?: string | null;
1830
+ }
1831
+ interface ParentComment {
1832
+ /**
1833
+ * Comment ID of the parent comment.
1834
+ * @format GUID
1835
+ * @immutable
1836
+ */
1837
+ id?: string | null;
1838
+ /**
1839
+ * Author of the parent comment.
1840
+ * @readonly
1841
+ */
1842
+ author?: CommentAuthor;
1843
+ /**
1844
+ * Parent comment status.
1845
+ * @readonly
1846
+ */
1847
+ status?: Status;
1848
+ }
1849
+ declare enum Status {
1850
+ /** Unknown status. */
1851
+ UNKNOWN = "UNKNOWN",
1852
+ /** This comment is published and publicly visible. */
1853
+ PUBLISHED = "PUBLISHED",
1854
+ /** This comment is deleted. */
1855
+ DELETED = "DELETED",
1856
+ /** This comment is pending moderation. Moderation is not currently supported. */
1857
+ PENDING = "PENDING",
1858
+ /** This comment has been hidden by a site moderator. */
1859
+ HIDDEN = "HIDDEN"
1860
+ }
1861
+ interface VoteSummary {
1862
+ /** Number of upvotes less downvotes on this comment. */
1863
+ netVoteCount?: number;
1864
+ /** Number of upvotes on this comment. */
1865
+ upvoteCount?: number;
1866
+ /** Number of downvotes on this comment. */
1867
+ downvoteCount?: number;
1868
+ }
1869
+ interface CommentReactionSummary {
1870
+ /** Total amount of reactions. */
1871
+ total?: number;
1872
+ /**
1873
+ * Number of each type of reaction. `key` is the code for a reaction type and
1874
+ * `value` is the amount of that reaction type.
1875
+ */
1876
+ reactionCodeCount?: Record<string, number>;
1877
+ }
1878
+ declare enum Action {
1879
+ /** Unknown content. */
1880
+ UNKNOWN = "UNKNOWN",
1881
+ /** Approve draft content. */
1882
+ APPROVE = "APPROVE",
1883
+ /** Reject draft content. */
1884
+ REJECT = "REJECT"
1885
+ }
1886
+ interface CreateCommentRequest {
1887
+ /** Comment to create. */
1888
+ comment?: Comment;
1889
+ }
1890
+ interface CreateCommentResponse {
1891
+ /** Created comment. */
1892
+ comment?: Comment;
1893
+ }
1894
+ interface GetCommentRequest {
1895
+ /**
1896
+ * ID of the comment to retrieve.
1897
+ * @format GUID
1898
+ */
1899
+ commentId: string;
1900
+ }
1901
+ interface GetCommentResponse {
1902
+ /** Retrieved comment. */
1903
+ comment?: Comment;
1904
+ }
1905
+ /** Comment info to update. */
1906
+ interface UpdateCommentRequest {
1907
+ /** Comment info to update. */
1908
+ comment?: Comment;
1909
+ }
1910
+ interface UpdateCommentResponse {
1911
+ /** Updated comment. */
1912
+ comment?: Comment;
1913
+ }
1914
+ interface DeleteCommentRequest {
1915
+ /**
1916
+ * ID of the comment to delete.
1917
+ * @format GUID
1918
+ */
1919
+ commentId: string;
1920
+ }
1921
+ interface DeleteCommentResponse {
1922
+ }
1923
+ interface ModerateDraftContentRequest {
1924
+ /**
1925
+ * ID of the comment to moderate.
1926
+ * @format GUID
1927
+ */
1928
+ commentId: string;
1929
+ /**
1930
+ * Revision number, which increments by `1` each time the comment is updated.
1931
+ *
1932
+ * To prevent conflicting changes, the current `revision` must be passed when updating the comment.
1933
+ */
1934
+ revision: string | null;
1935
+ /** Draft content action. */
1936
+ draftContentAction?: Action;
1937
+ }
1938
+ interface ModerateDraftContentResponse {
1939
+ /** Moderated comment. */
1940
+ comment?: Comment;
1941
+ }
1942
+ interface QueryCommentsRequest {
1943
+ /**
1944
+ * App ID to query comments for.
1945
+ * @format GUID
1946
+ */
1947
+ appId: string;
1948
+ /** Query options. */
1949
+ query: CursorQuery;
1950
+ }
1951
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1952
+ /**
1953
+ * Cursor paging options.
1954
+ *
1955
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
1956
+ */
1957
+ cursorPaging?: CursorPaging;
1958
+ /**
1959
+ * Filter object.
1960
+ *
1961
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1962
+ */
1963
+ filter?: Record<string, any> | null;
1964
+ /**
1965
+ * Sort object.
1966
+ *
1967
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1968
+ * @maxSize 5
1969
+ */
1970
+ sort?: Sorting[];
1971
+ }
1972
+ /** @oneof */
1973
+ interface CursorQueryPagingMethodOneOf {
1974
+ /**
1975
+ * Cursor paging options.
1976
+ *
1977
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
1978
+ */
1979
+ cursorPaging?: CursorPaging;
1980
+ }
1981
+ interface Sorting {
1982
+ /**
1983
+ * Name of the field to sort by.
1984
+ * @maxLength 512
1985
+ */
1986
+ fieldName?: string;
1987
+ /** Sort order. */
1988
+ order?: SortOrder;
1989
+ }
1990
+ declare enum SortOrder {
1991
+ ASC = "ASC",
1992
+ DESC = "DESC"
1993
+ }
1994
+ interface CursorPaging {
1995
+ /**
1996
+ * Maximum number of items to return in the results.
1997
+ * @max 100
1998
+ */
1999
+ limit?: number | null;
2000
+ /**
2001
+ * Pointer to the next or previous page in the list of results.
2002
+ *
2003
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2004
+ * Not relevant for the first request.
2005
+ * @maxLength 16000
2006
+ */
2007
+ cursor?: string | null;
2008
+ }
2009
+ interface QueryCommentsResponse {
2010
+ /** Retrieved comments. */
2011
+ comments?: Comment[];
2012
+ /** Paging metadata. */
2013
+ pagingMetadata?: CursorPagingMetadata;
2014
+ }
2015
+ interface CursorPagingMetadata {
2016
+ /** Number of items returned in current page. */
2017
+ count?: number | null;
2018
+ /** Cursor strings that point to the next page, previous page, or both. */
2019
+ cursors?: Cursors;
2020
+ /**
2021
+ * Whether there are more pages to retrieve following the current page.
2022
+ *
2023
+ * + `true`: Another page of results can be retrieved.
2024
+ * + `false`: This is the last page.
2025
+ */
2026
+ hasNext?: boolean | null;
2027
+ }
2028
+ interface Cursors {
2029
+ /**
2030
+ * Cursor string pointing to the next page in the list of results.
2031
+ * @maxLength 16000
2032
+ */
2033
+ next?: string | null;
2034
+ /**
2035
+ * Cursor pointing to the previous page in the list of results.
2036
+ * @maxLength 16000
2037
+ */
2038
+ prev?: string | null;
2039
+ }
2040
+ interface MarkCommentRequest {
2041
+ /**
2042
+ * ID of the comment to mark.
2043
+ * @format GUID
2044
+ */
2045
+ commentId: string;
2046
+ }
2047
+ interface MarkCommentResponse {
2048
+ /** Marked comment. */
2049
+ comment?: Comment;
2050
+ }
2051
+ interface UnmarkCommentRequest {
2052
+ /**
2053
+ * ID of the comment to unmark.
2054
+ * @format GUID
2055
+ */
2056
+ commentId: string;
2057
+ }
2058
+ interface UnmarkCommentResponse {
2059
+ /** Unmarked comment. */
2060
+ comment?: Comment;
2061
+ }
2062
+ interface HideCommentRequest {
2063
+ /**
2064
+ * ID of the comment to hide.
2065
+ * @format GUID
2066
+ */
2067
+ commentId: string;
2068
+ }
2069
+ interface HideCommentResponse {
2070
+ /** Hidden comment. */
2071
+ comment?: Comment;
2072
+ }
2073
+ interface PublishCommentRequest {
2074
+ /**
2075
+ * ID of the comment to publish.
2076
+ * @format GUID
2077
+ */
2078
+ commentId: string;
2079
+ }
2080
+ interface PublishCommentResponse {
2081
+ /** Published comment. */
2082
+ comment?: Comment;
2083
+ }
2084
+ /** Count comments options. */
2085
+ interface CountCommentsRequest {
2086
+ /**
2087
+ * App ID to count the comments of.
2088
+ * @format GUID
2089
+ */
2090
+ appId?: string;
2091
+ /** Filter to identify the comments that need to be counted. */
2092
+ filter?: Record<string, any> | null;
2093
+ }
2094
+ interface CountCommentsResponse {
2095
+ /** Number of comments. */
2096
+ count?: number;
2097
+ }
2098
+ interface ListCommentsByResourceRequest {
2099
+ /**
2100
+ * ID of the app from which the comments are listed.
2101
+ * @format GUID
2102
+ */
2103
+ appId: string;
2104
+ /**
2105
+ * ID of the specific context the comment is in response to.
2106
+ *
2107
+ * 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`.
2108
+ * @maxLength 128
2109
+ */
2110
+ contextId: string;
2111
+ /**
2112
+ * Reserved for internal use.
2113
+ * @maxLength 128
2114
+ */
2115
+ contextType?: string;
2116
+ /**
2117
+ * ID of the specific resource that the comment is in response to.
2118
+ *
2119
+ * 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`.
2120
+ * @maxLength 128
2121
+ */
2122
+ resourceId: string;
2123
+ /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
2124
+ commentSort?: CommentSort;
2125
+ /** Reply sort. Is ignored if `cursorPaging.cursor` is defined. */
2126
+ replySort?: ReplySort;
2127
+ /** Cursor paging. */
2128
+ cursorPaging?: ListCommentsByResourceCursorPaging;
2129
+ }
2130
+ interface CommentSort {
2131
+ /** Sort order. */
2132
+ order?: Order;
2133
+ /**
2134
+ * If set to `true`, marked comments appear in the original order, and not at the top of the list.
2135
+ *
2136
+ * Default: `false`. This means that marked comments are prioritized and listed first.
2137
+ */
2138
+ keepMarkedInOriginalOrder?: boolean;
2139
+ }
2140
+ declare enum Order {
2141
+ /** Unknown order. */
2142
+ UNKNOWN_ORDER = "UNKNOWN_ORDER",
2143
+ /** Oldest comments appear at the top of the list. */
2144
+ OLDEST_FIRST = "OLDEST_FIRST",
2145
+ /** Newest comments appear at the top of the list. */
2146
+ NEWEST_FIRST = "NEWEST_FIRST",
2147
+ /** Comments with the highest reaction count appear at the top of the list. */
2148
+ REACTION_COUNT = "REACTION_COUNT",
2149
+ /** Comments with the highest vote count appear at the top of the list. */
2150
+ NET_VOTE_COUNT = "NET_VOTE_COUNT",
2151
+ /** Comments with the highest rating appear at the top of the list. */
2152
+ RATING = "RATING",
2153
+ /** Comments with the lowest vote count appear at the top of the list. */
2154
+ NET_VOTE_COUNT_ASC = "NET_VOTE_COUNT_ASC",
2155
+ /** Comments with the lowest rating appear at the top of the list. */
2156
+ RATING_ASC = "RATING_ASC"
2157
+ }
2158
+ interface ReplySort {
2159
+ /** Sort order. */
2160
+ order?: ReplySortOrder;
2161
+ /**
2162
+ * Whether the marked comments are listed in the original order.
2163
+ *
2164
+ * If set to `true`, marked comments appear in the original order, and not at the top of the list.
2165
+ *
2166
+ * Default: `false`. In this case marked comments are prioritized and listed first.
2167
+ */
2168
+ keepMarkedInOriginalOrder?: boolean;
2169
+ }
2170
+ declare enum ReplySortOrder {
2171
+ /** Unknown order. */
2172
+ UNKNOWN_ORDER = "UNKNOWN_ORDER",
2173
+ /** Oldest comments appear at the top of the list. */
2174
+ OLDEST_FIRST = "OLDEST_FIRST",
2175
+ /** Newest comments appear at the top of the list. */
2176
+ NEWEST_FIRST = "NEWEST_FIRST",
2177
+ /** Comments with the highest reaction count appear at the top of the list. */
2178
+ REACTION_COUNT = "REACTION_COUNT"
2179
+ }
2180
+ interface ListCommentsByResourceCursorPaging {
2181
+ /** Pointer to the next or previous page in the list of results. */
2182
+ cursor?: string | null;
2183
+ /**
2184
+ * Number of items to return.
2185
+ * @min 1
2186
+ * @max 100
2187
+ */
2188
+ limit?: number | null;
2189
+ /**
2190
+ * Maximum number of replies in a response. Only applicable to parent comments.
2191
+ * @max 100
2192
+ */
2193
+ repliesLimit?: number | null;
2194
+ }
2195
+ interface ListCommentsByResourceResponse {
2196
+ /** Listed comments. */
2197
+ comments?: Comment[];
2198
+ /** Paging metadata. */
2199
+ pagingMetadata?: CursorPagingMetadata;
2200
+ /** Listed comment replies. */
2201
+ commentReplies?: Record<string, RepliesListResponse>;
2202
+ }
2203
+ interface RepliesListResponse {
2204
+ /** Listed comment replies. */
2205
+ replies?: Comment[];
2206
+ /** Paging metadata. */
2207
+ pagingMetadata?: CursorPagingMetadata;
2208
+ }
2209
+ interface GetCommentThreadRequest {
2210
+ /**
2211
+ * App ID.
2212
+ * @maxLength 128
2213
+ * @deprecated App ID.
2214
+ * @targetRemovalDate 2024-11-01
2215
+ */
2216
+ appId?: string;
2217
+ /**
2218
+ * Comment ID.
2219
+ * @format GUID
2220
+ */
2221
+ commentId: string;
2222
+ /** Comment sorting. */
2223
+ commentSort?: CommentSort;
2224
+ /** Reply sorting. */
2225
+ replySort?: ReplySort;
2226
+ }
2227
+ interface GetCommentThreadResponse {
2228
+ /** Retrieved replies. */
2229
+ comments?: Comment[];
2230
+ /** Paging metadata. */
2231
+ pagingMetadata?: CursorPagingMetadata;
2232
+ /** Retrieved replies of a reply. */
2233
+ commentReplies?: Record<string, RepliesListResponse>;
2234
+ }
2235
+ interface BulkPublishCommentRequest {
2236
+ /**
2237
+ * ID of the app where to publish the comment.
2238
+ * @format GUID
2239
+ */
2240
+ appId: string;
2241
+ /** 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
+ filter: Record<string, any> | null;
2243
+ }
2244
+ interface BulkPublishCommentResponse {
2245
+ /**
2246
+ * Job ID.
2247
+ *
2248
+ * Pass this ID to Get Async Job to retrieve job details and metadata.
2249
+ * @format GUID
2250
+ */
2251
+ jobId?: string;
2252
+ }
2253
+ interface BulkHideCommentRequest {
2254
+ /**
2255
+ * ID of the app where to hide the comments.
2256
+ * @format GUID
2257
+ */
2258
+ appId: string;
2259
+ /** 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
+ filter: Record<string, any> | null;
2261
+ }
2262
+ interface BulkHideCommentResponse {
2263
+ /**
2264
+ * Job ID.
2265
+ *
2266
+ * Pass this ID to Get Async Job to retrieve job details and metadata.
2267
+ * @format GUID
2268
+ */
2269
+ jobId?: string;
2270
+ }
2271
+ interface BulkDeleteCommentRequest {
2272
+ /**
2273
+ * ID of the app where to delete the comments.
2274
+ * @format GUID
2275
+ */
2276
+ appId: string;
2277
+ /** 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
+ filter: Record<string, any> | null;
2279
+ }
2280
+ interface BulkDeleteCommentResponse {
2281
+ /**
2282
+ * Job ID.
2283
+ *
2284
+ * Pass this ID to Get Async Job to retrieve job details and metadata.
2285
+ * @format GUID
2286
+ */
2287
+ jobId?: string;
2288
+ }
2289
+ interface BulkModerateDraftContentRequest {
2290
+ /**
2291
+ * ID of the app where to moderate the comments.
2292
+ * @format GUID
2293
+ */
2294
+ appId: string;
2295
+ /** 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"`}. */
2296
+ filter: Record<string, any> | null;
2297
+ /** Action to do regarding draft content */
2298
+ draftContentAction: Action;
2299
+ }
2300
+ interface BulkModerateDraftContentResponse {
2301
+ /**
2302
+ * Job ID.
2303
+ *
2304
+ * Pass this ID to Get Async Job to retrieve job details and metadata.
2305
+ * @format GUID
2306
+ */
2307
+ jobId?: string;
2308
+ }
2309
+ interface BulkMoveCommentByFilterRequest {
2310
+ /**
2311
+ * ID of the app from which to move the comments.
2312
+ * @format GUID
2313
+ */
2314
+ appId: string;
2315
+ /** 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"`}. */
2316
+ filter: Record<string, any> | null;
2317
+ /** Where to move the comment. */
2318
+ destination?: Destination;
2319
+ }
2320
+ interface Destination {
2321
+ /**
2322
+ * Context ID of where to move the comment to.
2323
+ * @maxLength 128
2324
+ */
2325
+ contextId?: string;
2326
+ /**
2327
+ * Resource ID of where to move the comment to.
2328
+ * @maxLength 128
2329
+ */
2330
+ resourceId?: string;
2331
+ }
2332
+ interface BulkMoveCommentByFilterResponse {
2333
+ /**
2334
+ * Job ID.
2335
+ *
2336
+ * Pass this ID to Get Async Job to retrieve job details and metadata.
2337
+ * @format GUID
2338
+ */
2339
+ jobId?: string;
2340
+ }
2341
+
2342
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2343
+ getUrl: (context: any) => string;
2344
+ httpMethod: K;
2345
+ path: string;
2346
+ pathParams: M;
2347
+ __requestType: T;
2348
+ __originalRequestType: S;
2349
+ __responseType: Q;
2350
+ __originalResponseType: R;
2351
+ };
2352
+ declare function createComment(): __PublicMethodMetaInfo<'POST', {}, CreateCommentRequest$1, CreateCommentRequest, CreateCommentResponse$1, CreateCommentResponse>;
2353
+ declare function getComment(): __PublicMethodMetaInfo<'GET', {
2354
+ commentId: string;
2355
+ }, GetCommentRequest$1, GetCommentRequest, GetCommentResponse$1, GetCommentResponse>;
2356
+ declare function updateComment(): __PublicMethodMetaInfo<'PATCH', {
2357
+ commentId: string;
2358
+ }, UpdateCommentRequest$1, UpdateCommentRequest, UpdateCommentResponse$1, UpdateCommentResponse>;
2359
+ declare function deleteComment(): __PublicMethodMetaInfo<'DELETE', {
2360
+ commentId: string;
2361
+ }, DeleteCommentRequest$1, DeleteCommentRequest, DeleteCommentResponse$1, DeleteCommentResponse>;
2362
+ declare function moderateDraftContent(): __PublicMethodMetaInfo<'POST', {
2363
+ commentId: string;
2364
+ }, ModerateDraftContentRequest$1, ModerateDraftContentRequest, ModerateDraftContentResponse$1, ModerateDraftContentResponse>;
2365
+ declare function queryComments(): __PublicMethodMetaInfo<'POST', {}, QueryCommentsRequest$1, QueryCommentsRequest, QueryCommentsResponse$1, QueryCommentsResponse>;
2366
+ declare function markComment(): __PublicMethodMetaInfo<'PUT', {
2367
+ commentId: string;
2368
+ }, MarkCommentRequest$1, MarkCommentRequest, MarkCommentResponse$1, MarkCommentResponse>;
2369
+ declare function unmarkComment(): __PublicMethodMetaInfo<'PUT', {
2370
+ commentId: string;
2371
+ }, UnmarkCommentRequest$1, UnmarkCommentRequest, UnmarkCommentResponse$1, UnmarkCommentResponse>;
2372
+ declare function hideComment(): __PublicMethodMetaInfo<'PUT', {
2373
+ commentId: string;
2374
+ }, HideCommentRequest$1, HideCommentRequest, HideCommentResponse$1, HideCommentResponse>;
2375
+ declare function publishComment(): __PublicMethodMetaInfo<'PUT', {
2376
+ commentId: string;
2377
+ }, PublishCommentRequest$1, PublishCommentRequest, PublishCommentResponse$1, PublishCommentResponse>;
2378
+ declare function countComments(): __PublicMethodMetaInfo<'POST', {}, CountCommentsRequest$1, CountCommentsRequest, CountCommentsResponse$1, CountCommentsResponse>;
2379
+ declare function listCommentsByResource(): __PublicMethodMetaInfo<'GET', {}, ListCommentsByResourceRequest$1, ListCommentsByResourceRequest, ListCommentsByResourceResponse$1, ListCommentsByResourceResponse>;
2380
+ declare function getCommentThread(): __PublicMethodMetaInfo<'GET', {
2381
+ commentId: string;
2382
+ }, GetCommentThreadRequest$1, GetCommentThreadRequest, GetCommentThreadResponse$1, GetCommentThreadResponse>;
2383
+ declare function bulkPublishComment(): __PublicMethodMetaInfo<'POST', {}, BulkPublishCommentRequest$1, BulkPublishCommentRequest, BulkPublishCommentResponse$1, BulkPublishCommentResponse>;
2384
+ declare function bulkHideComment(): __PublicMethodMetaInfo<'PUT', {}, BulkHideCommentRequest$1, BulkHideCommentRequest, BulkHideCommentResponse$1, BulkHideCommentResponse>;
2385
+ declare function bulkDeleteComment(): __PublicMethodMetaInfo<'PUT', {}, BulkDeleteCommentRequest$1, BulkDeleteCommentRequest, BulkDeleteCommentResponse$1, BulkDeleteCommentResponse>;
2386
+ declare function bulkModerateDraftContent(): __PublicMethodMetaInfo<'POST', {}, BulkModerateDraftContentRequest$1, BulkModerateDraftContentRequest, BulkModerateDraftContentResponse$1, BulkModerateDraftContentResponse>;
2387
+ declare function bulkMoveCommentByFilter(): __PublicMethodMetaInfo<'PUT', {}, BulkMoveCommentByFilterRequest$1, BulkMoveCommentByFilterRequest, BulkMoveCommentByFilterResponse$1, BulkMoveCommentByFilterResponse>;
2388
+
2389
+ export { type __PublicMethodMetaInfo, bulkDeleteComment, bulkHideComment, bulkModerateDraftContent, bulkMoveCommentByFilter, bulkPublishComment, countComments, createComment, deleteComment, getComment, getCommentThread, hideComment, listCommentsByResource, markComment, moderateDraftContent, publishComment, queryComments, unmarkComment, updateComment };