@wix/himalaya-cli 0.1099.0 → 0.1101.0

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 (55) hide show
  1. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/comments-v1/src/extensions.d.ts +13 -0
  2. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/_shared/runtime.generated.d.ts +27 -0
  3. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/_shared/types.generated.d.ts +829 -0
  4. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/categories.generated.d.ts +113 -0
  5. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/commentContexts.generated.d.ts +43 -0
  6. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/comments.generated.d.ts +553 -0
  7. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/contentRevisions.generated.d.ts +100 -0
  8. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/index.generated.d.ts +7 -0
  9. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/ratings.generated.d.ts +72 -0
  10. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk-auto/comments/widgets.generated.d.ts +138 -0
  11. package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-comments.mjs +280 -7
  12. package/dist/authoring-runtime/node_modules/@wix/himalaya/package.json +1 -1
  13. package/dist/cli.mjs +16 -1
  14. package/guides/release-notes.md +9 -0
  15. package/guides/sdk-reference.json +291 -1
  16. package/guides/wix-api-usage.md +34 -1
  17. package/package.json +2 -2
  18. package/templates/beauty-salon/dev/index.ts +394 -514
  19. package/templates/beauty-salon/tier5-src/_shared/collection-contract.ts +8 -1
  20. package/templates/beauty-salon/tier5-src/himi-blog-post/index.ts +14 -4
  21. package/templates/beauty-salon-owner/tier5-src/_shared/collection-contract.ts +8 -1
  22. package/templates/branded-lite/dev/index.ts +394 -514
  23. package/templates/branded-lite/tier5-src/_shared/collection-contract.ts +8 -1
  24. package/templates/branded-lite/tier5-src/himi-blog-post/index.ts +14 -4
  25. package/templates/community-club/tier5-src/_shared/collection-contract.ts +8 -1
  26. package/templates/community-club/tier5-src/himi-blog-post/index.ts +14 -4
  27. package/templates/community-club-owner/tier5-src/_shared/collection-contract.ts +8 -1
  28. package/templates/events-meetups/tier5-src/_shared/collection-contract.ts +8 -1
  29. package/templates/events-meetups/tier5-src/himi-blog-post/index.ts +14 -4
  30. package/templates/events-meetups-owner/tier5-src/_shared/collection-contract.ts +8 -1
  31. package/templates/gym-fitness/dev/index.ts +394 -514
  32. package/templates/gym-fitness/tier5-src/_shared/collection-contract.ts +8 -1
  33. package/templates/gym-fitness/tier5-src/himi-blog-post/index.ts +14 -4
  34. package/templates/gym-fitness-owner/tier5-src/_shared/collection-contract.ts +8 -1
  35. package/templates/nonprofit-cause/tier5-src/_shared/collection-contract.ts +8 -1
  36. package/templates/nonprofit-cause/tier5-src/himi-blog-post/index.ts +14 -4
  37. package/templates/nonprofit-cause-owner/tier5-src/_shared/collection-contract.ts +8 -1
  38. package/templates/owner-lite/tier5-src/_shared/collection-contract.ts +8 -1
  39. package/templates/podcast-creator/tier5-src/_shared/collection-contract.ts +8 -1
  40. package/templates/podcast-creator/tier5-src/himi-blog-post/index.ts +14 -4
  41. package/templates/podcast-creator-owner/tier5-src/_shared/collection-contract.ts +8 -1
  42. package/templates/portfolio-creative/dev/index.ts +396 -516
  43. package/templates/portfolio-creative/tier5-src/_shared/collection-contract.ts +8 -1
  44. package/templates/portfolio-creative/tier5-src/himi-blog-post/index.ts +14 -4
  45. package/templates/portfolio-creative-owner/tier5-src/_shared/collection-contract.ts +8 -1
  46. package/templates/restaurant/tier5-src/_shared/collection-contract.ts +8 -1
  47. package/templates/restaurant/tier5-src/himi-blog-post/index.ts +14 -4
  48. package/templates/restaurant-owner/tier5-src/_shared/collection-contract.ts +8 -1
  49. package/templates/retail-store/dev/index.ts +396 -516
  50. package/templates/retail-store/tier5-src/_shared/collection-contract.ts +8 -1
  51. package/templates/retail-store/tier5-src/himi-blog-post/index.ts +14 -4
  52. package/templates/retail-store-owner/tier5-src/_shared/collection-contract.ts +8 -1
  53. package/templates/yoga-studio/tier5-src/_shared/collection-contract.ts +8 -1
  54. package/templates/yoga-studio/tier5-src/himi-blog-post/index.ts +14 -4
  55. package/templates/yoga-studio-owner/tier5-src/_shared/collection-contract.ts +8 -1
@@ -0,0 +1,113 @@
1
+ import { type WixCallOptions } from "../_shared/runtime.generated.js";
2
+ import type { CursorPagingMetadata, QueryV2 } from "../_shared/types.generated.js";
3
+ export type { AddressLocation, CursorPaging, CursorPagingMetadata, Cursors, Paging, QueryV2, Sorting } from "../_shared/types.generated.js";
4
+ export type { WixCallOptions } from "../_shared/runtime.generated.js";
5
+ export interface Category {
6
+ id?: string;
7
+ name?: string;
8
+ guestCommenting?: boolean;
9
+ guestReactions?: boolean;
10
+ reactionType?: string;
11
+ repliesReactionType?: string;
12
+ markedCommentLabelType?: string;
13
+ customMarkedCommentLabel?: string;
14
+ mainReaction?: ReactionIcon;
15
+ ratingsSettings?: RatingsSettings;
16
+ revision?: string;
17
+ createdDate?: string;
18
+ updatedDate?: string;
19
+ permissionsSettings?: PermissionsSettings;
20
+ active?: boolean;
21
+ appId?: string;
22
+ }
23
+ export interface CreateCategoryRequest {
24
+ category?: Category;
25
+ }
26
+ export interface CreateCategoryResponse {
27
+ category?: Category;
28
+ }
29
+ export interface DeleteCategoryRequest {
30
+ categoryId?: string;
31
+ revision?: string;
32
+ }
33
+ export interface DeleteCategoryResponse {
34
+ }
35
+ export interface GetCategoryRequest {
36
+ categoryId?: string;
37
+ }
38
+ export interface GetCategoryResponse {
39
+ category?: Category;
40
+ }
41
+ export interface Permissions {
42
+ role?: string;
43
+ }
44
+ export interface PermissionsSettings {
45
+ createComment?: Permissions;
46
+ createReply?: Permissions;
47
+ createReact?: Permissions;
48
+ }
49
+ export interface QueryCategoryRequest {
50
+ query?: QueryV2;
51
+ }
52
+ export interface QueryCategoryResponse {
53
+ categories?: Category[];
54
+ pagingMetadata?: CursorPagingMetadata;
55
+ }
56
+ export interface RatingsSettings {
57
+ ratingsEnabled?: boolean;
58
+ ratingRequired?: boolean;
59
+ }
60
+ export interface ReactionIcon {
61
+ iconType?: string;
62
+ }
63
+ export interface UpdateCategoryRequest {
64
+ category?: Category;
65
+ }
66
+ export interface UpdateCategoryResponse {
67
+ category?: Category;
68
+ }
69
+ /**
70
+ * Creates a new category.
71
+ *
72
+ * @permissionId WIX_COMMENTS.CATEGORY_CREATE
73
+ * @fqn wix.comments.categories.v1.CommentsCategories.CreateCategory
74
+ *
75
+ * POST /comments/v1/categories
76
+ */
77
+ export declare function createCategory(req?: CreateCategoryRequest, opts?: WixCallOptions): Promise<CreateCategoryResponse>;
78
+ /**
79
+ * Deletes a category.
80
+ *
81
+ * @permissionId WIX_COMMENTS.CATEGORY_DELETE
82
+ * @fqn wix.comments.categories.v1.CommentsCategories.DeleteCategory
83
+ *
84
+ * DELETE /comments/v1/categories/{categoryId}
85
+ */
86
+ export declare function deleteCategory(req: DeleteCategoryRequest, opts?: WixCallOptions): Promise<DeleteCategoryResponse>;
87
+ /**
88
+ * Retrieves a category by ID.
89
+ *
90
+ * @permissionId WIX_COMMENTS.CATEGORY_READ
91
+ * @fqn wix.comments.categories.v1.CommentsCategories.GetCategory
92
+ *
93
+ * GET /comments/v1/categories/{categoryId}
94
+ */
95
+ export declare function getCategory(req: GetCategoryRequest, opts?: WixCallOptions): Promise<GetCategoryResponse>;
96
+ /**
97
+ * Creates a query to retrieve a list of comment categories.
98
+ *
99
+ * @permissionId WIX_COMMENTS.CATEGORY_READ
100
+ * @fqn wix.comments.categories.v1.CommentsCategories.QueryCategory
101
+ *
102
+ * POST /comments/v1/categories/query
103
+ */
104
+ export declare function queryCategory(req?: QueryCategoryRequest, opts?: WixCallOptions): Promise<QueryCategoryResponse>;
105
+ /**
106
+ * Updates a category.
107
+ *
108
+ * @permissionId WIX_COMMENTS.CATEGORY_EDIT
109
+ * @fqn wix.comments.categories.v1.CommentsCategories.UpdateCategory
110
+ *
111
+ * PATCH /comments/v1/categories/{categoryId}
112
+ */
113
+ export declare function updateCategory(req: UpdateCategoryRequest, opts?: WixCallOptions): Promise<UpdateCategoryResponse>;
@@ -0,0 +1,43 @@
1
+ import { type WixCallOptions } from "../_shared/runtime.generated.js";
2
+ export type { WixCallOptions } from "../_shared/runtime.generated.js";
3
+ export interface CommentContext {
4
+ appId?: string;
5
+ contextId?: string;
6
+ contextType?: string;
7
+ permissions?: Permissions;
8
+ registrationData?: RegistrationData;
9
+ }
10
+ export interface GetCommentContextRequest {
11
+ appId?: string;
12
+ contextId?: string;
13
+ contextType?: string;
14
+ fields?: string[];
15
+ }
16
+ export interface GetCommentContextResponse {
17
+ context?: CommentContext;
18
+ }
19
+ export interface Permissions {
20
+ viewContext?: boolean;
21
+ createComment?: boolean;
22
+ createReply?: boolean;
23
+ updateAnyComment?: boolean;
24
+ deleteAnyComment?: boolean;
25
+ rateResource?: boolean;
26
+ markComment?: boolean;
27
+ voteComment?: boolean;
28
+ reportComment?: boolean;
29
+ reactToComment?: boolean;
30
+ }
31
+ export interface RegistrationData {
32
+ requireOwnerApproval?: boolean;
33
+ requireEmailVerification?: boolean;
34
+ }
35
+ /**
36
+ * Retrieves the comment permissions resolved for the current identity in the specified context.
37
+ *
38
+ * @permissionId WIX_COMMENTS.COMMENT_CONTEXT_READ
39
+ * @fqn wix.comments.context.v1.CommentsContextHost.GetCommentContext
40
+ *
41
+ * GET /comments/v1/contexts/{appId}
42
+ */
43
+ export declare function getCommentContext(req: GetCommentContextRequest, opts?: WixCallOptions): Promise<GetCommentContextResponse>;
@@ -0,0 +1,553 @@
1
+ import { type WixCallOptions } from "../_shared/runtime.generated.js";
2
+ import type { Animation, AppEmbedData, AudioData, BlockquoteData, BulletedListData, ButtonData, CaptionData, CardData, CheckboxListData, CodeBlockData, CollapsibleListData, CursorPagingMetadata, CursorQuery, DividerData, DocumentStyle, EmbedData, FileData, GIFData, GalleryOptions, HTMLData, HeadingData, ImageData, LayoutCellData, LayoutData, Link, LinkPreviewData, ListItemNodeData, MapData, Media, Metadata, NodeStyle, OrderedListData, ParagraphData, PluginContainerData, PollData, ShapeData, SlotData, SmartBlockCellData, SmartBlockData, TableCellData, TableData, TextData, TocData, Video, VideoData } from "../_shared/types.generated.js";
3
+ export type { AddressLocation, AnchorData, Animation, AppEmbedData, AudioData, Backdrop, Background, BackgroundGradient, BackgroundImage, Banner, BlockquoteData, BookingData, Border, BorderColors, BorderWidths, BulletedListData, ButtonData, ButtonStyles, CaptionData, CardData, CardDataBackground, CardStyles, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, Colors, CursorPaging, CursorPagingMetadata, CursorQuery, Cursors, Decoration, Design, Dimensions, DividerData, DividerDataStyles, DocumentStyle, EmbedData, EntranceAnimation, EntranceEffect, EventData, FileData, FileSource, FontFamilyData, FontSizeData, GIF, GIFData, GalleryOptions, GalleryOptionsLayout, Gradient, HTMLData, HeadingData, Height, ImageData, ImageDataCrop, ImageDataStyles, ImageStyles, ItemStyle, Layers, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, Link, LinkData, LinkPreviewData, LinkPreviewDataStyles, ListItemNodeData, LoopAnimation, LoopEffect, MapData, MapSettings, Media, MentionData, Metadata, NodeStyle, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, PDFSettings, ParagraphData, Permissions, PlaybackOptions, PluginContainerData, PluginContainerDataWidth, PointerEffect, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollLayout, PricingData, Rel, RibbonStyles, SectionDivider, Settings, ShapeData, ShapeDataStyles, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, Sorting, Spoiler, SpoilerData, Stop, Styles, StylesBorder, TableCellData, TableData, TextData, TextNodeStyle, TextStyle, Thumbnails, TocData, Video, VideoData } from "../_shared/types.generated.js";
4
+ export type { WixCallOptions } from "../_shared/runtime.generated.js";
5
+ export interface AddCommentReactionRequest {
6
+ commentId?: string;
7
+ reactionCode?: string;
8
+ }
9
+ export interface AddCommentReactionResponse {
10
+ }
11
+ export interface Attachment {
12
+ image?: Image;
13
+ video?: VideoV2;
14
+ audio?: Audio;
15
+ document?: Document;
16
+ mimeType?: string;
17
+ }
18
+ export interface Audio {
19
+ id?: string;
20
+ url?: string;
21
+ urlExpirationDate?: string;
22
+ sizeInBytes?: string;
23
+ filename?: string;
24
+ duration?: number;
25
+ private?: boolean;
26
+ assetKey?: string;
27
+ format?: string;
28
+ quality?: string;
29
+ }
30
+ export interface AuthorBadgesInfo {
31
+ badgesByMemberId?: Record<string, unknown>;
32
+ }
33
+ export interface BulkDeleteCommentRequest {
34
+ appId?: string;
35
+ filter?: Record<string, unknown>;
36
+ }
37
+ export interface BulkDeleteCommentResponse {
38
+ jobId?: string;
39
+ }
40
+ export interface BulkGetCommentReactionsRequest {
41
+ appId?: string;
42
+ contextId?: string;
43
+ contextType?: string;
44
+ commentIds?: string[];
45
+ }
46
+ export interface BulkGetCommentReactionsResponse {
47
+ reactions?: Record<string, unknown>;
48
+ }
49
+ export interface BulkHideCommentRequest {
50
+ appId?: string;
51
+ filter?: Record<string, unknown>;
52
+ }
53
+ export interface BulkHideCommentResponse {
54
+ jobId?: string;
55
+ }
56
+ export interface BulkModerateDraftContentRequest {
57
+ appId?: string;
58
+ filter?: Record<string, unknown>;
59
+ draftContentAction?: string;
60
+ }
61
+ export interface BulkModerateDraftContentResponse {
62
+ jobId?: string;
63
+ }
64
+ export interface BulkMoveCommentByFilterRequest {
65
+ appId?: string;
66
+ filter?: Record<string, unknown>;
67
+ destination?: Destination;
68
+ }
69
+ export interface BulkMoveCommentByFilterResponse {
70
+ jobId?: string;
71
+ }
72
+ export interface BulkPublishCommentRequest {
73
+ appId?: string;
74
+ filter?: Record<string, unknown>;
75
+ }
76
+ export interface BulkPublishCommentResponse {
77
+ jobId?: string;
78
+ }
79
+ export interface Comment {
80
+ id?: string;
81
+ revision?: string;
82
+ createdDate?: string;
83
+ updatedDate?: string;
84
+ appId?: string;
85
+ contextId?: string;
86
+ resourceId?: string;
87
+ content?: CommentContent;
88
+ draftContent?: CommentContent;
89
+ author?: CommentAuthor;
90
+ parentComment?: ParentComment;
91
+ replyCount?: number;
92
+ voteSummary?: VoteSummary;
93
+ status?: string;
94
+ rating?: number;
95
+ reactionSummary?: CommentReactionSummary;
96
+ marked?: boolean;
97
+ commentDate?: string;
98
+ contentEdited?: boolean;
99
+ }
100
+ export interface CommentAuthor {
101
+ userId?: string;
102
+ memberId?: string;
103
+ visitorId?: string;
104
+ }
105
+ export interface CommentContent {
106
+ richContent?: RichContent;
107
+ mentions?: Mention[];
108
+ attachments?: Attachment[];
109
+ }
110
+ export interface CommentReactionSummary {
111
+ total?: number;
112
+ reactionCodeCount?: Record<string, unknown>;
113
+ }
114
+ export interface CommentSort {
115
+ order?: string;
116
+ keepMarkedInOriginalOrder?: boolean;
117
+ }
118
+ export interface ContactDetails {
119
+ email?: string;
120
+ }
121
+ export interface CountCommentsRequest {
122
+ appId?: string;
123
+ filter?: Record<string, unknown>;
124
+ }
125
+ export interface CountCommentsResponse {
126
+ count?: number;
127
+ }
128
+ export interface CreateCommentRequest {
129
+ comment?: Comment;
130
+ contactDetails?: ContactDetails;
131
+ }
132
+ export interface CreateCommentResponse {
133
+ comment?: Comment;
134
+ }
135
+ export interface DeleteCommentRequest {
136
+ commentId?: string;
137
+ }
138
+ export interface DeleteCommentResponse {
139
+ }
140
+ export interface Destination {
141
+ contextId?: string;
142
+ resourceId?: string;
143
+ }
144
+ export interface Document {
145
+ id?: string;
146
+ url?: string;
147
+ urlExpirationDate?: string;
148
+ sizeInBytes?: string;
149
+ filename?: string;
150
+ }
151
+ export interface GalleryData {
152
+ containerData?: PluginContainerData;
153
+ items?: Item[];
154
+ options?: GalleryOptions;
155
+ disableExpand?: boolean;
156
+ disableDownload?: boolean;
157
+ animation?: Animation;
158
+ }
159
+ export interface GetCommentRequest {
160
+ commentId?: string;
161
+ }
162
+ export interface GetCommentResponse {
163
+ comment?: Comment;
164
+ }
165
+ export interface GetCommentThreadRequest {
166
+ appId?: string;
167
+ commentId?: string;
168
+ commentSort?: CommentSort;
169
+ replySort?: ReplySort;
170
+ fields?: string[];
171
+ }
172
+ export interface GetCommentThreadResponse {
173
+ comments?: Comment[];
174
+ pagingMetadata?: CursorPagingMetadata;
175
+ commentReplies?: Record<string, unknown>;
176
+ authorBadges?: AuthorBadgesInfo;
177
+ }
178
+ export interface HideCommentRequest {
179
+ commentId?: string;
180
+ }
181
+ export interface HideCommentResponse {
182
+ comment?: Comment;
183
+ }
184
+ export interface Image {
185
+ id?: string;
186
+ url?: string;
187
+ height?: number;
188
+ width?: number;
189
+ altText?: string;
190
+ urlExpirationDate?: string;
191
+ filename?: string;
192
+ sizeInBytes?: string;
193
+ }
194
+ export interface Item {
195
+ image?: ItemImage;
196
+ video?: Video;
197
+ title?: string;
198
+ altText?: string;
199
+ }
200
+ export interface ItemImage {
201
+ media?: Media;
202
+ link?: Link;
203
+ }
204
+ export interface ListCommentsByResourceCursorPaging {
205
+ cursor?: string;
206
+ limit?: number;
207
+ repliesLimit?: number;
208
+ }
209
+ export interface ListCommentsByResourceRequest {
210
+ appId?: string;
211
+ contextId?: string;
212
+ contextType?: string;
213
+ resourceId?: string;
214
+ commentSort?: CommentSort;
215
+ replySort?: ReplySort;
216
+ cursorPaging?: ListCommentsByResourceCursorPaging;
217
+ fields?: string[];
218
+ }
219
+ export interface ListCommentsByResourceResponse {
220
+ comments?: Comment[];
221
+ pagingMetadata?: CursorPagingMetadata;
222
+ commentReplies?: Record<string, unknown>;
223
+ authorBadges?: AuthorBadgesInfo;
224
+ }
225
+ export interface MarkCommentRequest {
226
+ commentId?: string;
227
+ }
228
+ export interface MarkCommentResponse {
229
+ comment?: Comment;
230
+ }
231
+ export interface Mention {
232
+ userId?: string;
233
+ memberId?: string;
234
+ visitorId?: string;
235
+ groupId?: string;
236
+ }
237
+ export interface ModerateDraftContentRequest {
238
+ commentId?: string;
239
+ revision?: string;
240
+ draftContentAction?: string;
241
+ }
242
+ export interface ModerateDraftContentResponse {
243
+ comment?: Comment;
244
+ }
245
+ export interface Node {
246
+ buttonData?: ButtonData;
247
+ codeBlockData?: CodeBlockData;
248
+ dividerData?: DividerData;
249
+ fileData?: FileData;
250
+ galleryData?: GalleryData;
251
+ gifData?: GIFData;
252
+ headingData?: HeadingData;
253
+ htmlData?: HTMLData;
254
+ imageData?: ImageData;
255
+ linkPreviewData?: LinkPreviewData;
256
+ mapData?: MapData;
257
+ paragraphData?: ParagraphData;
258
+ pollData?: PollData;
259
+ textData?: TextData;
260
+ appEmbedData?: AppEmbedData;
261
+ videoData?: VideoData;
262
+ embedData?: EmbedData;
263
+ collapsibleListData?: CollapsibleListData;
264
+ tableData?: TableData;
265
+ tableCellData?: TableCellData;
266
+ externalData?: Record<string, unknown>;
267
+ audioData?: AudioData;
268
+ orderedListData?: OrderedListData;
269
+ bulletedListData?: BulletedListData;
270
+ blockquoteData?: BlockquoteData;
271
+ captionData?: CaptionData;
272
+ layoutData?: LayoutData;
273
+ layoutCellData?: LayoutCellData;
274
+ shapeData?: ShapeData;
275
+ cardData?: CardData;
276
+ tocData?: TocData;
277
+ smartBlockData?: SmartBlockData;
278
+ smartBlockCellData?: SmartBlockCellData;
279
+ checkboxListData?: CheckboxListData;
280
+ listItemData?: ListItemNodeData;
281
+ slotData?: SlotData;
282
+ type?: string;
283
+ id?: string;
284
+ nodes?: Node[];
285
+ style?: NodeStyle;
286
+ }
287
+ export interface ParentComment {
288
+ id?: string;
289
+ author?: CommentAuthor;
290
+ status?: string;
291
+ }
292
+ export interface PublishCommentRequest {
293
+ commentId?: string;
294
+ }
295
+ export interface PublishCommentResponse {
296
+ comment?: Comment;
297
+ }
298
+ export interface QueryCommentsRequest {
299
+ appId?: string;
300
+ query?: CursorQuery;
301
+ }
302
+ export interface QueryCommentsResponse {
303
+ comments?: Comment[];
304
+ pagingMetadata?: CursorPagingMetadata;
305
+ }
306
+ export interface RemoveCommentReactionRequest {
307
+ commentId?: string;
308
+ reactionCode?: string;
309
+ }
310
+ export interface RemoveCommentReactionResponse {
311
+ }
312
+ export interface ReplySort {
313
+ order?: string;
314
+ keepMarkedInOriginalOrder?: boolean;
315
+ }
316
+ export interface RichContent {
317
+ nodes?: Node[];
318
+ metadata?: Metadata;
319
+ documentStyle?: DocumentStyle;
320
+ }
321
+ export interface UnmarkCommentRequest {
322
+ commentId?: string;
323
+ }
324
+ export interface UnmarkCommentResponse {
325
+ comment?: Comment;
326
+ }
327
+ export interface UpdateCommentRequest {
328
+ comment?: Comment;
329
+ }
330
+ export interface UpdateCommentResponse {
331
+ comment?: Comment;
332
+ }
333
+ export interface VideoResolution {
334
+ url?: string;
335
+ height?: number;
336
+ width?: number;
337
+ format?: string;
338
+ quality?: string;
339
+ filename?: string;
340
+ durationInSeconds?: number;
341
+ private?: boolean;
342
+ assetKey?: string;
343
+ }
344
+ export interface VideoV2 {
345
+ id?: string;
346
+ url?: string;
347
+ resolutions?: VideoResolution[];
348
+ filename?: string;
349
+ posters?: Image[];
350
+ sizeInBytes?: string;
351
+ urlExpirationDate?: string;
352
+ }
353
+ export interface VoteSummary {
354
+ netVoteCount?: number;
355
+ upvoteCount?: number;
356
+ downvoteCount?: number;
357
+ }
358
+ /**
359
+ * Adds the current identity's reaction to a comment.
360
+ *
361
+ * @scope visitor — an anonymous visitor session is enough.
362
+ * @permissionId comments:v2:comment:add_comment_reaction
363
+ * @fqn wix.comments.ng.v1.CommentsNg.AddCommentReaction
364
+ *
365
+ * POST /comments/v1/comments/{commentId}/reactions
366
+ */
367
+ export declare function addCommentReaction(req: AddCommentReactionRequest, opts?: WixCallOptions): Promise<AddCommentReactionResponse>;
368
+ /**
369
+ * Deletes multiple comments.
370
+ *
371
+ * @permissionId WIX_COMMENTS.BULK_COMMENT_DELETE
372
+ * @fqn wix.comments.ng.v1.CommentsNg.BulkDeleteComment
373
+ *
374
+ * PUT /comments/v1/bulk/comments/delete-by-filter
375
+ */
376
+ export declare function bulkDeleteComment(req?: BulkDeleteCommentRequest, opts?: WixCallOptions): Promise<BulkDeleteCommentResponse>;
377
+ /**
378
+ * Retrieves reactions for multiple comments.
379
+ *
380
+ * @scope visitor — an anonymous visitor session is enough.
381
+ * @permissionId comments:v2:comment:bulk_get_comment_reactions
382
+ * @fqn wix.comments.ng.v1.CommentsNg.BulkGetCommentReactions
383
+ *
384
+ * POST /comments/v1/bulk/comments/reactions/get
385
+ */
386
+ export declare function bulkGetCommentReactions(req?: BulkGetCommentReactionsRequest, opts?: WixCallOptions): Promise<BulkGetCommentReactionsResponse>;
387
+ /**
388
+ * Hides multiple comments. The comment status becomes `HIDDEN`.
389
+ *
390
+ * @permissionId WIX_COMMENTS.BULK_COMMENT_HIDE
391
+ * @fqn wix.comments.ng.v1.CommentsNg.BulkHideComment
392
+ *
393
+ * PUT /comments/v1/bulk/comments/hide-by-filter
394
+ */
395
+ export declare function bulkHideComment(req?: BulkHideCommentRequest, opts?: WixCallOptions): Promise<BulkHideCommentResponse>;
396
+ /**
397
+ * Moderates the draft content of multiple comments that match the specified filter.
398
+ *
399
+ * @permissionId WIX_COMMENTS.BULK_COMMENT_MODERATE_DRAFT_CONTENT
400
+ * @fqn wix.comments.ng.v1.CommentsNg.BulkModerateDraftContent
401
+ *
402
+ * POST /comments/v1/bulk/comments/moderate-by-filter
403
+ */
404
+ export declare function bulkModerateDraftContent(req?: BulkModerateDraftContentRequest, opts?: WixCallOptions): Promise<BulkModerateDraftContentResponse>;
405
+ /**
406
+ * Moves multiple comments to another resource.
407
+ *
408
+ * @permissionId WIX_COMMENTS.BULK_COMMENT_MOVE
409
+ * @fqn wix.comments.ng.v1.CommentsNg.BulkMoveCommentByFilter
410
+ *
411
+ * PUT /comments/v1/bulk/comments/move-by-filter
412
+ */
413
+ export declare function bulkMoveCommentByFilter(req?: BulkMoveCommentByFilterRequest, opts?: WixCallOptions): Promise<BulkMoveCommentByFilterResponse>;
414
+ /**
415
+ * Publishes multiple comments with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
416
+ *
417
+ * @permissionId WIX_COMMENTS.BULK_COMMENT_PUBLISH
418
+ * @fqn wix.comments.ng.v1.CommentsNg.BulkPublishComment
419
+ *
420
+ * POST /comments/v1/bulk/comments/publish-by-filter
421
+ */
422
+ export declare function bulkPublishComment(req?: BulkPublishCommentRequest, opts?: WixCallOptions): Promise<BulkPublishCommentResponse>;
423
+ /**
424
+ * Counts comments, given the specified filtering. Comments with the `HIDDEN` status are not included in the response.
425
+ *
426
+ * @permissionId WIX_COMMENTS.COMMENT_COUNT
427
+ * @fqn wix.comments.ng.v1.CommentsNg.CountComments
428
+ *
429
+ * POST /comments/v1/comments/count
430
+ */
431
+ export declare function countComments(req?: CountCommentsRequest, opts?: WixCallOptions): Promise<CountCommentsResponse>;
432
+ /**
433
+ * Creates a new comment.
434
+ *
435
+ * @scope member — requires a signed-in site member.
436
+ * @permissionId WIX_COMMENTS.COMMENT_CREATE
437
+ * @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_AUTHOR
438
+ * @permissionId WIX_COMMENTS.COMMENT_OVERRIDE_COMMENT_DATE
439
+ * @fqn wix.comments.ng.v1.CommentsNg.CreateComment
440
+ *
441
+ * POST /comments/v1/comments
442
+ */
443
+ export declare function createComment(req?: CreateCommentRequest, opts?: WixCallOptions): Promise<CreateCommentResponse>;
444
+ /**
445
+ * Deletes a comment.
446
+ *
447
+ * @permissionId WIX_COMMENTS.COMMENT_DELETE
448
+ * @fqn wix.comments.ng.v1.CommentsNg.DeleteComment
449
+ *
450
+ * DELETE /comments/v1/comments/{commentId}
451
+ */
452
+ export declare function deleteComment(req: DeleteCommentRequest, opts?: WixCallOptions): Promise<DeleteCommentResponse>;
453
+ /**
454
+ * Retrieves a comment.
455
+ *
456
+ * @permissionId WIX_COMMENTS.COMMENT_READ
457
+ * @fqn wix.comments.ng.v1.CommentsNg.GetComment
458
+ *
459
+ * GET /comments/v1/comments/{commentId}
460
+ */
461
+ export declare function getComment(req: GetCommentRequest, opts?: WixCallOptions): Promise<GetCommentResponse>;
462
+ /**
463
+ * Returns a thread of a comment or a reply.
464
+ *
465
+ * @permissionId WIX_COMMENTS.COMMENT_THREAD
466
+ * @fqn wix.comments.ng.v1.CommentsNg.GetCommentThread
467
+ *
468
+ * GET /comments/v1/comments/{commentId}/thread
469
+ */
470
+ export declare function getCommentThread(req: GetCommentThreadRequest, opts?: WixCallOptions): Promise<GetCommentThreadResponse>;
471
+ /**
472
+ * Hides a comment in a widget. The comment status becomes `HIDDEN`.
473
+ *
474
+ * @permissionId WIX_COMMENTS.COMMENT_HIDE
475
+ * @fqn wix.comments.ng.v1.CommentsNg.HideComment
476
+ *
477
+ * PUT /comments/v1/comments/{commentId}/hide
478
+ */
479
+ export declare function hideComment(req: HideCommentRequest, opts?: WixCallOptions): Promise<HideCommentResponse>;
480
+ /**
481
+ * Lists published comments and replies from a specified resource, such as a blog post.
482
+ *
483
+ * @permissionId WIX_COMMENTS.COMMENT_LIST
484
+ * @fqn wix.comments.ng.v1.CommentsNg.ListCommentsByResource
485
+ *
486
+ * GET /comments/v1/comments/list-by-resource
487
+ */
488
+ export declare function listCommentsByResource(req?: ListCommentsByResourceRequest, opts?: WixCallOptions): Promise<ListCommentsByResourceResponse>;
489
+ /**
490
+ * Sets `marked` to `TRUE` to mark a comment.
491
+ *
492
+ * @permissionId WIX_COMMENTS.COMMENT_MARK
493
+ * @fqn wix.comments.ng.v1.CommentsNg.MarkComment
494
+ *
495
+ * PUT /comments/v1/comments/{commentId}/mark
496
+ */
497
+ export declare function markComment(req: MarkCommentRequest, opts?: WixCallOptions): Promise<MarkCommentResponse>;
498
+ /**
499
+ * Moderates the draft content of a comment.
500
+ *
501
+ * @permissionId WIX_COMMENTS.COMMENT_MODERATE_DRAFT_CONTENT
502
+ * @fqn wix.comments.ng.v1.CommentsNg.ModerateDraftContent
503
+ *
504
+ * POST /comments/v1/comments/{commentId}/moderate
505
+ */
506
+ export declare function moderateDraftContent(req: ModerateDraftContentRequest, opts?: WixCallOptions): Promise<ModerateDraftContentResponse>;
507
+ /**
508
+ * Publishes a comment with the `HIDDEN` status. The comment status becomes `PUBLISHED`.
509
+ *
510
+ * @permissionId WIX_COMMENTS.COMMENT_PUBLISH
511
+ * @fqn wix.comments.ng.v1.CommentsNg.PublishComment
512
+ *
513
+ * PUT /comments/v1/comments/{commentId}/publish
514
+ */
515
+ export declare function publishComment(req: PublishCommentRequest, opts?: WixCallOptions): Promise<PublishCommentResponse>;
516
+ /**
517
+ * Creates a query to retrieve a list of comments.
518
+ *
519
+ * @permissionId WIX_COMMENTS.COMMENT_QUERY
520
+ * @fqn wix.comments.ng.v1.CommentsNg.QueryComments
521
+ *
522
+ * POST /comments/v1/comments/query-cursor
523
+ */
524
+ export declare function queryComments(req?: QueryCommentsRequest, opts?: WixCallOptions): Promise<QueryCommentsResponse>;
525
+ /**
526
+ * Removes the current identity's reaction from a comment.
527
+ *
528
+ * @scope visitor — an anonymous visitor session is enough.
529
+ * @permissionId comments:v2:comment:remove_comment_reaction
530
+ * @fqn wix.comments.ng.v1.CommentsNg.RemoveCommentReaction
531
+ *
532
+ * POST /comments/v1/comments/{commentId}/reactions/remove
533
+ */
534
+ export declare function removeCommentReaction(req: RemoveCommentReactionRequest, opts?: WixCallOptions): Promise<RemoveCommentReactionResponse>;
535
+ /**
536
+ * Sets `marked` to `FALSE` to unmark a comment.
537
+ *
538
+ * @permissionId WIX_COMMENTS.COMMENT_MARK
539
+ * @fqn wix.comments.ng.v1.CommentsNg.UnmarkComment
540
+ *
541
+ * PUT /comments/v1/comments/{commentId}/unmark
542
+ */
543
+ export declare function unmarkComment(req: UnmarkCommentRequest, opts?: WixCallOptions): Promise<UnmarkCommentResponse>;
544
+ /**
545
+ * Updates a comment.
546
+ *
547
+ * @scope member — requires a signed-in site member.
548
+ * @permissionId WIX_COMMENTS.COMMENT_UPDATE
549
+ * @fqn wix.comments.ng.v1.CommentsNg.UpdateComment
550
+ *
551
+ * PATCH /comments/v1/comments/{commentId}
552
+ */
553
+ export declare function updateComment(req: UpdateCommentRequest, opts?: WixCallOptions): Promise<UpdateCommentResponse>;