@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/workflow-schemes-service.d.ts

@@ -0,0 +1,843 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type DefaultWorkflow, type IssueTypesWorkflowMapping, type IssueTypeWorkflowMapping, type WorkflowScheme } from "../models/common";
+import { type PageBeanWorkflowScheme, type WorkflowSchemeReadRequest, type WorkflowSchemeReadResponse, type WorkflowSchemeUpdateRequest, type WorkflowSchemeUpdateRequiredMappingsRequest, type WorkflowSchemeUpdateRequiredMappingsResponse } from "../models/workflow-schemes";
+/**
+ * This resource represents workflow schemes. Use it to manage workflow schemes
+ * and the workflow scheme's workflows and issue types.
+ *
+ * A workflow scheme maps issue types to workflows. A workflow scheme can be
+ * associated with one or more projects, which enables the projects to use the
+ * workflow-issue type mappings.
+ *
+ * Active workflow schemes (workflow schemes that are used by projects) cannot be
+ * edited. When an active workflow scheme is edited, a draft copy of the scheme is
+ * created. The draft workflow scheme is then be edited and published (replacing
+ * the active scheme).
+ *
+ * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
+ * for more information.
+ */
+export declare class WorkflowSchemesService extends CommonHttpService {
+    /**
+     * Creates a workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {POST} /rest/api/3/workflowscheme
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
+     * read:group:jira, read:issue-type:jira, read:project-category:jira,
+     * read:project:jira, read:user:jira, read:workflow-scheme:jira
+     */
+    createWorkflowScheme({ workflowScheme, }: {
+        /**
+         * @example {
+         *     "defaultWorkflow": "jira",
+         *     "description": "The description of the example workflow scheme.",
+         *     "issueTypeMappings": {
+         *         "10000": "scrum workflow",
+         *         "10001": "builds workflow"
+         *     },
+         *     "name": "Example workflow scheme"
+         * }
+         */
+        workflowScheme: WorkflowScheme;
+    }): Promise<WorkflowScheme>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/default
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
+     * read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type:jira, read:project-category:jira, read:project:jira,
+     * read:user:jira
+     */
+    deleteDefaultWorkflow({ id, updateDraftIfNeeded, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /**
+         * Set to true to create or update the draft of a workflow scheme and delete the
+         * mapping from the draft, when the workflow scheme cannot be edited. Defaults to
+         * `false`.
+         */
+        updateDraftIfNeeded?: boolean;
+    }): Promise<WorkflowScheme>;
+    /**
+     * 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).
+     *
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/workflow
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:workflow-scheme:jira
+     */
+    deleteWorkflowMapping({ id, workflowName, updateDraftIfNeeded, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /** The name of the workflow. */
+        workflowName: string;
+        /**
+         * Set to true to create or update the draft of a workflow scheme and delete the
+         * mapping from the draft, when the workflow scheme cannot be edited. Defaults to
+         * `false`.
+         */
+        updateDraftIfNeeded?: boolean;
+    }): Promise<void>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:workflow-scheme:jira
+     */
+    deleteWorkflowScheme({ id, }: {
+        /**
+         * The ID of the workflow scheme. Find this ID by editing the desired workflow
+         * scheme in Jira. The ID is shown in the URL as `schemeId`. For example,
+         * *schemeId=10301*.
+         */
+        id: number;
+    }): Promise<void>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
+     * read:group:jira, read:issue-type:jira, read:project-category:jira,
+     * read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira
+     */
+    deleteWorkflowSchemeIssueType({ id, issueType, updateDraftIfNeeded, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /** The ID of the issue type. */
+        issueType: string;
+        /**
+         * Set to true to create or update the draft of a workflow scheme and update the
+         * mapping in the draft, when the workflow scheme cannot be edited. Defaults to
+         * `false`.
+         */
+        updateDraftIfNeeded?: boolean;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Returns a [paginated](#pagination) list of all workflow schemes, not including
+     * draft workflow schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 50,
+     *   "startAt": 0,
+     *   "total": 2,
+     *   "values": [
+     *     {
+     *       "defaultWorkflow": "jira",
+     *       "description": "The description of the example workflow scheme.",
+     *       "id": 101010,
+     *       "issueTypeMappings": {
+     *         "10000": "scrum workflow",
+     *         "10001": "builds workflow"
+     *       },
+     *       "name": "Example workflow scheme",
+     *       "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     *     },
+     *     {
+     *       "defaultWorkflow": "jira",
+     *       "description": "The description of the another example workflow scheme.",
+     *       "id": 101011,
+     *       "issueTypeMappings": {
+     *         "10000": "scrum workflow",
+     *         "10001": "builds workflow"
+     *       },
+     *       "name": "Another example workflow scheme",
+     *       "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/workflowscheme
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
+     * read:group:jira, read:issue-type:jira, read:project-category:jira,
+     * read:project:jira, read:user:jira
+     */
+    getAllWorkflowSchemes({ startAt, maxResults, }: {
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: number;
+        /** The maximum number of items to return per page. */
+        maxResults?: number;
+    }): Promise<PageBeanWorkflowScheme>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "workflow": "jira"
+     * }
+     * @path {GET} /rest/api/3/workflowscheme/{id}/default
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira
+     */
+    getDefaultWorkflow({ id, returnDraftIfExists, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /**
+         * Set to `true` to return the default workflow for the workflow scheme's draft
+         * rather than scheme itself. If the workflow scheme does not have a draft, then
+         * the default workflow for the workflow scheme is returned.
+         */
+        returnDraftIfExists?: boolean;
+    }): Promise<DefaultWorkflow>;
+    /**
+     * Returns the workflow-issue type mappings for a workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultMapping": false,
+     *   "issueTypes": [
+     *     "10000",
+     *     "10001"
+     *   ],
+     *   "workflow": "jira"
+     * }
+     * @path {GET} /rest/api/3/workflowscheme/{id}/workflow
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
+     */
+    getWorkflow({ id, workflowName, returnDraftIfExists, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /**
+         * The name of a workflow in the scheme. Limits the results to the workflow-issue
+         * type mapping for the specified workflow.
+         */
+        workflowName?: string;
+        /**
+         * Returns the mapping from the workflow scheme's draft rather than the workflow
+         * scheme, if set to true. If no draft exists, the mapping from the workflow
+         * scheme is returned.
+         */
+        returnDraftIfExists?: boolean;
+    }): Promise<IssueTypesWorkflowMapping>;
+    /**
+     * Returns a workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {GET} /rest/api/3/workflowscheme/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
+     * read:group:jira, read:issue-type:jira, read:project-category:jira,
+     * read:project:jira, read:user:jira
+     */
+    getWorkflowScheme({ id, returnDraftIfExists, }: {
+        /**
+         * The ID of the workflow scheme. Find this ID by editing the desired workflow
+         * scheme in Jira. The ID is shown in the URL as `schemeId`. For example,
+         * *schemeId=10301*.
+         */
+        id: number;
+        /**
+         * Returns the workflow scheme's draft rather than scheme itself, if set to true.
+         * If the workflow scheme does not have a draft, then the workflow scheme is
+         * returned.
+         */
+        returnDraftIfExists?: boolean;
+    }): Promise<WorkflowScheme>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "issueType": "10000",
+     *   "workflow": "jira"
+     * }
+     * @path {GET} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
+     */
+    getWorkflowSchemeIssueType({ id, issueType, returnDraftIfExists, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /** The ID of the issue type. */
+        issueType: string;
+        /**
+         * Returns the mapping from the workflow scheme's draft rather than the workflow
+         * scheme, if set to true. If no draft exists, the mapping from the workflow
+         * scheme is returned.
+         */
+        returnDraftIfExists?: boolean;
+    }): Promise<IssueTypeWorkflowMapping>;
+    /**
+     * Returns a list of workflow schemes by providing workflow scheme IDs or project
+     * IDs.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* global permission to access all, including
+     * project-scoped, workflow schemes
+     *  *  *Administer projects* project permissions to access project-scoped workflow
+     * schemes
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "defaultWorkflow": {
+     *       "description": "This is the default workflow for Software Development
+     * projects.",
+     *       "id": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+     *       "name": "Default Software Development Workflow",
+     *       "usage": [
+     *         {
+     *           "issueTypeIds": [],
+     *           "projectId": "10047"
+     *         }
+     *       ],
+     *       "version": {
+     *         "id": "657812fc-bc72-400f-aae0-df8d88db3d9g",
+     *         "versionNumber": 1
+     *       }
+     *     },
+     *     "description": "This is the workflow scheme for the Software Development
+     * project type.",
+     *     "id": "3g78dg2a-ns2n-56ab-9812-42h5j1464567",
+     *     "name": "Software Developer Workflow Scheme",
+     *     "projectIdsUsingScheme": [
+     *       "10047"
+     *     ],
+     *     "scope": {
+     *       "project": {
+     *         "id": "10047"
+     *       },
+     *       "type": "GLOBAL"
+     *     },
+     *     "taskId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629",
+     *     "version": {
+     *       "id": "527213fc-bc72-400f-aae0-df8d88db2c8a",
+     *       "versionNumber": 1
+     *     },
+     *     "workflowsForIssueTypes": [
+     *       {
+     *         "issueTypeIds": [
+     *           "10013"
+     *         ],
+     *         "workflow": {
+     *           "description": "This is the workflow for the Software Development bug
+     * issue type.",
+     *           "id": "5e79ae0f-ed6c-47ce-8d50-80c0c4572745",
+     *           "name": "Software Development Bug Workflow",
+     *           "usage": [
+     *             {
+     *               "issueTypeIds": [
+     *                 "10013"
+     *               ],
+     *               "projectId": "10047"
+     *             }
+     *           ],
+     *           "version": {
+     *             "id": "897812dc-bc72-400f-aae0-df8d88fe3d8f",
+     *             "versionNumber": 1
+     *           }
+     *         }
+     *       }
+     *     ]
+     *   }
+     * ]
+     * @path {POST} /rest/api/3/workflowscheme/read
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira
+     */
+    readWorkflowSchemes({ expand, workflowSchemeReadRequest, }: {
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expand options include:
+         *
+         *  *  `workflows.usages` Returns the project and issue types that each workflow
+         * in the workflow scheme is associated with.
+         */
+        expand?: string;
+        /**
+         * @example {
+         *     "projectIds": [
+         *         "10047",
+         *         "10048"
+         *     ],
+         *     "workflowSchemeIds": [
+         *         "3e59db0f-ed6c-47ce-8d50-80c0c4572677"
+         *     ]
+         * }
+         */
+        workflowSchemeReadRequest: WorkflowSchemeReadRequest;
+    }): Promise<WorkflowSchemeReadResponse[]>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
+     * read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type:jira, read:project-category:jira, read:project:jira,
+     * read:user:jira
+     */
+    setWorkflowSchemeIssueType({ id, issueType, issueTypeWorkflowMapping, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /** The ID of the issue type. */
+        issueType: string;
+        /**
+         * The issue type-project mapping.
+         *
+         * @example {
+         *     "issueType": "10000",
+         *     "updateDraftIfNeeded": false,
+         *     "workflow": "jira"
+         * }
+         */
+        issueTypeWorkflowMapping: IssueTypeWorkflowMapping;
+    }): Promise<WorkflowScheme>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}/default
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
+     * read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type:jira, read:project-category:jira, read:project:jira,
+     * read:user:jira
+     */
+    updateDefaultWorkflow({ id, defaultWorkflow, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /**
+         * The new default workflow.
+         *
+         * @example {
+         *     "updateDraftIfNeeded": false,
+         *     "workflow": "jira"
+         * }
+         */
+        defaultWorkflow: DefaultWorkflow;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Updates company-managed and team-managed project workflow schemes. This API
+     * doesn't have a concept of draft, so any changes made to a workflow scheme are
+     * immediately available. When changing the available statuses for issue types, an
+     * [asynchronous task](#async) migrates the issues as defined in the provided
+     * mappings.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* project permission to update all, including
+     * global-scoped, workflow schemes.
+     *  *  *Administer projects* project permission to update project-scoped workflow
+     * schemes.
+     *
+     * @returns Returned if the request is successful and there is no asynchronous task.
+     * @path {POST} /rest/api/3/workflowscheme/update
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow-scheme:jira
+     */
+    updateSchemes({ workflowSchemeUpdateRequest, }: {
+        /**
+         * @example {
+         *     "defaultWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+         *     "description": "description",
+         *     "id": "10000",
+         *     "name": "name",
+         *     "statusMappingsByIssueTypeOverride": [
+         *         {
+         *             "issueTypeId": "10001",
+         *             "statusMappings": [
+         *                 {
+         *                     "newStatusId": "2",
+         *                     "oldStatusId": "1"
+         *                 },
+         *                 {
+         *                     "newStatusId": "4",
+         *                     "oldStatusId": "3"
+         *                 }
+         *             ]
+         *         },
+         *         {
+         *             "issueTypeId": "10002",
+         *             "statusMappings": [
+         *                 {
+         *                     "newStatusId": "4",
+         *                     "oldStatusId": "1"
+         *                 },
+         *                 {
+         *                     "newStatusId": "2",
+         *                     "oldStatusId": "3"
+         *                 }
+         *             ]
+         *         }
+         *     ],
+         *     "statusMappingsByWorkflows": [
+         *         {
+         *             "newWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+         *             "oldWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+         *             "statusMappings": [
+         *                 {
+         *                     "newStatusId": "2",
+         *                     "oldStatusId": "1"
+         *                 },
+         *                 {
+         *                     "newStatusId": "4",
+         *                     "oldStatusId": "3"
+         *                 }
+         *             ]
+         *         }
+         *     ],
+         *     "version": {
+         *         "id": "527213fc-bc72-400f-aae0-df8d88db2c8a",
+         *         "versionNumber": 1
+         *     },
+         *     "workflowsForIssueTypes": [
+         *         {
+         *             "issueTypeIds": [
+         *                 "10000",
+         *                 "10003"
+         *             ],
+         *             "workflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677"
+         *         },
+         *         {
+         *             "issueTypeIds": [
+         *                 "10001`",
+         *                 "10002"
+         *             ],
+         *             "workflowId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629"
+         *         }
+         *     ]
+         * }
+         */
+        workflowSchemeUpdateRequest: WorkflowSchemeUpdateRequest;
+    }): Promise<unknown>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}/workflow
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
+     * read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type:jira, read:project-category:jira, read:project:jira,
+     * read:user:jira
+     */
+    updateWorkflowMapping({ id, workflowName, issueTypesWorkflowMapping, }: {
+        /** The ID of the workflow scheme. */
+        id: number;
+        /** The name of the workflow. */
+        workflowName: string;
+        /**
+         * @example {
+         *     "issueTypes": [
+         *         "10000"
+         *     ],
+         *     "updateDraftIfNeeded": true,
+         *     "workflow": "jira"
+         * }
+         */
+        issueTypesWorkflowMapping: IssueTypesWorkflowMapping;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Updates a company-manged project 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).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "jira",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": false,
+     *   "id": 101010,
+     *   "issueTypeMappings": {
+     *     "10000": "scrum workflow",
+     *     "10001": "builds workflow"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
+     * read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type:jira, read:project-category:jira, read:project:jira,
+     * read:user:jira
+     */
+    updateWorkflowScheme({ id, workflowScheme, }: {
+        /**
+         * The ID of the workflow scheme. Find this ID by editing the desired workflow
+         * scheme in Jira. The ID is shown in the URL as `schemeId`. For example,
+         * *schemeId=10301*.
+         */
+        id: number;
+        /**
+         * @example {
+         *     "defaultWorkflow": "jira",
+         *     "description": "The description of the example workflow scheme.",
+         *     "issueTypeMappings": {
+         *         "10000": "scrum workflow"
+         *     },
+         *     "name": "Example workflow scheme",
+         *     "updateDraftIfNeeded": false
+         * }
+         */
+        workflowScheme: WorkflowScheme;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Gets the required status mappings for the desired changes to a workflow scheme.
+     * The results are provided per issue type and workflow. When updating a workflow
+     * scheme, status mappings can be provided per issue type, per workflow, or both.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* permission to update all, including global-scoped,
+     * workflow schemes.
+     *  *  *Administer projects* project permission to update project-scoped workflow
+     * schemes.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "statusMappingsByIssueTypes": [
+     *     {
+     *       "issueTypeId": "10000",
+     *       "statusIds": [
+     *         "10000",
+     *         "10001"
+     *       ]
+     *     }
+     *   ],
+     *   "statusMappingsByWorkflows": [
+     *     {
+     *       "sourceWorkflowId": "10000",
+     *       "statusIds": [
+     *         "10000",
+     *         "10001"
+     *       ],
+     *       "targetWorkflowId": "10001"
+     *     }
+     *   ],
+     *   "statuses": [
+     *     {
+     *       "category": "TODO",
+     *       "id": "10000",
+     *       "name": "To Do"
+     *     }
+     *   ],
+     *   "statusesPerWorkflow": [
+     *     {
+     *       "initialStatusId": "10000",
+     *       "statuses": [
+     *         "10000",
+     *         "10001"
+     *       ],
+     *       "workflowId": "10000"
+     *     }
+     *   ]
+     * }
+     * @path {POST} /rest/api/3/workflowscheme/update/mappings
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow-scheme:jira
+     */
+    updateWorkflowSchemeMappings({ workflowSchemeUpdateRequiredMappingsRequest, }: {
+        /**
+         * @example {
+         *     "defaultWorkflowId": "10010",
+         *     "id": "10001",
+         *     "workflowsForIssueTypes": [
+         *         {
+         *             "issueTypeIds": [
+         *                 "10010",
+         *                 "10011"
+         *             ],
+         *             "workflowId": "10001"
+         *         }
+         *     ]
+         * }
+         */
+        workflowSchemeUpdateRequiredMappingsRequest: WorkflowSchemeUpdateRequiredMappingsRequest;
+    }): Promise<WorkflowSchemeUpdateRequiredMappingsResponse>;
+    static initialize(): void;
+}