@wix/auto_sdk_comments_comments 1.0.6 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.mts} +554 -736
  2. package/build/{internal/cjs/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.ts} +554 -736
  3. package/build/index.d.mts +249 -0
  4. package/build/index.d.ts +249 -0
  5. package/build/index.js +5231 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +5144 -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-DjW1a70o.d.mts} +554 -736
  10. package/build/internal/{es/src/comments-v2-comment-comments.types.d.ts → comments-v2-comment-comments.universal-DjW1a70o.d.ts} +554 -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 +5231 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +5144 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2384 -0
  18. package/build/internal/meta.d.ts +2384 -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 +2384 -0
  24. package/build/meta.d.ts +2384 -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 -3626
  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 -3626
  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 -3626
  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 -3626
  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
@@ -1,3626 +0,0 @@
1
- /**
2
- * A comment is a user-generated message in response to a specific resource. It allows site visitors
3
- * to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
4
- * or other site content. Comments are composed of text, images, videos, or other forms of media.
5
- */
6
- export interface Comment {
7
- /**
8
- * Comment ID.
9
- * @format GUID
10
- * @readonly
11
- */
12
- _id?: string | null;
13
- /**
14
- * Revision number, which increments by 1 each time the comment is updated.
15
- *
16
- * To prevent conflicting changes, the current `revision` must be passed when updating the comment.
17
- * @readonly
18
- */
19
- revision?: string | null;
20
- /**
21
- * Date and time the comment was created.
22
- *
23
- * **Note:** This is the date from the system database, not the actual date when the comment was created. For example, if you migrate comments created in 2016, the `createdDate` field will show the current year. For the actual creation date, see the `commentDate` field.
24
- * @readonly
25
- */
26
- _createdDate?: Date | null;
27
- /**
28
- * Date and time the comment was last updated.
29
- * @readonly
30
- */
31
- _updatedDate?: Date | null;
32
- /**
33
- * ID of the app that the comment is added to.
34
- * @format GUID
35
- * @immutable
36
- */
37
- appId?: string | null;
38
- /**
39
- * ID of the specific context the comment is in response to.
40
- *
41
- * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
42
- * the `forumPostId` is used as both the `contextId` and the `resourceId`.
43
- * @immutable
44
- * @maxLength 128
45
- */
46
- contextId?: string | null;
47
- /**
48
- * ID of the specific resource that the comment is in response to.
49
- *
50
- * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
51
- * the `forumPostId` is used as both the `resourceId` and the `contextId`.
52
- * @immutable
53
- * @maxLength 128
54
- */
55
- resourceId?: string | null;
56
- /** Published comment content. */
57
- content?: CommentContent;
58
- /**
59
- * Comment's author.
60
- * @immutable
61
- */
62
- author?: CommentAuthor;
63
- /**
64
- * Parent comment information.
65
- *
66
- * Only present if this comment is in a direct reply to another comment.
67
- * See **Terminology** in the Comments introduction
68
- * for more information about parent comments.
69
- */
70
- parentComment?: ParentComment;
71
- /**
72
- * Number of comments that reply to this comment.
73
- * @readonly
74
- */
75
- replyCount?: number;
76
- /**
77
- * Summary of votes.
78
- * @readonly
79
- */
80
- voteSummary?: VoteSummary;
81
- /**
82
- * Comment status.
83
- * @readonly
84
- */
85
- status?: Status;
86
- /**
87
- * Comment rating.
88
- * @readonly
89
- */
90
- rating?: number | null;
91
- /**
92
- * Summary of reactions.
93
- * @readonly
94
- */
95
- reactionSummary?: CommentReactionSummary;
96
- /** Whether the comment is marked. */
97
- marked?: boolean;
98
- /**
99
- * Date and time when the comment was actually created.
100
- * @immutable
101
- */
102
- commentDate?: Date | null;
103
- /**
104
- * Whether the comment has the updated content.
105
- * @readonly
106
- */
107
- contentEdited?: boolean | null;
108
- }
109
- /** Comment content. */
110
- export interface CommentContent {
111
- /**
112
- * Comment rich content.
113
- *
114
- * <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">
115
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
116
- * </widget>
117
- */
118
- richContent?: RichContent;
119
- /**
120
- * People to tag with this comment.
121
- *
122
- * People can include users, members, visitors, or groups.
123
- * @maxSize 10
124
- */
125
- mentions?: Mention[];
126
- /**
127
- * Content attachments.
128
- * @maxSize 10
129
- */
130
- attachments?: Attachment[];
131
- }
132
- export interface RichContent {
133
- /** Node objects representing a rich content document. */
134
- nodes?: Node[];
135
- /** Object metadata. */
136
- metadata?: Metadata;
137
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
138
- documentStyle?: DocumentStyle;
139
- }
140
- export interface Node extends NodeDataOneOf {
141
- /** Data for a button node. */
142
- buttonData?: ButtonData;
143
- /** Data for a code block node. */
144
- codeBlockData?: CodeBlockData;
145
- /** Data for a divider node. */
146
- dividerData?: DividerData;
147
- /** Data for a file node. */
148
- fileData?: FileData;
149
- /** Data for a gallery node. */
150
- galleryData?: GalleryData;
151
- /** Data for a GIF node. */
152
- gifData?: GIFData;
153
- /** Data for a heading node. */
154
- headingData?: HeadingData;
155
- /** Data for an embedded HTML node. */
156
- htmlData?: HTMLData;
157
- /** Data for an image node. */
158
- imageData?: ImageData;
159
- /** Data for a link preview node. */
160
- linkPreviewData?: LinkPreviewData;
161
- /** @deprecated */
162
- mapData?: MapData;
163
- /** Data for a paragraph node. */
164
- paragraphData?: ParagraphData;
165
- /** Data for a poll node. */
166
- pollData?: PollData;
167
- /** Data for a text node. Used to apply decorations to text. */
168
- textData?: TextData;
169
- /** Data for an app embed node. */
170
- appEmbedData?: AppEmbedData;
171
- /** Data for a video node. */
172
- videoData?: VideoData;
173
- /** Data for an oEmbed node. */
174
- embedData?: EmbedData;
175
- /** Data for a collapsible list node. */
176
- collapsibleListData?: CollapsibleListData;
177
- /** Data for a table node. */
178
- tableData?: TableData;
179
- /** Data for a table cell node. */
180
- tableCellData?: TableCellData;
181
- /** Data for a custom external node. */
182
- externalData?: Record<string, any> | null;
183
- /** Data for an audio node. */
184
- audioData?: AudioData;
185
- /** Data for an ordered list node. */
186
- orderedListData?: OrderedListData;
187
- /** Data for a bulleted list node. */
188
- bulletedListData?: BulletedListData;
189
- /** Data for a block quote node. */
190
- blockquoteData?: BlockquoteData;
191
- /** Data for a caption node. */
192
- captionData?: CaptionData;
193
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
194
- layoutCellData?: LayoutCellData;
195
- /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
196
- type?: NodeType;
197
- /** Node ID. */
198
- _id?: string;
199
- /** A list of child nodes. */
200
- nodes?: Node[];
201
- /** Padding and background color styling for the node. */
202
- style?: NodeStyle;
203
- }
204
- /** @oneof */
205
- export interface NodeDataOneOf {
206
- /** Data for a button node. */
207
- buttonData?: ButtonData;
208
- /** Data for a code block node. */
209
- codeBlockData?: CodeBlockData;
210
- /** Data for a divider node. */
211
- dividerData?: DividerData;
212
- /** Data for a file node. */
213
- fileData?: FileData;
214
- /** Data for a gallery node. */
215
- galleryData?: GalleryData;
216
- /** Data for a GIF node. */
217
- gifData?: GIFData;
218
- /** Data for a heading node. */
219
- headingData?: HeadingData;
220
- /** Data for an embedded HTML node. */
221
- htmlData?: HTMLData;
222
- /** Data for an image node. */
223
- imageData?: ImageData;
224
- /** Data for a link preview node. */
225
- linkPreviewData?: LinkPreviewData;
226
- /** @deprecated */
227
- mapData?: MapData;
228
- /** Data for a paragraph node. */
229
- paragraphData?: ParagraphData;
230
- /** Data for a poll node. */
231
- pollData?: PollData;
232
- /** Data for a text node. Used to apply decorations to text. */
233
- textData?: TextData;
234
- /** Data for an app embed node. */
235
- appEmbedData?: AppEmbedData;
236
- /** Data for a video node. */
237
- videoData?: VideoData;
238
- /** Data for an oEmbed node. */
239
- embedData?: EmbedData;
240
- /** Data for a collapsible list node. */
241
- collapsibleListData?: CollapsibleListData;
242
- /** Data for a table node. */
243
- tableData?: TableData;
244
- /** Data for a table cell node. */
245
- tableCellData?: TableCellData;
246
- /** Data for a custom external node. */
247
- externalData?: Record<string, any> | null;
248
- /** Data for an audio node. */
249
- audioData?: AudioData;
250
- /** Data for an ordered list node. */
251
- orderedListData?: OrderedListData;
252
- /** Data for a bulleted list node. */
253
- bulletedListData?: BulletedListData;
254
- /** Data for a block quote node. */
255
- blockquoteData?: BlockquoteData;
256
- /** Data for a caption node. */
257
- captionData?: CaptionData;
258
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
259
- layoutCellData?: LayoutCellData;
260
- }
261
- export declare enum NodeType {
262
- PARAGRAPH = "PARAGRAPH",
263
- TEXT = "TEXT",
264
- HEADING = "HEADING",
265
- BULLETED_LIST = "BULLETED_LIST",
266
- ORDERED_LIST = "ORDERED_LIST",
267
- LIST_ITEM = "LIST_ITEM",
268
- BLOCKQUOTE = "BLOCKQUOTE",
269
- CODE_BLOCK = "CODE_BLOCK",
270
- VIDEO = "VIDEO",
271
- DIVIDER = "DIVIDER",
272
- FILE = "FILE",
273
- GALLERY = "GALLERY",
274
- GIF = "GIF",
275
- HTML = "HTML",
276
- IMAGE = "IMAGE",
277
- LINK_PREVIEW = "LINK_PREVIEW",
278
- /** @deprecated */
279
- MAP = "MAP",
280
- POLL = "POLL",
281
- APP_EMBED = "APP_EMBED",
282
- BUTTON = "BUTTON",
283
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
284
- TABLE = "TABLE",
285
- EMBED = "EMBED",
286
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
287
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
288
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
289
- TABLE_CELL = "TABLE_CELL",
290
- TABLE_ROW = "TABLE_ROW",
291
- EXTERNAL = "EXTERNAL",
292
- AUDIO = "AUDIO",
293
- CAPTION = "CAPTION",
294
- LAYOUT = "LAYOUT",
295
- LAYOUT_CELL = "LAYOUT_CELL"
296
- }
297
- export interface NodeStyle {
298
- /** The top padding value in pixels. */
299
- paddingTop?: string | null;
300
- /** The bottom padding value in pixels. */
301
- paddingBottom?: string | null;
302
- /** The background color as a hexadecimal value. */
303
- backgroundColor?: string | null;
304
- }
305
- export interface ButtonData {
306
- /** Styling for the button's container. */
307
- containerData?: PluginContainerData;
308
- /** The button type. */
309
- type?: Type;
310
- /** Styling for the button. */
311
- styles?: Styles;
312
- /** The text to display on the button. */
313
- text?: string | null;
314
- /** Button link details. */
315
- link?: Link;
316
- }
317
- export interface Border {
318
- /**
319
- * Deprecated: Use `borderWidth` in `styles` instead.
320
- * @deprecated
321
- */
322
- width?: number | null;
323
- /**
324
- * Deprecated: Use `borderRadius` in `styles` instead.
325
- * @deprecated
326
- */
327
- radius?: number | null;
328
- }
329
- export interface Colors {
330
- /**
331
- * Deprecated: Use `textColor` in `styles` instead.
332
- * @deprecated
333
- */
334
- text?: string | null;
335
- /**
336
- * Deprecated: Use `borderColor` in `styles` instead.
337
- * @deprecated
338
- */
339
- border?: string | null;
340
- /**
341
- * Deprecated: Use `backgroundColor` in `styles` instead.
342
- * @deprecated
343
- */
344
- background?: string | null;
345
- }
346
- export interface PluginContainerData {
347
- /** The width of the node when it's displayed. */
348
- width?: PluginContainerDataWidth;
349
- /** The node's alignment within its container. */
350
- alignment?: PluginContainerDataAlignment;
351
- /** Spoiler cover settings for the node. */
352
- spoiler?: Spoiler;
353
- /** The height of the node when it's displayed. */
354
- height?: Height;
355
- /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
356
- textWrap?: boolean | null;
357
- }
358
- export declare enum WidthType {
359
- /** Width matches the content width */
360
- CONTENT = "CONTENT",
361
- /** Small Width */
362
- SMALL = "SMALL",
363
- /** Width will match the original asset width */
364
- ORIGINAL = "ORIGINAL",
365
- /** coast-to-coast display */
366
- FULL_WIDTH = "FULL_WIDTH"
367
- }
368
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
369
- /**
370
- * One of the following predefined width options:
371
- * `CONTENT`: The width of the container matches the content width.
372
- * `SMALL`: A small width.
373
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
374
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
375
- */
376
- size?: WidthType;
377
- /** A custom width value in pixels. */
378
- custom?: string | null;
379
- }
380
- /** @oneof */
381
- export interface PluginContainerDataWidthDataOneOf {
382
- /**
383
- * One of the following predefined width options:
384
- * `CONTENT`: The width of the container matches the content width.
385
- * `SMALL`: A small width.
386
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
387
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
388
- */
389
- size?: WidthType;
390
- /** A custom width value in pixels. */
391
- custom?: string | null;
392
- }
393
- export declare enum PluginContainerDataAlignment {
394
- /** Center Alignment */
395
- CENTER = "CENTER",
396
- /** Left Alignment */
397
- LEFT = "LEFT",
398
- /** Right Alignment */
399
- RIGHT = "RIGHT"
400
- }
401
- export interface Spoiler {
402
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
403
- enabled?: boolean | null;
404
- /** The description displayed on top of the spoiler cover. */
405
- description?: string | null;
406
- /** The text for the button used to remove the spoiler cover. */
407
- buttonText?: string | null;
408
- }
409
- export interface Height {
410
- /** A custom height value in pixels. */
411
- custom?: string | null;
412
- }
413
- export declare enum Type {
414
- /** Regular link button */
415
- LINK = "LINK",
416
- /** Triggers custom action that is defined in plugin configuration by the consumer */
417
- ACTION = "ACTION"
418
- }
419
- export interface Styles {
420
- /**
421
- * Deprecated: Use `borderWidth` and `borderRadius` instead.
422
- * @deprecated
423
- */
424
- border?: Border;
425
- /**
426
- * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
427
- * @deprecated
428
- */
429
- colors?: Colors;
430
- /** Border width in pixels. */
431
- borderWidth?: number | null;
432
- /** Border width in pixels (hover state). */
433
- borderWidthHover?: number | null;
434
- /** Border radius in pixels. */
435
- borderRadius?: number | null;
436
- /**
437
- * Border color as a hexadecimal value.
438
- * @format COLOR_HEX
439
- */
440
- borderColor?: string | null;
441
- /**
442
- * Border color as a hexadecimal value (hover state).
443
- * @format COLOR_HEX
444
- */
445
- borderColorHover?: string | null;
446
- /**
447
- * Text color as a hexadecimal value.
448
- * @format COLOR_HEX
449
- */
450
- textColor?: string | null;
451
- /**
452
- * Text color as a hexadecimal value (hover state).
453
- * @format COLOR_HEX
454
- */
455
- textColorHover?: string | null;
456
- /**
457
- * Background color as a hexadecimal value.
458
- * @format COLOR_HEX
459
- */
460
- backgroundColor?: string | null;
461
- /**
462
- * Background color as a hexadecimal value (hover state).
463
- * @format COLOR_HEX
464
- */
465
- backgroundColorHover?: string | null;
466
- /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
467
- buttonSize?: string | null;
468
- }
469
- export interface Link extends LinkDataOneOf {
470
- /** The absolute URL for the linked document. */
471
- url?: string;
472
- /** The target node's ID. Used for linking to another node in this object. */
473
- anchor?: string;
474
- /**
475
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
476
- * `SELF` - Default. Opens the linked document in the same frame as the link.
477
- * `BLANK` - Opens the linked document in a new browser tab or window.
478
- * `PARENT` - Opens the linked document in the link's parent frame.
479
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
480
- */
481
- target?: Target;
482
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
483
- rel?: Rel;
484
- /** A serialized object used for a custom or external link panel. */
485
- customData?: string | null;
486
- }
487
- /** @oneof */
488
- export interface LinkDataOneOf {
489
- /** The absolute URL for the linked document. */
490
- url?: string;
491
- /** The target node's ID. Used for linking to another node in this object. */
492
- anchor?: string;
493
- }
494
- export declare enum Target {
495
- /** Opens the linked document in the same frame as it was clicked (this is default) */
496
- SELF = "SELF",
497
- /** Opens the linked document in a new window or tab */
498
- BLANK = "BLANK",
499
- /** Opens the linked document in the parent frame */
500
- PARENT = "PARENT",
501
- /** Opens the linked document in the full body of the window */
502
- TOP = "TOP"
503
- }
504
- export interface Rel {
505
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
506
- nofollow?: boolean | null;
507
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
508
- sponsored?: boolean | null;
509
- /** 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`. */
510
- ugc?: boolean | null;
511
- /** Indicates that this link protect referral information from being passed to the target website. */
512
- noreferrer?: boolean | null;
513
- }
514
- export interface CodeBlockData {
515
- /** Styling for the code block's text. */
516
- textStyle?: TextStyle;
517
- }
518
- export interface TextStyle {
519
- /** Text alignment. Defaults to `AUTO`. */
520
- textAlignment?: TextAlignment;
521
- /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
522
- lineHeight?: string | null;
523
- }
524
- export declare enum TextAlignment {
525
- /** browser default, eqivalent to `initial` */
526
- AUTO = "AUTO",
527
- /** Left align */
528
- LEFT = "LEFT",
529
- /** Right align */
530
- RIGHT = "RIGHT",
531
- /** Center align */
532
- CENTER = "CENTER",
533
- /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
534
- JUSTIFY = "JUSTIFY"
535
- }
536
- export interface DividerData {
537
- /** Styling for the divider's container. */
538
- containerData?: PluginContainerData;
539
- /** Divider line style. */
540
- lineStyle?: LineStyle;
541
- /** Divider width. */
542
- width?: Width;
543
- /** Divider alignment. */
544
- alignment?: Alignment;
545
- }
546
- export declare enum LineStyle {
547
- /** Single Line */
548
- SINGLE = "SINGLE",
549
- /** Double Line */
550
- DOUBLE = "DOUBLE",
551
- /** Dashed Line */
552
- DASHED = "DASHED",
553
- /** Dotted Line */
554
- DOTTED = "DOTTED"
555
- }
556
- export declare enum Width {
557
- /** Large line */
558
- LARGE = "LARGE",
559
- /** Medium line */
560
- MEDIUM = "MEDIUM",
561
- /** Small line */
562
- SMALL = "SMALL"
563
- }
564
- export declare enum Alignment {
565
- /** Center alignment */
566
- CENTER = "CENTER",
567
- /** Left alignment */
568
- LEFT = "LEFT",
569
- /** Right alignment */
570
- RIGHT = "RIGHT"
571
- }
572
- export interface FileData {
573
- /** Styling for the file's container. */
574
- containerData?: PluginContainerData;
575
- /** The source for the file's data. */
576
- src?: FileSource;
577
- /** File name. */
578
- name?: string | null;
579
- /** File type. */
580
- type?: string | null;
581
- /**
582
- * Use `sizeInKb` instead.
583
- * @deprecated
584
- */
585
- size?: number | null;
586
- /** Settings for PDF files. */
587
- pdfSettings?: PDFSettings;
588
- /** File MIME type. */
589
- mimeType?: string | null;
590
- /** File path. */
591
- path?: string | null;
592
- /** File size in KB. */
593
- sizeInKb?: string | null;
594
- }
595
- export declare enum ViewMode {
596
- /** No PDF view */
597
- NONE = "NONE",
598
- /** Full PDF view */
599
- FULL = "FULL",
600
- /** Mini PDF view */
601
- MINI = "MINI"
602
- }
603
- export interface FileSource extends FileSourceDataOneOf {
604
- /** The absolute URL for the file's source. */
605
- url?: string | null;
606
- /**
607
- * Custom ID. Use `id` instead.
608
- * @deprecated
609
- */
610
- custom?: string | null;
611
- /** An ID that's resolved to a URL by a resolver function. */
612
- _id?: string | null;
613
- /** Indicates whether the file's source is private. Defaults to `false`. */
614
- private?: boolean | null;
615
- }
616
- /** @oneof */
617
- export interface FileSourceDataOneOf {
618
- /** The absolute URL for the file's source. */
619
- url?: string | null;
620
- /**
621
- * Custom ID. Use `id` instead.
622
- * @deprecated
623
- */
624
- custom?: string | null;
625
- /** An ID that's resolved to a URL by a resolver function. */
626
- _id?: string | null;
627
- }
628
- export interface PDFSettings {
629
- /**
630
- * PDF view mode. One of the following:
631
- * `NONE` : The PDF isn't displayed.
632
- * `FULL` : A full page view of the PDF is displayed.
633
- * `MINI` : A mini view of the PDF is displayed.
634
- */
635
- viewMode?: ViewMode;
636
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
637
- disableDownload?: boolean | null;
638
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
639
- disablePrint?: boolean | null;
640
- }
641
- export interface GalleryData {
642
- /** Styling for the gallery's container. */
643
- containerData?: PluginContainerData;
644
- /** The items in the gallery. */
645
- items?: Item[];
646
- /** Options for defining the gallery's appearance. */
647
- options?: GalleryOptions;
648
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
649
- disableExpand?: boolean | null;
650
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
651
- disableDownload?: boolean | null;
652
- }
653
- export interface Media {
654
- /** The source for the media's data. */
655
- src?: FileSource;
656
- /** Media width in pixels. */
657
- width?: number | null;
658
- /** Media height in pixels. */
659
- height?: number | null;
660
- /** Media duration in seconds. Only relevant for audio and video files. */
661
- duration?: number | null;
662
- }
663
- export interface Image {
664
- /** Image file details. */
665
- media?: Media;
666
- /** Link details for images that are links. */
667
- link?: Link;
668
- }
669
- export interface Video {
670
- /** Video file details. */
671
- media?: Media;
672
- /** Video thumbnail file details. */
673
- thumbnail?: Media;
674
- }
675
- export interface Item extends ItemDataOneOf {
676
- /** An image item. */
677
- image?: Image;
678
- /** A video item. */
679
- video?: Video;
680
- /** Item title. */
681
- title?: string | null;
682
- /** Item's alternative text. */
683
- altText?: string | null;
684
- }
685
- /** @oneof */
686
- export interface ItemDataOneOf {
687
- /** An image item. */
688
- image?: Image;
689
- /** A video item. */
690
- video?: Video;
691
- }
692
- export interface GalleryOptions {
693
- /** Gallery layout. */
694
- layout?: Layout;
695
- /** Styling for gallery items. */
696
- item?: ItemStyle;
697
- /** Styling for gallery thumbnail images. */
698
- thumbnails?: Thumbnails;
699
- }
700
- export declare enum LayoutType {
701
- /** Collage type */
702
- COLLAGE = "COLLAGE",
703
- /** Masonry type */
704
- MASONRY = "MASONRY",
705
- /** Grid type */
706
- GRID = "GRID",
707
- /** Thumbnail type */
708
- THUMBNAIL = "THUMBNAIL",
709
- /** Slider type */
710
- SLIDER = "SLIDER",
711
- /** Slideshow type */
712
- SLIDESHOW = "SLIDESHOW",
713
- /** Panorama type */
714
- PANORAMA = "PANORAMA",
715
- /** Column type */
716
- COLUMN = "COLUMN",
717
- /** Magic type */
718
- MAGIC = "MAGIC",
719
- /** Fullsize images type */
720
- FULLSIZE = "FULLSIZE"
721
- }
722
- export declare enum Orientation {
723
- /** Rows Orientation */
724
- ROWS = "ROWS",
725
- /** Columns Orientation */
726
- COLUMNS = "COLUMNS"
727
- }
728
- export declare enum Crop {
729
- /** Crop to fill */
730
- FILL = "FILL",
731
- /** Crop to fit */
732
- FIT = "FIT"
733
- }
734
- export declare enum ThumbnailsAlignment {
735
- /** Top alignment */
736
- TOP = "TOP",
737
- /** Right alignment */
738
- RIGHT = "RIGHT",
739
- /** Bottom alignment */
740
- BOTTOM = "BOTTOM",
741
- /** Left alignment */
742
- LEFT = "LEFT",
743
- /** No thumbnail */
744
- NONE = "NONE"
745
- }
746
- export interface Layout {
747
- /** Gallery layout type. */
748
- type?: LayoutType;
749
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
750
- horizontalScroll?: boolean | null;
751
- /** Gallery orientation. */
752
- orientation?: Orientation;
753
- /** The number of columns to display on full size screens. */
754
- numberOfColumns?: number | null;
755
- /** The number of columns to display on mobile screens. */
756
- mobileNumberOfColumns?: number | null;
757
- }
758
- export interface ItemStyle {
759
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
760
- targetSize?: number | null;
761
- /** Item ratio */
762
- ratio?: number | null;
763
- /** Sets how item images are cropped. */
764
- crop?: Crop;
765
- /** The spacing between items in pixels. */
766
- spacing?: number | null;
767
- }
768
- export interface Thumbnails {
769
- /** Thumbnail alignment. */
770
- placement?: ThumbnailsAlignment;
771
- /** Spacing between thumbnails in pixels. */
772
- spacing?: number | null;
773
- }
774
- export interface GIFData {
775
- /** Styling for the GIF's container. */
776
- containerData?: PluginContainerData;
777
- /** The source of the full size GIF. */
778
- original?: GIF;
779
- /** The source of the downsized GIF. */
780
- downsized?: GIF;
781
- /** Height in pixels. */
782
- height?: number;
783
- /** Width in pixels. */
784
- width?: number;
785
- /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
786
- gifType?: GIFType;
787
- }
788
- export interface GIF {
789
- /**
790
- * GIF format URL.
791
- * @format WEB_URL
792
- */
793
- gif?: string | null;
794
- /**
795
- * MP4 format URL.
796
- * @format WEB_URL
797
- */
798
- mp4?: string | null;
799
- /**
800
- * Thumbnail URL.
801
- * @format WEB_URL
802
- */
803
- still?: string | null;
804
- }
805
- export declare enum GIFType {
806
- NORMAL = "NORMAL",
807
- STICKER = "STICKER"
808
- }
809
- export interface HeadingData {
810
- /** Heading level from 1-6. */
811
- level?: number;
812
- /** Styling for the heading text. */
813
- textStyle?: TextStyle;
814
- /** Indentation level from 1-4. */
815
- indentation?: number | null;
816
- }
817
- export interface HTMLData extends HTMLDataDataOneOf {
818
- /** The URL for the HTML code for the node. */
819
- url?: string;
820
- /** The HTML code for the node. */
821
- html?: string;
822
- /**
823
- * Whether this is an AdSense element. Use `source` instead.
824
- * @deprecated
825
- */
826
- isAdsense?: boolean | null;
827
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
828
- containerData?: PluginContainerData;
829
- /** The type of HTML code. */
830
- source?: Source;
831
- /** If container height is aligned with its content height. Defaults to `true`. */
832
- autoHeight?: boolean | null;
833
- }
834
- /** @oneof */
835
- export interface HTMLDataDataOneOf {
836
- /** The URL for the HTML code for the node. */
837
- url?: string;
838
- /** The HTML code for the node. */
839
- html?: string;
840
- /**
841
- * Whether this is an AdSense element. Use `source` instead.
842
- * @deprecated
843
- */
844
- isAdsense?: boolean | null;
845
- }
846
- export declare enum Source {
847
- HTML = "HTML",
848
- ADSENSE = "ADSENSE"
849
- }
850
- export interface ImageData {
851
- /** Styling for the image's container. */
852
- containerData?: PluginContainerData;
853
- /** Image file details. */
854
- image?: Media;
855
- /** Link details for images that are links. */
856
- link?: Link;
857
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
858
- disableExpand?: boolean | null;
859
- /** Image's alternative text. */
860
- altText?: string | null;
861
- /**
862
- * Deprecated: use Caption node instead.
863
- * @deprecated
864
- */
865
- caption?: string | null;
866
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
867
- disableDownload?: boolean | null;
868
- /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
869
- decorative?: boolean | null;
870
- /** Styling for the image. */
871
- styles?: ImageDataStyles;
872
- }
873
- export interface StylesBorder {
874
- /** Border width in pixels. */
875
- width?: number | null;
876
- /**
877
- * Border color as a hexadecimal value.
878
- * @format COLOR_HEX
879
- */
880
- color?: string | null;
881
- /** Border radius in pixels. */
882
- radius?: number | null;
883
- }
884
- export interface ImageDataStyles {
885
- /** Border attributes. */
886
- border?: StylesBorder;
887
- }
888
- export interface LinkPreviewData {
889
- /** Styling for the link preview's container. */
890
- containerData?: PluginContainerData;
891
- /** Link details. */
892
- link?: Link;
893
- /** Preview title. */
894
- title?: string | null;
895
- /** Preview thumbnail URL. */
896
- thumbnailUrl?: string | null;
897
- /** Preview description. */
898
- description?: string | null;
899
- /** The preview content as HTML. */
900
- html?: string | null;
901
- /** Styling for the link preview. */
902
- styles?: LinkPreviewDataStyles;
903
- }
904
- export declare enum Position {
905
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
906
- START = "START",
907
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
908
- END = "END",
909
- /** Thumbnail positioned at the top */
910
- TOP = "TOP",
911
- /** Thumbnail hidden and not displayed */
912
- HIDDEN = "HIDDEN"
913
- }
914
- export interface LinkPreviewDataStyles {
915
- /**
916
- * Background color as a hexadecimal value.
917
- * @format COLOR_HEX
918
- */
919
- backgroundColor?: string | null;
920
- /**
921
- * Title color as a hexadecimal value.
922
- * @format COLOR_HEX
923
- */
924
- titleColor?: string | null;
925
- /**
926
- * Subtitle color as a hexadecimal value.
927
- * @format COLOR_HEX
928
- */
929
- subtitleColor?: string | null;
930
- /**
931
- * Link color as a hexadecimal value.
932
- * @format COLOR_HEX
933
- */
934
- linkColor?: string | null;
935
- /** Border width in pixels. */
936
- borderWidth?: number | null;
937
- /** Border radius in pixels. */
938
- borderRadius?: number | null;
939
- /**
940
- * Border color as a hexadecimal value.
941
- * @format COLOR_HEX
942
- */
943
- borderColor?: string | null;
944
- /** Position of thumbnail. Defaults to `START`. */
945
- thumbnailPosition?: Position;
946
- }
947
- export interface MapData {
948
- /** Styling for the map's container. */
949
- containerData?: PluginContainerData;
950
- /** Map settings. */
951
- mapSettings?: MapSettings;
952
- }
953
- export interface MapSettings {
954
- /** The address to display on the map. */
955
- address?: string | null;
956
- /** Sets whether the map is draggable. */
957
- draggable?: boolean | null;
958
- /** Sets whether the location marker is visible. */
959
- marker?: boolean | null;
960
- /** Sets whether street view control is enabled. */
961
- streetViewControl?: boolean | null;
962
- /** Sets whether zoom control is enabled. */
963
- zoomControl?: boolean | null;
964
- /** Location latitude. */
965
- lat?: number | null;
966
- /** Location longitude. */
967
- lng?: number | null;
968
- /** Location name. */
969
- locationName?: string | null;
970
- /** Sets whether view mode control is enabled. */
971
- viewModeControl?: boolean | null;
972
- /** Initial zoom value. */
973
- initialZoom?: number | null;
974
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
975
- mapType?: MapType;
976
- }
977
- export declare enum MapType {
978
- /** Roadmap map type */
979
- ROADMAP = "ROADMAP",
980
- /** Satellite map type */
981
- SATELITE = "SATELITE",
982
- /** Hybrid map type */
983
- HYBRID = "HYBRID",
984
- /** Terrain map type */
985
- TERRAIN = "TERRAIN"
986
- }
987
- export interface ParagraphData {
988
- /** Styling for the paragraph text. */
989
- textStyle?: TextStyle;
990
- /** Indentation level from 1-4. */
991
- indentation?: number | null;
992
- /** Paragraph level */
993
- level?: number | null;
994
- }
995
- export interface PollData {
996
- /** Styling for the poll's container. */
997
- containerData?: PluginContainerData;
998
- /** Poll data. */
999
- poll?: Poll;
1000
- /** Layout settings for the poll and voting options. */
1001
- layout?: PollDataLayout;
1002
- /** Styling for the poll and voting options. */
1003
- design?: Design;
1004
- }
1005
- export declare enum ViewRole {
1006
- /** Only Poll creator can view the results */
1007
- CREATOR = "CREATOR",
1008
- /** Anyone who voted can see the results */
1009
- VOTERS = "VOTERS",
1010
- /** Anyone can see the results, even if one didn't vote */
1011
- EVERYONE = "EVERYONE"
1012
- }
1013
- export declare enum VoteRole {
1014
- /** Logged in member */
1015
- SITE_MEMBERS = "SITE_MEMBERS",
1016
- /** Anyone */
1017
- ALL = "ALL"
1018
- }
1019
- export interface Permissions {
1020
- /** Sets who can view the poll results. */
1021
- view?: ViewRole;
1022
- /** Sets who can vote. */
1023
- vote?: VoteRole;
1024
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1025
- allowMultipleVotes?: boolean | null;
1026
- }
1027
- export interface Option {
1028
- /** Option ID. */
1029
- _id?: string | null;
1030
- /** Option title. */
1031
- title?: string | null;
1032
- /** The image displayed with the option. */
1033
- image?: Media;
1034
- }
1035
- export interface Settings {
1036
- /** Permissions settings for voting. */
1037
- permissions?: Permissions;
1038
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1039
- showVoters?: boolean | null;
1040
- /** Sets whether the vote count is displayed. Defaults to `true`. */
1041
- showVotesCount?: boolean | null;
1042
- }
1043
- export declare enum PollLayoutType {
1044
- /** List */
1045
- LIST = "LIST",
1046
- /** Grid */
1047
- GRID = "GRID"
1048
- }
1049
- export declare enum PollLayoutDirection {
1050
- /** Left-to-right */
1051
- LTR = "LTR",
1052
- /** Right-to-left */
1053
- RTL = "RTL"
1054
- }
1055
- export interface PollLayout {
1056
- /** The layout for displaying the voting options. */
1057
- type?: PollLayoutType;
1058
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1059
- direction?: PollLayoutDirection;
1060
- /** Sets whether to display the main poll image. Defaults to `false`. */
1061
- enableImage?: boolean | null;
1062
- }
1063
- export interface OptionLayout {
1064
- /** Sets whether to display option images. Defaults to `false`. */
1065
- enableImage?: boolean | null;
1066
- }
1067
- export declare enum BackgroundType {
1068
- /** Color background type */
1069
- COLOR = "COLOR",
1070
- /** Image background type */
1071
- IMAGE = "IMAGE",
1072
- /** Gradiant background type */
1073
- GRADIENT = "GRADIENT"
1074
- }
1075
- export interface Gradient {
1076
- /** The gradient angle in degrees. */
1077
- angle?: number | null;
1078
- /**
1079
- * The start color as a hexademical value.
1080
- * @format COLOR_HEX
1081
- */
1082
- startColor?: string | null;
1083
- /**
1084
- * The end color as a hexademical value.
1085
- * @format COLOR_HEX
1086
- */
1087
- lastColor?: string | null;
1088
- }
1089
- export interface Background extends BackgroundBackgroundOneOf {
1090
- /**
1091
- * The background color as a hexademical value.
1092
- * @format COLOR_HEX
1093
- */
1094
- color?: string | null;
1095
- /** An image to use for the background. */
1096
- image?: Media;
1097
- /** Details for a gradient background. */
1098
- gradient?: Gradient;
1099
- /** Background type. For each option, include the relevant details. */
1100
- type?: BackgroundType;
1101
- }
1102
- /** @oneof */
1103
- export interface BackgroundBackgroundOneOf {
1104
- /**
1105
- * The background color as a hexademical value.
1106
- * @format COLOR_HEX
1107
- */
1108
- color?: string | null;
1109
- /** An image to use for the background. */
1110
- image?: Media;
1111
- /** Details for a gradient background. */
1112
- gradient?: Gradient;
1113
- }
1114
- export interface PollDesign {
1115
- /** Background styling. */
1116
- background?: Background;
1117
- /** Border radius in pixels. */
1118
- borderRadius?: number | null;
1119
- }
1120
- export interface OptionDesign {
1121
- /** Border radius in pixels. */
1122
- borderRadius?: number | null;
1123
- }
1124
- export interface Poll {
1125
- /** Poll ID. */
1126
- _id?: string | null;
1127
- /** Poll title. */
1128
- title?: string | null;
1129
- /** Poll creator ID. */
1130
- creatorId?: string | null;
1131
- /** Main poll image. */
1132
- image?: Media;
1133
- /** Voting options. */
1134
- options?: Option[];
1135
- /** The poll's permissions and display settings. */
1136
- settings?: Settings;
1137
- }
1138
- export interface PollDataLayout {
1139
- /** Poll layout settings. */
1140
- poll?: PollLayout;
1141
- /** Voting otpions layout settings. */
1142
- options?: OptionLayout;
1143
- }
1144
- export interface Design {
1145
- /** Styling for the poll. */
1146
- poll?: PollDesign;
1147
- /** Styling for voting options. */
1148
- options?: OptionDesign;
1149
- }
1150
- export interface TextData {
1151
- /** The text to apply decorations to. */
1152
- text?: string;
1153
- /** The decorations to apply. */
1154
- decorations?: Decoration[];
1155
- }
1156
- /** Adds appearence changes to text */
1157
- export interface Decoration extends DecorationDataOneOf {
1158
- /** Data for an anchor link decoration. */
1159
- anchorData?: AnchorData;
1160
- /** Data for a color decoration. */
1161
- colorData?: ColorData;
1162
- /** Data for an external link decoration. */
1163
- linkData?: LinkData;
1164
- /** Data for a mention decoration. */
1165
- mentionData?: MentionData;
1166
- /** Data for a font size decoration. */
1167
- fontSizeData?: FontSizeData;
1168
- /** Font weight for a bold decoration. */
1169
- fontWeightValue?: number | null;
1170
- /** Data for an italic decoration. Defaults to `true`. */
1171
- italicData?: boolean | null;
1172
- /** Data for an underline decoration. Defaults to `true`. */
1173
- underlineData?: boolean | null;
1174
- /** Data for a spoiler decoration. */
1175
- spoilerData?: SpoilerData;
1176
- /** The type of decoration to apply. */
1177
- type?: DecorationType;
1178
- }
1179
- /** @oneof */
1180
- export interface DecorationDataOneOf {
1181
- /** Data for an anchor link decoration. */
1182
- anchorData?: AnchorData;
1183
- /** Data for a color decoration. */
1184
- colorData?: ColorData;
1185
- /** Data for an external link decoration. */
1186
- linkData?: LinkData;
1187
- /** Data for a mention decoration. */
1188
- mentionData?: MentionData;
1189
- /** Data for a font size decoration. */
1190
- fontSizeData?: FontSizeData;
1191
- /** Font weight for a bold decoration. */
1192
- fontWeightValue?: number | null;
1193
- /** Data for an italic decoration. Defaults to `true`. */
1194
- italicData?: boolean | null;
1195
- /** Data for an underline decoration. Defaults to `true`. */
1196
- underlineData?: boolean | null;
1197
- /** Data for a spoiler decoration. */
1198
- spoilerData?: SpoilerData;
1199
- }
1200
- export declare enum DecorationType {
1201
- BOLD = "BOLD",
1202
- ITALIC = "ITALIC",
1203
- UNDERLINE = "UNDERLINE",
1204
- SPOILER = "SPOILER",
1205
- ANCHOR = "ANCHOR",
1206
- MENTION = "MENTION",
1207
- LINK = "LINK",
1208
- COLOR = "COLOR",
1209
- FONT_SIZE = "FONT_SIZE",
1210
- EXTERNAL = "EXTERNAL"
1211
- }
1212
- export interface AnchorData {
1213
- /** The target node's ID. */
1214
- anchor?: string;
1215
- }
1216
- export interface ColorData {
1217
- /** The text's background color as a hexadecimal value. */
1218
- background?: string | null;
1219
- /** The text's foreground color as a hexadecimal value. */
1220
- foreground?: string | null;
1221
- }
1222
- export interface LinkData {
1223
- /** Link details. */
1224
- link?: Link;
1225
- }
1226
- export interface MentionData {
1227
- /** The mentioned user's name. */
1228
- name?: string;
1229
- /** The version of the user's name that appears after the `@` character in the mention. */
1230
- slug?: string;
1231
- /** Mentioned user's ID. */
1232
- _id?: string | null;
1233
- }
1234
- export interface FontSizeData {
1235
- /** The units used for the font size. */
1236
- unit?: FontType;
1237
- /** Font size value. */
1238
- value?: number | null;
1239
- }
1240
- export declare enum FontType {
1241
- PX = "PX",
1242
- EM = "EM"
1243
- }
1244
- export interface SpoilerData {
1245
- /** Spoiler ID. */
1246
- _id?: string | null;
1247
- }
1248
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1249
- /** Data for embedded Wix Bookings content. */
1250
- bookingData?: BookingData;
1251
- /** Data for embedded Wix Events content. */
1252
- eventData?: EventData;
1253
- /** The type of Wix App content being embedded. */
1254
- type?: AppType;
1255
- /** The ID of the embedded content. */
1256
- itemId?: string | null;
1257
- /** The name of the embedded content. */
1258
- name?: string | null;
1259
- /**
1260
- * Deprecated: Use `image` instead.
1261
- * @deprecated
1262
- */
1263
- imageSrc?: string | null;
1264
- /** The URL for the embedded content. */
1265
- url?: string | null;
1266
- /** An image for the embedded content. */
1267
- image?: Media;
1268
- }
1269
- /** @oneof */
1270
- export interface AppEmbedDataAppDataOneOf {
1271
- /** Data for embedded Wix Bookings content. */
1272
- bookingData?: BookingData;
1273
- /** Data for embedded Wix Events content. */
1274
- eventData?: EventData;
1275
- }
1276
- export declare enum AppType {
1277
- PRODUCT = "PRODUCT",
1278
- EVENT = "EVENT",
1279
- BOOKING = "BOOKING"
1280
- }
1281
- export interface BookingData {
1282
- /** Booking duration in minutes. */
1283
- durations?: string | null;
1284
- }
1285
- export interface EventData {
1286
- /** Event schedule. */
1287
- scheduling?: string | null;
1288
- /** Event location. */
1289
- location?: string | null;
1290
- }
1291
- export interface VideoData {
1292
- /** Styling for the video's container. */
1293
- containerData?: PluginContainerData;
1294
- /** Video details. */
1295
- video?: Media;
1296
- /** Video thumbnail details. */
1297
- thumbnail?: Media;
1298
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
1299
- disableDownload?: boolean | null;
1300
- /** Video title. */
1301
- title?: string | null;
1302
- /** Video options. */
1303
- options?: PlaybackOptions;
1304
- }
1305
- export interface PlaybackOptions {
1306
- /** Sets whether the media will automatically start playing. */
1307
- autoPlay?: boolean | null;
1308
- /** Sets whether media's will be looped. */
1309
- playInLoop?: boolean | null;
1310
- /** Sets whether media's controls will be shown. */
1311
- showControls?: boolean | null;
1312
- }
1313
- export interface EmbedData {
1314
- /** Styling for the oEmbed node's container. */
1315
- containerData?: PluginContainerData;
1316
- /** An [oEmbed](https://www.oembed.com) object. */
1317
- oembed?: Oembed;
1318
- /** Origin asset source. */
1319
- src?: string | null;
1320
- }
1321
- export interface Oembed {
1322
- /** The resource type. */
1323
- type?: string | null;
1324
- /** The width of the resource specified in the `url` property in pixels. */
1325
- width?: number | null;
1326
- /** The height of the resource specified in the `url` property in pixels. */
1327
- height?: number | null;
1328
- /** Resource title. */
1329
- title?: string | null;
1330
- /** The source URL for the resource. */
1331
- url?: string | null;
1332
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1333
- html?: string | null;
1334
- /** The name of the author or owner of the resource. */
1335
- authorName?: string | null;
1336
- /** The URL for the author or owner of the resource. */
1337
- authorUrl?: string | null;
1338
- /** The name of the resource provider. */
1339
- providerName?: string | null;
1340
- /** The URL for the resource provider. */
1341
- providerUrl?: string | null;
1342
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1343
- thumbnailUrl?: string | null;
1344
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1345
- thumbnailWidth?: string | null;
1346
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1347
- thumbnailHeight?: string | null;
1348
- /** The URL for an embedded viedo. */
1349
- videoUrl?: string | null;
1350
- /** The oEmbed version number. This value must be `1.0`. */
1351
- version?: string | null;
1352
- }
1353
- export interface CollapsibleListData {
1354
- /** Styling for the collapsible list's container. */
1355
- containerData?: PluginContainerData;
1356
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1357
- expandOnlyOne?: boolean | null;
1358
- /** Sets which items are expanded when the page loads. */
1359
- initialExpandedItems?: InitialExpandedItems;
1360
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1361
- direction?: Direction;
1362
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1363
- isQapageData?: boolean | null;
1364
- }
1365
- export declare enum InitialExpandedItems {
1366
- /** First item will be expended initally */
1367
- FIRST = "FIRST",
1368
- /** All items will expended initally */
1369
- ALL = "ALL",
1370
- /** All items collapsed initally */
1371
- NONE = "NONE"
1372
- }
1373
- export declare enum Direction {
1374
- /** Left-to-right */
1375
- LTR = "LTR",
1376
- /** Right-to-left */
1377
- RTL = "RTL"
1378
- }
1379
- export interface TableData {
1380
- /** Styling for the table's container. */
1381
- containerData?: PluginContainerData;
1382
- /** The table's dimensions. */
1383
- dimensions?: Dimensions;
1384
- /**
1385
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
1386
- * @deprecated
1387
- */
1388
- header?: boolean | null;
1389
- /** Sets whether the table's first row is a header. Defaults to `false`. */
1390
- rowHeader?: boolean | null;
1391
- /** Sets whether the table's first column is a header. Defaults to `false`. */
1392
- columnHeader?: boolean | null;
1393
- }
1394
- export interface Dimensions {
1395
- /** An array representing relative width of each column in relation to the other columns. */
1396
- colsWidthRatio?: number[];
1397
- /** An array representing the height of each row in pixels. */
1398
- rowsHeight?: number[];
1399
- /** An array representing the minimum width of each column in pixels. */
1400
- colsMinWidth?: number[];
1401
- }
1402
- export interface TableCellData {
1403
- /** Styling for the cell's background color and text alignment. */
1404
- cellStyle?: CellStyle;
1405
- /** The cell's border colors. */
1406
- borderColors?: BorderColors;
1407
- }
1408
- export declare enum VerticalAlignment {
1409
- /** Top alignment */
1410
- TOP = "TOP",
1411
- /** Middle alignment */
1412
- MIDDLE = "MIDDLE",
1413
- /** Bottom alignment */
1414
- BOTTOM = "BOTTOM"
1415
- }
1416
- export interface CellStyle {
1417
- /** Vertical alignment for the cell's text. */
1418
- verticalAlignment?: VerticalAlignment;
1419
- /**
1420
- * Cell background color as a hexadecimal value.
1421
- * @format COLOR_HEX
1422
- */
1423
- backgroundColor?: string | null;
1424
- }
1425
- export interface BorderColors {
1426
- /**
1427
- * Left border color as a hexadecimal value.
1428
- * @format COLOR_HEX
1429
- */
1430
- left?: string | null;
1431
- /**
1432
- * Right border color as a hexadecimal value.
1433
- * @format COLOR_HEX
1434
- */
1435
- right?: string | null;
1436
- /**
1437
- * Top border color as a hexadecimal value.
1438
- * @format COLOR_HEX
1439
- */
1440
- top?: string | null;
1441
- /**
1442
- * Bottom border color as a hexadecimal value.
1443
- * @format COLOR_HEX
1444
- */
1445
- bottom?: string | null;
1446
- }
1447
- /**
1448
- * `NullValue` is a singleton enumeration to represent the null value for the
1449
- * `Value` type union.
1450
- *
1451
- * The JSON representation for `NullValue` is JSON `null`.
1452
- */
1453
- export declare enum NullValue {
1454
- /** Null value. */
1455
- NULL_VALUE = "NULL_VALUE"
1456
- }
1457
- /**
1458
- * `ListValue` is a wrapper around a repeated field of values.
1459
- *
1460
- * The JSON representation for `ListValue` is JSON array.
1461
- */
1462
- export interface ListValue {
1463
- /** Repeated field of dynamically typed values. */
1464
- values?: any[];
1465
- }
1466
- export interface AudioData {
1467
- /** Styling for the audio node's container. */
1468
- containerData?: PluginContainerData;
1469
- /** Audio file details. */
1470
- audio?: Media;
1471
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1472
- disableDownload?: boolean | null;
1473
- /** Cover image. */
1474
- coverImage?: Media;
1475
- /** Track name. */
1476
- name?: string | null;
1477
- /** Author name. */
1478
- authorName?: string | null;
1479
- /** An HTML version of the audio node. */
1480
- html?: string | null;
1481
- }
1482
- export interface OrderedListData {
1483
- /** Indentation level from 0-4. */
1484
- indentation?: number;
1485
- /** Offset level from 0-4. */
1486
- offset?: number | null;
1487
- /** List start number. */
1488
- start?: number | null;
1489
- }
1490
- export interface BulletedListData {
1491
- /** Indentation level from 0-4. */
1492
- indentation?: number;
1493
- /** Offset level from 0-4. */
1494
- offset?: number | null;
1495
- }
1496
- export interface BlockquoteData {
1497
- /** Indentation level from 1-4. */
1498
- indentation?: number;
1499
- }
1500
- export interface CaptionData {
1501
- textStyle?: TextStyle;
1502
- }
1503
- export interface LayoutCellData {
1504
- /** Size of the cell in 12 columns grid. */
1505
- colSpan?: number | null;
1506
- }
1507
- export interface Metadata {
1508
- /** Schema version. */
1509
- version?: number;
1510
- /**
1511
- * When the object was created.
1512
- * @readonly
1513
- * @deprecated
1514
- */
1515
- createdTimestamp?: Date | null;
1516
- /**
1517
- * When the object was most recently updated.
1518
- * @deprecated
1519
- */
1520
- updatedTimestamp?: Date | null;
1521
- /** Object ID. */
1522
- _id?: string | null;
1523
- }
1524
- export interface DocumentStyle {
1525
- /** Styling for H1 nodes. */
1526
- headerOne?: TextNodeStyle;
1527
- /** Styling for H2 nodes. */
1528
- headerTwo?: TextNodeStyle;
1529
- /** Styling for H3 nodes. */
1530
- headerThree?: TextNodeStyle;
1531
- /** Styling for H4 nodes. */
1532
- headerFour?: TextNodeStyle;
1533
- /** Styling for H5 nodes. */
1534
- headerFive?: TextNodeStyle;
1535
- /** Styling for H6 nodes. */
1536
- headerSix?: TextNodeStyle;
1537
- /** Styling for paragraph nodes. */
1538
- paragraph?: TextNodeStyle;
1539
- /** Styling for block quote nodes. */
1540
- blockquote?: TextNodeStyle;
1541
- /** Styling for code block nodes. */
1542
- codeBlock?: TextNodeStyle;
1543
- }
1544
- export interface TextNodeStyle {
1545
- /** The decorations to apply to the node. */
1546
- decorations?: Decoration[];
1547
- /** Padding and background color for the node. */
1548
- nodeStyle?: NodeStyle;
1549
- /** Line height for text in the node. */
1550
- lineHeight?: string | null;
1551
- }
1552
- export interface Mention extends MentionIdentityOneOf {
1553
- /**
1554
- * Wix user ID.
1555
- * @format GUID
1556
- */
1557
- userId?: string | null;
1558
- /**
1559
- * Member ID. See the Members API for more details.
1560
- * @format GUID
1561
- */
1562
- memberId?: string | null;
1563
- /**
1564
- * Visitor ID.
1565
- * @format GUID
1566
- */
1567
- visitorId?: string | null;
1568
- /**
1569
- * Group ID. See the Groups API for more details.
1570
- * @format GUID
1571
- */
1572
- groupId?: string | null;
1573
- }
1574
- /** @oneof */
1575
- export interface MentionIdentityOneOf {
1576
- /**
1577
- * Wix user ID.
1578
- * @format GUID
1579
- */
1580
- userId?: string | null;
1581
- /**
1582
- * Member ID. See the Members API for more details.
1583
- * @format GUID
1584
- */
1585
- memberId?: string | null;
1586
- /**
1587
- * Visitor ID.
1588
- * @format GUID
1589
- */
1590
- visitorId?: string | null;
1591
- /**
1592
- * Group ID. See the Groups API for more details.
1593
- * @format GUID
1594
- */
1595
- groupId?: string | null;
1596
- }
1597
- export interface Attachment extends AttachmentMediaOneOf {
1598
- /** Information about the image. */
1599
- image?: string;
1600
- /** Information about the video. */
1601
- video?: string;
1602
- /** Information about the audio. */
1603
- audio?: string;
1604
- /** Information about the document. */
1605
- document?: string;
1606
- /**
1607
- * Mime type of attachment.
1608
- * @maxLength 3000
1609
- */
1610
- mimeType?: string | null;
1611
- }
1612
- /** @oneof */
1613
- export interface AttachmentMediaOneOf {
1614
- /** Information about the image. */
1615
- image?: string;
1616
- /** Information about the video. */
1617
- video?: string;
1618
- /** Information about the audio. */
1619
- audio?: string;
1620
- /** Information about the document. */
1621
- document?: string;
1622
- }
1623
- export interface VideoResolution {
1624
- /** Video URL. */
1625
- url?: string;
1626
- /** Video height. */
1627
- height?: number;
1628
- /** Video width. */
1629
- width?: number;
1630
- /** Video format for example, mp4, hls. */
1631
- format?: string;
1632
- /**
1633
- * Video quality. For example: 480p, 720p.
1634
- * @readonly
1635
- */
1636
- quality?: string | null;
1637
- /**
1638
- * Video filename.
1639
- * @readonly
1640
- */
1641
- filename?: string | null;
1642
- /**
1643
- * Video duration in seconds.
1644
- * @readonly
1645
- */
1646
- durationInSeconds?: number | null;
1647
- /**
1648
- * When true, this is a protected asset, and calling the URL will return a 403 error.
1649
- * In order to access private assets, make a request to:
1650
- * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
1651
- * @readonly
1652
- */
1653
- private?: boolean | null;
1654
- /**
1655
- * Key to identify the video resolution's relationship to the original media in WixMedia.
1656
- * Can be used to request a download for the specific video resolution.
1657
- * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
1658
- * @readonly
1659
- */
1660
- assetKey?: string | null;
1661
- }
1662
- export interface ContentAuthor extends ContentAuthorAuthorOneOf {
1663
- /**
1664
- * Wix user ID.
1665
- * @format GUID
1666
- */
1667
- userId?: string | null;
1668
- /**
1669
- * Member ID. See the Members API for more details.
1670
- * @format GUID
1671
- */
1672
- memberId?: string | null;
1673
- /**
1674
- * Visitor ID.
1675
- * @format GUID
1676
- */
1677
- visitorId?: string | null;
1678
- /**
1679
- * 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).
1680
- * @format GUID
1681
- */
1682
- appId?: string | null;
1683
- }
1684
- /** @oneof */
1685
- export interface ContentAuthorAuthorOneOf {
1686
- /**
1687
- * Wix user ID.
1688
- * @format GUID
1689
- */
1690
- userId?: string | null;
1691
- /**
1692
- * Member ID. See the Members API for more details.
1693
- * @format GUID
1694
- */
1695
- memberId?: string | null;
1696
- /**
1697
- * Visitor ID.
1698
- * @format GUID
1699
- */
1700
- visitorId?: string | null;
1701
- /**
1702
- * 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).
1703
- * @format GUID
1704
- */
1705
- appId?: string | null;
1706
- }
1707
- export interface CommentAuthor extends CommentAuthorIdentityOneOf {
1708
- /**
1709
- * Wix user ID.
1710
- * @format GUID
1711
- */
1712
- userId?: string | null;
1713
- /**
1714
- * Member ID. See the Members API for more details.
1715
- * @format GUID
1716
- */
1717
- memberId?: string | null;
1718
- /**
1719
- * Visitor ID.
1720
- * @format GUID
1721
- */
1722
- visitorId?: string | null;
1723
- }
1724
- /** @oneof */
1725
- export interface CommentAuthorIdentityOneOf {
1726
- /**
1727
- * Wix user ID.
1728
- * @format GUID
1729
- */
1730
- userId?: string | null;
1731
- /**
1732
- * Member ID. See the Members API for more details.
1733
- * @format GUID
1734
- */
1735
- memberId?: string | null;
1736
- /**
1737
- * Visitor ID.
1738
- * @format GUID
1739
- */
1740
- visitorId?: string | null;
1741
- }
1742
- export interface ParentComment {
1743
- /**
1744
- * Comment ID of the parent comment.
1745
- * @format GUID
1746
- * @immutable
1747
- */
1748
- _id?: string | null;
1749
- /**
1750
- * Author of the parent comment.
1751
- * @readonly
1752
- */
1753
- author?: CommentAuthor;
1754
- /**
1755
- * Parent comment status.
1756
- * @readonly
1757
- */
1758
- status?: Status;
1759
- }
1760
- export declare enum Status {
1761
- /** Unknown status. */
1762
- UNKNOWN = "UNKNOWN",
1763
- /** This comment is published and publicly visible. */
1764
- PUBLISHED = "PUBLISHED",
1765
- /** This comment is deleted. */
1766
- DELETED = "DELETED",
1767
- /** This comment is pending moderation. Moderation is not currently supported. */
1768
- PENDING = "PENDING",
1769
- /** This comment has been hidden by a site moderator. */
1770
- HIDDEN = "HIDDEN"
1771
- }
1772
- export interface VoteSummary {
1773
- /** Number of upvotes less downvotes on this comment. */
1774
- netVoteCount?: number;
1775
- /** Number of upvotes on this comment. */
1776
- upvoteCount?: number;
1777
- /** Number of downvotes on this comment. */
1778
- downvoteCount?: number;
1779
- }
1780
- export interface CommentReactionSummary {
1781
- /** Total amount of reactions. */
1782
- total?: number;
1783
- /**
1784
- * Number of each type of reaction. `key` is the code for a reaction type and
1785
- * `value` is the amount of that reaction type.
1786
- */
1787
- reactionCodeCount?: Record<string, number>;
1788
- }
1789
- export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
1790
- /** insert/update documents */
1791
- update?: InternalDocumentUpdateOperation;
1792
- /** delete by document ids */
1793
- deleteByIds?: DeleteByIdsOperation;
1794
- /** delete documents matching filter */
1795
- deleteByFilter?: DeleteByFilterOperation;
1796
- /** update internal documents matching filter */
1797
- updateByFilter?: InternalDocumentUpdateByFilterOperation;
1798
- /** update only existing documents */
1799
- updateExisting?: InternalUpdateExistingOperation;
1800
- /** insert/update documents with versioning */
1801
- versionedUpdate?: VersionedDocumentUpdateOperation;
1802
- /** delete by document ids with versioning */
1803
- versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1804
- /**
1805
- * type of the documents
1806
- * @minLength 2
1807
- */
1808
- documentType?: string;
1809
- /**
1810
- * language of the documents (mandatory)
1811
- * @minLength 2
1812
- */
1813
- language?: string | null;
1814
- /**
1815
- * one or more search documents
1816
- * @deprecated
1817
- */
1818
- addDocuments?: InternalDocument[];
1819
- /**
1820
- * one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
1821
- * @deprecated
1822
- */
1823
- removeDocumentIds?: string[];
1824
- /** id to pass to processing notification */
1825
- correlationId?: string | null;
1826
- /** when event was created / issued */
1827
- issuedAt?: Date | null;
1828
- }
1829
- /** @oneof */
1830
- export interface UpdateInternalDocumentsEventOperationOneOf {
1831
- /** insert/update documents */
1832
- update?: InternalDocumentUpdateOperation;
1833
- /** delete by document ids */
1834
- deleteByIds?: DeleteByIdsOperation;
1835
- /** delete documents matching filter */
1836
- deleteByFilter?: DeleteByFilterOperation;
1837
- /** update internal documents matching filter */
1838
- updateByFilter?: InternalDocumentUpdateByFilterOperation;
1839
- /** update only existing documents */
1840
- updateExisting?: InternalUpdateExistingOperation;
1841
- /** insert/update documents with versioning */
1842
- versionedUpdate?: VersionedDocumentUpdateOperation;
1843
- /** delete by document ids with versioning */
1844
- versionedDeleteByIds?: VersionedDeleteByIdsOperation;
1845
- }
1846
- export interface InternalDocument {
1847
- /** document with mandatory fields (id) and with fields specific to the type of the document */
1848
- document?: Record<string, any> | null;
1849
- }
1850
- export interface InternalDocumentUpdateOperation {
1851
- /** documents to index or update */
1852
- documents?: InternalDocument[];
1853
- }
1854
- export interface DeleteByIdsOperation {
1855
- /** ids of the documents to delete */
1856
- documentIds?: string[];
1857
- }
1858
- export interface DeleteByFilterOperation {
1859
- /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
1860
- filter?: Record<string, any> | null;
1861
- }
1862
- export interface InternalDocumentUpdateByFilterOperation {
1863
- /** documents matching this filter will be updated */
1864
- filter?: Record<string, any> | null;
1865
- /** partial document to apply */
1866
- document?: InternalDocument;
1867
- }
1868
- export interface InternalUpdateExistingOperation {
1869
- /** documents to update */
1870
- documents?: InternalDocument[];
1871
- }
1872
- export interface VersionedDocumentUpdateOperation {
1873
- /** documents to create or overwrite */
1874
- documents?: InternalDocument[];
1875
- /** versioning mode to use instead of default */
1876
- versioningMode?: VersioningMode;
1877
- }
1878
- export declare enum VersioningMode {
1879
- /** use default versioning mode agreed with search team */
1880
- DEFAULT = "DEFAULT",
1881
- /** execute only if version is greater than existing */
1882
- GREATER_THAN = "GREATER_THAN",
1883
- /** execute only if version is greater or equal to existing */
1884
- GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
1885
- }
1886
- export interface VersionedDeleteByIdsOperation {
1887
- /** ids with version of the documents to delete */
1888
- documentIds?: VersionedDocumentId[];
1889
- }
1890
- export interface VersionedDocumentId {
1891
- /** document id */
1892
- documentId?: string;
1893
- /** document version */
1894
- version?: string;
1895
- /** versioning mode to use instead of default */
1896
- versioningMode?: VersioningMode;
1897
- }
1898
- export interface CommentModerated {
1899
- comment?: Comment;
1900
- moderationAction?: Action;
1901
- }
1902
- export declare enum Action {
1903
- /** Unknown content. */
1904
- UNKNOWN = "UNKNOWN",
1905
- /** Approve draft content. */
1906
- APPROVE = "APPROVE",
1907
- /** Reject draft content. */
1908
- REJECT = "REJECT"
1909
- }
1910
- export interface CreateCommentRequest {
1911
- /** Comment to create. */
1912
- comment?: Comment;
1913
- }
1914
- export interface ContactDetails {
1915
- }
1916
- export interface CreateCommentResponse {
1917
- /** Created comment. */
1918
- comment?: Comment;
1919
- }
1920
- export interface ResourceCommentCountChanged {
1921
- /** ID of the app that the comment is added to. */
1922
- appId?: string;
1923
- /**
1924
- * ID of the specific context the comment is in response to.
1925
- *
1926
- * 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`.
1927
- */
1928
- contextId?: string;
1929
- /**
1930
- * ID of the specific resource that the comment is in response to.
1931
- *
1932
- * 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`.
1933
- */
1934
- resourceId?: string;
1935
- /** How many comments are published for the resource. */
1936
- publishedCommentCount?: number;
1937
- }
1938
- export interface GetCommentRequest {
1939
- /**
1940
- * ID of the comment to retrieve.
1941
- * @format GUID
1942
- */
1943
- commentId: string;
1944
- }
1945
- export interface GetCommentResponse {
1946
- /** Retrieved comment. */
1947
- comment?: Comment;
1948
- }
1949
- /** Comment info to update. */
1950
- export interface UpdateCommentRequest {
1951
- /** Comment info to update. */
1952
- comment?: Comment;
1953
- }
1954
- export interface UpdateCommentResponse {
1955
- /** Updated comment. */
1956
- comment?: Comment;
1957
- }
1958
- export interface CommentContentChanged {
1959
- /** Comment ID. */
1960
- commentId?: string;
1961
- /** Content before the update. */
1962
- previousContent?: CommentContent;
1963
- /** Content after the update. */
1964
- currentContent?: CommentContent;
1965
- }
1966
- export interface DeleteCommentRequest {
1967
- /**
1968
- * ID of the comment to delete.
1969
- * @format GUID
1970
- */
1971
- commentId: string;
1972
- }
1973
- export interface DeleteCommentResponse {
1974
- }
1975
- export interface CommentDeleted {
1976
- comment?: Comment;
1977
- }
1978
- export interface ModerateDraftContentRequest {
1979
- /**
1980
- * ID of the comment to moderate.
1981
- * @format GUID
1982
- */
1983
- commentId: string;
1984
- /**
1985
- * Revision number, which increments by `1` each time the comment is updated.
1986
- *
1987
- * To prevent conflicting changes, the current `revision` must be passed when updating the comment.
1988
- */
1989
- revision: string | null;
1990
- /** Draft content action. */
1991
- draftContentAction?: Action;
1992
- }
1993
- export interface ModerateDraftContentResponse {
1994
- /** Moderated comment. */
1995
- comment?: Comment;
1996
- }
1997
- export interface CommentPublished {
1998
- /** Comment info. */
1999
- comment?: Comment;
2000
- /** Whether this is the first comment publish. */
2001
- firstPublish?: boolean;
2002
- }
2003
- export interface CommentHidden {
2004
- comment?: Comment;
2005
- }
2006
- export interface QueryCommentsRequest {
2007
- /**
2008
- * App ID to query comments for.
2009
- * @format GUID
2010
- */
2011
- appId: string;
2012
- /** Query options. */
2013
- query: CursorQuery;
2014
- }
2015
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2016
- /**
2017
- * Cursor paging options.
2018
- *
2019
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2020
- */
2021
- cursorPaging?: CursorPaging;
2022
- /**
2023
- * Filter object.
2024
- *
2025
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2026
- */
2027
- filter?: Record<string, any> | null;
2028
- /**
2029
- * Sort object.
2030
- *
2031
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2032
- * @maxSize 5
2033
- */
2034
- sort?: Sorting[];
2035
- }
2036
- /** @oneof */
2037
- export interface CursorQueryPagingMethodOneOf {
2038
- /**
2039
- * Cursor paging options.
2040
- *
2041
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2042
- */
2043
- cursorPaging?: CursorPaging;
2044
- }
2045
- export interface Sorting {
2046
- /**
2047
- * Name of the field to sort by.
2048
- * @maxLength 512
2049
- */
2050
- fieldName?: string;
2051
- /** Sort order. */
2052
- order?: SortOrder;
2053
- }
2054
- export declare enum SortOrder {
2055
- ASC = "ASC",
2056
- DESC = "DESC"
2057
- }
2058
- export interface CursorPaging {
2059
- /**
2060
- * Maximum number of items to return in the results.
2061
- * @max 100
2062
- */
2063
- limit?: number | null;
2064
- /**
2065
- * Pointer to the next or previous page in the list of results.
2066
- *
2067
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2068
- * Not relevant for the first request.
2069
- * @maxLength 16000
2070
- */
2071
- cursor?: string | null;
2072
- }
2073
- export interface QueryCommentsResponse {
2074
- /** Retrieved comments. */
2075
- comments?: Comment[];
2076
- /** Paging metadata. */
2077
- pagingMetadata?: CursorPagingMetadata;
2078
- }
2079
- export interface CursorPagingMetadata {
2080
- /** Number of items returned in current page. */
2081
- count?: number | null;
2082
- /** Cursor strings that point to the next page, previous page, or both. */
2083
- cursors?: Cursors;
2084
- /**
2085
- * Whether there are more pages to retrieve following the current page.
2086
- *
2087
- * + `true`: Another page of results can be retrieved.
2088
- * + `false`: This is the last page.
2089
- */
2090
- hasNext?: boolean | null;
2091
- }
2092
- export interface Cursors {
2093
- /**
2094
- * Cursor string pointing to the next page in the list of results.
2095
- * @maxLength 16000
2096
- */
2097
- next?: string | null;
2098
- /**
2099
- * Cursor pointing to the previous page in the list of results.
2100
- * @maxLength 16000
2101
- */
2102
- prev?: string | null;
2103
- }
2104
- export interface MarkCommentRequest {
2105
- /**
2106
- * ID of the comment to mark.
2107
- * @format GUID
2108
- */
2109
- commentId: string;
2110
- }
2111
- export interface MarkCommentResponse {
2112
- /** Marked comment. */
2113
- comment?: Comment;
2114
- }
2115
- export interface CommentMarked {
2116
- comment?: Comment;
2117
- }
2118
- export interface UnmarkCommentRequest {
2119
- /**
2120
- * ID of the comment to unmark.
2121
- * @format GUID
2122
- */
2123
- commentId: string;
2124
- }
2125
- export interface UnmarkCommentResponse {
2126
- /** Unmarked comment. */
2127
- comment?: Comment;
2128
- }
2129
- export interface CommentUnmarked {
2130
- comment?: Comment;
2131
- }
2132
- export interface HideCommentRequest {
2133
- /**
2134
- * ID of the comment to hide.
2135
- * @format GUID
2136
- */
2137
- commentId: string;
2138
- }
2139
- export interface HideCommentResponse {
2140
- /** Hidden comment. */
2141
- comment?: Comment;
2142
- }
2143
- export interface PublishCommentRequest {
2144
- /**
2145
- * ID of the comment to publish.
2146
- * @format GUID
2147
- */
2148
- commentId: string;
2149
- }
2150
- export interface PublishCommentResponse {
2151
- /** Published comment. */
2152
- comment?: Comment;
2153
- }
2154
- /** Count comments options. */
2155
- export interface CountCommentsRequest {
2156
- /**
2157
- * App ID to count the comments of.
2158
- * @format GUID
2159
- */
2160
- appId?: string;
2161
- /** Filter to identify the comments that need to be counted. */
2162
- filter?: Record<string, any> | null;
2163
- }
2164
- export interface CountCommentsResponse {
2165
- /** Number of comments. */
2166
- count?: number;
2167
- }
2168
- export interface ListCommentsByResourceRequest {
2169
- /**
2170
- * ID of the app from which the comments are listed.
2171
- * @format GUID
2172
- */
2173
- appId: string;
2174
- /**
2175
- * ID of the specific context the comment is in response to.
2176
- *
2177
- * 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`.
2178
- * @maxLength 128
2179
- */
2180
- contextId: string;
2181
- /**
2182
- * Reserved for internal use.
2183
- * @maxLength 128
2184
- */
2185
- contextType?: string;
2186
- /**
2187
- * ID of the specific resource that the comment is in response to.
2188
- *
2189
- * 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`.
2190
- * @maxLength 128
2191
- */
2192
- resourceId: string;
2193
- /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
2194
- commentSort?: CommentSort;
2195
- /** Reply sort. Is ignored if `cursorPaging.cursor` is defined. */
2196
- replySort?: ReplySort;
2197
- /** Cursor paging. */
2198
- cursorPaging?: ListCommentsByResourceCursorPaging;
2199
- }
2200
- export interface CommentSort {
2201
- /** Sort order. */
2202
- order?: Order;
2203
- /**
2204
- * If set to `true`, marked comments appear in the original order, and not at the top of the list.
2205
- *
2206
- * Default: `false`. This means that marked comments are prioritized and listed first.
2207
- */
2208
- keepMarkedInOriginalOrder?: boolean;
2209
- }
2210
- export declare enum Order {
2211
- /** Unknown order. */
2212
- UNKNOWN_ORDER = "UNKNOWN_ORDER",
2213
- /** Oldest comments appear at the top of the list. */
2214
- OLDEST_FIRST = "OLDEST_FIRST",
2215
- /** Newest comments appear at the top of the list. */
2216
- NEWEST_FIRST = "NEWEST_FIRST",
2217
- /** Comments with the highest reaction count appear at the top of the list. */
2218
- REACTION_COUNT = "REACTION_COUNT",
2219
- /** Comments with the highest vote count appear at the top of the list. */
2220
- NET_VOTE_COUNT = "NET_VOTE_COUNT",
2221
- /** Comments with the highest rating appear at the top of the list. */
2222
- RATING = "RATING",
2223
- /** Comments with the lowest vote count appear at the top of the list. */
2224
- NET_VOTE_COUNT_ASC = "NET_VOTE_COUNT_ASC",
2225
- /** Comments with the lowest rating appear at the top of the list. */
2226
- RATING_ASC = "RATING_ASC"
2227
- }
2228
- export interface ReplySort {
2229
- /** Sort order. */
2230
- order?: ReplySortOrder;
2231
- /**
2232
- * Whether the marked comments are listed in the original order.
2233
- *
2234
- * If set to `true`, marked comments appear in the original order, and not at the top of the list.
2235
- *
2236
- * Default: `false`. In this case marked comments are prioritized and listed first.
2237
- */
2238
- keepMarkedInOriginalOrder?: boolean;
2239
- }
2240
- export declare enum ReplySortOrder {
2241
- /** Unknown order. */
2242
- UNKNOWN_ORDER = "UNKNOWN_ORDER",
2243
- /** Oldest comments appear at the top of the list. */
2244
- OLDEST_FIRST = "OLDEST_FIRST",
2245
- /** Newest comments appear at the top of the list. */
2246
- NEWEST_FIRST = "NEWEST_FIRST",
2247
- /** Comments with the highest reaction count appear at the top of the list. */
2248
- REACTION_COUNT = "REACTION_COUNT"
2249
- }
2250
- export interface ListCommentsByResourceCursorPaging {
2251
- /** Pointer to the next or previous page in the list of results. */
2252
- cursor?: string | null;
2253
- /**
2254
- * Number of items to return.
2255
- * @min 1
2256
- * @max 100
2257
- */
2258
- limit?: number | null;
2259
- /**
2260
- * Maximum number of replies in a response. Only applicable to parent comments.
2261
- * @max 100
2262
- */
2263
- repliesLimit?: number | null;
2264
- }
2265
- export interface ListCommentsByResourceResponse {
2266
- /** Listed comments. */
2267
- comments?: Comment[];
2268
- /** Paging metadata. */
2269
- pagingMetadata?: CursorPagingMetadata;
2270
- /** Listed comment replies. */
2271
- commentReplies?: Record<string, RepliesListResponse>;
2272
- }
2273
- export interface RepliesListResponse {
2274
- /** Listed comment replies. */
2275
- replies?: Comment[];
2276
- /** Paging metadata. */
2277
- pagingMetadata?: CursorPagingMetadata;
2278
- }
2279
- export interface GetCommentThreadRequest {
2280
- /**
2281
- * App ID.
2282
- * @maxLength 128
2283
- * @deprecated App ID.
2284
- * @targetRemovalDate 2024-11-01
2285
- */
2286
- appId?: string;
2287
- /**
2288
- * Comment ID.
2289
- * @format GUID
2290
- */
2291
- commentId: string;
2292
- /** Comment sorting. */
2293
- commentSort?: CommentSort;
2294
- /** Reply sorting. */
2295
- replySort?: ReplySort;
2296
- }
2297
- export interface GetCommentThreadResponse {
2298
- /** Retrieved replies. */
2299
- comments?: Comment[];
2300
- /** Paging metadata. */
2301
- pagingMetadata?: CursorPagingMetadata;
2302
- /** Retrieved replies of a reply. */
2303
- commentReplies?: Record<string, RepliesListResponse>;
2304
- }
2305
- export interface BulkPublishCommentRequest {
2306
- /**
2307
- * ID of the app where to publish the comment.
2308
- * @format GUID
2309
- */
2310
- appId: string;
2311
- /** 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"`}. */
2312
- filter: Record<string, any> | null;
2313
- }
2314
- export interface BulkPublishCommentResponse {
2315
- /**
2316
- * Job ID.
2317
- *
2318
- * Pass this ID to Get Async Job to retrieve job details and metadata.
2319
- * @format GUID
2320
- */
2321
- jobId?: string;
2322
- }
2323
- export interface BulkHideCommentRequest {
2324
- /**
2325
- * ID of the app where to hide the comments.
2326
- * @format GUID
2327
- */
2328
- appId: string;
2329
- /** 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"`}. */
2330
- filter: Record<string, any> | null;
2331
- }
2332
- export interface BulkHideCommentResponse {
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
- export interface BulkDeleteCommentRequest {
2342
- /**
2343
- * ID of the app where to delete the comments.
2344
- * @format GUID
2345
- */
2346
- appId: string;
2347
- /** 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"`}. */
2348
- filter: Record<string, any> | null;
2349
- }
2350
- export interface BulkDeleteCommentResponse {
2351
- /**
2352
- * Job ID.
2353
- *
2354
- * Pass this ID to Get Async Job to retrieve job details and metadata.
2355
- * @format GUID
2356
- */
2357
- jobId?: string;
2358
- }
2359
- export interface BulkModerateDraftContentRequest {
2360
- /**
2361
- * ID of the app where to moderate the comments.
2362
- * @format GUID
2363
- */
2364
- appId: string;
2365
- /** 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"`}. */
2366
- filter: Record<string, any> | null;
2367
- /** Action to do regarding draft content */
2368
- draftContentAction: Action;
2369
- }
2370
- export interface BulkModerateDraftContentResponse {
2371
- /**
2372
- * Job ID.
2373
- *
2374
- * Pass this ID to Get Async Job to retrieve job details and metadata.
2375
- * @format GUID
2376
- */
2377
- jobId?: string;
2378
- }
2379
- export interface BulkMoveCommentByFilterRequest {
2380
- /**
2381
- * ID of the app from which to move the comments.
2382
- * @format GUID
2383
- */
2384
- appId: string;
2385
- /** 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"`}. */
2386
- filter: Record<string, any> | null;
2387
- /** Where to move the comment. */
2388
- destination?: Destination;
2389
- }
2390
- export interface Destination {
2391
- /**
2392
- * Context ID of where to move the comment to.
2393
- * @maxLength 128
2394
- */
2395
- contextId?: string;
2396
- /**
2397
- * Resource ID of where to move the comment to.
2398
- * @maxLength 128
2399
- */
2400
- resourceId?: string;
2401
- }
2402
- export interface BulkMoveCommentByFilterResponse {
2403
- /**
2404
- * Job ID.
2405
- *
2406
- * Pass this ID to Get Async Job to retrieve job details and metadata.
2407
- * @format GUID
2408
- */
2409
- jobId?: string;
2410
- }
2411
- export interface CommentMoved {
2412
- comment?: Comment;
2413
- destination?: Destination;
2414
- }
2415
- export interface DomainEvent extends DomainEventBodyOneOf {
2416
- createdEvent?: EntityCreatedEvent;
2417
- updatedEvent?: EntityUpdatedEvent;
2418
- deletedEvent?: EntityDeletedEvent;
2419
- actionEvent?: ActionEvent;
2420
- /**
2421
- * Unique event ID.
2422
- * Allows clients to ignore duplicate webhooks.
2423
- */
2424
- _id?: string;
2425
- /**
2426
- * Assumes actions are also always typed to an entity_type
2427
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2428
- */
2429
- entityFqdn?: string;
2430
- /**
2431
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2432
- * This is although the created/updated/deleted notion is duplication of the oneof types
2433
- * Example: created/updated/deleted/started/completed/email_opened
2434
- */
2435
- slug?: string;
2436
- /** ID of the entity associated with the event. */
2437
- entityId?: string;
2438
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2439
- eventTime?: Date | null;
2440
- /**
2441
- * Whether the event was triggered as a result of a privacy regulation application
2442
- * (for example, GDPR).
2443
- */
2444
- triggeredByAnonymizeRequest?: boolean | null;
2445
- /** If present, indicates the action that triggered the event. */
2446
- originatedFrom?: string | null;
2447
- /**
2448
- * A sequence number defining the order of updates to the underlying entity.
2449
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2450
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2451
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2452
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2453
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2454
- */
2455
- entityEventSequence?: string | null;
2456
- }
2457
- /** @oneof */
2458
- export interface DomainEventBodyOneOf {
2459
- createdEvent?: EntityCreatedEvent;
2460
- updatedEvent?: EntityUpdatedEvent;
2461
- deletedEvent?: EntityDeletedEvent;
2462
- actionEvent?: ActionEvent;
2463
- }
2464
- export interface EntityCreatedEvent {
2465
- entity?: string;
2466
- }
2467
- export interface RestoreInfo {
2468
- deletedDate?: Date | null;
2469
- }
2470
- export interface EntityUpdatedEvent {
2471
- /**
2472
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2473
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2474
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2475
- */
2476
- currentEntity?: string;
2477
- }
2478
- export interface EntityDeletedEvent {
2479
- /** Entity that was deleted */
2480
- deletedEntity?: string | null;
2481
- }
2482
- export interface ActionEvent {
2483
- body?: string;
2484
- }
2485
- export interface MessageEnvelope {
2486
- /**
2487
- * App instance ID.
2488
- * @format GUID
2489
- */
2490
- instanceId?: string | null;
2491
- /**
2492
- * Event type.
2493
- * @maxLength 150
2494
- */
2495
- eventType?: string;
2496
- /** The identification type and identity data. */
2497
- identity?: IdentificationData;
2498
- /** Stringify payload. */
2499
- data?: string;
2500
- }
2501
- export interface IdentificationData extends IdentificationDataIdOneOf {
2502
- /**
2503
- * ID of a site visitor that has not logged in to the site.
2504
- * @format GUID
2505
- */
2506
- anonymousVisitorId?: string;
2507
- /**
2508
- * ID of a site visitor that has logged in to the site.
2509
- * @format GUID
2510
- */
2511
- memberId?: string;
2512
- /**
2513
- * ID of a Wix user (site owner, contributor, etc.).
2514
- * @format GUID
2515
- */
2516
- wixUserId?: string;
2517
- /**
2518
- * ID of an app.
2519
- * @format GUID
2520
- */
2521
- appId?: string;
2522
- /** @readonly */
2523
- identityType?: WebhookIdentityType;
2524
- }
2525
- /** @oneof */
2526
- export interface IdentificationDataIdOneOf {
2527
- /**
2528
- * ID of a site visitor that has not logged in to the site.
2529
- * @format GUID
2530
- */
2531
- anonymousVisitorId?: string;
2532
- /**
2533
- * ID of a site visitor that has logged in to the site.
2534
- * @format GUID
2535
- */
2536
- memberId?: string;
2537
- /**
2538
- * ID of a Wix user (site owner, contributor, etc.).
2539
- * @format GUID
2540
- */
2541
- wixUserId?: string;
2542
- /**
2543
- * ID of an app.
2544
- * @format GUID
2545
- */
2546
- appId?: string;
2547
- }
2548
- export declare enum WebhookIdentityType {
2549
- UNKNOWN = "UNKNOWN",
2550
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2551
- MEMBER = "MEMBER",
2552
- WIX_USER = "WIX_USER",
2553
- APP = "APP"
2554
- }
2555
- interface PluginContainerDataWidthNonNullableFields {
2556
- size: WidthType;
2557
- }
2558
- interface PluginContainerDataNonNullableFields {
2559
- width?: PluginContainerDataWidthNonNullableFields;
2560
- alignment: PluginContainerDataAlignment;
2561
- }
2562
- interface LinkNonNullableFields {
2563
- url: string;
2564
- anchor: string;
2565
- target: Target;
2566
- }
2567
- interface ButtonDataNonNullableFields {
2568
- containerData?: PluginContainerDataNonNullableFields;
2569
- type: Type;
2570
- link?: LinkNonNullableFields;
2571
- }
2572
- interface TextStyleNonNullableFields {
2573
- textAlignment: TextAlignment;
2574
- }
2575
- interface CodeBlockDataNonNullableFields {
2576
- textStyle?: TextStyleNonNullableFields;
2577
- }
2578
- interface DividerDataNonNullableFields {
2579
- containerData?: PluginContainerDataNonNullableFields;
2580
- lineStyle: LineStyle;
2581
- width: Width;
2582
- alignment: Alignment;
2583
- }
2584
- interface PDFSettingsNonNullableFields {
2585
- viewMode: ViewMode;
2586
- }
2587
- interface FileDataNonNullableFields {
2588
- containerData?: PluginContainerDataNonNullableFields;
2589
- pdfSettings?: PDFSettingsNonNullableFields;
2590
- }
2591
- interface ImageNonNullableFields {
2592
- link?: LinkNonNullableFields;
2593
- }
2594
- interface ItemNonNullableFields {
2595
- image?: ImageNonNullableFields;
2596
- }
2597
- interface LayoutNonNullableFields {
2598
- type: LayoutType;
2599
- orientation: Orientation;
2600
- }
2601
- interface ItemStyleNonNullableFields {
2602
- crop: Crop;
2603
- }
2604
- interface ThumbnailsNonNullableFields {
2605
- placement: ThumbnailsAlignment;
2606
- }
2607
- interface GalleryOptionsNonNullableFields {
2608
- layout?: LayoutNonNullableFields;
2609
- item?: ItemStyleNonNullableFields;
2610
- thumbnails?: ThumbnailsNonNullableFields;
2611
- }
2612
- interface GalleryDataNonNullableFields {
2613
- containerData?: PluginContainerDataNonNullableFields;
2614
- items: ItemNonNullableFields[];
2615
- options?: GalleryOptionsNonNullableFields;
2616
- }
2617
- interface GIFDataNonNullableFields {
2618
- containerData?: PluginContainerDataNonNullableFields;
2619
- height: number;
2620
- width: number;
2621
- gifType: GIFType;
2622
- }
2623
- interface HeadingDataNonNullableFields {
2624
- level: number;
2625
- textStyle?: TextStyleNonNullableFields;
2626
- }
2627
- interface HTMLDataNonNullableFields {
2628
- url: string;
2629
- html: string;
2630
- containerData?: PluginContainerDataNonNullableFields;
2631
- source: Source;
2632
- }
2633
- interface ImageDataNonNullableFields {
2634
- containerData?: PluginContainerDataNonNullableFields;
2635
- link?: LinkNonNullableFields;
2636
- }
2637
- interface LinkPreviewDataStylesNonNullableFields {
2638
- thumbnailPosition: Position;
2639
- }
2640
- interface LinkPreviewDataNonNullableFields {
2641
- containerData?: PluginContainerDataNonNullableFields;
2642
- link?: LinkNonNullableFields;
2643
- styles?: LinkPreviewDataStylesNonNullableFields;
2644
- }
2645
- interface MapSettingsNonNullableFields {
2646
- mapType: MapType;
2647
- }
2648
- interface MapDataNonNullableFields {
2649
- containerData?: PluginContainerDataNonNullableFields;
2650
- mapSettings?: MapSettingsNonNullableFields;
2651
- }
2652
- interface ParagraphDataNonNullableFields {
2653
- textStyle?: TextStyleNonNullableFields;
2654
- }
2655
- interface PermissionsNonNullableFields {
2656
- view: ViewRole;
2657
- vote: VoteRole;
2658
- }
2659
- interface SettingsNonNullableFields {
2660
- permissions?: PermissionsNonNullableFields;
2661
- }
2662
- interface PollNonNullableFields {
2663
- settings?: SettingsNonNullableFields;
2664
- }
2665
- interface PollLayoutNonNullableFields {
2666
- type: PollLayoutType;
2667
- direction: PollLayoutDirection;
2668
- }
2669
- interface PollDataLayoutNonNullableFields {
2670
- poll?: PollLayoutNonNullableFields;
2671
- }
2672
- interface BackgroundNonNullableFields {
2673
- type: BackgroundType;
2674
- }
2675
- interface PollDesignNonNullableFields {
2676
- background?: BackgroundNonNullableFields;
2677
- }
2678
- interface DesignNonNullableFields {
2679
- poll?: PollDesignNonNullableFields;
2680
- }
2681
- interface PollDataNonNullableFields {
2682
- containerData?: PluginContainerDataNonNullableFields;
2683
- poll?: PollNonNullableFields;
2684
- layout?: PollDataLayoutNonNullableFields;
2685
- design?: DesignNonNullableFields;
2686
- }
2687
- interface AnchorDataNonNullableFields {
2688
- anchor: string;
2689
- }
2690
- interface LinkDataNonNullableFields {
2691
- link?: LinkNonNullableFields;
2692
- }
2693
- interface MentionDataNonNullableFields {
2694
- name: string;
2695
- slug: string;
2696
- }
2697
- interface FontSizeDataNonNullableFields {
2698
- unit: FontType;
2699
- }
2700
- interface DecorationNonNullableFields {
2701
- anchorData?: AnchorDataNonNullableFields;
2702
- linkData?: LinkDataNonNullableFields;
2703
- mentionData?: MentionDataNonNullableFields;
2704
- fontSizeData?: FontSizeDataNonNullableFields;
2705
- type: DecorationType;
2706
- }
2707
- interface TextDataNonNullableFields {
2708
- text: string;
2709
- decorations: DecorationNonNullableFields[];
2710
- }
2711
- interface AppEmbedDataNonNullableFields {
2712
- type: AppType;
2713
- }
2714
- interface VideoDataNonNullableFields {
2715
- containerData?: PluginContainerDataNonNullableFields;
2716
- }
2717
- interface EmbedDataNonNullableFields {
2718
- containerData?: PluginContainerDataNonNullableFields;
2719
- }
2720
- interface CollapsibleListDataNonNullableFields {
2721
- containerData?: PluginContainerDataNonNullableFields;
2722
- initialExpandedItems: InitialExpandedItems;
2723
- direction: Direction;
2724
- }
2725
- interface DimensionsNonNullableFields {
2726
- colsWidthRatio: number[];
2727
- rowsHeight: number[];
2728
- colsMinWidth: number[];
2729
- }
2730
- interface TableDataNonNullableFields {
2731
- containerData?: PluginContainerDataNonNullableFields;
2732
- dimensions?: DimensionsNonNullableFields;
2733
- }
2734
- interface CellStyleNonNullableFields {
2735
- verticalAlignment: VerticalAlignment;
2736
- }
2737
- interface TableCellDataNonNullableFields {
2738
- cellStyle?: CellStyleNonNullableFields;
2739
- }
2740
- interface AudioDataNonNullableFields {
2741
- containerData?: PluginContainerDataNonNullableFields;
2742
- }
2743
- interface OrderedListDataNonNullableFields {
2744
- indentation: number;
2745
- }
2746
- interface BulletedListDataNonNullableFields {
2747
- indentation: number;
2748
- }
2749
- interface BlockquoteDataNonNullableFields {
2750
- indentation: number;
2751
- }
2752
- interface CaptionDataNonNullableFields {
2753
- textStyle?: TextStyleNonNullableFields;
2754
- }
2755
- interface NodeNonNullableFields {
2756
- buttonData?: ButtonDataNonNullableFields;
2757
- codeBlockData?: CodeBlockDataNonNullableFields;
2758
- dividerData?: DividerDataNonNullableFields;
2759
- fileData?: FileDataNonNullableFields;
2760
- galleryData?: GalleryDataNonNullableFields;
2761
- gifData?: GIFDataNonNullableFields;
2762
- headingData?: HeadingDataNonNullableFields;
2763
- htmlData?: HTMLDataNonNullableFields;
2764
- imageData?: ImageDataNonNullableFields;
2765
- linkPreviewData?: LinkPreviewDataNonNullableFields;
2766
- mapData?: MapDataNonNullableFields;
2767
- paragraphData?: ParagraphDataNonNullableFields;
2768
- pollData?: PollDataNonNullableFields;
2769
- textData?: TextDataNonNullableFields;
2770
- appEmbedData?: AppEmbedDataNonNullableFields;
2771
- videoData?: VideoDataNonNullableFields;
2772
- embedData?: EmbedDataNonNullableFields;
2773
- collapsibleListData?: CollapsibleListDataNonNullableFields;
2774
- tableData?: TableDataNonNullableFields;
2775
- tableCellData?: TableCellDataNonNullableFields;
2776
- audioData?: AudioDataNonNullableFields;
2777
- orderedListData?: OrderedListDataNonNullableFields;
2778
- bulletedListData?: BulletedListDataNonNullableFields;
2779
- blockquoteData?: BlockquoteDataNonNullableFields;
2780
- captionData?: CaptionDataNonNullableFields;
2781
- type: NodeType;
2782
- _id: string;
2783
- nodes: NodeNonNullableFields[];
2784
- }
2785
- interface MetadataNonNullableFields {
2786
- version: number;
2787
- }
2788
- interface TextNodeStyleNonNullableFields {
2789
- decorations: DecorationNonNullableFields[];
2790
- }
2791
- interface DocumentStyleNonNullableFields {
2792
- headerOne?: TextNodeStyleNonNullableFields;
2793
- headerTwo?: TextNodeStyleNonNullableFields;
2794
- headerThree?: TextNodeStyleNonNullableFields;
2795
- headerFour?: TextNodeStyleNonNullableFields;
2796
- headerFive?: TextNodeStyleNonNullableFields;
2797
- headerSix?: TextNodeStyleNonNullableFields;
2798
- paragraph?: TextNodeStyleNonNullableFields;
2799
- blockquote?: TextNodeStyleNonNullableFields;
2800
- codeBlock?: TextNodeStyleNonNullableFields;
2801
- }
2802
- interface RichContentNonNullableFields {
2803
- nodes: NodeNonNullableFields[];
2804
- metadata?: MetadataNonNullableFields;
2805
- documentStyle?: DocumentStyleNonNullableFields;
2806
- }
2807
- interface AttachmentNonNullableFields {
2808
- image: string;
2809
- video: string;
2810
- audio: string;
2811
- document: string;
2812
- }
2813
- interface CommentContentNonNullableFields {
2814
- richContent?: RichContentNonNullableFields;
2815
- attachments: AttachmentNonNullableFields[];
2816
- }
2817
- interface ParentCommentNonNullableFields {
2818
- status: Status;
2819
- }
2820
- interface VoteSummaryNonNullableFields {
2821
- netVoteCount: number;
2822
- upvoteCount: number;
2823
- downvoteCount: number;
2824
- }
2825
- interface CommentReactionSummaryNonNullableFields {
2826
- total: number;
2827
- }
2828
- export interface CommentNonNullableFields {
2829
- content?: CommentContentNonNullableFields;
2830
- draftContent?: CommentContentNonNullableFields;
2831
- parentComment?: ParentCommentNonNullableFields;
2832
- parentIdsInThread: string[];
2833
- replyCount: number;
2834
- voteSummary?: VoteSummaryNonNullableFields;
2835
- status: Status;
2836
- reactionSummary?: CommentReactionSummaryNonNullableFields;
2837
- marked: boolean;
2838
- }
2839
- export interface CreateCommentResponseNonNullableFields {
2840
- comment?: CommentNonNullableFields;
2841
- }
2842
- export interface GetCommentResponseNonNullableFields {
2843
- comment?: CommentNonNullableFields;
2844
- }
2845
- export interface UpdateCommentResponseNonNullableFields {
2846
- comment?: CommentNonNullableFields;
2847
- }
2848
- export interface ModerateDraftContentResponseNonNullableFields {
2849
- comment?: CommentNonNullableFields;
2850
- }
2851
- export interface QueryCommentsResponseNonNullableFields {
2852
- comments: CommentNonNullableFields[];
2853
- }
2854
- export interface MarkCommentResponseNonNullableFields {
2855
- comment?: CommentNonNullableFields;
2856
- }
2857
- export interface UnmarkCommentResponseNonNullableFields {
2858
- comment?: CommentNonNullableFields;
2859
- }
2860
- export interface HideCommentResponseNonNullableFields {
2861
- comment?: CommentNonNullableFields;
2862
- }
2863
- export interface PublishCommentResponseNonNullableFields {
2864
- comment?: CommentNonNullableFields;
2865
- }
2866
- export interface CountCommentsResponseNonNullableFields {
2867
- count: number;
2868
- }
2869
- export interface ListCommentsByResourceResponseNonNullableFields {
2870
- comments: CommentNonNullableFields[];
2871
- }
2872
- export interface GetCommentThreadResponseNonNullableFields {
2873
- comments: CommentNonNullableFields[];
2874
- }
2875
- export interface BulkPublishCommentResponseNonNullableFields {
2876
- jobId: string;
2877
- }
2878
- export interface BulkHideCommentResponseNonNullableFields {
2879
- jobId: string;
2880
- }
2881
- export interface BulkDeleteCommentResponseNonNullableFields {
2882
- jobId: string;
2883
- }
2884
- export interface BulkModerateDraftContentResponseNonNullableFields {
2885
- jobId: string;
2886
- }
2887
- export interface BulkMoveCommentByFilterResponseNonNullableFields {
2888
- jobId: string;
2889
- }
2890
- export interface BaseEventMetadata {
2891
- /**
2892
- * App instance ID.
2893
- * @format GUID
2894
- */
2895
- instanceId?: string | null;
2896
- /**
2897
- * Event type.
2898
- * @maxLength 150
2899
- */
2900
- eventType?: string;
2901
- /** The identification type and identity data. */
2902
- identity?: IdentificationData;
2903
- }
2904
- export interface EventMetadata extends BaseEventMetadata {
2905
- /**
2906
- * Unique event ID.
2907
- * Allows clients to ignore duplicate webhooks.
2908
- */
2909
- _id?: string;
2910
- /**
2911
- * Assumes actions are also always typed to an entity_type
2912
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2913
- */
2914
- entityFqdn?: string;
2915
- /**
2916
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2917
- * This is although the created/updated/deleted notion is duplication of the oneof types
2918
- * Example: created/updated/deleted/started/completed/email_opened
2919
- */
2920
- slug?: string;
2921
- /** ID of the entity associated with the event. */
2922
- entityId?: string;
2923
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2924
- eventTime?: Date | null;
2925
- /**
2926
- * Whether the event was triggered as a result of a privacy regulation application
2927
- * (for example, GDPR).
2928
- */
2929
- triggeredByAnonymizeRequest?: boolean | null;
2930
- /** If present, indicates the action that triggered the event. */
2931
- originatedFrom?: string | null;
2932
- /**
2933
- * A sequence number defining the order of updates to the underlying entity.
2934
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2935
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2936
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2937
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2938
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2939
- */
2940
- entityEventSequence?: string | null;
2941
- }
2942
- export interface CommentContentChangedEnvelope {
2943
- data: CommentContentChanged;
2944
- metadata: EventMetadata;
2945
- }
2946
- /**
2947
- * Triggered when comment content is updated.
2948
- * @permissionScope Read Comments
2949
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
2950
- * @permissionScope Manage Comments
2951
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
2952
- * @permissionId WIX_COMMENTS.COMMENT_READ
2953
- * @webhook
2954
- * @eventType wix.comments.v2.comment_comment_content_changed
2955
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2956
- * @slug comment_content_changed
2957
- */
2958
- export declare function onCommentContentChanged(handler: (event: CommentContentChangedEnvelope) => void | Promise<void>): void;
2959
- export interface CommentHiddenEnvelope {
2960
- data: CommentHidden;
2961
- metadata: EventMetadata;
2962
- }
2963
- /**
2964
- * Triggered when a comment is hidden.
2965
- * @permissionScope Read Comments
2966
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
2967
- * @permissionScope Manage Comments
2968
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
2969
- * @permissionId WIX_COMMENTS.COMMENT_READ
2970
- * @webhook
2971
- * @eventType wix.comments.v2.comment_comment_hidden
2972
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2973
- * @slug comment_hidden
2974
- * @documentationMaturity preview
2975
- */
2976
- export declare function onCommentHidden(handler: (event: CommentHiddenEnvelope) => void | Promise<void>): void;
2977
- export interface CommentMarkedEnvelope {
2978
- data: CommentMarked;
2979
- metadata: EventMetadata;
2980
- }
2981
- /**
2982
- * Triggered when a comment is marked.
2983
- * @permissionScope Read Comments
2984
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
2985
- * @permissionScope Manage Comments
2986
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
2987
- * @permissionId WIX_COMMENTS.COMMENT_READ
2988
- * @webhook
2989
- * @eventType wix.comments.v2.comment_comment_marked
2990
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
2991
- * @slug comment_marked
2992
- */
2993
- export declare function onCommentMarked(handler: (event: CommentMarkedEnvelope) => void | Promise<void>): void;
2994
- export interface CommentMovedEnvelope {
2995
- data: CommentMoved;
2996
- metadata: EventMetadata;
2997
- }
2998
- /**
2999
- * Triggered when a comment is moved.
3000
- * @permissionScope Read Comments
3001
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3002
- * @permissionScope Manage Comments
3003
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3004
- * @permissionId WIX_COMMENTS.COMMENT_READ
3005
- * @webhook
3006
- * @eventType wix.comments.v2.comment_comment_moved
3007
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
3008
- * @slug comment_moved
3009
- * @documentationMaturity preview
3010
- */
3011
- export declare function onCommentMoved(handler: (event: CommentMovedEnvelope) => void | Promise<void>): void;
3012
- export interface CommentPublishedEnvelope {
3013
- data: CommentPublished;
3014
- metadata: EventMetadata;
3015
- }
3016
- /**
3017
- * Triggered when a comment is published.
3018
- * @permissionScope Read Comments
3019
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3020
- * @permissionScope Manage Comments
3021
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3022
- * @permissionId WIX_COMMENTS.COMMENT_READ
3023
- * @webhook
3024
- * @eventType wix.comments.v2.comment_comment_published
3025
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
3026
- * @slug comment_published
3027
- * @documentationMaturity preview
3028
- */
3029
- export declare function onCommentPublished(handler: (event: CommentPublishedEnvelope) => void | Promise<void>): void;
3030
- export interface CommentUnmarkedEnvelope {
3031
- data: CommentUnmarked;
3032
- metadata: EventMetadata;
3033
- }
3034
- /**
3035
- * Triggered when a comment is unmarked.
3036
- * @permissionScope Read Comments
3037
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3038
- * @permissionScope Manage Comments
3039
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3040
- * @permissionId WIX_COMMENTS.COMMENT_READ
3041
- * @webhook
3042
- * @eventType wix.comments.v2.comment_comment_unmarked
3043
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
3044
- * @slug comment_unmarked
3045
- */
3046
- export declare function onCommentUnmarked(handler: (event: CommentUnmarkedEnvelope) => void | Promise<void>): void;
3047
- export interface CommentCreatedEnvelope {
3048
- entity: Comment;
3049
- metadata: EventMetadata;
3050
- }
3051
- /**
3052
- * Triggered when a comment is created.
3053
- * @permissionScope Read Comments
3054
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3055
- * @permissionScope Manage Comments
3056
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3057
- * @permissionId WIX_COMMENTS.COMMENT_READ
3058
- * @webhook
3059
- * @eventType wix.comments.v2.comment_created
3060
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
3061
- * @slug created
3062
- */
3063
- export declare function onCommentCreated(handler: (event: CommentCreatedEnvelope) => void | Promise<void>): void;
3064
- export interface CommentResourceCommentCountChangedEnvelope {
3065
- data: ResourceCommentCountChanged;
3066
- metadata: EventMetadata;
3067
- }
3068
- /**
3069
- * Triggered when the total number of comments has changed in a resource.
3070
- * @permissionScope Read Comments
3071
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3072
- * @permissionScope Manage Comments
3073
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3074
- * @permissionId WIX_COMMENTS.COMMENT_READ
3075
- * @webhook
3076
- * @eventType wix.comments.v2.comment_resource_comment_count_changed
3077
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
3078
- * @slug resource_comment_count_changed
3079
- */
3080
- export declare function onCommentResourceCommentCountChanged(handler: (event: CommentResourceCommentCountChangedEnvelope) => void | Promise<void>): void;
3081
- export interface CommentUpdatedEnvelope {
3082
- entity: Comment;
3083
- metadata: EventMetadata;
3084
- }
3085
- /**
3086
- * Triggered when a comment is updated.
3087
- * @permissionScope Read Comments
3088
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3089
- * @permissionScope Manage Comments
3090
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3091
- * @permissionId WIX_COMMENTS.COMMENT_READ
3092
- * @webhook
3093
- * @eventType wix.comments.v2.comment_updated
3094
- * @serviceIdentifier wix.comments.ng.v1.CommentsNg
3095
- * @slug updated
3096
- */
3097
- export declare function onCommentUpdated(handler: (event: CommentUpdatedEnvelope) => void | Promise<void>): void;
3098
- /**
3099
- * Creates a new comment and publishes it.
3100
- *
3101
- * The `appId`, `contextId`, and `resourceId` are all required and associate the created comment with the specific
3102
- * resource it responds to. See **Integrations** in the Comments introduction for a list of integrated scopes for these fields.
3103
- *
3104
- * If the created comment is a direct response to another comment, the `commentId` of the parent comment should be passed
3105
- * as `parentComment.id` in this comment's request. See **Terminology** in the Comments introduction for additional information on parent comments and replies.
3106
- * @param comment - Comment to create.
3107
- * @public
3108
- * @requiredField comment
3109
- * @requiredField comment.appId
3110
- * @requiredField comment.content
3111
- * @requiredField comment.contextId
3112
- * @requiredField comment.resourceId
3113
- * @permissionId WIX_COMMENTS.COMMENT_CREATE
3114
- * @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_AUTHOR
3115
- * @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_COMMENT_DATE
3116
- * @permissionScope Manage Comments
3117
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3118
- * @permissionScope Manage Comments
3119
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3120
- * @permissionScope Manage Comments
3121
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3122
- * @applicableIdentity APP
3123
- * @returns Created comment.
3124
- * @fqn wix.comments.ng.v1.CommentsNg.CreateComment
3125
- */
3126
- export declare function createComment(comment: Comment): Promise<Comment & CommentNonNullableFields>;
3127
- /**
3128
- * Retrieves a comment.
3129
- * @param commentId - ID of the comment to retrieve.
3130
- * @public
3131
- * @requiredField commentId
3132
- * @permissionId WIX_COMMENTS.COMMENT_READ
3133
- * @permissionScope Read Comments
3134
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3135
- * @permissionScope Manage Comments
3136
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3137
- * @applicableIdentity APP
3138
- * @returns Retrieved comment.
3139
- * @fqn wix.comments.ng.v1.CommentsNg.GetComment
3140
- */
3141
- export declare function getComment(commentId: string): Promise<Comment & CommentNonNullableFields>;
3142
- /**
3143
- * Updates a comment.
3144
- *
3145
- * Each time the comment is updated, `revision` increments by 1. The current `revision` must be
3146
- * passed when updating the comment. This ensures you're working with the latest comment and
3147
- * prevents unintended overwrites.
3148
- * @param _id - Comment ID.
3149
- * @public
3150
- * @requiredField _id
3151
- * @requiredField comment
3152
- * @requiredField comment.revision
3153
- * @permissionId WIX_COMMENTS.COMMENT_UPDATE
3154
- * @permissionScope Manage Comments
3155
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3156
- * @applicableIdentity APP
3157
- * @returns Updated comment.
3158
- * @fqn wix.comments.ng.v1.CommentsNg.UpdateComment
3159
- */
3160
- export declare function updateComment(_id: string | null, comment: UpdateComment): Promise<Comment & CommentNonNullableFields>;
3161
- export interface UpdateComment {
3162
- /**
3163
- * Comment ID.
3164
- * @format GUID
3165
- * @readonly
3166
- */
3167
- _id?: string | null;
3168
- /**
3169
- * Revision number, which increments by 1 each time the comment is updated.
3170
- *
3171
- * To prevent conflicting changes, the current `revision` must be passed when updating the comment.
3172
- * @readonly
3173
- */
3174
- revision?: string | null;
3175
- /**
3176
- * Date and time the comment was created.
3177
- *
3178
- * **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.
3179
- * @readonly
3180
- */
3181
- _createdDate?: Date | null;
3182
- /**
3183
- * Date and time the comment was last updated.
3184
- * @readonly
3185
- */
3186
- _updatedDate?: Date | null;
3187
- /**
3188
- * ID of the app that the comment is added to.
3189
- * @format GUID
3190
- * @immutable
3191
- */
3192
- appId?: string | null;
3193
- /**
3194
- * ID of the specific context the comment is in response to.
3195
- *
3196
- * Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,
3197
- * the `forumPostId` is used as both the `contextId` and the `resourceId`.
3198
- * @immutable
3199
- * @maxLength 128
3200
- */
3201
- contextId?: string | null;
3202
- /**
3203
- * ID of the specific resource that the comment is in response to.
3204
- *
3205
- * Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,
3206
- * the `forumPostId` is used as both the `resourceId` and the `contextId`.
3207
- * @immutable
3208
- * @maxLength 128
3209
- */
3210
- resourceId?: string | null;
3211
- /** Published comment content. */
3212
- content?: CommentContent;
3213
- /**
3214
- * Comment's author.
3215
- * @immutable
3216
- */
3217
- author?: CommentAuthor;
3218
- /**
3219
- * Parent comment information.
3220
- *
3221
- * Only present if this comment is in a direct reply to another comment.
3222
- * See **Terminology** in the Comments introduction
3223
- * for more information about parent comments.
3224
- */
3225
- parentComment?: ParentComment;
3226
- /**
3227
- * Number of comments that reply to this comment.
3228
- * @readonly
3229
- */
3230
- replyCount?: number;
3231
- /**
3232
- * Summary of votes.
3233
- * @readonly
3234
- */
3235
- voteSummary?: VoteSummary;
3236
- /**
3237
- * Comment status.
3238
- * @readonly
3239
- */
3240
- status?: Status;
3241
- /**
3242
- * Comment rating.
3243
- * @readonly
3244
- */
3245
- rating?: number | null;
3246
- /**
3247
- * Summary of reactions.
3248
- * @readonly
3249
- */
3250
- reactionSummary?: CommentReactionSummary;
3251
- /** Whether the comment is marked. */
3252
- marked?: boolean;
3253
- /**
3254
- * Date and time when the comment was actually created.
3255
- * @immutable
3256
- */
3257
- commentDate?: Date | null;
3258
- /**
3259
- * Whether the comment has the updated content.
3260
- * @readonly
3261
- */
3262
- contentEdited?: boolean | null;
3263
- }
3264
- /**
3265
- * Deletes a comment.
3266
- *
3267
- * This method deletes the `content` of the comment and sets its `status` to `DELETED`.
3268
- * @param commentId - ID of the comment to delete.
3269
- * @public
3270
- * @requiredField commentId
3271
- * @permissionId WIX_COMMENTS.COMMENT_DELETE
3272
- * @permissionScope Manage Comments
3273
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3274
- * @applicableIdentity APP
3275
- * @fqn wix.comments.ng.v1.CommentsNg.DeleteComment
3276
- */
3277
- export declare function deleteComment(commentId: string): Promise<void>;
3278
- /**
3279
- * Moderates the draft content of a comment.
3280
- *
3281
- * - `APPROVE`: Moves `draftContent` to `content` and updates the comment `status` to `PUBLISHED`.
3282
- * - `REJECT`: Clears `draftContent` if comment `status` is `PUBLISHED` or, if comment `status` is `PENDING` it will keep `draftContent` the same and change `status` to `HIDDEN`.
3283
- * @param commentId - ID of the comment to moderate.
3284
- * @param revision - Revision number, which increments by `1` each time the comment is updated.
3285
- *
3286
- * To prevent conflicting changes, the current `revision` must be passed when updating the comment.
3287
- * @public
3288
- * @documentationMaturity preview
3289
- * @requiredField commentId
3290
- * @requiredField revision
3291
- * @permissionId WIX_COMMENTS.COMMENT_MODERATE_DRAFT_CONTENT
3292
- * @permissionScope Manage Comments
3293
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3294
- * @applicableIdentity APP
3295
- * @fqn wix.comments.ng.v1.CommentsNg.ModerateDraftContent
3296
- */
3297
- export declare function moderateDraftContent(commentId: string, revision: string | null, options?: ModerateDraftContentOptions): Promise<ModerateDraftContentResponse & ModerateDraftContentResponseNonNullableFields>;
3298
- export interface ModerateDraftContentOptions {
3299
- /** Draft content action. */
3300
- draftContentAction?: Action;
3301
- }
3302
- /**
3303
- * Creates a query to retrieve a list of comments.
3304
- *
3305
- * The `queryComments()` function builds a query to retrieve a list of comments and returns a [`CommentsQueryBuilder`](#commentsquerybuilder) object.
3306
- *
3307
- * The returned object contains the query definition, which is typically used to run the query using the [`find()`](#commentsquerybuilder/find) function.
3308
- *
3309
- * You can refine the query by chaining `CommentsQueryBuilder` functions onto the query. `CommentsQueryBuilder` functions enable you to sort, filter, and control the results that `queryComments()` returns.
3310
- *
3311
- * `queryComments()` runs with the following `CommentsQueryBuilder` default that you can override:
3312
- * + `ascending("_id")`
3313
- *
3314
- * The functions that are chained to `queryComments()` are applied in the order they are called. For example, if you apply `ascending("voteSummary.netVoteCount")` and then `ascending("replyCount")`, the results are sorted first by the `"voteSummary.netVoteCount"`, and then, if there are multiple results with the same `"voteSummary.netVoteCount"`, the items are sorted by `"replyCount"`.
3315
- *
3316
- * The following `CommentsQueryBuilder` functions are supported for the `queryComments()` function. For a full description of the comment object, see the object returned for the [`items`](#commentsqueryresult/items) property in [`CommentsQueryResult`](#commentsqueryresult).
3317
- * @public
3318
- * @requiredField appId
3319
- * @param appId - App ID to query comments for.
3320
- * @permissionScope Read Comments
3321
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3322
- * @permissionScope Manage Comments
3323
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3324
- * @permissionId WIX_COMMENTS.COMMENT_QUERY
3325
- * @applicableIdentity APP
3326
- * @fqn wix.comments.ng.v1.CommentsNg.QueryComments
3327
- */
3328
- export declare function queryComments(appId: string): CommentsQueryBuilder;
3329
- interface QueryCursorResult {
3330
- cursors: Cursors;
3331
- hasNext: () => boolean;
3332
- hasPrev: () => boolean;
3333
- length: number;
3334
- pageSize: number;
3335
- }
3336
- export interface CommentsQueryResult extends QueryCursorResult {
3337
- items: Comment[];
3338
- query: CommentsQueryBuilder;
3339
- next: () => Promise<CommentsQueryResult>;
3340
- prev: () => Promise<CommentsQueryResult>;
3341
- }
3342
- export interface CommentsQueryBuilder {
3343
- /** @param propertyName - Property whose value is compared with `value`.
3344
- * @param value - Value to compare against.
3345
- */
3346
- eq: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'replyCount' | 'voteSummary.netVoteCount' | 'status' | 'rating' | 'reactionSummary.total' | 'marked', value: any) => CommentsQueryBuilder;
3347
- /** @param propertyName - Property whose value is compared with `value`.
3348
- * @param value - Value to compare against.
3349
- */
3350
- ne: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'replyCount' | 'voteSummary.netVoteCount' | 'status' | 'rating' | 'reactionSummary.total' | 'marked', value: any) => CommentsQueryBuilder;
3351
- /** @param propertyName - Property whose value is compared with `value`.
3352
- * @param value - Value to compare against.
3353
- */
3354
- ge: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
3355
- /** @param propertyName - Property whose value is compared with `value`.
3356
- * @param value - Value to compare against.
3357
- */
3358
- gt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
3359
- /** @param propertyName - Property whose value is compared with `value`.
3360
- * @param value - Value to compare against.
3361
- */
3362
- le: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
3363
- /** @param propertyName - Property whose value is compared with `value`.
3364
- * @param value - Value to compare against.
3365
- */
3366
- lt: (propertyName: 'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total', value: any) => CommentsQueryBuilder;
3367
- in: (propertyName: '_id' | 'contextId' | 'resourceId' | 'author.userId' | 'author.memberId' | 'author.visitorId' | 'parentComment.id' | 'status', value: any) => CommentsQueryBuilder;
3368
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3369
- ascending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
3370
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3371
- descending: (...propertyNames: Array<'replyCount' | 'voteSummary.netVoteCount' | 'rating' | 'reactionSummary.total' | 'marked'>) => CommentsQueryBuilder;
3372
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
3373
- limit: (limit: number) => CommentsQueryBuilder;
3374
- /** @param cursor - A pointer to specific record */
3375
- skipTo: (cursor: string) => CommentsQueryBuilder;
3376
- find: () => Promise<CommentsQueryResult>;
3377
- }
3378
- /**
3379
- * Sets `marked` to `TRUE` to mark a comment.
3380
- *
3381
- * Call Query Comments to filter for marked comments to then apply customization to.
3382
- * See Sample Flows for an example.
3383
- * @param commentId - ID of the comment to mark.
3384
- * @public
3385
- * @requiredField commentId
3386
- * @permissionId WIX_COMMENTS.COMMENT_MARK
3387
- * @permissionScope Manage Comments
3388
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3389
- * @applicableIdentity APP
3390
- * @fqn wix.comments.ng.v1.CommentsNg.MarkComment
3391
- */
3392
- export declare function markComment(commentId: string): Promise<MarkCommentResponse & MarkCommentResponseNonNullableFields>;
3393
- /**
3394
- * Sets `marked` to `FALSE` to unmark a comment.
3395
- * @param commentId - ID of the comment to unmark.
3396
- * @public
3397
- * @requiredField commentId
3398
- * @permissionId WIX_COMMENTS.COMMENT_MARK
3399
- * @permissionScope Manage Comments
3400
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3401
- * @applicableIdentity APP
3402
- * @fqn wix.comments.ng.v1.CommentsNg.UnmarkComment
3403
- */
3404
- export declare function unmarkComment(commentId: string): Promise<UnmarkCommentResponse & UnmarkCommentResponseNonNullableFields>;
3405
- /**
3406
- * Hides a comment in a widget. The comment status becomes `HIDDEN`.
3407
- * @param commentId - ID of the comment to hide.
3408
- * @public
3409
- * @documentationMaturity preview
3410
- * @requiredField commentId
3411
- * @permissionId WIX_COMMENTS.COMMENT_HIDE
3412
- * @permissionScope Manage Comments
3413
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3414
- * @applicableIdentity APP
3415
- * @fqn wix.comments.ng.v1.CommentsNg.HideComment
3416
- */
3417
- export declare function hideComment(commentId: string): Promise<HideCommentResponse & HideCommentResponseNonNullableFields>;
3418
- /**
3419
- * Publishes a comment with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
3420
- *
3421
- * To publish a new comment, call Create Comment.
3422
- * @param commentId - ID of the comment to publish.
3423
- * @public
3424
- * @documentationMaturity preview
3425
- * @requiredField commentId
3426
- * @permissionId WIX_COMMENTS.COMMENT_PUBLISH
3427
- * @permissionScope Manage Comments
3428
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3429
- * @applicableIdentity APP
3430
- * @fqn wix.comments.ng.v1.CommentsNg.PublishComment
3431
- */
3432
- export declare function publishComment(commentId: string): Promise<PublishCommentResponse & PublishCommentResponseNonNullableFields>;
3433
- /**
3434
- * Counts comments, given the specified filtering. Comments with the `HIDDEN` status are not included in the response.
3435
- * @param appId - App ID to count the comments of.
3436
- * @public
3437
- * @requiredField appId
3438
- * @permissionId WIX_COMMENTS.COMMENT_COUNT
3439
- * @permissionScope Manage Comments
3440
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3441
- * @applicableIdentity APP
3442
- * @fqn wix.comments.ng.v1.CommentsNg.CountComments
3443
- */
3444
- export declare function countComments(appId: string, options?: CountCommentsOptions): Promise<CountCommentsResponse & CountCommentsResponseNonNullableFields>;
3445
- export interface CountCommentsOptions {
3446
- /** Filter to identify the comments that need to be counted. */
3447
- filter?: Record<string, any> | null;
3448
- }
3449
- /**
3450
- * Lists published comments and replies from a specified resource, such as a blog post.
3451
- * @param appId - ID of the app from which the comments are listed.
3452
- * @public
3453
- * @documentationMaturity preview
3454
- * @requiredField appId
3455
- * @requiredField options.contextId
3456
- * @requiredField options.resourceId
3457
- * @permissionId WIX_COMMENTS.COMMENT_LIST
3458
- * @permissionScope Read Comments
3459
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3460
- * @permissionScope Manage Comments
3461
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3462
- * @applicableIdentity APP
3463
- * @fqn wix.comments.ng.v1.CommentsNg.ListCommentsByResource
3464
- */
3465
- export declare function listCommentsByResource(appId: string, options?: ListCommentsByResourceOptions): Promise<ListCommentsByResourceResponse & ListCommentsByResourceResponseNonNullableFields>;
3466
- export interface ListCommentsByResourceOptions {
3467
- /**
3468
- * ID of the specific context the comment is in response to.
3469
- *
3470
- * 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`.
3471
- * @maxLength 128
3472
- */
3473
- contextId: string;
3474
- /**
3475
- * Reserved for internal use.
3476
- * @maxLength 128
3477
- */
3478
- contextType?: string;
3479
- /**
3480
- * ID of the specific resource that the comment is in response to.
3481
- *
3482
- * 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`.
3483
- * @maxLength 128
3484
- */
3485
- resourceId: string;
3486
- /** Comment sort. Is ignored if `cursorPaging.cursor` is defined. */
3487
- commentSort?: CommentSort;
3488
- /** Reply sort. Is ignored if `cursorPaging.cursor` is defined. */
3489
- replySort?: ReplySort;
3490
- /** Cursor paging. */
3491
- cursorPaging?: ListCommentsByResourceCursorPaging;
3492
- }
3493
- /**
3494
- * Returns a thread of a comment or a reply.
3495
- *
3496
- * If you request a comment thread, the method returns a single comment with cursors. With cursors (`pagingMetadata.cursors.next` or `pagingMetadata.cursors.prev`) you can load replies by calling the List Comments by Resource method.
3497
- *
3498
- * If you request a reply thread, the method returns a reply with its parent comment. With cursors (`pagingMetadata.cursors.next` or `pagingMetadata.cursors.prev`) you can load replies by calling the List Comments by Resource method.
3499
- * @param commentId - Comment ID.
3500
- * @public
3501
- * @documentationMaturity preview
3502
- * @requiredField commentId
3503
- * @permissionId WIX_COMMENTS.COMMENT_THREAD
3504
- * @permissionScope Read Comments
3505
- * @permissionScopeId SCOPE.DC_COMMENTS.READ.COMMENTS
3506
- * @permissionScope Manage Comments
3507
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3508
- * @applicableIdentity APP
3509
- * @fqn wix.comments.ng.v1.CommentsNg.GetCommentThread
3510
- */
3511
- export declare function getCommentThread(commentId: string, options?: GetCommentThreadOptions): Promise<GetCommentThreadResponse & GetCommentThreadResponseNonNullableFields>;
3512
- export interface GetCommentThreadOptions {
3513
- /**
3514
- * App ID.
3515
- * @maxLength 128
3516
- * @deprecated App ID.
3517
- * @targetRemovalDate 2024-11-01
3518
- */
3519
- appId?: string;
3520
- /** Comment sorting. */
3521
- commentSort?: CommentSort;
3522
- /** Reply sorting. */
3523
- replySort?: ReplySort;
3524
- }
3525
- /**
3526
- * Publishes multiple comments with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
3527
- * @param appId - ID of the app where to publish the comment.
3528
- * @public
3529
- * @documentationMaturity preview
3530
- * @requiredField appId
3531
- * @requiredField options
3532
- * @requiredField options.filter
3533
- * @permissionId WIX_COMMENTS.BULK_COMMENT_PUBLISH
3534
- * @permissionScope Manage Comments
3535
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3536
- * @applicableIdentity APP
3537
- * @fqn wix.comments.ng.v1.CommentsNg.BulkPublishComment
3538
- */
3539
- export declare function bulkPublishComment(appId: string, options: BulkPublishCommentOptions): Promise<BulkPublishCommentResponse & BulkPublishCommentResponseNonNullableFields>;
3540
- export interface BulkPublishCommentOptions {
3541
- /** 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"`}. */
3542
- filter: Record<string, any> | null;
3543
- }
3544
- /**
3545
- * Hides multiple comments. The comment status becomes `HIDDEN`.
3546
- * @param appId - ID of the app where to hide the comments.
3547
- * @public
3548
- * @documentationMaturity preview
3549
- * @requiredField appId
3550
- * @requiredField options
3551
- * @requiredField options.filter
3552
- * @permissionId WIX_COMMENTS.BULK_COMMENT_HIDE
3553
- * @permissionScope Manage Comments
3554
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3555
- * @applicableIdentity APP
3556
- * @fqn wix.comments.ng.v1.CommentsNg.BulkHideComment
3557
- */
3558
- export declare function bulkHideComment(appId: string, options: BulkHideCommentOptions): Promise<BulkHideCommentResponse & BulkHideCommentResponseNonNullableFields>;
3559
- export interface BulkHideCommentOptions {
3560
- /** 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"`}. */
3561
- filter: Record<string, any> | null;
3562
- }
3563
- /**
3564
- * Deletes multiple comments.
3565
- * @param appId - ID of the app where to delete the comments.
3566
- * @public
3567
- * @documentationMaturity preview
3568
- * @requiredField appId
3569
- * @requiredField options
3570
- * @requiredField options.filter
3571
- * @permissionId WIX_COMMENTS.BULK_COMMENT_DELETE
3572
- * @permissionScope Manage Comments
3573
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3574
- * @applicableIdentity APP
3575
- * @fqn wix.comments.ng.v1.CommentsNg.BulkDeleteComment
3576
- */
3577
- export declare function bulkDeleteComment(appId: string, options: BulkDeleteCommentOptions): Promise<BulkDeleteCommentResponse & BulkDeleteCommentResponseNonNullableFields>;
3578
- export interface BulkDeleteCommentOptions {
3579
- /** 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"`}. */
3580
- filter: Record<string, any> | null;
3581
- }
3582
- /**
3583
- * Moderates the draft content of multiple comments.
3584
- * @param appId - ID of the app where to moderate the comments.
3585
- * @public
3586
- * @documentationMaturity preview
3587
- * @requiredField appId
3588
- * @requiredField options
3589
- * @requiredField options.draftContentAction
3590
- * @requiredField options.filter
3591
- * @permissionId WIX_COMMENTS.BULK_COMMENT_MODERATE_DRAFT_CONTENT
3592
- * @permissionScope Manage Comments
3593
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3594
- * @applicableIdentity APP
3595
- * @fqn wix.comments.ng.v1.CommentsNg.BulkModerateDraftContent
3596
- */
3597
- export declare function bulkModerateDraftContent(appId: string, options: BulkModerateDraftContentOptions): Promise<BulkModerateDraftContentResponse & BulkModerateDraftContentResponseNonNullableFields>;
3598
- export interface BulkModerateDraftContentOptions {
3599
- /** 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"`}. */
3600
- filter: Record<string, any> | null;
3601
- /** Action to do regarding draft content */
3602
- draftContentAction: Action;
3603
- }
3604
- /**
3605
- * Moves multiple comments to another resource.
3606
- * @param appId - ID of the app from which to move the comments.
3607
- * @public
3608
- * @documentationMaturity preview
3609
- * @requiredField appId
3610
- * @requiredField options.destination.contextId
3611
- * @requiredField options.destination.resourceId
3612
- * @requiredField options.filter
3613
- * @permissionId WIX_COMMENTS.BULK_COMMENT_MOVE
3614
- * @permissionScope Manage Comments
3615
- * @permissionScopeId SCOPE.DC_COMMENTS.MANAGE.COMMENTS
3616
- * @applicableIdentity APP
3617
- * @fqn wix.comments.ng.v1.CommentsNg.BulkMoveCommentByFilter
3618
- */
3619
- export declare function bulkMoveCommentByFilter(appId: string, options?: BulkMoveCommentByFilterOptions): Promise<BulkMoveCommentByFilterResponse & BulkMoveCommentByFilterResponseNonNullableFields>;
3620
- export interface BulkMoveCommentByFilterOptions {
3621
- /** 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"`}. */
3622
- filter: Record<string, any> | null;
3623
- /** Where to move the comment. */
3624
- destination?: Destination;
3625
- }
3626
- export {};