Types bug fixes (MrRefactoring#101)

* endpoint types changed

* type definition changed

* version 2.0.1

* changelog added

* issueTypeIds fixed

* models types changed

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Jira.js changelog
 
+### 2.0.1
+
+- Types bug fixes
+
 ### 2.0.0
 
 - One client divided to three: [Agile](https://developer.atlassian.com/cloud/jira/software/rest/intro/), [Version2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/), [Version3](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "main": "out/index.js",
   "types": "out/index.d.ts",
   "repository": "https://github.com/MrRefactoring/jira.js.git",

src/agile/backlog.ts

@@ -10,21 +10,21 @@ export class Backlog {
      *  <br />
      *  This operation is equivalent to remove future and active sprints from a given set of issues.
      *  At most 50 issues may be moved at once.  */
-  async moveIssuesToBacklog<T = void>(parameters?: Parameters.MoveIssuesToBacklog, callback?: Callback<T>): Promise<void>;
+  async moveIssuesToBacklog<T = void>(parameters: Parameters.MoveIssuesToBacklog | undefined, callback: Callback<T>): Promise<void>;
   /**
      * Move issues to the backlog.
      *  <br />
      *  This operation is equivalent to remove future and active sprints from a given set of issues.
      *  At most 50 issues may be moved at once.  */
-  async moveIssuesToBacklog<T = void>(parameters?: Parameters.MoveIssuesToBacklog, callback?: undefined): Promise<T>;
+  async moveIssuesToBacklog<T = void>(parameters?: Parameters.MoveIssuesToBacklog, callback?: never): Promise<T>;
   async moveIssuesToBacklog<T = void>(parameters?: Parameters.MoveIssuesToBacklog, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: '/agile/1.0/backlog/issue',
       method: 'POST',
       data: {
         issues: parameters?.issues,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'moveIssuesToBacklog' });
   }
@@ -41,9 +41,9 @@ export class Backlog {
      *  This operation is equivalent to remove future and active sprints from a given set of issues if the board has sprints
      *  If the board does not have sprints this will put the issues back into the backlog from the board.
      *  At most 50 issues may be moved at once.  */
-  async moveIssuesToBacklogForBoard<T = void>(parameters: Parameters.MoveIssuesToBacklogForBoard, callback?: undefined): Promise<T>;
+  async moveIssuesToBacklogForBoard<T = void>(parameters: Parameters.MoveIssuesToBacklogForBoard, callback?: never): Promise<T>;
   async moveIssuesToBacklogForBoard<T = void>(parameters: Parameters.MoveIssuesToBacklogForBoard, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: `/agile/1.0/backlog/${parameters.boardId}/issue`,
       method: 'POST',
       data: {
@@ -52,7 +52,7 @@ export class Backlog {
         rankAfterIssue: parameters.rankAfterIssue,
         rankCustomFieldId: parameters.rankCustomFieldId,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'moveIssuesToBacklogForBoard' });
   }

src/agile/board.ts

@@ -23,7 +23,7 @@ export class Builds {
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async submitBuilds<T = Models.SubmitBuilds>(parameters?: Parameters.SubmitBuilds, callback?: Callback<T>): Promise<void>;
+  async submitBuilds<T = Models.SubmitBuilds>(parameters: Parameters.SubmitBuilds | undefined, callback: Callback<T>): Promise<void>;
   /**
      * Update / insert builds data.
      *
@@ -41,17 +41,17 @@ export class Builds {
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async submitBuilds<T = Models.SubmitBuilds>(parameters?: Parameters.SubmitBuilds, callback?: undefined): Promise<T>;
+  async submitBuilds<T = Models.SubmitBuilds>(parameters?: Parameters.SubmitBuilds, callback?: never): Promise<T>;
   async submitBuilds<T = Models.SubmitBuilds>(parameters?: Parameters.SubmitBuilds, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: '/builds/0.1/bulk',
       method: 'POST',
       data: {
         properties: parameters?.properties,
         builds: parameters?.builds,
         providerMetadata: parameters?.providerMetadata,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'submitBuilds' });
   }
@@ -71,9 +71,9 @@ export class Builds {
      * deleted successfully (if needed).
      *
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
-     * This resource requires the 'DELETE' scope for Connect apps.
+     * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async deleteBuildsByProperty<T = unknown>(parameters?: Parameters.DeleteBuildsByProperty, callback?: Callback<T>): Promise<void>;
+  async deleteBuildsByProperty<T = unknown>(parameters: Parameters.DeleteBuildsByProperty | undefined, callback: Callback<T>): Promise<void>;
   /**
      * Bulk delete all builds data that match the given request.
      *
@@ -90,17 +90,17 @@ export class Builds {
      * deleted successfully (if needed).
      *
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
-     * This resource requires the 'DELETE' scope for Connect apps.
+     * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async deleteBuildsByProperty<T = unknown>(parameters?: Parameters.DeleteBuildsByProperty, callback?: undefined): Promise<T>;
+  async deleteBuildsByProperty<T = unknown>(parameters?: Parameters.DeleteBuildsByProperty, callback?: never): Promise<T>;
   async deleteBuildsByProperty<T = unknown>(parameters?: Parameters.DeleteBuildsByProperty, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: '/builds/0.1/bulkByProperties',
       method: 'DELETE',
       params: {
         _updateSequenceNumber: parameters?._updateSequenceNumber,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'deleteBuildsByProperty' });
   }
@@ -110,7 +110,7 @@ export class Builds {
      * The result will be what is currently stored, ignoring any pending updates or deletes.
      *
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
-     * This resource requires the 'READ' scope for Connect apps.
+     * This resource requires the 'WRITE' scope for Connect apps.
      *  */
   async getBuildByKey<T = Models.GetBuildByKey>(parameters: Parameters.GetBuildByKey, callback: Callback<T>): Promise<void>;
   /**
@@ -119,14 +119,14 @@ export class Builds {
      * The result will be what is currently stored, ignoring any pending updates or deletes.
      *
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
-     * This resource requires the 'READ' scope for Connect apps.
+     * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async getBuildByKey<T = Models.GetBuildByKey>(parameters: Parameters.GetBuildByKey, callback?: undefined): Promise<T>;
+  async getBuildByKey<T = Models.GetBuildByKey>(parameters: Parameters.GetBuildByKey, callback?: never): Promise<T>;
   async getBuildByKey<T = Models.GetBuildByKey>(parameters: Parameters.GetBuildByKey, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: `/builds/0.1/pipelines/${parameters.pipelineId}/builds/${parameters.buildNumber}`,
       method: 'GET',
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'getBuildByKey' });
   }
@@ -149,15 +149,15 @@ export class Builds {
      * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async deleteBuildByKey<T = unknown>(parameters: Parameters.DeleteBuildByKey, callback?: undefined): Promise<T>;
+  async deleteBuildByKey<T = unknown>(parameters: Parameters.DeleteBuildByKey, callback?: never): Promise<T>;
   async deleteBuildByKey<T = unknown>(parameters: Parameters.DeleteBuildByKey, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: `/builds/0.1/pipelines/${parameters.pipelineId}/builds/${parameters.buildNumber}`,
       method: 'DELETE',
       params: {
         _updateSequenceNumber: parameters._updateSequenceNumber,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'deleteBuildByKey' });
   }

src/agile/builds.ts

@@ -18,7 +18,7 @@ export class Deployments {
      * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async submitDeployments<T = Models.SubmitDeployments>(parameters?: Parameters.SubmitDeployments, callback?: Callback<T>): Promise<void>;
+  async submitDeployments<T = Models.SubmitDeployments>(parameters: Parameters.SubmitDeployments | undefined, callback: Callback<T>): Promise<void>;
   /**
      * Update / insert deployment data.
      *
@@ -31,17 +31,17 @@ export class Deployments {
      * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'WRITE' scope for Connect apps.
      *  */
-  async submitDeployments<T = Models.SubmitDeployments>(parameters?: Parameters.SubmitDeployments, callback?: undefined): Promise<T>;
+  async submitDeployments<T = Models.SubmitDeployments>(parameters?: Parameters.SubmitDeployments, callback?: never): Promise<T>;
   async submitDeployments<T = Models.SubmitDeployments>(parameters?: Parameters.SubmitDeployments, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: '/deployments/0.1/bulk',
       method: 'POST',
       data: {
         properties: parameters?.properties,
         deployments: parameters?.deployments,
         providerMetadata: parameters?.providerMetadata,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'submitDeployments' });
   }
@@ -59,7 +59,7 @@ export class Deployments {
      * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'DELETE' scope for Connect apps.
      *  */
-  async deleteDeploymentsByProperty<T = unknown>(parameters?: Parameters.DeleteDeploymentsByProperty, callback?: Callback<T>): Promise<void>;
+  async deleteDeploymentsByProperty<T = unknown>(parameters: Parameters.DeleteDeploymentsByProperty | undefined, callback: Callback<T>): Promise<void>;
   /**
      * Bulk delete all deployments that match the given request.
      *
@@ -74,15 +74,15 @@ export class Deployments {
      * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'DELETE' scope for Connect apps.
      *  */
-  async deleteDeploymentsByProperty<T = unknown>(parameters?: Parameters.DeleteDeploymentsByProperty, callback?: undefined): Promise<T>;
+  async deleteDeploymentsByProperty<T = unknown>(parameters?: Parameters.DeleteDeploymentsByProperty, callback?: never): Promise<T>;
   async deleteDeploymentsByProperty<T = unknown>(parameters?: Parameters.DeleteDeploymentsByProperty, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: '/deployments/0.1/bulkByProperties',
       method: 'DELETE',
       params: {
         _updateSequenceNumber: parameters?._updateSequenceNumber,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'deleteDeploymentsByProperty' });
   }
@@ -103,12 +103,12 @@ export class Deployments {
      * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'READ' scope for Connect apps.
      *  */
-  async getDeploymentByKey<T = Models.GetDeploymentByKey>(parameters: Parameters.GetDeploymentByKey, callback?: undefined): Promise<T>;
+  async getDeploymentByKey<T = Models.GetDeploymentByKey>(parameters: Parameters.GetDeploymentByKey, callback?: never): Promise<T>;
   async getDeploymentByKey<T = Models.GetDeploymentByKey>(parameters: Parameters.GetDeploymentByKey, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: `/deployments/0.1/pipelines/${parameters.pipelineId}/environments/${parameters.environmentId}/deployments/${parameters.deploymentSequenceNumber}`,
       method: 'GET',
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'getDeploymentByKey' });
   }
@@ -129,15 +129,15 @@ export class Deployments {
      * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
      * This resource requires the 'DELETE' scope for Connect apps.
      *  */
-  async deleteDeploymentByKey<T = unknown>(parameters: Parameters.DeleteDeploymentByKey, callback?: undefined): Promise<T>;
+  async deleteDeploymentByKey<T = unknown>(parameters: Parameters.DeleteDeploymentByKey, callback?: never): Promise<T>;
   async deleteDeploymentByKey<T = unknown>(parameters: Parameters.DeleteDeploymentByKey, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: `/deployments/0.1/pipelines/${parameters.pipelineId}/environments/${parameters.environmentId}/deployments/${parameters.deploymentSequenceNumber}`,
       method: 'DELETE',
       params: {
         _updateSequenceNumber: parameters._updateSequenceNumber,
       },
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'deleteDeploymentByKey' });
   }
@@ -148,12 +148,12 @@ export class Deployments {
   /**
      * Retrieve the  Deployment gating status for the given `pipelineId + environmentId + deploymentSequenceNumber` combination. Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the 'READ' scope.
      *  */
-  async getDeploymentGatingStatusByKey<T = Models.GetDeploymentGatingStatusByKey>(parameters: Parameters.GetDeploymentGatingStatusByKey, callback?: undefined): Promise<T>;
+  async getDeploymentGatingStatusByKey<T = Models.GetDeploymentGatingStatusByKey>(parameters: Parameters.GetDeploymentGatingStatusByKey, callback?: never): Promise<T>;
   async getDeploymentGatingStatusByKey<T = Models.GetDeploymentGatingStatusByKey>(parameters: Parameters.GetDeploymentGatingStatusByKey, callback?: Callback<T>): Promise<void | T> {
-    const config = ({
+    const config = {
       url: `/deployments/0.1/pipelines/${parameters.pipelineId}/environments/${parameters.environmentId}/deployments/${parameters.deploymentSequenceNumber}/gating-status`,
       method: 'GET',
-    } as RequestConfig);
+    } as RequestConfig;
 
     return this.client.sendRequest(config, callback, { methodName: 'getDeploymentGatingStatusByKey' });
   }