/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { DefaultWorkflow, IssueTypeWorkflowMapping, IssueTypesWorkflowMapping, WorkflowScheme } from '../models'; export interface CreateWorkflowSchemeRequest { WorkflowScheme: WorkflowScheme; } export interface DeleteDefaultWorkflowRequest { id: number; updateDraftIfNeeded?: boolean; } export interface DeleteWorkflowMappingRequest { id: number; workflowName: string; updateDraftIfNeeded?: boolean; } export interface DeleteWorkflowSchemeRequest { id: number; } export interface DeleteWorkflowSchemeIssueTypeRequest { id: number; issueType: string; updateDraftIfNeeded?: boolean; } export interface GetDefaultWorkflowRequest { id: number; returnDraftIfExists?: boolean; } export interface GetWorkflowRequest { id: number; workflowName?: string; returnDraftIfExists?: boolean; } export interface GetWorkflowSchemeRequest { id: number; returnDraftIfExists?: boolean; } export interface GetWorkflowSchemeIssueTypeRequest { id: number; issueType: string; returnDraftIfExists?: boolean; } export interface SetWorkflowSchemeIssueTypeRequest { id: number; issueType: string; IssueTypeWorkflowMapping: IssueTypeWorkflowMapping; } export interface UpdateDefaultWorkflowRequest { id: number; DefaultWorkflow: DefaultWorkflow; } export interface UpdateWorkflowMappingRequest { id: number; workflowName: string; IssueTypesWorkflowMapping: IssueTypesWorkflowMapping; } export interface UpdateWorkflowSchemeRequest { id: number; WorkflowScheme: WorkflowScheme; } /** * no description */ export declare class WorkflowSchemesApi extends runtime.BaseAPI { /** * Creates a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create workflow scheme */ createWorkflowSchemeRaw(requestParameters: CreateWorkflowSchemeRequest): Promise>; /** * Creates a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create workflow scheme */ createWorkflowScheme(requestParameters: CreateWorkflowSchemeRequest): Promise; /** * Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira\'s system workflow (the *jira* workflow). Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete default workflow */ deleteDefaultWorkflowRaw(requestParameters: DeleteDefaultWorkflowRequest): Promise>; /** * Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira\'s system workflow (the *jira* workflow). Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete default workflow */ deleteDefaultWorkflow(requestParameters: DeleteDefaultWorkflowRequest): Promise; /** * Deletes the workflow-issue type mapping for a workflow in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete issue types for workflow in workflow scheme */ deleteWorkflowMappingRaw(requestParameters: DeleteWorkflowMappingRequest): Promise>; /** * Deletes the workflow-issue type mapping for a workflow in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete issue types for workflow in workflow scheme */ deleteWorkflowMapping(requestParameters: DeleteWorkflowMappingRequest): Promise; /** * Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete workflow scheme */ deleteWorkflowSchemeRaw(requestParameters: DeleteWorkflowSchemeRequest): Promise>; /** * Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete workflow scheme */ deleteWorkflowScheme(requestParameters: DeleteWorkflowSchemeRequest): Promise; /** * Deletes the issue type-workflow mapping for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete workflow for issue type in workflow scheme */ deleteWorkflowSchemeIssueTypeRaw(requestParameters: DeleteWorkflowSchemeIssueTypeRequest): Promise>; /** * Deletes the issue type-workflow mapping for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete workflow for issue type in workflow scheme */ deleteWorkflowSchemeIssueType(requestParameters: DeleteWorkflowSchemeIssueTypeRequest): Promise; /** * Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get default workflow */ getDefaultWorkflowRaw(requestParameters: GetDefaultWorkflowRequest): Promise>; /** * Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get default workflow */ getDefaultWorkflow(requestParameters: GetDefaultWorkflowRequest): Promise; /** * Returns the workflow-issue type mappings for a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get issue types for workflows in workflow scheme */ getWorkflowRaw(requestParameters: GetWorkflowRequest): Promise>; /** * Returns the workflow-issue type mappings for a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get issue types for workflows in workflow scheme */ getWorkflow(requestParameters: GetWorkflowRequest): Promise; /** * Returns a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get workflow scheme */ getWorkflowSchemeRaw(requestParameters: GetWorkflowSchemeRequest): Promise>; /** * Returns a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get workflow scheme */ getWorkflowScheme(requestParameters: GetWorkflowSchemeRequest): Promise; /** * Returns the issue type-workflow mapping for an issue type in a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get workflow for issue type in workflow scheme */ getWorkflowSchemeIssueTypeRaw(requestParameters: GetWorkflowSchemeIssueTypeRequest): Promise>; /** * Returns the issue type-workflow mapping for an issue type in a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get workflow for issue type in workflow scheme */ getWorkflowSchemeIssueType(requestParameters: GetWorkflowSchemeIssueTypeRequest): Promise; /** * Sets the workflow for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Set workflow for issue type in workflow scheme */ setWorkflowSchemeIssueTypeRaw(requestParameters: SetWorkflowSchemeIssueTypeRequest): Promise>; /** * Sets the workflow for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Set workflow for issue type in workflow scheme */ setWorkflowSchemeIssueType(requestParameters: SetWorkflowSchemeIssueTypeRequest): Promise; /** * Sets the default workflow for a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update default workflow */ updateDefaultWorkflowRaw(requestParameters: UpdateDefaultWorkflowRequest): Promise>; /** * Sets the default workflow for a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update default workflow */ updateDefaultWorkflow(requestParameters: UpdateDefaultWorkflowRequest): Promise; /** * Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Set issue types for workflow in workflow scheme */ updateWorkflowMappingRaw(requestParameters: UpdateWorkflowMappingRequest): Promise>; /** * Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Set issue types for workflow in workflow scheme */ updateWorkflowMapping(requestParameters: UpdateWorkflowMappingRequest): Promise; /** * Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that `updateDraftIfNeeded` is set to `true`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update workflow scheme */ updateWorkflowSchemeRaw(requestParameters: UpdateWorkflowSchemeRequest): Promise>; /** * Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that `updateDraftIfNeeded` is set to `true`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update workflow scheme */ updateWorkflowScheme(requestParameters: UpdateWorkflowSchemeRequest): Promise; }