@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -5,8 +5,8 @@ exports.ProjectsService = void 0;
 // This file is generated by "api-typescript-generator".
 // To update this file run "yarn build:openapi".
 const zod_1 = require("zod");
-const commonHttpClient = require("../core/CommonHttpClient");
-const CommonHttpService_1 = require("../core/CommonHttpService");
+const commonHttpClient = require("../../core/CommonHttpClient");
+const CommonHttpService_1 = require("../../core/CommonHttpService");
 const common_1 = require("../models/common");
 const projects_1 = require("../models/projects");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
@@ -29,10 +29,11 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {POST} /rest/api/3/project/{projectIdOrKey}/archive
+         * @path POST `/rest/api/3/project/{projectIdOrKey}/archive`
          * @scopes-current manage:jira-project
          * @scopes-beta write:project:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-archive-post
+         * @param params
          */
         this.archiveProject = ({ projectIdOrKey, }) => {
             return this.getClientInstance()
@@ -116,15 +117,19 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the project is created.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "id": 10010,
          *   "key": "EX",
          *   "self": "https://your-domain.atlassian.net/jira/rest/api/3/project/10042"
          * }
-         * @path {POST} /rest/api/3/project
+         * ```
+         * @path POST `/rest/api/3/project`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:project:jira, read:project:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-post
+         * @param params
          */
         this.createProject = ({ createProjectDetails, }) => {
             return this.getClientInstance()
@@ -154,10 +159,11 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          * **[Permissions](#permissions) required:** *Administer Jira* [global
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
-         * @path {DELETE} /rest/api/3/project/{projectIdOrKey}
+         * @path DELETE `/rest/api/3/project/{projectIdOrKey}`
          * @scopes-current manage:jira-configuration
          * @scopes-beta delete:project:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-delete
+         * @param params
          */
         this.deleteProject = ({ projectIdOrKey, enableUndo, }) => {
             return this.getClientInstance()
@@ -187,10 +193,11 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          * **[Permissions](#permissions) required:** *Administer Jira* [global
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
-         * @path {POST} /rest/api/3/project/{projectIdOrKey}/delete
+         * @path POST `/rest/api/3/project/{projectIdOrKey}/delete`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:project:jira, write:project.property:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-delete-post
+         * @param params
          */
         this.deleteProjectAsynchronously = ({ projectIdOrKey, }) => {
             return this.getClientInstance()
@@ -217,17 +224,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          * @deprecated
          * @returns Returned if the request is successful.
          *
-         * example: [
+         * example:
+         * ```
+         * [
          *   {
          *     "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": {
@@ -240,8 +245,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "First Project Category",
          *       "id": "10000",
          *       "name": "FIRST",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *       "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *     },
          *     "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *     "simplified": false,
@@ -249,14 +253,10 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   },
          *   {
          *     "avatarUrls": {
-         *       "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
-         *       "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
-         *       "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
-         *       "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
+         *       "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
+         *       "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
+         *       "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
+         *       "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
          *     },
          *     "id": "10001",
          *     "insight": {
@@ -269,21 +269,19 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "First Project Category",
          *       "id": "10000",
          *       "name": "FIRST",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *       "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *     },
          *     "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
          *     "simplified": false,
          *     "style": "CLASSIC"
          *   }
          * ]
-         * @path {GET} /rest/api/3/project
+         * ```
+         * @path GET `/rest/api/3/project`
          * @scopes-current read:jira-work
-         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
-         * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
-         * read:issue-type-hierarchy:jira, read:project-category:jira,
-         * read:project-version:jira, read:project.component:jira
+         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-get
+         * @param params
          */
         this.getAllProjects = ({ expand, recent, properties, } = {}) => {
             return this.getClientInstance()
@@ -317,7 +315,9 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: [
+         * example:
+         * ```
+         * [
          *   {
          *     "id": "3",
          *     "name": "Task",
@@ -325,8 +325,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "statuses": [
          *       {
          *         "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"
@@ -342,10 +341,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "subtask": false
          *   }
          * ]
-         * @path {GET} /rest/api/3/project/{projectIdOrKey}/statuses
+         * ```
+         * @path GET `/rest/api/3/project/{projectIdOrKey}/statuses`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-status:jira, read:issue-type:jira, read:status:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-statuses-get
+         * @param params
          */
         this.getAllStatuses = ({ projectIdOrKey, }) => {
             return this.getClientInstance()
@@ -383,7 +384,9 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "hierarchy": [
          *     {
          *       "issueTypes": [
@@ -430,10 +433,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   ],
          *   "projectId": 10030
          * }
-         * @path {GET} /rest/api/3/project/{projectId}/hierarchy
+         * ```
+         * @path GET `/rest/api/3/project/{projectId}/hierarchy`
          * @scopes-current read:jira-work
          * @scopes-beta read:issue-type:jira, read:issue-type-hierarchy:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectid-hierarchy-get
+         * @param params
          */
         this.getHierarchy = ({ projectId, }) => {
             return this.getClientInstance()
@@ -463,7 +468,9 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "description": "description",
          *   "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
          *   "id": 10100,
@@ -481,8 +488,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *           "group": {
          *             "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
          *             "name": "jira-administrators",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          *           },
          *           "id": 1,
          *           "notificationType": "Group",
@@ -499,12 +505,10 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *           "notificationType": "ProjectRole",
          *           "parameter": "10360",
          *           "projectRole": {
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
          *             "name": "Developers",
          *             "id": 10360,
-         *             "description": "A project role that represents developers in a
-         * project",
+         *             "description": "A project role that represents developers in a project",
          *             "actors": [
          *               {
          *                 "actorGroup": {
@@ -554,8 +558,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *             "accountId": "5b10a2844c20165700ede21g",
          *             "active": false,
          *             "displayName": "Mia Krystof",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *           }
          *         },
          *         {
@@ -572,8 +575,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *             "navigable": true,
          *             "orderable": true,
          *             "schema": {
-         *               "custom":
-         * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+         *               "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
          *               "customId": 10101,
          *               "type": "project"
          *             },
@@ -589,8 +591,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     },
          *     {
          *       "event": {
-         *         "description": "Custom event that is published together with an issue
-         * created event",
+         *         "description": "Custom event that is published together with an issue created event",
          *         "id": 20,
          *         "name": "Custom event",
          *         "templateEvent": {
@@ -605,8 +606,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *           "group": {
          *             "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
          *             "name": "jira-administrators",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          *           },
          *           "id": 1,
          *           "notificationType": "Group",
@@ -623,12 +623,10 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *           "notificationType": "ProjectRole",
          *           "parameter": "10360",
          *           "projectRole": {
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
          *             "name": "Developers",
          *             "id": 10360,
-         *             "description": "A project role that represents developers in a
-         * project",
+         *             "description": "A project role that represents developers in a project",
          *             "actors": [
          *               {
          *                 "actorGroup": {
@@ -678,8 +676,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *             "accountId": "5b10a2844c20165700ede21g",
          *             "active": false,
          *             "displayName": "Mia Krystof",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *           }
          *         },
          *         {
@@ -696,8 +693,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *             "navigable": true,
          *             "orderable": true,
          *             "schema": {
-         *               "custom":
-         * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+         *               "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
          *               "customId": 10101,
          *               "type": "project"
          *             },
@@ -718,12 +714,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   ],
          *   "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
          * }
-         * @path {GET} /rest/api/3/project/{projectKeyOrId}/notificationscheme
+         * ```
+         * @path GET `/rest/api/3/project/{projectKeyOrId}/notificationscheme`
          * @scopes-current read:jira-work
-         * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira,
-         * read:user:jira, read:group:jira, read:field:jira, read:avatar:jira,
-         * read:field-configuration:jira, read:notification-scheme:jira
+         * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira, read:user:jira, read:group:jira, read:field:jira, read:avatar:jira, read:field-configuration:jira, read:notification-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectkeyorid-notificationscheme-get
+         * @param params
          */
         this.getNotificationSchemeForProject = ({ projectKeyOrId, expand, }) => {
             return this.getClientInstance()
@@ -757,41 +753,33 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "assigneeType": "PROJECT_LEAD",
          *   "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"
          *   },
          *   "components": [
          *     {
-         *       "ari":
-         * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
+         *       "ari": "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
          *       "assignee": {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "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"
          *       },
          *       "assigneeType": "PROJECT_LEAD",
          *       "description": "This is a Jira component",
@@ -802,20 +790,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "accountType": "atlassian",
          *         "active": false,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "key": "",
          *         "name": "",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *       },
          *       "metadata": {
          *         "icon": "https://www.example.com/icon.png"
@@ -828,20 +811,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "accountType": "atlassian",
          *         "active": false,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "key": "",
          *         "name": "",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *       },
          *       "realAssigneeType": "PROJECT_LEAD",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
@@ -859,8 +837,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "avatarId": 1,
          *       "description": "A task that needs to be done.",
          *       "hierarchyLevel": 0,
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+         *       "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
          *       "id": "3",
          *       "name": "Task",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
@@ -871,8 +848,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "A problem with the software.",
          *       "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
          *       "hierarchyLevel": 0,
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+         *       "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
          *       "id": "1",
          *       "name": "Bug",
          *       "scope": {
@@ -891,20 +867,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "accountType": "atlassian",
          *     "active": false,
          *     "avatarUrls": {
-         *       "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *       "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *       "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *       "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *       "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *       "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *       "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *       "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *     },
          *     "displayName": "Mia Krystof",
          *     "key": "",
          *     "name": "",
-         *     "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *   },
          *   "name": "Example",
          *   "projectCategory": {
@@ -917,8 +888,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "propertyKey": "propertyValue"
          *   },
          *   "roles": {
-         *     "Developers":
-         * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
+         *     "Developers": "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
          *   },
          *   "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *   "simplified": false,
@@ -926,13 +896,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   "url": "https://www.example.com",
          *   "versions": []
          * }
-         * @path {GET} /rest/api/3/project/{projectIdOrKey}
+         * ```
+         * @path GET `/rest/api/3/project/{projectIdOrKey}`
          * @scopes-current read:jira-work
-         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
-         * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
-         * read:issue-type-hierarchy:jira, read:project-category:jira,
-         * read:project-version:jira, read:project.component:jira
+         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-get
+         * @param params
          */
         this.getProject = ({ projectIdOrKey, expand, properties, }) => {
             return this.getClientInstance()
@@ -974,17 +943,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: [
+         * example:
+         * ```
+         * [
          *   {
          *     "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": {
@@ -997,8 +964,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "First Project Category",
          *       "id": "10000",
          *       "name": "FIRST",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *       "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *     },
          *     "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *     "simplified": false,
@@ -1006,14 +972,10 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   },
          *   {
          *     "avatarUrls": {
-         *       "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
-         *       "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
-         *       "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
-         *       "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
+         *       "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
+         *       "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
+         *       "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
+         *       "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
          *     },
          *     "id": "10001",
          *     "insight": {
@@ -1026,21 +988,19 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "First Project Category",
          *       "id": "10000",
          *       "name": "FIRST",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *       "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *     },
          *     "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
          *     "simplified": false,
          *     "style": "CLASSIC"
          *   }
          * ]
-         * @path {GET} /rest/api/3/project/recent
+         * ```
+         * @path GET `/rest/api/3/project/recent`
          * @scopes-current read:jira-work
-         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
-         * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
-         * read:issue-type-hierarchy:jira, read:project-category:jira,
-         * read:project-version:jira, read:project.component:jira
+         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-recent-get
+         * @param params
          */
         this.getRecent = ({ expand, properties, } = {}) => {
             return this.getClientInstance()
@@ -1076,41 +1036,33 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "assigneeType": "PROJECT_LEAD",
          *   "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"
          *   },
          *   "components": [
          *     {
-         *       "ari":
-         * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
+         *       "ari": "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
          *       "assignee": {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "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"
          *       },
          *       "assigneeType": "PROJECT_LEAD",
          *       "description": "This is a Jira component",
@@ -1121,20 +1073,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "accountType": "atlassian",
          *         "active": false,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "key": "",
          *         "name": "",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *       },
          *       "metadata": {
          *         "icon": "https://www.example.com/icon.png"
@@ -1147,20 +1094,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "accountType": "atlassian",
          *         "active": false,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "key": "",
          *         "name": "",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *       },
          *       "realAssigneeType": "PROJECT_LEAD",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
@@ -1178,8 +1120,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "avatarId": 1,
          *       "description": "A task that needs to be done.",
          *       "hierarchyLevel": 0,
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+         *       "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
          *       "id": "3",
          *       "name": "Task",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
@@ -1190,8 +1131,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "A problem with the software.",
          *       "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
          *       "hierarchyLevel": 0,
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+         *       "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
          *       "id": "1",
          *       "name": "Bug",
          *       "scope": {
@@ -1210,20 +1150,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "accountType": "atlassian",
          *     "active": false,
          *     "avatarUrls": {
-         *       "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *       "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *       "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *       "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *       "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *       "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *       "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *       "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *     },
          *     "displayName": "Mia Krystof",
          *     "key": "",
          *     "name": "",
-         *     "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *   },
          *   "name": "Example",
          *   "projectCategory": {
@@ -1236,8 +1171,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "propertyKey": "propertyValue"
          *   },
          *   "roles": {
-         *     "Developers":
-         * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
+         *     "Developers": "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
          *   },
          *   "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *   "simplified": false,
@@ -1245,14 +1179,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   "url": "https://www.example.com",
          *   "versions": []
          * }
-         * @path {POST} /rest/api/3/project/{projectIdOrKey}/restore
+         * ```
+         * @path POST `/rest/api/3/project/{projectIdOrKey}/restore`
          * @scopes-current manage:jira-configuration
-         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
-         * read:user:jira, write:project:jira, read:application-role:jira,
-         * read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira,
-         * read:project-category:jira, read:project-version:jira,
-         * read:project.component:jira
+         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira, read:user:jira, write:project:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-restore-post
+         * @param params
          */
         this.restore = ({ projectIdOrKey, }) => {
             return this.getClientInstance()
@@ -1289,26 +1221,22 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
-         *   "nextPage":
-         * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2",
-         *   "self":
-         * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2",
+         *   "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2",
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2",
          *   "startAt": 0,
          *   "total": 7,
          *   "values": [
          *     {
          *       "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": {
@@ -1321,8 +1249,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "description": "First Project Category",
          *         "id": "10000",
          *         "name": "FIRST",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *       },
          *       "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *       "simplified": false,
@@ -1330,14 +1257,10 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     },
          *     {
          *       "avatarUrls": {
-         *         "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
-         *         "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
-         *         "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
-         *         "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
+         *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
+         *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
+         *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
+         *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
          *       },
          *       "id": "10001",
          *       "insight": {
@@ -1350,8 +1273,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "description": "First Project Category",
          *         "id": "10000",
          *         "name": "FIRST",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *       },
          *       "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
          *       "simplified": false,
@@ -1359,13 +1281,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/project/search
+         * ```
+         * @path GET `/rest/api/3/project/search`
          * @scopes-current read:jira-work
-         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
-         * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
-         * read:issue-type-hierarchy:jira, read:project-category:jira,
-         * read:project-version:jira, read:project.component:jira
+         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-search-get
+         * @param params
          */
         this.searchProjects = ({ startAt, maxResults, orderBy, id, keys, query, typeKey, categoryId, action, expand, status, properties, propertyQuery, } = {}) => {
             return this.getClientInstance()
@@ -1412,41 +1333,33 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the project is updated.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "assigneeType": "PROJECT_LEAD",
          *   "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"
          *   },
          *   "components": [
          *     {
-         *       "ari":
-         * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
+         *       "ari": "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
          *       "assignee": {
          *         "accountId": "5b10a2844c20165700ede21g",
          *         "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"
          *       },
          *       "assigneeType": "PROJECT_LEAD",
          *       "description": "This is a Jira component",
@@ -1457,20 +1370,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "accountType": "atlassian",
          *         "active": false,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "key": "",
          *         "name": "",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *       },
          *       "metadata": {
          *         "icon": "https://www.example.com/icon.png"
@@ -1483,20 +1391,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *         "accountType": "atlassian",
          *         "active": false,
          *         "avatarUrls": {
-         *           "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *           "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *           "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *           "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *         },
          *         "displayName": "Mia Krystof",
          *         "key": "",
          *         "name": "",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *       },
          *       "realAssigneeType": "PROJECT_LEAD",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
@@ -1514,8 +1417,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "avatarId": 1,
          *       "description": "A task that needs to be done.",
          *       "hierarchyLevel": 0,
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+         *       "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
          *       "id": "3",
          *       "name": "Task",
          *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
@@ -1526,8 +1428,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *       "description": "A problem with the software.",
          *       "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
          *       "hierarchyLevel": 0,
-         *       "iconUrl":
-         * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+         *       "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
          *       "id": "1",
          *       "name": "Bug",
          *       "scope": {
@@ -1546,20 +1447,15 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "accountType": "atlassian",
          *     "active": false,
          *     "avatarUrls": {
-         *       "16x16":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-         *       "24x24":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-         *       "32x32":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-         *       "48x48":
-         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *       "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *       "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *       "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *       "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
          *     },
          *     "displayName": "Mia Krystof",
          *     "key": "",
          *     "name": "",
-         *     "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *   },
          *   "name": "Example",
          *   "projectCategory": {
@@ -1572,8 +1468,7 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *     "propertyKey": "propertyValue"
          *   },
          *   "roles": {
-         *     "Developers":
-         * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
+         *     "Developers": "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
          *   },
          *   "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *   "simplified": false,
@@ -1581,14 +1476,12 @@ class ProjectsService extends CommonHttpService_1.CommonHttpService {
          *   "url": "https://www.example.com",
          *   "versions": []
          * }
-         * @path {PUT} /rest/api/3/project/{projectIdOrKey}
+         * ```
+         * @path PUT `/rest/api/3/project/{projectIdOrKey}`
          * @scopes-current manage:jira-project
-         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
-         * read:user:jira, write:project:jira, write:project.avatar:jira,
-         * read:application-role:jira, read:avatar:jira, read:group:jira,
-         * read:issue-type-hierarchy:jira, read:project-category:jira,
-         * read:project-version:jira, read:project.component:jira
+         * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira, read:user:jira, write:project:jira, write:project.avatar:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-put
+         * @param params
          */
         this.updateProject = ({ projectIdOrKey, expand, updateProjectDetails, }) => {
             return this.getClientInstance()