@wix/auto_sdk_feedback_comments 1.0.0

package/build/internal/es/index.d.mts

@@ -0,0 +1,116 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { Comment, CursorQuery, QueryCommentsResponse, StatusWithLiterals, UpdateCommentStatusOptions, UpdateCommentStatusResponse, CommentReply, CreateCommentReplyOptions, CreateCommentReplyResponse, UpdateCommentReplyIdentifiers, UpdateCommentReplyOptions, UpdateCommentReplyResponse, DeleteCommentReplyIdentifiers, DeleteCommentReplyResponse } from './index.typings.mjs';
+export { AccountInfo, ActionEvent, Breakpoint, CommentLocation, CreateCommentReplyRequest, CreateCommentRequest, CreateCommentResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DeleteCommentReplyRequest, DeleteCommentRequest, DeleteCommentResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetCommentRequest, GetCommentResponse, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, Position, QueryCommentsRequest, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Status, UpdateCommentReplyRequest, UpdateCommentRequest, UpdateCommentResponse, UpdateCommentStatusRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
+
+/** @internal */
+declare function getComment$1(httpClient: HttpClient): GetCommentSignature;
+interface GetCommentSignature {
+    /**
+     * Retrieves a Comment.
+     * @param - ID of the Comment to retrieve.
+     * @returns The requested Comment.
+     */
+    (commentId: string): Promise<NonNullablePaths<Comment, `_id` | `feedbackId` | `metaSiteId` | `commenterId` | `message` | `status` | `commentLocation.pageId` | `commentLocation.x` | `commentLocation.y` | `commentLocation.breakpoint._id` | `commentLocation.breakpoint.minWidth` | `commentLocation.breakpoint.maxWidth` | `commentLocation.innerPath` | `commentLocation.position.selector` | `commentLocation.position.offsetXPct` | `commentLocation.position.offsetYPct` | `commentLocation.position.innerPath` | `replies` | `replies.${number}.replierId` | `replies.${number}.message`, 2>>;
+}
+/** @internal */
+declare function queryComments$1(httpClient: HttpClient): QueryCommentsSignature;
+interface QueryCommentsSignature {
+    /**
+     * Retrieves a list of Comments, given the provided [paging, filtering, and sorting][1].
+     *
+     * Up to 1,000 Comments can be returned per request.
+     *
+     * To learn how to query Comments, see [API Query Language][2].
+     *
+     * [1]: https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging
+     * [2]: https://dev.wix.com/docs/rest/articles/getting-started/api-query-language
+     * @param - Query options.
+     */
+    (query: CursorQuery): Promise<NonNullablePaths<QueryCommentsResponse, `comments` | `comments.${number}._id` | `comments.${number}.feedbackId` | `comments.${number}.metaSiteId` | `comments.${number}.commenterId` | `comments.${number}.message` | `comments.${number}.status` | `comments.${number}.commentLocation.pageId` | `comments.${number}.commentLocation.x` | `comments.${number}.commentLocation.y` | `comments.${number}.commentLocation.breakpoint._id` | `comments.${number}.commentLocation.breakpoint.minWidth` | `comments.${number}.commentLocation.breakpoint.maxWidth` | `comments.${number}.commentLocation.innerPath` | `comments.${number}.commentLocation.position.selector` | `comments.${number}.commentLocation.position.offsetXPct` | `comments.${number}.commentLocation.position.offsetYPct` | `comments.${number}.commentLocation.position.innerPath`, 4>>;
+}
+/** @internal */
+declare function updateCommentStatus$1(httpClient: HttpClient): UpdateCommentStatusSignature;
+interface UpdateCommentStatusSignature {
+    /**
+     * Updates the triage status of a Comment.
+     *
+     * This is the only part of a Comment the site owner may change — the text belongs to whoever
+     * wrote it.
+     *
+     * Each time the Comment is updated, `revision` increments by 1. The current `revision` must be
+     * passed, which ensures you're working with the latest Comment and prevents unintended
+     * overwrites.
+     * @param - ID of the Comment to triage.
+     * @param - Status to set on the Comment.
+     */
+    (commentId: string, status: StatusWithLiterals, options: NonNullablePaths<UpdateCommentStatusOptions, `revision`, 0>): Promise<NonNullablePaths<UpdateCommentStatusResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
+}
+/** @internal */
+declare function deleteComment$1(httpClient: HttpClient): DeleteCommentSignature;
+interface DeleteCommentSignature {
+    /**
+     * Deletes a Comment.
+     *
+     * Deleting a Comment also deletes its replies.
+     * @param - ID of the Comment to delete.
+     */
+    (commentId: string): Promise<void>;
+}
+/** @internal */
+declare function createCommentReply$1(httpClient: HttpClient): CreateCommentReplySignature;
+interface CreateCommentReplySignature {
+    /**
+     * Adds a reply to a Comment.
+     *
+     * The reply is attributed to the calling user, or to the calling app when the call carries no
+     * user identity.
+     * @param - ID of the Comment to reply to.
+     * @param - The reply to add. Only `message` is honored.
+     */
+    (commentId: string, reply: NonNullablePaths<CommentReply, `message`, 0>, options: NonNullablePaths<CreateCommentReplyOptions, `revision`, 0>): Promise<NonNullablePaths<CreateCommentReplyResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
+}
+/** @internal */
+declare function updateCommentReply$1(httpClient: HttpClient): UpdateCommentReplySignature;
+interface UpdateCommentReplySignature {
+    /**
+     * Updates the text of one of the caller's own replies to a Comment.
+     *
+     * The reply is addressed by `reply_index`, its position in the Comment's `replies` list. Because
+     * indexes shift when a reply is deleted, the Comment's current `revision` must be passed; a stale
+     * `revision` is rejected rather than applied to whichever reply now sits at that index.
+     * @param - New text for the reply.
+     */
+    (identifiers: NonNullablePaths<UpdateCommentReplyIdentifiers, `commentId` | `replyIndex`, 0>, message: string, options: NonNullablePaths<UpdateCommentReplyOptions, `revision`, 0>): Promise<NonNullablePaths<UpdateCommentReplyResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
+}
+/** @internal */
+declare function deleteCommentReply$1(httpClient: HttpClient): DeleteCommentReplySignature;
+interface DeleteCommentReplySignature {
+    /**
+     * Deletes a reply to a Comment.
+     *
+     * The site owner may delete any reply, not only their own, as part of moderating the Comment.
+     *
+     * The reply is addressed by `reply_index`, its position in the Comment's `replies` list. Because
+     * indexes shift when a reply is deleted, the Comment's current `revision` must be passed; a stale
+     * `revision` is rejected rather than applied to whichever reply now sits at that index.
+     * @param - Current revision of the Comment.
+     */
+    (identifiers: NonNullablePaths<DeleteCommentReplyIdentifiers, `commentId` | `replyIndex`, 0>, revision: string): Promise<NonNullablePaths<DeleteCommentReplyResponse, `comment._id` | `comment.feedbackId` | `comment.metaSiteId` | `comment.commenterId` | `comment.message` | `comment.status` | `comment.commentLocation.pageId` | `comment.commentLocation.x` | `comment.commentLocation.y` | `comment.commentLocation.breakpoint._id` | `comment.commentLocation.breakpoint.minWidth` | `comment.commentLocation.breakpoint.maxWidth` | `comment.commentLocation.innerPath` | `comment.commentLocation.position.selector` | `comment.commentLocation.position.offsetXPct` | `comment.commentLocation.position.offsetYPct` | `comment.commentLocation.position.innerPath` | `comment.replies` | `comment.replies.${number}.replierId` | `comment.replies.${number}.message`, 3>>;
+}
+
+/** @internal */
+declare const getComment: MaybeContext<BuildRESTFunction<typeof getComment$1> & typeof getComment$1>;
+/** @internal */
+declare const queryComments: MaybeContext<BuildRESTFunction<typeof queryComments$1> & typeof queryComments$1>;
+/** @internal */
+declare const updateCommentStatus: MaybeContext<BuildRESTFunction<typeof updateCommentStatus$1> & typeof updateCommentStatus$1>;
+/** @internal */
+declare const deleteComment: MaybeContext<BuildRESTFunction<typeof deleteComment$1> & typeof deleteComment$1>;
+/** @internal */
+declare const createCommentReply: MaybeContext<BuildRESTFunction<typeof createCommentReply$1> & typeof createCommentReply$1>;
+/** @internal */
+declare const updateCommentReply: MaybeContext<BuildRESTFunction<typeof updateCommentReply$1> & typeof updateCommentReply$1>;
+/** @internal */
+declare const deleteCommentReply: MaybeContext<BuildRESTFunction<typeof deleteCommentReply$1> & typeof deleteCommentReply$1>;
+
+export { Comment, CommentReply, CreateCommentReplyOptions, CreateCommentReplyResponse, CursorQuery, DeleteCommentReplyIdentifiers, DeleteCommentReplyResponse, QueryCommentsResponse, StatusWithLiterals, UpdateCommentReplyIdentifiers, UpdateCommentReplyOptions, UpdateCommentReplyResponse, UpdateCommentStatusOptions, UpdateCommentStatusResponse, createCommentReply, deleteComment, deleteCommentReply, getComment, queryComments, updateCommentReply, updateCommentStatus };