@esm-js/jira.js/src/agile/issue.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

import type * as Models from './models';
import type * as Parameters from './parameters';
import type { Client } from '../clients';
import type { Callback } from '../callback';
import type { RequestConfig } from '../requestConfig';

export class Issue {
  constructor(private client: Client) {}

  /**
   * Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once.
   *
   * This operation may fail for some issues, although this will be rare. In that case the 207 status code is returned
   * for the whole response and detailed information regarding each issue is available in the response body.
   *
   * If rankCustomFieldId is not defined, the default rank field will be used.
   */
  async rankIssues<T = void>(parameters: Parameters.RankIssues, callback: Callback<T>): Promise<void>;
  /**
   * Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once.
   *
   * This operation may fail for some issues, although this will be rare. In that case the 207 status code is returned
   * for the whole response and detailed information regarding each issue is available in the response body.
   *
   * If rankCustomFieldId is not defined, the default rank field will be used.
   */
  async rankIssues<T = void>(parameters: Parameters.RankIssues, callback?: never): Promise<T>;
  async rankIssues<T = void>(parameters: Parameters.RankIssues, callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/agile/1.0/issue/rank',
      method: 'PUT',
      data: {
        issues: parameters.issues,
        rankAfterIssue: parameters.rankAfterIssue,
        rankBeforeIssue: parameters.rankBeforeIssue,
        rankCustomFieldId: parameters.rankCustomFieldId,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields,
   * like sprint, closedSprints, flagged, and epic.
   */
  async getIssue<T = Models.Issue>(parameters: Parameters.GetIssue, callback: Callback<T>): Promise<void>;
  /**
   * Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields,
   * like sprint, closedSprints, flagged, and epic.
   */
  async getIssue<T = Models.Issue>(parameters: Parameters.GetIssue, callback?: never): Promise<T>;
  async getIssue<T = Models.Issue>(parameters: Parameters.GetIssue, callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: `/rest/agile/1.0/issue/${parameters.issueIdOrKey}`,
      method: 'GET',
      params: {
        fields: parameters.fields,
        expand: parameters.expand,
        updateHistory: parameters.updateHistory,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * Returns the estimation of the issue and a fieldId of the field that is used for it. `boardId` param is required.
   * This param determines which field will be updated on a issue.
   *
   * Original time internally stores and returns the estimation as a number of seconds.
   *
   * The field used for estimation on the given board can be obtained from [board configuration
   * resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta
   * resource](#api-rest-api-3-issue-getEditIssueMeta) or [field resource](#api-rest-api-3-field-get).
   */
  async getIssueEstimationForBoard<T = unknown>(
    parameters: Parameters.GetIssueEstimationForBoard,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * Returns the estimation of the issue and a fieldId of the field that is used for it. `boardId` param is required.
   * This param determines which field will be updated on a issue.
   *
   * Original time internally stores and returns the estimation as a number of seconds.
   *
   * The field used for estimation on the given board can be obtained from [board configuration
   * resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta
   * resource](#api-rest-api-3-issue-getEditIssueMeta) or [field resource](#api-rest-api-3-field-get).
   */
  async getIssueEstimationForBoard<T = unknown>(
    parameters: Parameters.GetIssueEstimationForBoard,
    callback?: never,
  ): Promise<T>;
  async getIssueEstimationForBoard<T = unknown>(
    parameters: Parameters.GetIssueEstimationForBoard,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: `/rest/agile/1.0/issue/${parameters.issueIdOrKey}/estimation`,
      method: 'GET',
      params: {
        boardId: parameters.boardId,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * Updates the estimation of the issue. boardId param is required. This param determines which field will be updated
   * on an issue.
   *
   * Note that this resource changes the estimation field of the issue regardless of appearance the field on the screen.
   *
   * Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which
   * represent number of minutes. However, internally the field stores and returns the estimation as a number of
   * seconds.
   *
   * The field used for estimation on the given board can be obtained from [board configuration
   * resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta
   * resource](#api-rest-api-3-issue-issueIdOrKey-editmeta-get) or [field resource](#api-rest-api-3-field-get).
   */
  async estimateIssueForBoard<T = unknown>(
    parameters: Parameters.EstimateIssueForBoard,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * Updates the estimation of the issue. boardId param is required. This param determines which field will be updated
   * on an issue.
   *
   * Note that this resource changes the estimation field of the issue regardless of appearance the field on the screen.
   *
   * Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which
   * represent number of minutes. However, internally the field stores and returns the estimation as a number of
   * seconds.
   *
   * The field used for estimation on the given board can be obtained from [board configuration
   * resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta
   * resource](#api-rest-api-3-issue-issueIdOrKey-editmeta-get) or [field resource](#api-rest-api-3-field-get).
   */
  async estimateIssueForBoard<T = unknown>(parameters: Parameters.EstimateIssueForBoard, callback?: never): Promise<T>;
  async estimateIssueForBoard<T = unknown>(
    parameters: Parameters.EstimateIssueForBoard,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: `/rest/agile/1.0/issue/${parameters.issueIdOrKey}/estimation`,
      method: 'PUT',
      params: {
        boardId: parameters.boardId,
      },
      data: {
        value: parameters.value,
      },
    };

    return this.client.sendRequest(config, callback);
  }
}