@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/workflow-schemes-service.js

@@ -0,0 +1,1030 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowSchemesService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const common_1 = require("../models/common");
+const workflow_schemes_1 = require("../models/workflow-schemes");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * 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.
+ */
+class WorkflowSchemesService extends common_http_service_1.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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowScheme,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.createWorkflowScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/default",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                updateDraftIfNeeded,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteDefaultWorkflow.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/workflow",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                workflowName,
+                updateDraftIfNeeded,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteWorkflowScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
+            method: "DELETE",
+            pathParams: {
+                id,
+                issueType,
+            },
+            query: {
+                updateDraftIfNeeded,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteWorkflowSchemeIssueType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme",
+            method: "GET",
+            query: {
+                startAt,
+                maxResults,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.getAllWorkflowSchemes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/default",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                returnDraftIfExists,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.getDefaultWorkflow.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/workflow",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                workflowName,
+                returnDraftIfExists,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflow.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                returnDraftIfExists,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflowScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
+            method: "GET",
+            pathParams: {
+                id,
+                issueType,
+            },
+            query: {
+                returnDraftIfExists,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflowSchemeIssueType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/read",
+            method: "POST",
+            query: {
+                expand,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowSchemeReadRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.readWorkflowSchemes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
+            method: "PUT",
+            pathParams: {
+                id,
+                issueType,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: issueTypeWorkflowMapping,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.setWorkflowSchemeIssueType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/default",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: defaultWorkflow,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateDefaultWorkflow.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/update",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowSchemeUpdateRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateSchemes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}/workflow",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            query: {
+                workflowName,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: issueTypesWorkflowMapping,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowMapping.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/{id}",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowScheme,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowScheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflowscheme/update/mappings",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowSchemeUpdateRequiredMappingsRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowSchemeMappings.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.getAllWorkflowSchemes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("PageBeanWorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.getAllWorkflowSchemes.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.createWorkflowScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.createWorkflowScheme.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.getWorkflowScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.getWorkflowScheme.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.updateWorkflowScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.updateWorkflowScheme.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.deleteWorkflowScheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("WorkflowSchemesService.deleteWorkflowScheme.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.getDefaultWorkflow.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("DefaultWorkflow"),
+        })
+            .describe("WorkflowSchemesService.getDefaultWorkflow.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.updateDefaultWorkflow.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.updateDefaultWorkflow.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.deleteDefaultWorkflow.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.deleteDefaultWorkflow.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.getWorkflowSchemeIssueType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeWorkflowMapping"),
+        })
+            .describe("WorkflowSchemesService.getWorkflowSchemeIssueType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.setWorkflowSchemeIssueType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.setWorkflowSchemeIssueType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.deleteWorkflowSchemeIssueType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.deleteWorkflowSchemeIssueType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.getWorkflow.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypesWorkflowMapping"),
+        })
+            .describe("WorkflowSchemesService.getWorkflow.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.updateWorkflowMapping.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowScheme"),
+        })
+            .describe("WorkflowSchemesService.updateWorkflowMapping.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.readWorkflowSchemes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowSchemeReadResponse")),
+        })
+            .describe("WorkflowSchemesService.readWorkflowSchemes.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.updateSchemes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("WorkflowSchemesService.updateSchemes.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.updateWorkflowSchemeMappings.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowSchemeUpdateRequiredMappingsResponse"),
+        })
+            .describe("WorkflowSchemesService.updateWorkflowSchemeMappings.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([
+            workflow_schemes_1.registerWorkflowSchemesValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.WorkflowSchemesService = WorkflowSchemesService;
+//# sourceMappingURL=workflow-schemes-service.js.map