@resolution/jira-api-client 0.5.2 → 0.5.4

package/lib/openapi/platform/services/IssueCommentsService.d.ts

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type Comment } from "../models/common";
 import { type IssueCommentListRequestBean, type PageBeanComment, type PageOfComments } from "../models/issueComments";
 /**
@@ -26,13 +26,14 @@ export declare class IssueCommentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "author": {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "body": {
      *     "type": "doc",
@@ -43,9 +44,7 @@ export declare class IssueCommentsService extends CommonHttpService {
      *         "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."
+     *             "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."
      *           }
      *         ]
      *       }
@@ -53,14 +52,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *   },
      *   "created": "2021-01-17T12:34:00.000+0000",
      *   "id": "10000",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "updated": "2021-01-18T23:45:00.000+0000",
      *   "visibility": {
@@ -69,12 +66,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *     "value": "Administrators"
      *   }
      * }
-     * @path {POST} /rest/api/3/issue/{issueIdOrKey}/comment
+     * ```
+     * @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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-post
+     * @param params
      */
     addComment: ({ issueIdOrKey, expand, comment, }: {
         /** The ID or key of the issue. */
@@ -86,16 +83,14 @@ export declare class IssueCommentsService extends CommonHttpService {
          */
         expand?: string | undefined;
         /**
-         * @example {
+         * @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.",
+         *                         "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"
          *                     }
          *                 ],
@@ -130,10 +125,11 @@ export declare class IssueCommentsService extends CommonHttpService {
      *  *  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}
+     * @path DELETE `/rest/api/3/issue/{issueIdOrKey}/comment/{id}`
      * @scopes-current write:jira-work
      * @scopes-beta delete:comment:jira, delete:comment.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-id-delete
+     * @param params
      */
     deleteComment: ({ issueIdOrKey, id, }: {
         /** The ID or key of the issue. */
@@ -158,13 +154,14 @@ export declare class IssueCommentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "author": {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "body": {
      *     "type": "doc",
@@ -175,9 +172,7 @@ export declare class IssueCommentsService extends CommonHttpService {
      *         "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."
+     *             "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."
      *           }
      *         ]
      *       }
@@ -185,14 +180,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *   },
      *   "created": "2021-01-17T12:34:00.000+0000",
      *   "id": "10000",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "updated": "2021-01-18T23:45:00.000+0000",
      *   "visibility": {
@@ -201,11 +194,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *     "value": "Administrators"
      *   }
      * }
-     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/comment/{id}
+     * ```
+     * @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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-id-get
+     * @param params
      */
     getComment: ({ issueIdOrKey, id, expand, }: {
         /** The ID or key of the issue. */
@@ -237,15 +231,16 @@ export declare class IssueCommentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "comments": [
      *     {
      *       "author": {
      *         "accountId": "5b10a2844c20165700ede21g",
      *         "active": false,
      *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "body": {
      *         "type": "doc",
@@ -256,9 +251,7 @@ export declare class IssueCommentsService extends CommonHttpService {
      *             "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."
+     *                 "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."
      *               }
      *             ]
      *           }
@@ -266,14 +259,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *       },
      *       "created": "2021-01-17T12:34:00.000+0000",
      *       "id": "10000",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "updated": "2021-01-18T23:45:00.000+0000",
      *       "visibility": {
@@ -287,11 +278,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/comment
+     * ```
+     * @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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-get
+     * @param params
      */
     getComments: ({ issueIdOrKey, startAt, maxResults, orderBy, expand, }: {
         /** The ID or key of the issue. */
@@ -330,7 +322,9 @@ export declare class IssueCommentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 1048576,
      *   "startAt": 0,
@@ -341,8 +335,7 @@ export declare class IssueCommentsService extends CommonHttpService {
      *         "accountId": "5b10a2844c20165700ede21g",
      *         "active": false,
      *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "body": {
      *         "type": "doc",
@@ -353,9 +346,7 @@ export declare class IssueCommentsService extends CommonHttpService {
      *             "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."
+     *                 "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."
      *               }
      *             ]
      *           }
@@ -363,14 +354,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *       },
      *       "created": "2021-01-17T12:34:00.000+0000",
      *       "id": "10000",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "updated": "2021-01-18T23:45:00.000+0000",
      *       "visibility": {
@@ -381,12 +370,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {POST} /rest/api/3/comment/list
+     * ```
+     * @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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-comment-list-post
+     * @param params
      */
     getCommentsByIds: ({ expand, issueCommentListRequestBean, }: {
         /**
@@ -401,7 +390,8 @@ export declare class IssueCommentsService extends CommonHttpService {
         /**
          * The list of comment IDs.
          *
-         * @example {
+         * @example
+         * {
          *     "ids": [
          *         1,
          *         2,
@@ -432,13 +422,14 @@ export declare class IssueCommentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "author": {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "body": {
      *     "type": "doc",
@@ -449,9 +440,7 @@ export declare class IssueCommentsService extends CommonHttpService {
      *         "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."
+     *             "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."
      *           }
      *         ]
      *       }
@@ -459,14 +448,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *   },
      *   "created": "2021-01-17T12:34:00.000+0000",
      *   "id": "10000",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "updated": "2021-01-18T23:45:00.000+0000",
      *   "visibility": {
@@ -475,12 +462,12 @@ export declare class IssueCommentsService extends CommonHttpService {
      *     "value": "Administrators"
      *   }
      * }
-     * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/comment/{id}
+     * ```
+     * @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
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-id-put
+     * @param params
      */
     updateComment: ({ issueIdOrKey, id, notifyUsers, overrideEditableFlag, expand, comment, }: {
         /** The ID or key of the issue. */
@@ -504,16 +491,14 @@ export declare class IssueCommentsService extends CommonHttpService {
          */
         expand?: string | undefined;
         /**
-         * @example {
+         * @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.",
+         *                         "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"
          *                     }
          *                 ],