@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type NotificationScheme, type PageBeanProject, type Project } from "../models/common";
 import { type CreateProjectDetails, type IssueTypeWithStatus, type ProjectIdentifiers, type ProjectIssueTypeHierarchy, type StringList, type UpdateProjectDetails } from "../models/projects";
 /**
@@ -18,10 +18,11 @@ export declare class ProjectsService extends 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
      */
     archiveProject: ({ projectIdOrKey, }: {
         /** The project ID or project key (case sensitive). */
@@ -91,21 +92,26 @@ export declare class ProjectsService extends 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
      */
     createProject: ({ createProjectDetails, }: {
         /**
          * The JSON representation of the project being created.
          *
-         * @example {
+         * @example
+         * {
          *     "assigneeType": "PROJECT_LEAD",
          *     "avatarId": 10200,
          *     "categoryId": 10120,
@@ -116,8 +122,7 @@ export declare class ProjectsService extends CommonHttpService {
          *     "name": "Example",
          *     "notificationScheme": 10021,
          *     "permissionScheme": 10011,
-         *     "projectTemplateKey":
-         * "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
+         *     "projectTemplateKey": "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
          *     "projectTypeKey": "business",
          *     "url": "http://atlassian.com"
          * }
@@ -133,10 +138,11 @@ export declare class ProjectsService extends 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
      */
     deleteProject: ({ projectIdOrKey, enableUndo, }: {
         /** The project ID or project key (case sensitive). */
@@ -161,10 +167,11 @@ export declare class ProjectsService extends 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
      */
     deleteProjectAsynchronously: ({ projectIdOrKey, }: {
         /** The project ID or project key (case sensitive). */
@@ -184,17 +191,15 @@ export declare class ProjectsService extends 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": {
@@ -207,8 +212,7 @@ export declare class ProjectsService 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,
@@ -216,14 +220,10 @@ export declare class ProjectsService extends 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": {
@@ -236,21 +236,19 @@ export declare class ProjectsService 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/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
      */
     getAllProjects: ({ expand, recent, properties, }?: {
         /**
@@ -287,7 +285,9 @@ export declare class ProjectsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "id": "3",
      *     "name": "Task",
@@ -295,8 +295,7 @@ export declare class ProjectsService extends 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"
@@ -312,10 +311,12 @@ export declare class ProjectsService extends 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
      */
     getAllStatuses: ({ projectIdOrKey, }: {
         /** The project ID or project key (case sensitive). */
@@ -339,7 +340,9 @@ export declare class ProjectsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "hierarchy": [
      *     {
      *       "issueTypes": [
@@ -386,10 +389,12 @@ export declare class ProjectsService extends 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
      */
     getHierarchy: ({ projectId, }: {
         /** The ID of the project. */
@@ -405,7 +410,9 @@ export declare class ProjectsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "description": "description",
      *   "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
      *   "id": 10100,
@@ -423,8 +430,7 @@ export declare class ProjectsService extends 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",
@@ -441,12 +447,10 @@ export declare class ProjectsService extends 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": {
@@ -496,8 +500,7 @@ export declare class ProjectsService 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"
      *           }
      *         },
      *         {
@@ -514,8 +517,7 @@ export declare class ProjectsService extends 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"
      *             },
@@ -531,8 +533,7 @@ export declare class ProjectsService extends 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": {
@@ -547,8 +548,7 @@ export declare class ProjectsService extends 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",
@@ -565,12 +565,10 @@ export declare class ProjectsService extends 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": {
@@ -620,8 +618,7 @@ export declare class ProjectsService 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"
      *           }
      *         },
      *         {
@@ -638,8 +635,7 @@ export declare class ProjectsService extends 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"
      *             },
@@ -660,12 +656,12 @@ export declare class ProjectsService extends 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
      */
     getNotificationSchemeForProject: ({ projectKeyOrId, expand, }: {
         /** The project ID or project key (case sensitive). */
@@ -697,41 +693,33 @@ export declare class ProjectsService extends 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",
@@ -742,20 +730,15 @@ export declare class ProjectsService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "metadata": {
      *         "icon": "https://www.example.com/icon.png"
@@ -768,20 +751,15 @@ export declare class ProjectsService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "realAssigneeType": "PROJECT_LEAD",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
@@ -799,8 +777,7 @@ export declare class ProjectsService extends 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",
@@ -811,8 +788,7 @@ export declare class ProjectsService extends 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": {
@@ -831,20 +807,15 @@ export declare class ProjectsService extends CommonHttpService {
      *     "accountType": "atlassian",
      *     "active": false,
      *     "avatarUrls": {
-     *       "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *       "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *       "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *       "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *       "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *     },
      *     "displayName": "Mia Krystof",
      *     "key": "",
      *     "name": "",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "name": "Example",
      *   "projectCategory": {
@@ -857,8 +828,7 @@ export declare class ProjectsService extends 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,
@@ -866,13 +836,12 @@ export declare class ProjectsService extends 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
      */
     getProject: ({ projectIdOrKey, expand, properties, }: {
         /** The project ID or project key (case sensitive). */
@@ -914,17 +883,15 @@ export declare class ProjectsService extends 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": {
@@ -937,8 +904,7 @@ export declare class ProjectsService 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,
@@ -946,14 +912,10 @@ export declare class ProjectsService extends 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": {
@@ -966,21 +928,19 @@ export declare class ProjectsService 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/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
      */
     getRecent: ({ expand, properties, }?: {
         /**
@@ -1019,41 +979,33 @@ export declare class ProjectsService extends 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",
@@ -1064,20 +1016,15 @@ export declare class ProjectsService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "metadata": {
      *         "icon": "https://www.example.com/icon.png"
@@ -1090,20 +1037,15 @@ export declare class ProjectsService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "realAssigneeType": "PROJECT_LEAD",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
@@ -1121,8 +1063,7 @@ export declare class ProjectsService extends 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",
@@ -1133,8 +1074,7 @@ export declare class ProjectsService extends 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": {
@@ -1153,20 +1093,15 @@ export declare class ProjectsService extends CommonHttpService {
      *     "accountType": "atlassian",
      *     "active": false,
      *     "avatarUrls": {
-     *       "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *       "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *       "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *       "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *       "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *     },
      *     "displayName": "Mia Krystof",
      *     "key": "",
      *     "name": "",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "name": "Example",
      *   "projectCategory": {
@@ -1179,8 +1114,7 @@ export declare class ProjectsService extends 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,
@@ -1188,14 +1122,12 @@ export declare class ProjectsService extends 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
      */
     restore: ({ projectIdOrKey, }: {
         /** The project ID or project key (case sensitive). */
@@ -1218,26 +1150,22 @@ export declare class ProjectsService extends 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": {
@@ -1250,8 +1178,7 @@ export declare class ProjectsService 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,
@@ -1259,14 +1186,10 @@ export declare class ProjectsService extends 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": {
@@ -1279,8 +1202,7 @@ export declare class ProjectsService 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/ABC",
      *       "simplified": false,
@@ -1288,13 +1210,12 @@ export declare class ProjectsService extends 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
      */
     searchProjects: ({ startAt, maxResults, orderBy, id, keys, query, typeKey, categoryId, action, expand, status, properties, propertyQuery, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -1421,41 +1342,33 @@ export declare class ProjectsService extends 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",
@@ -1466,20 +1379,15 @@ export declare class ProjectsService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "metadata": {
      *         "icon": "https://www.example.com/icon.png"
@@ -1492,20 +1400,15 @@ export declare class ProjectsService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "realAssigneeType": "PROJECT_LEAD",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
@@ -1523,8 +1426,7 @@ export declare class ProjectsService extends 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",
@@ -1535,8 +1437,7 @@ export declare class ProjectsService extends 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": {
@@ -1555,20 +1456,15 @@ export declare class ProjectsService extends CommonHttpService {
      *     "accountType": "atlassian",
      *     "active": false,
      *     "avatarUrls": {
-     *       "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *       "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *       "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *       "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *       "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *     },
      *     "displayName": "Mia Krystof",
      *     "key": "",
      *     "name": "",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "name": "Example",
      *   "projectCategory": {
@@ -1581,8 +1477,7 @@ export declare class ProjectsService extends 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,
@@ -1590,14 +1485,12 @@ export declare class ProjectsService extends 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
      */
     updateProject: ({ projectIdOrKey, expand, updateProjectDetails, }: {
         /** The project ID or project key (case sensitive). */
@@ -1617,7 +1510,8 @@ export declare class ProjectsService extends CommonHttpService {
         /**
          * The project details to be updated.
          *
-         * @example {
+         * @example
+         * {
          *     "assigneeType": "PROJECT_LEAD",
          *     "avatarId": 10200,
          *     "categoryId": 10120,