@resolution/jira-api-client 0.1.6 → 0.3.0

package/lib/openapi/platform/services/issue-comments-service.d.ts

@@ -1,528 +0,0 @@
-import { CommonHttpService } from "../core/common-http-service";
-import { type Comment } from "../models/common";
-import { type IssueCommentListRequestBean, type PageBeanComment, type PageOfComments } from "../models/issue-comments";
-/**
- * This resource represents issue comments. Use it to:
- *
- *  *  get, create, update, and delete a comment from an issue.
- *  *  get all comments from issue.
- *  *  get a list of comments by comment ID.
- */
-export declare class IssueCommentsService extends CommonHttpService {
-    /**
-     * Adds a comment to an issue.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:**
-     *
-     *  *  *Browse projects* and *Add comments* [ project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
-     * issue containing the comment is in.
-     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-     * configured, issue-level security permission to view the issue.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "author": {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "active": false,
-     *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *   },
-     *   "body": {
-     *     "type": "doc",
-     *     "version": 1,
-     *     "content": [
-     *       {
-     *         "type": "paragraph",
-     *         "content": [
-     *           {
-     *             "type": "text",
-     *             "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-     * Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum.
-     * Sed semper quam laoreet nisi egestas at posuere augue semper."
-     *           }
-     *         ]
-     *       }
-     *     ]
-     *   },
-     *   "created": "2021-01-17T12:34:00.000+0000",
-     *   "id": "10000",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
-     *   "updateAuthor": {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "active": false,
-     *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *   },
-     *   "updated": "2021-01-18T23:45:00.000+0000",
-     *   "visibility": {
-     *     "identifier": "Administrators",
-     *     "type": "role",
-     *     "value": "Administrators"
-     *   }
-     * }
-     * @path {POST} /rest/api/3/issue/{issueIdOrKey}/comment
-     * @scopes-current write:jira-work
-     * @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira,
-     * read:project:jira, read:project-role:jira, read:user:jira, write:comment:jira,
-     * read:avatar:jira
-     */
-    addComment({ issueIdOrKey, expand, comment, }: {
-        /** The ID or key of the issue. */
-        issueIdOrKey: string;
-        /**
-         * Use [expand](#expansion) to include additional information about comments in
-         * the response. This parameter accepts `renderedBody`, which returns the comment
-         * body rendered in HTML.
-         */
-        expand?: string;
-        /**
-         * @example {
-         *     "body": {
-         *         "content": [
-         *             {
-         *                 "content": [
-         *                     {
-         *                         "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper.",
-         *                         "type": "text"
-         *                     }
-         *                 ],
-         *                 "type": "paragraph"
-         *             }
-         *         ],
-         *         "type": "doc",
-         *         "version": 1
-         *     },
-         *     "visibility": {
-         *         "identifier": "Administrators",
-         *         "type": "role",
-         *         "value": "Administrators"
-         *     }
-         * }
-         */
-        comment: Comment;
-    }): Promise<Comment>;
-    /**
-     * Deletes a comment.
-     *
-     * **[Permissions](#permissions) required:**
-     *
-     *  *  *Browse projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
-     * issue containing the comment is in.
-     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-     * configured, issue-level security permission to view the issue.
-     *  *  *Delete all comments*[ project
-     * permission](https://confluence.atlassian.com/x/yodKLg) to delete any comment or
-     * *Delete own comments* to delete comment created by the user,
-     *  *  If the comment has visibility restrictions, the user belongs to the group
-     * or has the role visibility is restricted to.
-     *
-     * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/comment/{id}
-     * @scopes-current write:jira-work
-     * @scopes-beta delete:comment:jira, delete:comment.property:jira
-     */
-    deleteComment({ issueIdOrKey, id, }: {
-        /** The ID or key of the issue. */
-        issueIdOrKey: string;
-        /** The ID of the comment. */
-        id: string;
-    }): Promise<void>;
-    /**
-     * Returns a comment.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:**
-     *
-     *  *  *Browse projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project
-     * containing the comment.
-     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-     * configured, issue-level security permission to view the issue.
-     *  *  If the comment has visibility restrictions, the user belongs to the group
-     * or has the role visibility is restricted to.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "author": {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "active": false,
-     *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *   },
-     *   "body": {
-     *     "type": "doc",
-     *     "version": 1,
-     *     "content": [
-     *       {
-     *         "type": "paragraph",
-     *         "content": [
-     *           {
-     *             "type": "text",
-     *             "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-     * Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum.
-     * Sed semper quam laoreet nisi egestas at posuere augue semper."
-     *           }
-     *         ]
-     *       }
-     *     ]
-     *   },
-     *   "created": "2021-01-17T12:34:00.000+0000",
-     *   "id": "10000",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
-     *   "updateAuthor": {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "active": false,
-     *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *   },
-     *   "updated": "2021-01-18T23:45:00.000+0000",
-     *   "visibility": {
-     *     "identifier": "Administrators",
-     *     "type": "role",
-     *     "value": "Administrators"
-     *   }
-     * }
-     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/comment/{id}
-     * @scopes-current read:jira-work
-     * @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira,
-     * read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira
-     */
-    getComment({ issueIdOrKey, id, expand, }: {
-        /** The ID or key of the issue. */
-        issueIdOrKey: string;
-        /** The ID of the comment. */
-        id: string;
-        /**
-         * Use [expand](#expansion) to include additional information about comments in
-         * the response. This parameter accepts `renderedBody`, which returns the comment
-         * body rendered in HTML.
-         */
-        expand?: string;
-    }): Promise<Comment>;
-    /**
-     * Returns all comments for an issue.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** Comments are included in the response
-     * where the user has:
-     *
-     *  *  *Browse projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project
-     * containing the comment.
-     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-     * configured, issue-level security permission to view the issue.
-     *  *  If the comment has visibility restrictions, belongs to the group or has the
-     * role visibility is role visibility is restricted to.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "comments": [
-     *     {
-     *       "author": {
-     *         "accountId": "5b10a2844c20165700ede21g",
-     *         "active": false,
-     *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *       },
-     *       "body": {
-     *         "type": "doc",
-     *         "version": 1,
-     *         "content": [
-     *           {
-     *             "type": "paragraph",
-     *             "content": [
-     *               {
-     *                 "type": "text",
-     *                 "text": "Lorem ipsum dolor sit amet, consectetur adipiscing
-     * elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis
-     * fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
-     *               }
-     *             ]
-     *           }
-     *         ]
-     *       },
-     *       "created": "2021-01-17T12:34:00.000+0000",
-     *       "id": "10000",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
-     *       "updateAuthor": {
-     *         "accountId": "5b10a2844c20165700ede21g",
-     *         "active": false,
-     *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *       },
-     *       "updated": "2021-01-18T23:45:00.000+0000",
-     *       "visibility": {
-     *         "identifier": "Administrators",
-     *         "type": "role",
-     *         "value": "Administrators"
-     *       }
-     *     }
-     *   ],
-     *   "maxResults": 1,
-     *   "startAt": 0,
-     *   "total": 1
-     * }
-     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/comment
-     * @scopes-current read:jira-work
-     * @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira,
-     * read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira
-     */
-    getComments({ issueIdOrKey, startAt, maxResults, orderBy, expand, }: {
-        /** The ID or key of the issue. */
-        issueIdOrKey: string;
-        /** The index of the first item to return in a page of results (page offset). */
-        startAt?: number;
-        /** The maximum number of items to return per page. */
-        maxResults?: number;
-        /**
-         * [Order](#ordering) the results by a field. Accepts *created* to sort comments
-         * by their created date.
-         */
-        orderBy?: "created" | "-created" | "+created";
-        /**
-         * Use [expand](#expansion) to include additional information about comments in
-         * the response. This parameter accepts `renderedBody`, which returns the comment
-         * body rendered in HTML.
-         */
-        expand?: string;
-    }): Promise<PageOfComments>;
-    /**
-     * Returns a [paginated](#pagination) list of comments specified by a list of
-     * comment IDs.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** Comments are returned where the user:
-     *
-     *  *  has *Browse projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project
-     * containing the comment.
-     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-     * configured, issue-level security permission to view the issue.
-     *  *  If the comment has visibility restrictions, belongs to the group or has the
-     * role visibility is restricted to.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "isLast": true,
-     *   "maxResults": 1048576,
-     *   "startAt": 0,
-     *   "total": 1,
-     *   "values": [
-     *     {
-     *       "author": {
-     *         "accountId": "5b10a2844c20165700ede21g",
-     *         "active": false,
-     *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *       },
-     *       "body": {
-     *         "type": "doc",
-     *         "version": 1,
-     *         "content": [
-     *           {
-     *             "type": "paragraph",
-     *             "content": [
-     *               {
-     *                 "type": "text",
-     *                 "text": "Lorem ipsum dolor sit amet, consectetur adipiscing
-     * elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis
-     * fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
-     *               }
-     *             ]
-     *           }
-     *         ]
-     *       },
-     *       "created": "2021-01-17T12:34:00.000+0000",
-     *       "id": "10000",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
-     *       "updateAuthor": {
-     *         "accountId": "5b10a2844c20165700ede21g",
-     *         "active": false,
-     *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *       },
-     *       "updated": "2021-01-18T23:45:00.000+0000",
-     *       "visibility": {
-     *         "identifier": "Administrators",
-     *         "type": "role",
-     *         "value": "Administrators"
-     *       }
-     *     }
-     *   ]
-     * }
-     * @path {POST} /rest/api/3/comment/list
-     * @scopes-current read:jira-work
-     * @scopes-beta delete:comment.property:jira, read:avatar:jira, read:comment:jira,
-     * read:group:jira, read:project-role:jira, read:user:jira,
-     * read:comment.property:jira, read:project:jira
-     */
-    getCommentsByIds({ expand, issueCommentListRequestBean, }: {
-        /**
-         * Use [expand](#expansion) to include additional information about comments in
-         * the response. This parameter accepts a comma-separated list. Expand options
-         * include:
-         *
-         *  *  `renderedBody` Returns the comment body rendered in HTML.
-         *  *  `properties` Returns the comment's properties.
-         */
-        expand?: string;
-        /**
-         * The list of comment IDs.
-         *
-         * @example {
-         *     "ids": [
-         *         1,
-         *         2,
-         *         5,
-         *         10
-         *     ]
-         * }
-         */
-        issueCommentListRequestBean: IssueCommentListRequestBean;
-    }): Promise<PageBeanComment>;
-    /**
-     * Updates a comment.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:**
-     *
-     *  *  *Browse projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
-     * issue containing the comment is in.
-     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-     * configured, issue-level security permission to view the issue.
-     *  *  *Edit all comments*[ project
-     * permission](https://confluence.atlassian.com/x/yodKLg) to update any comment or
-     * *Edit own comments* to update comment created by the user.
-     *  *  If the comment has visibility restrictions, the user belongs to the group
-     * or has the role visibility is restricted to.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "author": {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "active": false,
-     *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *   },
-     *   "body": {
-     *     "type": "doc",
-     *     "version": 1,
-     *     "content": [
-     *       {
-     *         "type": "paragraph",
-     *         "content": [
-     *           {
-     *             "type": "text",
-     *             "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-     * Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum.
-     * Sed semper quam laoreet nisi egestas at posuere augue semper."
-     *           }
-     *         ]
-     *       }
-     *     ]
-     *   },
-     *   "created": "2021-01-17T12:34:00.000+0000",
-     *   "id": "10000",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
-     *   "updateAuthor": {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "active": false,
-     *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *   },
-     *   "updated": "2021-01-18T23:45:00.000+0000",
-     *   "visibility": {
-     *     "identifier": "Administrators",
-     *     "type": "role",
-     *     "value": "Administrators"
-     *   }
-     * }
-     * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/comment/{id}
-     * @scopes-current write:jira-work
-     * @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira,
-     * read:project:jira, read:project-role:jira, read:user:jira, write:comment:jira,
-     * read:avatar:jira
-     */
-    updateComment({ issueIdOrKey, id, notifyUsers, overrideEditableFlag, expand, comment, }: {
-        /** The ID or key of the issue. */
-        issueIdOrKey: string;
-        /** The ID of the comment. */
-        id: string;
-        /** Whether users are notified when a comment is updated. */
-        notifyUsers?: boolean;
-        /**
-         * Whether screen security is overridden to enable uneditable fields to be edited.
-         * Available to Connect app users with the *Administer Jira* [global
-         * permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on
-         * behalf of users with *Administer Jira* [global
-         * permission](https://confluence.atlassian.com/x/x4dKLg).
-         */
-        overrideEditableFlag?: boolean;
-        /**
-         * Use [expand](#expansion) to include additional information about comments in
-         * the response. This parameter accepts `renderedBody`, which returns the comment
-         * body rendered in HTML.
-         */
-        expand?: string;
-        /**
-         * @example {
-         *     "body": {
-         *         "content": [
-         *             {
-         *                 "content": [
-         *                     {
-         *                         "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper.",
-         *                         "type": "text"
-         *                     }
-         *                 ],
-         *                 "type": "paragraph"
-         *             }
-         *         ],
-         *         "type": "doc",
-         *         "version": 1
-         *     },
-         *     "visibility": {
-         *         "identifier": "Administrators",
-         *         "type": "role",
-         *         "value": "Administrators"
-         *     }
-         * }
-         */
-        comment: Comment;
-    }): Promise<Comment>;
-    static initialize(): void;
-}