Short parameters were added for applicable methods (MrRefactoring#218)

* service desk api updates

* removed deprecated properties

* removed deprecated properties

* agile API updated

* agile models updates

* MrRefactoring#219 accountId bugfix

* Version 2 API updates

* Version 2 models links added

* short parameters added for version 2

* timeout added for unit tests

* tests fixes

* deps updated

* package.json updated

* updates

* version3 updated

* prettier run

* changelog updated

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Jira.js changelog
 
+### 2.16.0
+
+Short parameters were added for applicable methods.
+
 ### 2.15.17
 
 - Badge fix

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.15.17",
+  "version": "2.16.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",
@@ -51,7 +51,7 @@
     }
   },
   "devDependencies": {
-    "@swc-node/register": "^1.5.4",
+    "@swc-node/register": "^1.5.5",
     "@types/express": "^4.17.15",
     "@types/node": "^18.11.18",
     "@types/oauth": "^0.9.1",
@@ -66,11 +66,11 @@
     "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-sort-exports": "^0.8.0",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.2",
     "prettier-plugin-jsdoc": "^0.4.2",
     "sinon": "^15.0.1",
-    "typedoc": "^0.23.23",
-    "typedoc-plugin-extras": "^2.3.1",
+    "typedoc": "^0.23.24",
+    "typedoc-plugin-extras": "^2.3.2",
     "typescript": "^4.9.4"
   },
   "dependencies": {

package.json

@@ -36,22 +36,18 @@ export class Backlog {
   }
 
   /**
-   * Move issues to the backlog of a particular board (if they are already on that board).
-   *
-   * 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.
+   * Move issues to the backlog of a particular board (if they are already on that board). 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: Callback<T>
   ): Promise<void>;
   /**
-   * Move issues to the backlog of a particular board (if they are already on that board).
-   *
-   * 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.
+   * Move issues to the backlog of a particular board (if they are already on that board). 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,

src/agile/backlog.ts

@@ -50,13 +50,12 @@ export class Board {
    * <code>location</code> must include the <code>type</code> property (Valid values: project, user). If choosing
    * 'project', then a project must be specified by a <code>projectKeyOrId</code> property in <code>location</code>. If
    * choosing 'user', the current user is chosen by default. The <code>projectKeyOrId</code> property should not be
-   * provided. </li> </ul> <p> Note: <ul>
-   *  <li>
-   *  If you want to create a new project with an associated board, use the <a href="https://docs.atlassian.com/jira/REST/latest">Jira platform REST API</a>.
-   *  For more information, see the <a href="#api-rest-api-<ver>-project-post">Create project</a> method.
-   *  The <code>projectTypeKey</code> for software boards must be 'software' and the <code>projectTemplateKey</code> must be either
-   *  <code>com.pyxis.greenhopper.jira:gh-kanban-template</code> or <code>com.pyxis.greenhopper.jira:gh-scrum-template</code>.
-   *  </li>
+   * provided. </li> </ul> <p> Note: <ul> <li> If you want to create a new project with an associated board, use the <a
+   * href="https://docs.atlassian.com/jira/REST/latest">Jira platform REST API</a>. For more information, see the <a
+   * href="#api-rest-api-<ver>-project-post">Create project</a> method. The <code>projectTypeKey</code> for software
+   * boards must be 'software' and the <code>projectTemplateKey</code> must be either
+   * <code>com.pyxis.greenhopper.jira:gh-kanban-template</code> or
+   * <code>com.pyxis.greenhopper.jira:gh-scrum-template</code>. </li>
    *  <li>
    *  You can create a filter using the <a href="https://docs.atlassian.com/jira/REST/latest">Jira REST API</a>.
    *  For more information, see the <a href="#api-rest-api-<ver>-filter-post">Create filter</a> method.
@@ -76,13 +75,12 @@ export class Board {
    * <code>location</code> must include the <code>type</code> property (Valid values: project, user). If choosing
    * 'project', then a project must be specified by a <code>projectKeyOrId</code> property in <code>location</code>. If
    * choosing 'user', the current user is chosen by default. The <code>projectKeyOrId</code> property should not be
-   * provided. </li> </ul> <p> Note: <ul>
-   *  <li>
-   *  If you want to create a new project with an associated board, use the <a href="https://docs.atlassian.com/jira/REST/latest">Jira platform REST API</a>.
-   *  For more information, see the <a href="#api-rest-api-<ver>-project-post">Create project</a> method.
-   *  The <code>projectTypeKey</code> for software boards must be 'software' and the <code>projectTemplateKey</code> must be either
-   *  <code>com.pyxis.greenhopper.jira:gh-kanban-template</code> or <code>com.pyxis.greenhopper.jira:gh-scrum-template</code>.
-   *  </li>
+   * provided. </li> </ul> <p> Note: <ul> <li> If you want to create a new project with an associated board, use the <a
+   * href="https://docs.atlassian.com/jira/REST/latest">Jira platform REST API</a>. For more information, see the <a
+   * href="#api-rest-api-<ver>-project-post">Create project</a> method. The <code>projectTypeKey</code> for software
+   * boards must be 'software' and the <code>projectTemplateKey</code> must be either
+   * <code>com.pyxis.greenhopper.jira:gh-kanban-template</code> or
+   * <code>com.pyxis.greenhopper.jira:gh-scrum-template</code>. </li>
    *  <li>
    *  You can create a filter using the <a href="https://docs.atlassian.com/jira/REST/latest">Jira REST API</a>.
    *  For more information, see the <a href="#api-rest-api-<ver>-filter-post">Create filter</a> method.
@@ -228,12 +226,12 @@ export class Board {
    * for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping
    * as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of
    * issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues
-   * in that column will be marked as already completed.</li> <li><code>estimation</code> (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field.
-   *  If the estimation type is "field", the ID and display name of the field used for estimation is also returned.
-   *  Note, estimates for an issue can be updated by a PUT /rest/api/~ver~/issue/{issueIdOrKey} request, however the fields must be on the screen.
-   *  "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
-   *  </li>
-   *  <li><code>ranking</code> - Contains information about custom field used for ranking in the given board.</li>
+   * in that column will be marked as already completed.</li> <li><code>estimation</code> (Scrum only) - Contains
+   * information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation
+   * type is "field", the ID and display name of the field used for estimation is also returned. Note, estimates for an
+   * issue can be updated by a PUT /rest/api/~ver~/issue/{issueIdOrKey} request, however the fields must be on the
+   * screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in
+   * "timetracking" field should be updated. </li> <li><code>ranking</code> - Contains information about custom field used for ranking in the given board.</li>
    *  </ul>
    */
   async getConfiguration<T = Models.GetConfiguration>(
@@ -249,12 +247,12 @@ export class Board {
    * for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping
    * as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of
    * issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues
-   * in that column will be marked as already completed.</li> <li><code>estimation</code> (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field.
-   *  If the estimation type is "field", the ID and display name of the field used for estimation is also returned.
-   *  Note, estimates for an issue can be updated by a PUT /rest/api/~ver~/issue/{issueIdOrKey} request, however the fields must be on the screen.
-   *  "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
-   *  </li>
-   *  <li><code>ranking</code> - Contains information about custom field used for ranking in the given board.</li>
+   * in that column will be marked as already completed.</li> <li><code>estimation</code> (Scrum only) - Contains
+   * information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation
+   * type is "field", the ID and display name of the field used for estimation is also returned. Note, estimates for an
+   * issue can be updated by a PUT /rest/api/~ver~/issue/{issueIdOrKey} request, however the fields must be on the
+   * screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in
+   * "timetracking" field should be updated. </li> <li><code>ranking</code> - Contains information about custom field used for ranking in the given board.</li>
    *  </ul>
    */
   async getConfiguration<T = Models.GetConfiguration>(