@resolution/jira-api-client 0.5.2 → 0.5.4

package/lib/openapi/software/services/BoardService.d.ts

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type Board, type BoardConfigBean, type BoardCreateBean, type BoardFilterBean, type FeatureResponseBean, type FeatureToggleRequestBean, type PageBeanQuickFilterBean, type PartialSuccessBean, type ProjectDetails, type QuickFilterBean, type ReportsResponseBean, type SearchResults } from "../models/board";
 import { type IssueRankRequestBean, type SprintBean } from "../models/common";
 /**
@@ -39,18 +39,23 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the created board.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": 84,
      *   "name": "scrum board",
      *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
      *   "type": "scrum"
      * }
-     * @path {POST} /rest/agile/1.0/board
+     * ```
+     * @path POST `/rest/agile/1.0/board`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-post
+     * @param params
      */
     createBoard: ({ boardCreateBean, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "filterId": 10040,
          *     "location": {
          *         "projectKeyOrId": "10000",
@@ -65,8 +70,9 @@ export declare class BoardService extends CommonHttpService {
     /**
      * Deletes the board. Admin without the view permission can still remove the board.
      *
-     * @path {DELETE} /rest/agile/1.0/board/{boardId}
+     * @path DELETE `/rest/agile/1.0/board/{boardId}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-delete
+     * @param params
      */
     deleteBoard: ({ boardId, }: {
         /** ID of the board to be deleted */
@@ -76,8 +82,9 @@ export declare class BoardService extends CommonHttpService {
      * Removes the property from the board identified by the id. Ths user removing the
      * property is required to have permissions to modify the board.
      *
-     * @path {DELETE} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
+     * @path DELETE `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-delete
+     * @param params
      */
     deleteBoardProperty: ({ boardId, propertyKey, }: {
         /** the id of the board from which the property will be removed. */
@@ -96,7 +103,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested boards, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 2,
      *   "startAt": 1,
@@ -116,8 +125,10 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/agile/1.0/board
+     * ```
+     * @path GET `/rest/agile/1.0/board`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-get
+     * @param params
      */
     getAllBoards: ({ startAt, maxResults, type, name, projectKeyOrId, accountIdLocation, projectLocation, includePrivate, negateLocationFiltering, orderBy, expand, projectTypeLocation, filterId, }?: {
         /**
@@ -182,10 +193,11 @@ export declare class BoardService extends CommonHttpService {
     /**
      * Returns all quick filters from a board, for a given board ID.
      *
-     * @returns Returns the requested quick filters, at the specified page of the results.
-     * Quick filters will be ordered first by position.
+     * @returns Returns the requested quick filters, at the specified page of the results. Quick filters will be ordered first by position.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 2,
      *   "startAt": 1,
@@ -209,8 +221,10 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/quickfilter`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-get
+     * @param params
      */
     getAllQuickFilters: ({ boardId, startAt, maxResults, }: {
         /** The ID of the board that contains the requested quick filters. */
@@ -230,11 +244,11 @@ export declare class BoardService extends CommonHttpService {
      * Returns all sprints from a board, for a given board ID. This only includes
      * sprints that the user has permission to view.
      *
-     * @returns Returns the requested sprints, at the specified page of the results. Sprints
-     * will be ordered first by state (i.e. closed, active, future) then by their
-     * position in the backlog.
+     * @returns Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 2,
      *   "startAt": 1,
@@ -260,8 +274,10 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/sprint
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/sprint`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-get
+     * @param params
      */
     getAllSprints: ({ boardId, startAt, maxResults, state, }: {
         /** The ID of the board that contains the requested sprints. */
@@ -301,7 +317,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested versions, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 2,
      *   "startAt": 1,
@@ -328,8 +346,10 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/version
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/version`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-version-get
+     * @param params
      */
     getAllVersions: ({ boardId, startAt, maxResults, released, }: {
         /** The ID of the board that contains the requested versions. */
@@ -358,7 +378,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested board.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": 84,
      *   "location": {
      *     "displayName": "Example Project",
@@ -374,8 +396,10 @@ export declare class BoardService extends CommonHttpService {
      *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
      *   "type": "scrum"
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-get
+     * @param params
      */
     getBoard: ({ boardId, }: {
         /** The ID of the requested board. */
@@ -388,13 +412,17 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested boards, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": 84,
      *   "name": "scrum board",
      *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
      * }
-     * @path {GET} /rest/agile/1.0/board/filter/{filterId}
+     * ```
+     * @path GET `/rest/agile/1.0/board/filter/{filterId}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-filter-filterid-get
+     * @param params
      */
     getBoardByFilterId: ({ filterId, startAt, maxResults, }: {
         /**
@@ -428,7 +456,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -445,8 +475,7 @@ export declare class BoardService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -458,14 +487,10 @@ export declare class BoardService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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": {
@@ -478,8 +503,7 @@ export declare class BoardService 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,
@@ -491,8 +515,7 @@ export declare class BoardService 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",
@@ -503,10 +526,7 @@ export declare class BoardService 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."
      *                     }
      *                   ]
      *                 }
@@ -514,14 +534,12 @@ export declare class BoardService 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": {
@@ -547,8 +565,7 @@ export declare class BoardService 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",
@@ -567,8 +584,7 @@ export declare class BoardService 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,
@@ -576,8 +592,7 @@ export declare class BoardService 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": {
@@ -599,16 +614,17 @@ export declare class BoardService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-epicid-issue-get
+     * @param params
      */
     getBoardIssuesForEpic: ({ boardId, epicId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The ID of the board that contains the requested issues. */
@@ -651,7 +667,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -668,8 +686,7 @@ export declare class BoardService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -681,14 +698,10 @@ export declare class BoardService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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": {
@@ -701,8 +714,7 @@ export declare class BoardService 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,
@@ -714,8 +726,7 @@ export declare class BoardService 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",
@@ -726,10 +737,7 @@ export declare class BoardService 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."
      *                     }
      *                   ]
      *                 }
@@ -737,14 +745,12 @@ export declare class BoardService 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": {
@@ -770,8 +776,7 @@ export declare class BoardService 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",
@@ -790,8 +795,7 @@ export declare class BoardService 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,
@@ -799,8 +803,7 @@ export declare class BoardService 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": {
@@ -822,16 +825,17 @@ export declare class BoardService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-sprintid-issue-get
+     * @param params
      */
     getBoardIssuesForSprint: ({ boardId, sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The ID of the board that contains requested issues. */
@@ -873,8 +877,9 @@ export declare class BoardService extends CommonHttpService {
      * permissions to view the board.
      *
      * @returns Returned if the board exists and the property was found.
-     * @path {GET} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
+     * @path GET `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-get
+     * @param params
      */
     getBoardProperty: ({ boardId, propertyKey, }: {
         /** the ID of the board from which the property will be returned. */
@@ -888,8 +893,9 @@ export declare class BoardService extends CommonHttpService {
      * board.
      *
      * @returns Returned if the board with given id exists.
-     * @path {GET} /rest/agile/1.0/board/{boardId}/properties
+     * @path GET `/rest/agile/1.0/board/{boardId}/properties`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get
+     * @param params
      */
     getBoardPropertyKeys: ({ boardId, }: {
         /** the ID of the board from which property keys will be returned. */
@@ -922,7 +928,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the configuration of the board for given boardId.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "columnConfig": {
      *     "columns": [
      *       {
@@ -986,8 +994,10 @@ export declare class BoardService extends CommonHttpService {
      *   },
      *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/configuration
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/configuration`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-configuration-get
+     * @param params
      */
     getConfiguration: ({ boardId, }: {
         /** The ID of the board for which configuration is requested. */
@@ -1000,7 +1010,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested epics, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 2,
      *   "startAt": 1,
@@ -1028,8 +1040,10 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/epic
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/epic`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-get
+     * @param params
      */
     getEpics: ({ boardId, startAt, maxResults, done, }: {
         /** The ID of the board that contains the requested epics. */
@@ -1052,8 +1066,9 @@ export declare class BoardService extends CommonHttpService {
     }) => Promise<unknown>;
     /**
      * @returns 200 response
-     * @path {GET} /rest/agile/1.0/board/{boardId}/features
+     * @path GET `/rest/agile/1.0/board/{boardId}/features`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-get
+     * @param params
      */
     getFeaturesForBoard: ({ boardId, }: {
         boardId: number;
@@ -1069,7 +1084,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -1086,8 +1103,7 @@ export declare class BoardService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -1099,14 +1115,10 @@ export declare class BoardService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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": {
@@ -1119,8 +1131,7 @@ export declare class BoardService 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,
@@ -1132,8 +1143,7 @@ export declare class BoardService 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",
@@ -1144,10 +1154,7 @@ export declare class BoardService 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."
      *                     }
      *                   ]
      *                 }
@@ -1155,14 +1162,12 @@ export declare class BoardService 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": {
@@ -1188,8 +1193,7 @@ export declare class BoardService 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",
@@ -1208,8 +1212,7 @@ export declare class BoardService 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,
@@ -1217,8 +1220,7 @@ export declare class BoardService 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": {
@@ -1240,16 +1242,17 @@ export declare class BoardService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/backlog
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/backlog`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-backlog-get
+     * @param params
      */
     getIssuesForBacklog: ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The ID of the board that has the backlog containing the requested issues. */
@@ -1295,7 +1298,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -1312,8 +1317,7 @@ export declare class BoardService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -1325,14 +1329,10 @@ export declare class BoardService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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": {
@@ -1345,8 +1345,7 @@ export declare class BoardService 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,
@@ -1358,8 +1357,7 @@ export declare class BoardService 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",
@@ -1370,10 +1368,7 @@ export declare class BoardService 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."
      *                     }
      *                   ]
      *                 }
@@ -1381,14 +1376,12 @@ export declare class BoardService 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": {
@@ -1414,8 +1407,7 @@ export declare class BoardService 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",
@@ -1434,8 +1426,7 @@ export declare class BoardService 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,
@@ -1443,8 +1434,7 @@ export declare class BoardService 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": {
@@ -1466,16 +1456,17 @@ export declare class BoardService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/issue
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-get
+     * @param params
      */
     getIssuesForBoard: ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The ID of the board that contains the requested issues. */
@@ -1517,7 +1508,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -1534,8 +1527,7 @@ export declare class BoardService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -1547,14 +1539,10 @@ export declare class BoardService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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": {
@@ -1567,8 +1555,7 @@ export declare class BoardService 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,
@@ -1580,8 +1567,7 @@ export declare class BoardService 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",
@@ -1592,10 +1578,7 @@ export declare class BoardService 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."
      *                     }
      *                   ]
      *                 }
@@ -1603,14 +1586,12 @@ export declare class BoardService 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": {
@@ -1636,8 +1617,7 @@ export declare class BoardService 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",
@@ -1656,8 +1636,7 @@ export declare class BoardService 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,
@@ -1665,8 +1644,7 @@ export declare class BoardService 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": {
@@ -1688,16 +1666,17 @@ export declare class BoardService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/epic/none/issue
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/epic/none/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-none-issue-get
+     * @param params
      */
     getIssuesWithoutEpicForBoard: ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The ID of the board that contains the requested issues. */
@@ -1750,7 +1729,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the board's projects, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 10,
      *   "startAt": 0,
@@ -1777,8 +1758,10 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/project
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/project`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-get
+     * @param params
      */
     getProjects: ({ boardId, startAt, maxResults, }: {
         /** The ID of the board that contains returned projects. */
@@ -1816,8 +1799,9 @@ export declare class BoardService extends CommonHttpService {
      * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
      * doesn't have reference to any project.
      *
-     * @path {GET} /rest/agile/1.0/board/{boardId}/project/full
+     * @path GET `/rest/agile/1.0/board/{boardId}/project/full`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-full-get
+     * @param params
      */
     getProjectsFull: ({ boardId, }: {
         /** The ID of the board that contains returned projects. */
@@ -1830,7 +1814,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the requested quick filter.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "boardId": 1,
      *   "description": "Issues of type bug",
      *   "id": 1,
@@ -1838,8 +1824,10 @@ export declare class BoardService extends CommonHttpService {
      *   "name": "Bugs",
      *   "position": 0
      * }
-     * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
+     * ```
+     * @path GET `/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-quickfilterid-get
+     * @param params
      */
     getQuickFilter: ({ boardId, quickFilterId, }: {
         boardId: number;
@@ -1848,8 +1836,9 @@ export declare class BoardService extends CommonHttpService {
     }) => Promise<QuickFilterBean>;
     /**
      * @returns 200 response
-     * @path {GET} /rest/agile/1.0/board/{boardId}/reports
+     * @path GET `/rest/agile/1.0/board/{boardId}/reports`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-reports-get
+     * @param params
      */
     getReportsForBoard: ({ boardId, }: {
         boardId: number;
@@ -1864,7 +1853,9 @@ export declare class BoardService extends CommonHttpService {
      *
      * @returns Returns the list of issue with status of rank operation.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "entries": [
      *     {
      *       "issueId": 10000,
@@ -1878,8 +1869,7 @@ export declare class BoardService extends CommonHttpService {
      *     },
      *     {
      *       "errors": [
-     *         "JIRA Agile cannot execute the rank operation at this time. Please try
-     * again later."
+     *         "JIRA Agile cannot execute the rank operation at this time. Please try again later."
      *       ],
      *       "issueId": 10002,
      *       "issueKey": "PR-3",
@@ -1887,13 +1877,16 @@ export declare class BoardService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {POST} /rest/agile/1.0/board/{boardId}/issue
+     * ```
+     * @path POST `/rest/agile/1.0/board/{boardId}/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-post
+     * @param params
      */
     moveIssuesToBoard: ({ boardId, issueRankRequestBean, }: {
         boardId: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "issues": [
          *         "PR-1",
          *         "10001",
@@ -1912,15 +1905,17 @@ export declare class BoardService extends CommonHttpService {
      * by the id. The user who stores the data is required to have permissions to
      * modify the board.
      *
-     * @returns * status: 200, mediaType: application/json
+     * @returns
+     *  * status: 200, mediaType: application/json
      *
      *    Returned if the board property is successfully updated.
      *
      *  * status: 201, mediaType: application/json
      *
      *    Returned if the board property is successfully created.
-     * @path {PUT} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
+     * @path PUT `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-put
+     * @param params
      */
     setBoardProperty: ({ boardId, propertyKey, requestBody, }: {
         /** the ID of the board on which the property will be set. */
@@ -1939,8 +1934,9 @@ export declare class BoardService extends CommonHttpService {
     }>;
     /**
      * @returns 200 response
-     * @path {PUT} /rest/agile/1.0/board/{boardId}/features
+     * @path PUT `/rest/agile/1.0/board/{boardId}/features`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-put
+     * @param params
      */
     toggleFeatures: ({ boardId, featureToggleRequestBean, }: {
         boardId: number;