code quality improvements

Author: MrRefactoring

package.json

@@ -37,8 +37,13 @@
     "test": "npm run test:unit && npm run test:integration",
     "test:unit": "ava tests/unit --timeout=2m -с 8",
     "test:integration": "ava --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/integration/**/*.test.ts",
-    "replacePermissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'",
-    "replacePermissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'"
+    "replace:permissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'",
+    "replace:permissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'",
+    "replace:pagination:version2": "grep -rl \"(#pagination)\" ./src/version2 | xargs sed -i '' 's/(#pagination)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#pagination)/g'",
+    "replace:pagination:version3": "grep -rl \"(#pagination)\" ./src/version3 | xargs sed -i '' 's/(#pagination)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#pagination)/g'",
+    "replace:async:version2": "grep -rl \"(#async)\" ./src/version2 | xargs sed -i '' 's/(#async)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#async-operations)/g'",
+    "replace:async:version3": "grep -rl \"(#async)\" ./src/version3 | xargs sed -i '' 's/(#async)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#async-operations)/g'",
+    "code:formatting": "npm run replace:permissions:version2 && npm run replace:permissions:version3 && npm run replace:pagination:version2 && npm run replace:pagination:version3 && npm run replace:async:version2 && npm run replace:async:version3 && npm run prettier && npm run lint:fix"
   },
   "ava": {
     "extensions": [

src/clients/baseClient.ts

@@ -16,7 +16,9 @@ export class BaseClient implements Client {
     try {
       new URL(config.host);
     } catch (e) {
-      throw new Error('Couldn\'t parse the host URL. Perhaps you forgot to add \'http://\' or \'https://\' at the beginning of the URL?');
+      throw new Error(
+        "Couldn't parse the host URL. Perhaps you forgot to add 'http://' or 'https://' at the beginning of the URL?",
+      );
     }
 
     this.instance = axios.create({

src/version3/issueNotificationSchemes.ts

@@ -93,11 +93,11 @@ export class IssueNotificationSchemes {
   }
 
   /**
-   * Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide
-   * either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will
-   * return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because
-   * team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by
-   * projectId.
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) mapping of
+   * project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or
+   * project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only
+   * company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a
+   * default notification scheme. The mappings are ordered by projectId.
    *
    * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
    * Permission to access Jira.
@@ -107,11 +107,11 @@ export class IssueNotificationSchemes {
     callback: Callback<T>,
   ): Promise<void>;
   /**
-   * Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide
-   * either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will
-   * return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because
-   * team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by
-   * projectId.
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) mapping of
+   * project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or
+   * project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only
+   * company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a
+   * default notification scheme. The mappings are ordered by projectId.
    *
    * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
    * Permission to access Jira.

src/version3/issuePriorities.ts

@@ -129,8 +129,8 @@ export class IssuePriorities {
   }
 
   /**
-   * Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined
-   * by any combination of these criteria:
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
+   * priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
    *
    * - A list of priority IDs. Any invalid priority IDs are ignored.
    * - Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only,
@@ -144,8 +144,8 @@ export class IssuePriorities {
     callback: Callback<T>,
   ): Promise<void>;
   /**
-   * Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined
-   * by any combination of these criteria:
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
+   * priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
    *
    * - A list of priority IDs. Any invalid priority IDs are ignored.
    * - Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only,

src/version3/issueResolutions.ts

@@ -33,8 +33,8 @@ export class IssueResolutions {
   /**
    * Creates an issue resolution.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async createResolution<T = Models.ResolutionId>(
     parameters: Parameters.CreateResolution,
@@ -43,8 +43,8 @@ export class IssueResolutions {
   /**
    * Creates an issue resolution.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async createResolution<T = Models.ResolutionId>(
     parameters: Parameters.CreateResolution,
@@ -66,8 +66,8 @@ export class IssueResolutions {
   /**
    * Sets default issue resolution.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async setDefaultResolution<T = void>(
     parameters: Parameters.SetDefaultResolution,
@@ -76,8 +76,8 @@ export class IssueResolutions {
   /**
    * Sets default issue resolution.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async setDefaultResolution<T = void>(parameters: Parameters.SetDefaultResolution, callback?: never): Promise<T>;
   async setDefaultResolution<T = void>(
@@ -98,15 +98,15 @@ export class IssueResolutions {
   /**
    * Changes the order of issue resolutions.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async moveResolutions<T = void>(parameters: Parameters.MoveResolutions, callback: Callback<T>): Promise<void>;
   /**
    * Changes the order of issue resolutions.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async moveResolutions<T = void>(parameters: Parameters.MoveResolutions, callback?: never): Promise<T>;
   async moveResolutions<T = void>(parameters: Parameters.MoveResolutions, callback?: Callback<T>): Promise<void | T> {
@@ -124,28 +124,30 @@ export class IssueResolutions {
   }
 
   /**
-   * Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined
-   * by any combination of these criteria:
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
+   * resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:
    *
    * - A list of resolutions IDs.
    * - Whether the field configuration is a default. This returns resolutions from company-managed (classic) projects
    *   only, as there is no concept of default resolutions in team-managed projects.
    *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * Permission to access Jira.
    */
   async searchResolutions<T = Models.PageResolution>(
     parameters: Parameters.SearchResolutions | undefined,
     callback: Callback<T>,
   ): Promise<void>;
   /**
-   * Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined
-   * by any combination of these criteria:
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
+   * resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:
    *
    * - A list of resolutions IDs.
    * - Whether the field configuration is a default. This returns resolutions from company-managed (classic) projects
    *   only, as there is no concept of default resolutions in team-managed projects.
    *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * Permission to access Jira.
    */
   async searchResolutions<T = Models.PageResolution>(
     parameters?: Parameters.SearchResolutions,
@@ -201,15 +203,15 @@ export class IssueResolutions {
   /**
    * Updates an issue resolution.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async updateResolution<T = void>(parameters: Parameters.UpdateResolution, callback: Callback<T>): Promise<void>;
   /**
    * Updates an issue resolution.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async updateResolution<T = void>(parameters: Parameters.UpdateResolution, callback?: never): Promise<T>;
   async updateResolution<T = void>(parameters: Parameters.UpdateResolution, callback?: Callback<T>): Promise<void | T> {
@@ -230,11 +232,13 @@ export class IssueResolutions {
   /**
    * Deletes an issue resolution.
    *
-   * This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the
-   * task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
+   * This operation is
+   * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the
+   * `location` link in the response to determine the status of the task and use [Get
+   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async deleteResolution<T = Models.TaskProgressObject>(
     parameters: Parameters.DeleteResolution,
@@ -243,11 +247,13 @@ export class IssueResolutions {
   /**
    * Deletes an issue resolution.
    *
-   * This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the
-   * task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
+   * This operation is
+   * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the
+   * `location` link in the response to determine the status of the task and use [Get
+   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
   async deleteResolution<T = Models.TaskProgressObject>(
     parameters: Parameters.DeleteResolution,

src/version3/projectComponents.ts

@@ -78,8 +78,8 @@ export class ProjectComponents {
    *
    * This operation can be accessed anonymously.
    *
-   * **[Permissions](#permissions) required:** _Browse projects_ [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse
+   * projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.
    */
   async getComponent<T = Models.ProjectComponent>(parameters: Parameters.GetComponent, callback?: never): Promise<T>;
   async getComponent<T = Models.ProjectComponent>(

src/version3/projects.ts

@@ -595,8 +595,8 @@ export class Projects {
    * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. Deprecated,
    * use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) supporting search and pagination.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
    * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
    * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
    * permission](https://confluence.atlassian.com/x/yodKLg).
@@ -609,8 +609,8 @@ export class Projects {
    * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. Deprecated,
    * use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) supporting search and pagination.
    *
-   * **[Permissions](#permissions) required:** _Administer Jira_ [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
    * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
    * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
    * permission](https://confluence.atlassian.com/x/yodKLg).