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

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

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

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

  /**
   * Move issues to the backlog.\
   * 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>;
  /**
   * Move issues to the backlog.\
   * 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?: never): Promise<T>;
  async moveIssuesToBacklog<T = void>(
    parameters: Parameters.MoveIssuesToBacklog,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/agile/1.0/backlog/issue',
      method: 'POST',
      data: {
        issues: parameters.issues,
      },
    };

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

  /**
   * 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.
   */
  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: RequestConfig = {
      url: `/rest/agile/1.0/backlog/${parameters.boardId}/issue`,
      method: 'POST',
      data: {
        issues: parameters.issues,
        rankAfterIssue: parameters.rankAfterIssue,
        rankBeforeIssue: parameters.rankBeforeIssue,
        rankCustomFieldId: parameters.rankCustomFieldId,
      },
    };

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