@esm-js/jira.js/src/version2/models/workflowScheme.ts

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

import type { User } from './user';

/** Details about a workflow scheme. */
export interface WorkflowScheme {
  /**
   * The name of the default workflow for the workflow scheme. The default workflow has _All Unassigned Issue Types_
   * assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to _Jira
   * Workflow (jira)_.
   */
  defaultWorkflow?: string;
  /** The description of the workflow scheme. */
  description?: string;
  /** Whether the workflow scheme is a draft or not. */
  draft?: boolean;
  /** The ID of the workflow scheme. */
  id?: number;
  /**
   * The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an
   * issue type can only be mapped to one workflow in a workflow scheme.
   */
  issueTypeMappings?: unknown;
  /** The issue types available in Jira. */
  issueTypes?: unknown;
  /**
   * The date-time that the draft workflow scheme was last modified. A modification is a change to the issue
   * type-project mappings only. This property does not apply to non-draft workflows.
   */
  lastModified?: string;
  lastModifiedUser?: User;
  /**
   * The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when
   * creating a workflow scheme.
   */
  name?: string;
  /**
   * For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The
   * default workflow has _All Unassigned Issue Types_ assigned to it in Jira.
   */
  originalDefaultWorkflow?: string;
  /**
   * For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme,
   * where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one
   * workflow in a workflow scheme.
   */
  originalIssueTypeMappings?: unknown;
  self?: string;
  /**
   * Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow
   * scheme is a workflow scheme that is used by at least one project. The following examples show how this property
   * works:
   *
   * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is
   * updated. Otherwise, a draft workflow scheme is created. Update an active workflow scheme with `updateDraftIfNeeded`
   * set to `false`: An error is returned, as active workflow schemes cannot be updated. Update an inactive workflow
   * scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do
   * not require drafts to update.
   *
   *     Defaults to `false`.
   */
  updateDraftIfNeeded?: boolean;
}