@esm-js/jira.js/src/version3/models/jiraWorkflow.ts

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

import type { WorkflowScope } from './workflowScope';
import type { WorkflowLayout } from './workflowLayout';
import type { WorkflowReferenceStatus } from './workflowReferenceStatus';
import type { WorkflowTransitions } from './workflowTransitions';
import type { ProjectIssueTypes } from './projectIssueTypes';
import type { DocumentVersion } from './documentVersion';

/** Details of a workflow. */
export interface JiraWorkflow {
  /** The creation date of the workflow. */
  created?: string;
  /** The description of the workflow. */
  description?: string;
  /** The ID of the workflow. */
  id?: string;
  /** Indicates if the workflow can be edited. */
  isEditable?: boolean;
  /** The name of the workflow. */
  name?: string;
  scope?: WorkflowScope;
  startPointLayout?: WorkflowLayout;
  /** The statuses referenced in this workflow. */
  statuses?: WorkflowReferenceStatus[];
  /** If there is a current [asynchronous task](#async-operations) operation for this workflow. */
  taskId?: string;
  /**
   * The transitions of the workflow. Note that a transition can have either the deprecated `to`/`from` fields or the
   * `toStatusReference`/`links` fields, but never both nor a combination.
   */
  transitions?: WorkflowTransitions[];
  /** The last edited date of the workflow. */
  updated?: string;
  /**
   * @deprecated See the [deprecation
   *   notice](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2298) for details.
   *
   *   Use the optional `workflows.usages` expand to get additional information about the projects and issue types
   *   associated with the requested workflows.
   */
  usages?: ProjectIssueTypes[];
  version?: DocumentVersion;
}