Endpoints updates (#167)

* - Version 2 and Version 3
  - `mediaApiFileId` property added to `AttachmentMetadata` model.
  - [`getAvatarImageByType`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-rest-api-2-universal-avatar-view-type-type-get) method added to `Avatar` group.
  - [`getAvatarImageByID`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-rest-api-2-universal-avatar-view-type-type-avatar-id-get) method added to `Avatar` group.
  - [`getAvatarImageByOwner`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-rest-api-2-universal-avatar-view-type-type-owner-entityid-get) method added to `Avatar` group.
  - `editPermissions` property added to `Filter` model.
  - [`getAttachmentContent`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-rest-api-2-attachment-content-id-get) method added to `IssueAttachments` group.
  - [`getAttachmentThumbnail`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-rest-api-2-attachment-thumbnail-id-get) method added to `IssueAttachments` group.
  - `overrideScreenSecurity` and `overrideEditableFlag` properties added to `replaceIssueFieldOption` method in `IssueCustomFieldOptionsApps` group.
  - [`updateMultipleCustomFieldValues`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-values--apps-/#api-rest-api-2-app-field-value-post) method added to `IssueCustomFieldValuesApps` group.
  - [`createFieldConfiguration`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-rest-api-2-fieldconfiguration-post) method added to `IssueFieldConfigurations` group.
  - [`updateFieldConfiguration`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-rest-api-2-fieldconfiguration-id-put) method added to `IssueFieldConfigurations` group.
  - [`deleteFieldConfiguration`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-rest-api-2-fieldconfiguration-id-delete) method added to `IssueFieldConfigurations` group.
  - `custom` property added to `JiraExpressionEvalContext` model.
  - `schemes` property added to `Workflow` model.

* Version 3 updates

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Jira.js changelog
 
+### 2.8.0
+
+- JSDoc improvements.
+- Version 2 and Version 3
+  - `mediaApiFileId` property added to `AttachmentMetadata` model.
+  - [`getAvatarImageByType`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-rest-api-2-universal-avatar-view-type-type-get) method added to `Avatar` group.
+  - [`getAvatarImageByID`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-rest-api-2-universal-avatar-view-type-type-avatar-id-get) method added to `Avatar` group.
+  - [`getAvatarImageByOwner`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-rest-api-2-universal-avatar-view-type-type-owner-entityid-get) method added to `Avatar` group.
+  - `editPermissions` property added to `Filter` model.
+  - [`getAttachmentContent`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-rest-api-2-attachment-content-id-get) method added to `IssueAttachments` group.
+  - [`getAttachmentThumbnail`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-rest-api-2-attachment-thumbnail-id-get) method added to `IssueAttachments` group.
+  - `overrideScreenSecurity` and `overrideEditableFlag` properties added to `replaceIssueFieldOption` method in `IssueCustomFieldOptionsApps` group.
+  - [`updateMultipleCustomFieldValues`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-values--apps-/#api-rest-api-2-app-field-value-post) method added to `IssueCustomFieldValuesApps` group.
+  - [`createFieldConfiguration`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-rest-api-2-fieldconfiguration-post) method added to `IssueFieldConfigurations` group.
+  - [`updateFieldConfiguration`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-rest-api-2-fieldconfiguration-id-put) method added to `IssueFieldConfigurations` group.
+  - [`deleteFieldConfiguration`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-rest-api-2-fieldconfiguration-id-delete) method added to `IssueFieldConfigurations` group.
+  - `custom` property added to `JiraExpressionEvalContext` model.
+  - `schemes` property added to `Workflow` model.
+
 ### 2.7.0
 
 - Version 2:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "jira.js is a powerful Node.JS/Browser module that allows you to interact with the Jira API very easily",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -44,29 +44,29 @@
   "devDependencies": {
     "@types/express": "^4.17.13",
     "@types/jest": "^27.0.2",
-    "@types/node": "^16.11.1",
+    "@types/node": "^16.11.7",
     "@types/oauth": "^0.9.1",
-    "@types/sinon": "^10.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.1.0",
-    "@typescript-eslint/parser": "^5.1.0",
+    "@types/sinon": "^10.0.6",
+    "@typescript-eslint/eslint-plugin": "^5.3.1",
+    "@typescript-eslint/parser": "^5.3.1",
     "dotenv": "^10.0.0",
-    "eslint": "^8.0.1",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-airbnb-typescript": "^14.0.1",
+    "eslint": "^8.2.0",
+    "eslint-config-airbnb": "^19.0.0",
+    "eslint-config-airbnb-typescript": "^15.0.0",
     "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-import": "^2.25.3",
     "jest": "^27.3.1",
     "prettier": "^2.4.1",
-    "prettier-plugin-jsdoc": "^0.3.24",
-    "sinon": "^11.1.2",
+    "prettier-plugin-jsdoc": "^0.3.30",
+    "sinon": "^12.0.1",
     "ts-jest": "^27.0.7",
-    "typedoc": "^0.22.6",
+    "typedoc": "^0.22.9",
     "typedoc-plugin-extras": "^2.2.1",
     "typescript": "^4.4.4"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",
-    "axios": "^0.23.0",
+    "axios": "^0.24.0",
     "form-data": "^4.0.0",
     "oauth": "^0.9.15",
     "telemetry.jira.js": "<2",

package.json

@@ -84,8 +84,8 @@ export class BaseClient implements Client {
       bodyExists: !!requestConfig.data,
       callbackUsed: !!callback,
       headersExists: !!requestConfig.headers,
-      libVersion: '2.7.0',
-      libVersionHash: '14230927309d90e1e375e50abbc7ec23',
+      libVersion: '2.8.0',
+      libVersionHash: '96f223040672ea79c655dceda08e0830',
       methodName: telemetryData?.methodName || 'sendRequest',
       onErrorMiddlewareUsed: !!this.config.middlewares?.onError,
       onResponseMiddlewareUsed: !!this.config.middlewares?.onResponse,

src/clients/baseClient.ts

@@ -184,4 +184,133 @@ export class Avatars {
 
     return this.client.sendRequest(config, callback, { methodName: 'version2.avatars.deleteAvatar' });
   }
+
+  /**
+   * Returns the default project or issue type avatar image.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
+   */
+  async getAvatarImageByType<T = unknown>(
+    parameters: Parameters.GetAvatarImageByType,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the default project or issue type avatar image.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
+   */
+  async getAvatarImageByType<T = unknown>(parameters: Parameters.GetAvatarImageByType, callback?: never): Promise<T>;
+  async getAvatarImageByType<T = unknown>(
+    parameters: Parameters.GetAvatarImageByType,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/universal_avatar/view/type/${parameters.type}`,
+      method: 'GET',
+      params: {
+        size: parameters.size,
+        format: parameters.format,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'version2.avatars.getAvatarImageByType' });
+  }
+
+  /**
+   * Returns a project or issue type avatar image by ID.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *
+   * - For system avatars, none.
+   * - For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for
+   *   the project the avatar belongs to.
+   * - For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
+   *   for at least one project the issue type is used in.
+   */
+  async getAvatarImageByID<T = unknown>(
+    parameters: Parameters.GetAvatarImageByID,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns a project or issue type avatar image by ID.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *
+   * - For system avatars, none.
+   * - For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for
+   *   the project the avatar belongs to.
+   * - For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
+   *   for at least one project the issue type is used in.
+   */
+  async getAvatarImageByID<T = unknown>(parameters: Parameters.GetAvatarImageByID, callback?: never): Promise<T>;
+  async getAvatarImageByID<T = unknown>(
+    parameters: Parameters.GetAvatarImageByID,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/universal_avatar/view/type/${parameters.type}/avatar/${parameters.id}`,
+      method: 'GET',
+      params: {
+        size: parameters.size,
+        format: parameters.format,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'version2.avatars.getAvatarImageByID' });
+  }
+
+  /**
+   * Returns the avatar image for a project or issue type.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *
+   * - For system avatars, none.
+   * - For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for
+   *   the project the avatar belongs to.
+   * - For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
+   *   for at least one project the issue type is used in.
+   */
+  async getAvatarImageByOwner<T = unknown>(
+    parameters: Parameters.GetAvatarImageByOwner,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the avatar image for a project or issue type.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *
+   * - For system avatars, none.
+   * - For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for
+   *   the project the avatar belongs to.
+   * - For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
+   *   for at least one project the issue type is used in.
+   */
+  async getAvatarImageByOwner<T = unknown>(parameters: Parameters.GetAvatarImageByOwner, callback?: never): Promise<T>;
+  async getAvatarImageByOwner<T = unknown>(
+    parameters: Parameters.GetAvatarImageByOwner,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/universal_avatar/view/type/${parameters.type}/owner/${parameters.entityId}`,
+      method: 'GET',
+      params: {
+        size: parameters.size,
+        format: parameters.format,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'version2.avatars.getAvatarImageByOwner' });
+  }
 }

src/version2/avatars.ts

@@ -97,6 +97,7 @@ export class Filters {
         favourite: parameters?.favourite,
         favouritedCount: parameters?.favouritedCount,
         sharePermissions: parameters?.sharePermissions,
+        editPermissions: parameters?.editPermissions,
         sharedUsers: parameters?.sharedUsers,
         subscriptions: parameters?.subscriptions,
       },

src/version2/filters.ts

@@ -110,10 +110,7 @@ export class Groups {
    * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Browse
    * users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    */
-  async bulkGetGroups<T = Models.PageGroupDetails>(
-    parameters?: Parameters.BulkGetGroups,
-    callback?: never
-  ): Promise<T>;
+  async bulkGetGroups<T = Models.PageGroupDetails>(parameters?: Parameters.BulkGetGroups, callback?: never): Promise<T>;
   async bulkGetGroups<T = Models.PageGroupDetails>(
     parameters?: Parameters.BulkGetGroups,
     callback?: Callback<T>,

src/version2/groups.ts

@@ -8,6 +8,58 @@ import { RequestConfig } from '../requestConfig';
 export class IssueAttachments {
   constructor(private client: Client) {}
 
+  /**
+   * Returns the contents of an attachment. A `Range` header can be set to define a range of bytes within the attachment
+   * to download. See the [HTTP Range header standard](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range)
+   * for details.
+   *
+   * To return a thumbnail of the attachment, use [Download attachment thumbnail](#api-rest-api-2-attachment-thumbnail-id-get).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** For the
+   * issue containing the attachment:
+   *
+   * - *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+   * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
+   *   to view the issue.
+   */
+  async getAttachmentContent<T = unknown>(
+    parameters: Parameters.GetAttachmentContent,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the contents of an attachment. A `Range` header can be set to define a range of bytes within the attachment
+   * to download. See the [HTTP Range header standard](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range)
+   * for details.
+   *
+   * To return a thumbnail of the attachment, use [Download attachment thumbnail](#api-rest-api-2-attachment-thumbnail-id-get).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** For the
+   * issue containing the attachment:
+   *
+   * - *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+   * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
+   *   to view the issue.
+   */
+  async getAttachmentContent<T = unknown>(parameters: Parameters.GetAttachmentContent, callback?: never): Promise<T>;
+  async getAttachmentContent<T = unknown>(
+    parameters: Parameters.GetAttachmentContent,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/attachment/content/${parameters.id}`,
+      method: 'GET',
+      params: {
+        redirect: parameters.redirect,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'version2.issueAttachments.getAttachmentContent' });
+  }
+
   /**
    * Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.
    *
@@ -39,6 +91,62 @@ export class IssueAttachments {
     return this.client.sendRequest(config, callback, { methodName: 'version2.issueAttachments.getAttachmentMeta' });
   }
 
+  /**
+   * Returns the thumbnail of an attachment.
+   *
+   * To return the attachment contents, use [Download attachment content](#api-rest-api-2-attachment-content-id-get).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** For the
+   * issue containing the attachment:
+   *
+   * - *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+   * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
+   *   to view the issue.
+   */
+  async getAttachmentThumbnail<T = unknown>(
+    parameters: Parameters.GetAttachmentThumbnail,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns the thumbnail of an attachment.
+   *
+   * To return the attachment contents, use [Download attachment content](#api-rest-api-2-attachment-content-id-get).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** For the
+   * issue containing the attachment:
+   *
+   * - *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+   * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
+   *   to view the issue.
+   */
+  async getAttachmentThumbnail<T = unknown>(
+    parameters: Parameters.GetAttachmentThumbnail,
+    callback?: never
+  ): Promise<T>;
+  async getAttachmentThumbnail<T = unknown>(
+    parameters: Parameters.GetAttachmentThumbnail,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/attachment/thumbnail/${parameters.id}`,
+      method: 'GET',
+      params: {
+        redirect: parameters.redirect,
+        fallbackToDefault: parameters.fallbackToDefault,
+        width: parameters.width,
+        height: parameters.height,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, {
+      methodName: 'version2.issueAttachments.getAttachmentThumbnail',
+    });
+  }
+
   /**
    * Returns the metadata for an attachment. Note that the attachment itself is not returned.
    *