@esm-js/jira.js/src/version3/workflowStatuses.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 WorkflowStatuses {
  constructor(private client: Client) {}

  /**
   * Returns a list of all statuses associated with active workflows.
   *
   * This operation can be accessed anonymously.
   *
   * [Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required: _Browse
   * projects_ [project
   * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/) for the
   * project.
   */
  async getStatuses<T = Models.StatusDetails[]>(callback: Callback<T>): Promise<void>;
  /**
   * Returns a list of all statuses associated with active workflows.
   *
   * This operation can be accessed anonymously.
   *
   * [Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required: _Browse
   * projects_ [project
   * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/) for the
   * project.
   */
  async getStatuses<T = Models.StatusDetails[]>(callback?: never): Promise<T>;
  async getStatuses<T = Models.StatusDetails[]>(callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/3/status',
      method: 'GET',
    };

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

  /**
   * Returns a status. The status must be associated with an active workflow to be returned.
   *
   * If a name is used on more than one status, only the status found first is returned. Therefore, identifying the
   * status by its ID may be preferable.
   *
   * This operation can be accessed anonymously.
   *
   * [Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required: _Browse
   * projects_ [project
   * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/) for the
   * project.
   */
  async getStatus<T = Models.StatusDetails>(
    parameters: Parameters.GetStatus | string,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * Returns a status. The status must be associated with an active workflow to be returned.
   *
   * If a name is used on more than one status, only the status found first is returned. Therefore, identifying the
   * status by its ID may be preferable.
   *
   * This operation can be accessed anonymously.
   *
   * [Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required: _Browse
   * projects_ [project
   * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/) for the
   * project.
   */
  async getStatus<T = Models.StatusDetails>(parameters: Parameters.GetStatus | string, callback?: never): Promise<T>;
  async getStatus<T = Models.StatusDetails>(
    parameters: Parameters.GetStatus | string,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const idOrName = typeof parameters === 'string' ? parameters : parameters.idOrName;

    const config: RequestConfig = {
      url: `/rest/api/3/status/${idOrName}`,
      method: 'GET',
    };

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