@resolution/jira-api-client 0.5.2 → 0.5.4

package/lib/openapi/platform/services/IssuesService.js

@@ -5,8 +5,8 @@ exports.IssuesService = void 0;
 // This file is generated by "api-typescript-generator".
 // To update this file run "yarn build:openapi".
 const zod_1 = require("zod");
-const commonHttpClient = require("../core/CommonHttpClient");
-const CommonHttpService_1 = require("../core/CommonHttpService");
+const commonHttpClient = require("../../core/CommonHttpClient");
+const CommonHttpService_1 = require("../../core/CommonHttpService");
 const common_1 = require("../models/common");
 const issues_1 = require("../models/issues");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
@@ -48,11 +48,11 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * **Signed-in users only:** This API can't be accessed anonymously.
          *
-         * @returns Returned if there is at least one valid issue to archive in the request. The
-         * return message will include the count of archived issues and subtasks, as well
-         * as error details for issues which failed to get archived.
+         * @returns Returned if there is at least one valid issue to archive in the request. The return message will include the count of archived issues and subtasks, as well as error details for issues which failed to get archived.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "errors": {
          *     "issueIsSubtask": {
          *       "count": 3,
@@ -92,10 +92,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   },
          *   "numberOfIssuesUpdated": 10
          * }
-         * @path {PUT} /rest/api/3/issue/archive
+         * ```
+         * @path PUT `/rest/api/3/issue/archive`
          * @scopes-current write:jira-work
          * @scopes-beta write:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-archive-put
+         * @param params
          */
         this.archiveIssues = ({ issueArchivalSyncRequest, }) => {
             return this.getClientInstance()
@@ -144,11 +146,15 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the URL to check the status of the submitted request.
          *
-         * example: "https://your-domain.atlassian.net/rest/api/3/task/1010"
-         * @path {POST} /rest/api/3/issue/archive
+         * example:
+         * ```
+         * "https://your-domain.atlassian.net/rest/api/3/task/1010"
+         * ```
+         * @path POST `/rest/api/3/issue/archive`
          * @scopes-current write:jira-work
          * @scopes-beta write:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-archive-post
+         * @param params
          */
         this.archiveIssuesAsync = ({ archiveIssueAsyncRequest, }) => {
             return this.getClientInstance()
@@ -190,10 +196,11 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          * configured, issue-level security permission to view the issue.
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/assignee
+         * @path PUT `/rest/api/3/issue/{issueIdOrKey}/assignee`
          * @scopes-current write:jira-work
          * @scopes-beta write:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-assignee-put
+         * @param params
          */
         this.assignIssue = ({ issueIdOrKey, user, }) => {
             return this.getClientInstance()
@@ -246,7 +253,9 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "id": "10000",
          *   "key": "ED-24",
          *   "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
@@ -258,11 +267,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   }
          * }
-         * @path {POST} /rest/api/3/issue
+         * ```
+         * @path POST `/rest/api/3/issue`
          * @scopes-current write:jira-work
-         * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
-         * write:attachment:jira, read:issue:jira
+         * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira, write:attachment:jira, read:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-post
+         * @param params
          */
         this.createIssue = ({ updateHistory, issueUpdateDetails, }) => {
             return this.getClientInstance()
@@ -310,8 +320,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          * [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
          * project in which each issue or subtask is created.
          *
-         * @returns Returned if any of the issue or subtask creation requests were successful. A
-         * request may be unsuccessful when it:
+         * @returns Returned if any of the issue or subtask creation requests were successful. A request may be unsuccessful when it:
          *
          *  *  is missing required fields.
          *  *  contains invalid field values.
@@ -321,7 +330,9 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *  *  is for a subtask when the option to create subtasks is disabled.
          *  *  is invalid for any other reason.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "issues": [
          *     {
          *       "id": "10000",
@@ -343,11 +354,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   ],
          *   "errors": []
          * }
-         * @path {POST} /rest/api/3/issue/bulk
+         * ```
+         * @path POST `/rest/api/3/issue/bulk`
          * @scopes-current write:jira-work
-         * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
-         * write:attachment:jira, read:issue:jira
+         * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira, write:attachment:jira, read:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-bulk-post
+         * @param params
          */
         this.createIssues = ({ issuesUpdateBean, }) => {
             return this.getClientInstance()
@@ -385,10 +397,11 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
          * configured, issue-level security permission to view the issue.
          *
-         * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}
+         * @path DELETE `/rest/api/3/issue/{issueIdOrKey}`
          * @scopes-current write:jira-work
          * @scopes-beta delete:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-delete
+         * @param params
          */
         this.deleteIssue = ({ issueIdOrKey, deleteSubtasks, }) => {
             return this.getClientInstance()
@@ -425,10 +438,11 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          * configured, issue-level security permission to view the issue.
          *
          * @returns Returned if the request is successful.
-         * @path {POST} /rest/api/3/issue/{issueIdOrKey}/transitions
+         * @path POST `/rest/api/3/issue/{issueIdOrKey}/transitions`
          * @scopes-current write:jira-work
          * @scopes-beta write:issue:jira, write:issue.property:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-transitions-post
+         * @param params
          */
         this.doTransition = ({ issueIdOrKey, issueUpdateDetails, }) => {
             return this.getClientInstance()
@@ -484,18 +498,19 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
          * configured, issue-level security permission to view the issue.
          *
-         * @returns * status: 200, mediaType: application/json
+         * @returns
+         *  * status: 200, mediaType: application/json
          *
-         *    Returned if the request is successful and the `returnIssue` parameter is
-         * `true`
+         *    Returned if the request is successful and the `returnIssue` parameter is `true`
          *
          *  * status: 204, mediaType: application/json
          *
          *    Returned if the request is successful.
-         * @path {PUT} /rest/api/3/issue/{issueIdOrKey}
+         * @path PUT `/rest/api/3/issue/{issueIdOrKey}`
          * @scopes-current write:jira-work
          * @scopes-beta write:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-put
+         * @param params
          */
         this.editIssue = ({ issueIdOrKey, notifyUsers, overrideScreenSecurity, overrideEditableFlag, returnIssue, expand, issueUpdateDetails, }) => {
             return this.getClientInstance()
@@ -546,23 +561,23 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * **Rate limiting:** Only a single request can be active at any given time.
          *
-         * @returns Returns the details of your export task. You can use the [get
-         * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
-         * API to view the progress of your request.
+         * @returns Returns the details of your export task. You can use the [get task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) API to view the progress of your request.
          *
-         * example: {
-         *   "payload": "{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002],
-         * issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01,
-         * dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}",
+         * example:
+         * ```
+         * {
+         *   "payload": "{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002], issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01, dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}",
          *   "progress": 0,
          *   "status": "ENQUEUED",
          *   "submittedTime": 1623230887000,
          *   "taskId": "10990"
          * }
-         * @path {PUT} /rest/api/3/issues/archive/export
+         * ```
+         * @path PUT `/rest/api/3/issues/archive/export`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issues-archive-export-put
+         * @param params
          */
         this.exportArchivedIssues = ({ archivedIssuesFilterRequest, }) => {
             return this.getClientInstance()
@@ -599,13 +614,13 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
-         *   "nextPage":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2",
-         *   "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2",
+         *   "nextPage": "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2",
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2",
          *   "startAt": 2,
          *   "total": 5,
          *   "values": [
@@ -614,19 +629,14 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "active": true,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "emailAddress": "mia@example.com",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          *         "timeZone": "Australia/Sydney"
          *       },
          *       "created": "1970-01-18T06:27:50.429+0000",
@@ -648,19 +658,14 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "active": true,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "emailAddress": "mia@example.com",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          *         "timeZone": "Australia/Sydney"
          *       },
          *       "created": "1970-01-18T06:27:51.429+0000",
@@ -679,10 +684,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/issue/{issueIdOrKey}/changelog
+         * ```
+         * @path GET `/rest/api/3/issue/{issueIdOrKey}/changelog`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-changelog-get
+         * @param params
          */
         this.getChangeLogs = ({ issueIdOrKey, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -721,26 +728,23 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "histories": [
          *     {
          *       "author": {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "active": true,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "emailAddress": "mia@example.com",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          *         "timeZone": "Australia/Sydney"
          *       },
          *       "created": "1970-01-18T06:27:50.429+0000",
@@ -762,19 +766,14 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "active": true,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "emailAddress": "mia@example.com",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          *         "timeZone": "Australia/Sydney"
          *       },
          *       "created": "1970-01-18T06:27:51.429+0000",
@@ -796,10 +795,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   "startAt": 0,
          *   "total": 2
          * }
-         * @path {POST} /rest/api/3/issue/{issueIdOrKey}/changelog/list
+         * ```
+         * @path POST `/rest/api/3/issue/{issueIdOrKey}/changelog/list`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-changelog-list-post
+         * @param params
          */
         this.getChangeLogsByIds = ({ issueIdOrKey, issueChangelogIds, }) => {
             return this.getClientInstance()
@@ -847,18 +848,16 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          * @deprecated
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "projects": [
          *     {
          *       "avatarUrls": {
-         *         "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
-         *         "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
-         *         "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
-         *         "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
+         *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
+         *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
+         *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
+         *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
          *       },
          *       "id": "10000",
          *       "issuetypes": [
@@ -876,8 +875,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *               "required": true
          *             }
          *           },
-         *           "iconUrl":
-         * "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
+         *           "iconUrl": "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
          *           "id": "1",
          *           "name": "Bug",
          *           "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
@@ -890,10 +888,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/issue/createmeta
+         * ```
+         * @path GET `/rest/api/3/issue/createmeta`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-get
+         * @param params
          */
         this.getCreateIssueMeta = ({ projectIds, projectKeys, issuetypeIds, issuetypeNames, expand, } = {}) => {
             return this.getClientInstance()
@@ -931,7 +931,9 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "fields": [
          *     {
          *       "fieldId": "assignee",
@@ -948,10 +950,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
+         * ```
+         * @path GET `/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get
+         * @param params
          */
         this.getCreateIssueMetaIssueTypeId = ({ projectIdOrKey, issueTypeId, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -990,12 +994,13 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "issueTypes": [
          *     {
          *       "description": "An error in the code",
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
+         *       "iconUrl": "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
          *       "id": "1",
          *       "name": "Bug",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
@@ -1006,10 +1011,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
+         * ```
+         * @path GET `/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-projectidorkey-issuetypes-get
+         * @param params
          */
         this.getCreateIssueMetaIssueTypes = ({ projectIdOrKey, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -1099,7 +1106,9 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "fields": {
          *     "summary": {
          *       "allowedValues": [
@@ -1116,8 +1125,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *       ],
          *       "required": false,
          *       "schema": {
-         *         "custom":
-         * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
+         *         "custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
          *         "customId": 10001,
          *         "items": "option",
          *         "type": "array"
@@ -1125,10 +1133,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   }
          * }
-         * @path {GET} /rest/api/3/issue/{issueIdOrKey}/editmeta
+         * ```
+         * @path GET `/rest/api/3/issue/{issueIdOrKey}/editmeta`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-meta:jira, read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-editmeta-get
+         * @param params
          */
         this.getEditIssueMeta = ({ issueIdOrKey, overrideScreenSecurity, overrideEditableFlag, }) => {
             return this.getClientInstance()
@@ -1160,7 +1170,9 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: [
+         * example:
+         * ```
+         * [
          *   {
          *     "id": 1,
          *     "name": "Issue Created"
@@ -1170,7 +1182,8 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     "name": "Issue Updated"
          *   }
          * ]
-         * @path {GET} /rest/api/3/events
+         * ```
+         * @path GET `/rest/api/3/events`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:issue-event:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-events-get
@@ -1211,22 +1224,14 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "fields": {
          *     "watcher": {
          *       "isWatching": false,
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
-         *       "watchCount": 1,
-         *       "watchers": [
-         *         {
-         *           "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/issue/EX-1/watchers",
+         *       "watchCount": 1
          *     },
          *     "attachment": [
          *       {
@@ -1235,32 +1240,24 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *           "accountType": "atlassian",
          *           "active": false,
          *           "avatarUrls": {
-         *             "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *             "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *             "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *             "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *             "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *             "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *             "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *             "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *           },
          *           "displayName": "Mia Krystof",
          *           "key": "",
          *           "name": "",
-         *           "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *           "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *         },
-         *         "content":
-         * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
+         *         "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
          *         "created": "2022-10-06T07:32:47.000+0000",
          *         "filename": "picture.jpg",
          *         "id": 10000,
          *         "mimeType": "image/jpeg",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
          *         "size": 23123,
-         *         "thumbnail":
-         * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
+         *         "thumbnail": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
          *       }
          *     ],
          *     "sub-tasks": [
@@ -1269,8 +1266,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "outwardIssue": {
          *           "fields": {
          *             "status": {
-         *               "iconUrl":
-         * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+         *               "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
          *               "name": "Open"
          *             }
          *           },
@@ -1303,14 +1299,10 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     },
          *     "project": {
          *       "avatarUrls": {
-         *         "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-         *         "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-         *         "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-         *         "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+         *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+         *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+         *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+         *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          *       },
          *       "id": "10000",
          *       "insight": {
@@ -1323,8 +1315,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "description": "First Project Category",
          *         "id": "10000",
          *         "name": "FIRST",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *       },
          *       "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *       "simplified": false,
@@ -1336,8 +1327,7 @@ class IssuesService extends CommonHttpService_1.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",
@@ -1348,9 +1338,7 @@ class IssuesService extends CommonHttpService_1.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."
          *                 }
          *               ]
          *             }
@@ -1358,14 +1346,12 @@ class IssuesService extends CommonHttpService_1.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": {
@@ -1381,8 +1367,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "outwardIssue": {
          *           "fields": {
          *             "status": {
-         *               "iconUrl":
-         * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+         *               "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
          *               "name": "Open"
          *             }
          *           },
@@ -1402,8 +1387,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         "inwardIssue": {
          *           "fields": {
          *             "status": {
-         *               "iconUrl":
-         * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+         *               "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
          *               "name": "Open"
          *             }
          *           },
@@ -1425,8 +1409,7 @@ class IssuesService extends CommonHttpService_1.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"
          *         },
          *         "comment": {
          *           "type": "doc",
@@ -1445,8 +1428,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *         },
          *         "id": "100028",
          *         "issueId": "10002",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
          *         "started": "2021-01-17T12:34:00.000+0000",
          *         "timeSpent": "3h 20m",
          *         "timeSpentSeconds": 12000,
@@ -1454,8 +1436,7 @@ class IssuesService extends CommonHttpService_1.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"
          *         },
          *         "updated": "2021-01-18T23:45:00.000+0000",
          *         "visibility": {
@@ -1479,12 +1460,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   "key": "ED-1",
          *   "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
          * }
-         * @path {GET} /rest/api/3/issue/{issueIdOrKey}
+         * ```
+         * @path GET `/rest/api/3/issue/{issueIdOrKey}`
          * @scopes-current read:jira-work
-         * @scopes-beta read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira,
-         * read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira,
-         * read:user:jira, read:field-configuration:jira
+         * @scopes-beta read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira, read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira, read:user:jira, read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-get
+         * @param params
          */
         this.getIssue = ({ issueIdOrKey, fields, fieldsByKeys, expand, properties, updateHistory, failFast, }) => {
             return this.getClientInstance()
@@ -1525,42 +1506,44 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "issuesApproachingLimit": {
          *     "attachment": {
-         *       "15070": 1822,
-         *       "15111": 1999
+         *       "15070L": 1822,
+         *       "15111L": 1999
          *     },
          *     "comment": {
-         *       "10000": 4997,
-         *       "15073": 4999,
-         *       "15110": 5000
+         *       "10000L": 4997,
+         *       "15073L": 4999,
+         *       "15110L": 5000
          *     },
          *     "remoteIssueLinks": {
-         *       "15107": 2000
+         *       "15107L": 2000
          *     },
          *     "worklog": {
-         *       "15101": 4342
+         *       "15101L": 4342
          *     }
          *   },
          *   "issuesBreachingLimit": {
          *     "attachment": {
-         *       "15057": 2005,
-         *       "15116": 2065,
-         *       "15117": 3005
+         *       "15057L": 2005,
+         *       "15116L": 2065,
+         *       "15117L": 3005
          *     },
          *     "comment": {
-         *       "15055": 5202
+         *       "15055L": 5202
          *     },
          *     "issuelinks": {
-         *       "15058": 2120
+         *       "15058L": 2120
          *     },
          *     "remoteIssueLinks": {
-         *       "15059": 2094
+         *       "15059L": 2094
          *     },
          *     "worklog": {
-         *       "15056": 5085,
-         *       "15169": 120864
+         *       "15056L": 5085,
+         *       "15169L": 120864
          *     }
          *   },
          *   "limits": {
@@ -1571,16 +1554,21 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *     "worklog": 5000
          *   }
          * }
-         * @path {GET} /rest/api/3/issue/limit/report
+         * ```
+         * @path GET `/rest/api/3/issue/limit/report`
          * @scopes-current read:jira-work
          * @scopes-beta read:project:jira, read:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-limit-report-get
+         * @param params
          */
-        this.getIssueLimitReport = ({ issueLimitReportRequest, }) => {
+        this.getIssueLimitReport = ({ isReturningKeys, issueLimitReportRequest, }) => {
             return this.getClientInstance()
                 .request({
                 path: "/rest/api/3/issue/limit/report",
                 method: "GET",
+                query: {
+                    isReturningKeys,
+                },
                 headers: {
                     "Content-Type": "application/json",
                 },
@@ -1620,7 +1608,9 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "transitions": [
          *     {
          *       "fields": {
@@ -1639,8 +1629,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *           ],
          *           "required": false,
          *           "schema": {
-         *             "custom":
-         * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
+         *             "custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
          *             "customId": 10001,
          *             "items": "option",
          *             "type": "array"
@@ -1656,8 +1645,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *       "name": "Close Issue",
          *       "to": {
          *         "description": "The issue is currently being worked on.",
-         *         "iconUrl":
-         * "https://your-domain.atlassian.net/images/icons/progress.gif",
+         *         "iconUrl": "https://your-domain.atlassian.net/images/icons/progress.gif",
          *         "id": "10000",
          *         "name": "In Progress",
          *         "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
@@ -1666,8 +1654,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *           "id": 1,
          *           "key": "in-flight",
          *           "name": "In Progress",
-         *           "self":
-         * "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
+         *           "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
          *         }
          *       }
          *     },
@@ -1688,8 +1675,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *           ],
          *           "required": false,
          *           "schema": {
-         *             "custom":
-         * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
+         *             "custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
          *             "customId": 10001,
          *             "items": "option",
          *             "type": "array"
@@ -1710,8 +1696,7 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *           ],
          *           "required": false,
          *           "schema": {
-         *             "custom":
-         * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
+         *             "custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
          *             "customId": 10001,
          *             "items": "option",
          *             "type": "array"
@@ -1731,17 +1716,18 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *           "colorName": "green",
          *           "id": 9,
          *           "key": "completed",
-         *           "self":
-         * "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
+         *           "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
          *         }
          *       }
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/issue/{issueIdOrKey}/transitions
+         * ```
+         * @path GET `/rest/api/3/issue/{issueIdOrKey}/transitions`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue.transition:jira, read:status:jira, read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-transitions-get
+         * @param params
          */
         this.getTransitions = ({ issueIdOrKey, expand, transitionId, skipRemoteOnlyCondition, includeUnavailableTransitions, sortByOpsBarAndStatus, }) => {
             return this.getClientInstance()
@@ -1780,10 +1766,11 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          * configured, issue-level security permission to view the issue.
          *
          * @returns Returned if the email is queued for sending.
-         * @path {POST} /rest/api/3/issue/{issueIdOrKey}/notify
+         * @path POST `/rest/api/3/issue/{issueIdOrKey}/notify`
          * @scopes-current write:jira-work
          * @scopes-beta send:notification:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-notify-post
+         * @param params
          */
         this.notify = ({ issueIdOrKey, notification, }) => {
             return this.getClientInstance()
@@ -1825,12 +1812,11 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *
          * **Signed-in users only:** This API can't be accessed anonymously.
          *
-         * @returns Returned if there is at least one valid issue to unarchive in the request. It
-         * will return the count of unarchived issues, which also includes the count of
-         * the subtasks unarchived, and it will show the detailed errors for those issues
-         * which are not unarchived.
+         * @returns Returned if there is at least one valid issue to unarchive in the request. It will return the count of unarchived issues, which also includes the count of the subtasks unarchived, and it will show the detailed errors for those issues which are not unarchived.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "errors": {
          *     "issueIsSubtask": {
          *       "count": 3,
@@ -1861,10 +1847,12 @@ class IssuesService extends CommonHttpService_1.CommonHttpService {
          *   },
          *   "numberOfIssuesUpdated": 10
          * }
-         * @path {PUT} /rest/api/3/issue/unarchive
+         * ```
+         * @path PUT `/rest/api/3/issue/unarchive`
          * @scopes-current write:jira-work
          * @scopes-beta write:issue:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-unarchive-put
+         * @param params
          */
         this.unarchiveIssues = ({ issueArchivalSyncRequest, }) => {
             return this.getClientInstance()