New endpoints added (#137)

* New endpoints added

* lib version changed in baseClient

Author: MrRefactoring

CHANGELOG.md

@@ -1,7 +1,9 @@
 # Jira.js changelog
 
-### 2.3.1
+### 2.4.0
 
+- Some properties to some endpoints added :D
+- [IssueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-) group added
 - [#136](https://github.com/MrRefactoring/jira.js/pull/136) Fixed all URLs for Cloud Agile endpoint. Thanks [John Brunton](https://github.com/jbrunton)!
 - Internal code styles improved
 

README.md

@@ -266,6 +266,7 @@ Available groups:
   - [issues](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-group-issues)
   - [issueAttachments](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-group-issue-attachments)
   - [issueComments](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-group-issue-comments)
+  - [issueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-)
   - [issueCommentProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comment-properties/#api-group-issue-comment-properties)
   - [issueFields](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-fields/#api-group-issue-fields)
   - [issueFieldConfigurations](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-field-configurations/#api-group-issue-field-configurations)
@@ -346,6 +347,7 @@ Available groups:
   - [issues](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-group-issues)
   - [issueAttachments](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-group-issue-attachments)
   - [issueComments](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-group-issue-comments)
+  - [issueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-)
   - [issueCommentProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties/#api-group-issue-comment-properties)
   - [issueFields](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-group-issue-fields)
   - [issueFieldConfigurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-group-issue-field-configurations)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.3.0",
+  "version": "2.4.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",

package.json

@@ -84,8 +84,8 @@ export class BaseClient implements Client {
       bodyExists: !!requestConfig.data,
       callbackUsed: !!callback,
       headersExists: !!requestConfig.headers,
-      libVersion: '2.3.0',
-      libVersionHash: 'ae14c21d807ec17e583ca3b6c2097de5',
+      libVersion: '2.4.0',
+      libVersionHash: '11e0eed8d3696c0a632f822df385ab3c',
       methodName: telemetryData?.methodName || 'sendRequest',
       onErrorMiddlewareUsed: !!this.config.middlewares?.onError,
       onResponseMiddlewareUsed: !!this.config.middlewares?.onResponse,

src/clients/baseClient.ts

@@ -14,6 +14,7 @@ import {
   IssueAttachments,
   IssueCommentProperties,
   IssueComments,
+  IssueCustomFieldConfigurationApps,
   IssueCustomFieldContexts,
   IssueCustomFieldOptions,
   IssueCustomFieldOptionsApps,
@@ -96,6 +97,7 @@ export class Version2Client extends BaseClient {
   issueAttachments = new IssueAttachments(this);
   issueCommentProperties = new IssueCommentProperties(this);
   issueComments = new IssueComments(this);
+  issueCustomFieldConfigurationApps = new IssueCustomFieldConfigurationApps(this);
   issueCustomFieldContexts = new IssueCustomFieldContexts(this);
   issueCustomFieldOptions = new IssueCustomFieldOptions(this);
   issueCustomFieldOptionsApps = new IssueCustomFieldOptionsApps(this);

src/version2/client/version2Client.ts

@@ -12,6 +12,7 @@ export * from './instanceInformation';
 export * from './issueAttachments';
 export * from './issueCommentProperties';
 export * from './issueComments';
+export * from './issueCustomFieldConfigurationApps';
 export * from './issueCustomFieldContexts';
 export * from './issueCustomFieldOptions';
 export * from './issueCustomFieldOptionsApps';

src/version2/index.ts

@@ -0,0 +1,92 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Client } from '../clients';
+import { Callback } from '../callback';
+import { RequestConfig } from '../requestConfig';
+
+export class IssueCustomFieldConfigurationApps {
+  constructor(private client: Client) {}
+
+  /**
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of configurations for a custom field. The result can be filtered by
+   * `contextId` or `issueId`, otherwise all configurations are returned. Invalid IDs are ignored.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created
+   * the custom field.
+   */
+  async getCustomFieldConfiguration<T = Models.PageContextualConfiguration>(
+    parameters: Parameters.GetCustomFieldConfiguration,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of configurations for a custom field. The result can be filtered by
+   * `contextId` or `issueId`, otherwise all configurations are returned. Invalid IDs are ignored.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created
+   * the custom field.
+   */
+  async getCustomFieldConfiguration<T = Models.PageContextualConfiguration>(
+    parameters: Parameters.GetCustomFieldConfiguration,
+    callback?: never
+  ): Promise<T>;
+  async getCustomFieldConfiguration<T = Models.PageContextualConfiguration>(
+    parameters: Parameters.GetCustomFieldConfiguration,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/app/field/${parameters.fieldIdOrKey}/context/configuration`,
+      method: 'GET',
+      params: {
+        contextId: parameters.contextId,
+        issueId: parameters.issueId,
+        startAt: parameters.startAt,
+        maxResults: parameters.maxResults,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, {
+      methodName: 'version2.issueCustomFieldConfigurationApps.getCustomFieldConfiguration',
+    });
+  }
+
+  /**
+   * Update the configuration for contexts of a custom field.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created
+   * the custom field.
+   */
+  async updateCustomFieldConfiguration<T = unknown>(
+    parameters: Parameters.UpdateCustomFieldConfiguration,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Update the configuration for contexts of a custom field.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created
+   * the custom field.
+   */
+  async updateCustomFieldConfiguration<T = unknown>(
+    parameters: Parameters.UpdateCustomFieldConfiguration,
+    callback?: never
+  ): Promise<T>;
+  async updateCustomFieldConfiguration<T = unknown>(
+    parameters: Parameters.UpdateCustomFieldConfiguration,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/app/field/${parameters.fieldIdOrKey}/context/configuration`,
+      method: 'PUT',
+      data: {
+        configurations: parameters.configurations,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, {
+      methodName: 'version2.issueCustomFieldConfigurationApps.updateCustomFieldConfiguration',
+    });
+  }
+}

src/version2/issueCustomFieldConfigurationApps.ts

@@ -81,6 +81,48 @@ export class IssueTypes {
     return this.client.sendRequest(config, callback, { methodName: 'version2.issueTypes.createIssueType' });
   }
 
+  /**
+   * Returns issue types for a project.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project or *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async getIssueTypesForProject<T = Array<Models.IssueTypeDetails>>(
+    parameters: Parameters.GetIssueTypesForProject,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns issue types for a project.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project or *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async getIssueTypesForProject<T = Array<Models.IssueTypeDetails>>(
+    parameters: Parameters.GetIssueTypesForProject,
+    callback?: never
+  ): Promise<T>;
+  async getIssueTypesForProject<T = Array<Models.IssueTypeDetails>>(
+    parameters: Parameters.GetIssueTypesForProject,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/rest/api/2/issuetype/project',
+      method: 'GET',
+      params: {
+        projectId: parameters.projectId,
+        level: parameters.level,
+      },
+    };
+
+    return this.client.sendRequest(config, callback, { methodName: 'version2.issueTypes.getIssueTypesForProject' });
+  }
+
   /**
    * Returns an issue type.
    *

src/version2/issueTypes.ts

@@ -0,0 +1,7 @@
+/** Details of the contextual configuration for a custom field. */
+export interface ContextualConfiguration {
+  /** The ID of the context the configuration is associated with. */
+  contextId: number;
+  /** The configuration associated with the context. */
+  configuration?: {};
+}