@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,5 +1,5 @@
-import * as commonHttpClient from "../core/CommonHttpClient";
-import { CommonHttpService } from "../core/CommonHttpService";
+import * as commonHttpClient from "../../core/CommonHttpClient";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type IssueBean, type User } from "../models/common";
 import { type ArchivedIssuesFilterRequest, type ArchiveIssueAsyncRequest, type CreatedIssue, type CreatedIssues, type ExportArchivedIssuesTaskProgressResponse, type IssueArchivalSyncRequest, type IssueArchivalSyncResponse, type IssueChangelogIds, type IssueCreateMetadata, type IssueEvent, type IssueLimitReportRequest, type IssueLimitReportResponseBean, type IssuesUpdateBean, type IssueUpdateDetails, type IssueUpdateMetadata, type Notification, type PageBeanChangelog, type PageOfChangelogs, type PageOfCreateMetaIssueTypes, type PageOfCreateMetaIssueTypeWithField, type Transitions } from "../models/issues";
 /**
@@ -38,11 +38,11 @@ export declare class IssuesService extends 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,
@@ -82,16 +82,19 @@ export declare class IssuesService extends 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
      */
     archiveIssues: ({ issueArchivalSyncRequest, }: {
         /**
          * Contains a list of issue keys or IDs to be archived.
          *
-         * @example {
+         * @example
+         * {
          *     "issueIdsOrKeys": [
          *         "PR-1",
          *         "1001",
@@ -129,18 +132,23 @@ export declare class IssuesService extends 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
      */
     archiveIssuesAsync: ({ archiveIssueAsyncRequest, }: {
         /**
          * A JQL query specifying the issues to archive. Note that subtasks can only be
          * archived through their parent issues.
          *
-         * @example {
+         * @example
+         * {
          *     "jql": "project = FOO AND updated < -2y"
          * }
          */
@@ -167,10 +175,11 @@ export declare class IssuesService extends 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
      */
     assignIssue: ({ issueIdOrKey, user, }: {
         /** The ID or key of the issue to be assigned. */
@@ -178,7 +187,8 @@ export declare class IssuesService extends CommonHttpService {
         /**
          * The request object with the user that the issue is assigned to.
          *
-         * @example {
+         * @example
+         * {
          *     "accountId": "5b10ac8d82e05b22cc7d4ef5"
          * }
          */
@@ -213,7 +223,9 @@ export declare class IssuesService extends 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",
@@ -225,11 +237,12 @@ export declare class IssuesService extends 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
      */
     createIssue: ({ updateHistory, issueUpdateDetails, }: {
         /**
@@ -241,7 +254,8 @@ export declare class IssuesService extends CommonHttpService {
          */
         updateHistory?: boolean | undefined;
         /**
-         * @example {
+         * @example
+         * {
          *     "fields": {
          *         "assignee": {
          *             "id": "5b109f2e9729b51b54dc274d"
@@ -300,8 +314,7 @@ export declare class IssuesService extends CommonHttpService {
          *                 {
          *                     "content": [
          *                         {
-         *                             "text": "Order entry fails when selecting
-         * supplier.",
+         *                             "text": "Order entry fails when selecting supplier.",
          *                             "type": "text"
          *                         }
          *                     ],
@@ -394,8 +407,7 @@ export declare class IssuesService extends 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.
@@ -405,7 +417,9 @@ export declare class IssuesService extends CommonHttpService {
      *  *  is for a subtask when the option to create subtasks is disabled.
      *  *  is invalid for any other reason.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "issues": [
      *     {
      *       "id": "10000",
@@ -427,15 +441,17 @@ export declare class IssuesService extends 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
      */
     createIssues: ({ issuesUpdateBean, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "issueUpdates": [
          *         {
          *             "fields": {
@@ -496,8 +512,7 @@ export declare class IssuesService extends CommonHttpService {
          *                         {
          *                             "content": [
          *                                 {
-         *                                     "text": "Order entry fails when selecting
-         * supplier.",
+         *                                     "text": "Order entry fails when selecting supplier.",
          *                                     "type": "text"
          *                                 }
          *                             ],
@@ -628,8 +643,7 @@ export declare class IssuesService extends CommonHttpService {
          *                         {
          *                             "content": [
          *                                 {
-         *                                     "text": "Order remains pending after
-         * approved.",
+         *                                     "text": "Order remains pending after approved.",
          *                                     "type": "text"
          *                                 }
          *                             ],
@@ -713,10 +727,11 @@ export declare class IssuesService extends 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
      */
     deleteIssue: ({ issueIdOrKey, deleteSubtasks, }: {
         /** The ID or key of the issue. */
@@ -745,16 +760,18 @@ export declare class IssuesService extends 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
      */
     doTransition: ({ issueIdOrKey, issueUpdateDetails, }: {
         /** The ID or key of the issue. */
         issueIdOrKey: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "fields": {
          *         "assignee": {
          *             "name": "bob"
@@ -849,18 +866,19 @@ export declare class IssuesService extends 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
      */
     editIssue: ({ issueIdOrKey, notifyUsers, overrideScreenSecurity, overrideEditableFlag, returnIssue, expand, issueUpdateDetails, }: {
         /** The ID or key of the issue. */
@@ -900,7 +918,8 @@ export declare class IssuesService extends CommonHttpService {
          */
         expand?: string | undefined;
         /**
-         * @example {
+         * @example
+         * {
          *     "fields": {
          *         "customfield_10000": {
          *             "content": [
@@ -1012,23 +1031,23 @@ export declare class IssuesService extends 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
      */
     exportArchivedIssues: ({ archivedIssuesFilterRequest, }: {
         /**
@@ -1037,7 +1056,8 @@ export declare class IssuesService extends CommonHttpService {
          * If you don't provide any filters, you'll get a list of up to one million
          * archived issues.
          *
-         * @example {
+         * @example
+         * {
          *     "archivedBy": [
          *         "uuid-rep-001",
          *         "uuid-rep-002"
@@ -1082,13 +1102,13 @@ export declare class IssuesService extends 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": [
@@ -1097,19 +1117,14 @@ export declare class IssuesService extends 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",
@@ -1131,19 +1146,14 @@ export declare class IssuesService extends 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",
@@ -1162,10 +1172,12 @@ export declare class IssuesService extends 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
      */
     getChangeLogs: ({ issueIdOrKey, startAt, maxResults, }: {
         /** The ID or key of the issue. */
@@ -1190,26 +1202,23 @@ export declare class IssuesService extends 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",
@@ -1231,19 +1240,14 @@ export declare class IssuesService extends 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",
@@ -1265,16 +1269,19 @@ export declare class IssuesService extends 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
      */
     getChangeLogsByIds: ({ issueIdOrKey, issueChangelogIds, }: {
         /** The ID or key of the issue. */
         issueIdOrKey: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "changelogIds": [
          *         10001,
          *         10002
@@ -1307,18 +1314,16 @@ export declare class IssuesService extends 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": [
@@ -1336,8 +1341,7 @@ export declare class IssuesService extends 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",
@@ -1350,10 +1354,12 @@ export declare class IssuesService extends 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
      */
     getCreateIssueMeta: ({ projectIds, projectKeys, issuetypeIds, issuetypeNames, expand, }?: {
         /**
@@ -1409,7 +1415,9 @@ export declare class IssuesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "fields": [
      *     {
      *       "fieldId": "assignee",
@@ -1426,10 +1434,12 @@ export declare class IssuesService extends 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
      */
     getCreateIssueMetaIssueTypeId: ({ projectIdOrKey, issueTypeId, startAt, maxResults, }: {
         /** The ID or key of the project. */
@@ -1455,12 +1465,13 @@ export declare class IssuesService extends 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",
@@ -1471,10 +1482,12 @@ export declare class IssuesService extends 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
      */
     getCreateIssueMetaIssueTypes: ({ projectIdOrKey, startAt, maxResults, }: {
         /** The ID or key of the project. */
@@ -1550,7 +1563,9 @@ export declare class IssuesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "fields": {
      *     "summary": {
      *       "allowedValues": [
@@ -1567,8 +1582,7 @@ export declare class IssuesService extends 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"
@@ -1576,10 +1590,12 @@ export declare class IssuesService extends 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
      */
     getEditIssueMeta: ({ issueIdOrKey, overrideScreenSecurity, overrideEditableFlag, }: {
         /** The ID or key of the issue. */
@@ -1609,7 +1625,9 @@ export declare class IssuesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "id": 1,
      *     "name": "Issue Created"
@@ -1619,7 +1637,8 @@ export declare class IssuesService extends 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
@@ -1646,22 +1665,14 @@ export declare class IssuesService extends 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": [
      *       {
@@ -1670,32 +1681,24 @@ export declare class IssuesService extends 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": [
@@ -1704,8 +1707,7 @@ export declare class IssuesService extends 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"
      *             }
      *           },
@@ -1738,14 +1740,10 @@ export declare class IssuesService extends 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": {
@@ -1758,8 +1756,7 @@ export declare class IssuesService extends 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,
@@ -1771,8 +1768,7 @@ export declare class IssuesService 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",
@@ -1783,9 +1779,7 @@ export declare class IssuesService 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."
      *                 }
      *               ]
      *             }
@@ -1793,14 +1787,12 @@ export declare class IssuesService 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": {
@@ -1816,8 +1808,7 @@ export declare class IssuesService extends 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"
      *             }
      *           },
@@ -1837,8 +1828,7 @@ export declare class IssuesService extends 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"
      *             }
      *           },
@@ -1860,8 +1850,7 @@ export declare class IssuesService 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"
      *         },
      *         "comment": {
      *           "type": "doc",
@@ -1880,8 +1869,7 @@ export declare class IssuesService extends 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,
@@ -1889,8 +1877,7 @@ export declare class IssuesService 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"
      *         },
      *         "updated": "2021-01-18T23:45:00.000+0000",
      *         "visibility": {
@@ -1914,12 +1901,12 @@ export declare class IssuesService extends 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
      */
     getIssue: ({ issueIdOrKey, fields, fieldsByKeys, expand, properties, updateHistory, failFast, }: {
         /** The ID or key of the issue. */
@@ -2014,42 +2001,44 @@ export declare class IssuesService extends 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": {
@@ -2060,12 +2049,20 @@ export declare class IssuesService extends 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
      */
-    getIssueLimitReport: ({ issueLimitReportRequest, }: {
+    getIssueLimitReport: ({ isReturningKeys, issueLimitReportRequest, }: {
+        /**
+         * Return issue keys instead of issue ids in the response.
+         *
+         * Usage: Add `?isReturningKeys=true` to the end of the path to request issue keys.
+         */
+        isReturningKeys?: boolean | undefined;
         issueLimitReportRequest: IssueLimitReportRequest;
     }) => Promise<IssueLimitReportResponseBean>;
     /**
@@ -2093,7 +2090,9 @@ export declare class IssuesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "transitions": [
      *     {
      *       "fields": {
@@ -2112,8 +2111,7 @@ export declare class IssuesService extends 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"
@@ -2129,8 +2127,7 @@ export declare class IssuesService extends 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",
@@ -2139,8 +2136,7 @@ export declare class IssuesService extends 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"
      *         }
      *       }
      *     },
@@ -2161,8 +2157,7 @@ export declare class IssuesService extends 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"
@@ -2183,8 +2178,7 @@ export declare class IssuesService extends 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"
@@ -2204,17 +2198,18 @@ export declare class IssuesService extends 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
      */
     getTransitions: ({ issueIdOrKey, expand, transitionId, skipRemoteOnlyCondition, includeUnavailableTransitions, sortByOpsBarAndStatus, }: {
         /** The ID or key of the issue. */
@@ -2258,10 +2253,11 @@ export declare class IssuesService extends 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
      */
     notify: ({ issueIdOrKey, notification, }: {
         /** ID or key of the issue that the notification is sent for. */
@@ -2269,9 +2265,9 @@ export declare class IssuesService extends CommonHttpService {
         /**
          * The request object for the notification and recipients.
          *
-         * @example {
-         *     "htmlBody": "The <strong>latest</strong> test results for this ticket are
-         * now available.",
+         * @example
+         * {
+         *     "htmlBody": "The <strong>latest</strong> test results for this ticket are now available.",
          *     "restrict": {
          *         "groupIds": [],
          *         "groups": [
@@ -2327,12 +2323,11 @@ export declare class IssuesService extends 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,
@@ -2363,16 +2358,19 @@ export declare class IssuesService extends 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
      */
     unarchiveIssues: ({ issueArchivalSyncRequest, }: {
         /**
          * Contains a list of issue keys or IDs to be unarchived.
          *
-         * @example {
+         * @example
+         * {
          *     "issueIdsOrKeys": [
          *         "PR-1",
          *         "1001",