@resolution/jira-api-client 0.1.0

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

@@ -0,0 +1,744 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type DefaultWorkflow, type IssueTypesWorkflowMapping, type IssueTypeWorkflowMapping, type WorkflowScheme } from "../models/common";
+import type { PublishDraftWorkflowScheme } from "../models/workflow-scheme-drafts";
+/**
+ * This resource represents draft workflow schemes. Use it to manage drafts of
+ * workflow schemes.
+ *
+ * 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. Editing an active workflow scheme creates a draft copy of the scheme.
+ * The draft workflow scheme can 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 WorkflowSchemeDraftsService extends CommonHttpService {
+    /**
+     * Create a draft workflow scheme from an active workflow scheme, by copying the
+     * active workflow scheme. Note that an active workflow scheme can only have one
+     * draft workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {POST} /rest/api/3/workflowscheme/{id}/createdraft
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:group:jira, read:issue-security-level:jira, read:project-role:jira,
+     * read:screen:jira, read:status:jira, read:user:jira, read:workflow-scheme:jira,
+     * read:workflow:jira, write:workflow-scheme:jira, read:application-role:jira,
+     * read:avatar:jira, read:issue-type:jira, read:project-category:jira,
+     * read:project:jira
+     */
+    createWorkflowSchemeDraftFromParent({ id, }: {
+        /** The ID of the active workflow scheme that the draft is created from. */
+        id: number;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Resets the default workflow for a workflow scheme's draft. That is, the default
+     * workflow is set to Jira's system workflow (the *jira* workflow).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/draft/default
+     * @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
+     */
+    deleteDraftDefaultWorkflow({ id, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Deletes the workflow-issue type mapping for a workflow in a workflow scheme's
+     * draft.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/draft/workflow
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:workflow-scheme:jira
+     */
+    deleteDraftWorkflowMapping({ id, workflowName, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+        /** The name of the workflow. */
+        workflowName: string;
+    }): Promise<void>;
+    /**
+     * Deletes a draft workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/draft
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:workflow-scheme:jira
+     */
+    deleteWorkflowSchemeDraft({ id, }: {
+        /** The ID of the active workflow scheme that the draft was created from. */
+        id: number;
+    }): Promise<void>;
+    /**
+     * Deletes the issue type-workflow mapping for an issue type in a workflow
+     * scheme's draft.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {DELETE} /rest/api/3/workflowscheme/{id}/draft/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
+     */
+    deleteWorkflowSchemeDraftIssueType({ id, issueType, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+        /** The ID of the issue type. */
+        issueType: string;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Returns the default workflow for a workflow scheme's draft. 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}/draft/default
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira
+     */
+    getDraftDefaultWorkflow({ id, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+    }): Promise<DefaultWorkflow>;
+    /**
+     * Returns the workflow-issue type mappings for a workflow scheme's draft.
+     *
+     * **[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}/draft/workflow
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
+     */
+    getDraftWorkflow({ id, workflowName, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        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;
+    }): Promise<IssueTypesWorkflowMapping>;
+    /**
+     * Returns the draft workflow scheme for an active workflow scheme. Draft workflow
+     * schemes allow changes to be made to the active workflow schemes: When an active
+     * workflow scheme is updated, a draft copy is created. The draft is modified,
+     * then the changes in the draft are copied back to the active workflow scheme.
+     * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
+     * for more information.
+     * Note that:
+     *
+     *  *  Only active workflow schemes can have draft workflow schemes.
+     *  *  An active workflow scheme can only have one draft workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {GET} /rest/api/3/workflowscheme/{id}/draft
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:group:jira, read:issue-security-level:jira, read:project-role:jira,
+     * read:screen:jira, read:status:jira, read:user:jira, read:workflow-scheme:jira,
+     * read:workflow:jira, read:application-role:jira, read:avatar:jira,
+     * read:issue-type:jira, read:project-category:jira, read:project:jira
+     */
+    getWorkflowSchemeDraft({ id, }: {
+        /** The ID of the active workflow scheme that the draft was created from. */
+        id: number;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Returns the issue type-workflow mapping for an issue type in a workflow
+     * scheme's draft.
+     *
+     * **[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}/draft/issuetype/{issueType}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
+     */
+    getWorkflowSchemeDraftIssueType({ id, issueType, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+        /** The ID of the issue type. */
+        issueType: string;
+    }): Promise<IssueTypeWorkflowMapping>;
+    /**
+     * Publishes a draft workflow scheme.
+     *
+     * Where the draft workflow includes new workflow statuses for an issue type,
+     * mappings are provided to update issues with the original workflow status to the
+     * new workflow status.
+     *
+     * This operation is [asynchronous](#async). Follow the `location` link in the
+     * response to determine the status of the task and use [Get
+     * task](#api-rest-api-3-task-taskId-get) to obtain updates.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {POST} /rest/api/3/workflowscheme/{id}/draft/publish
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow-scheme:jira
+     */
+    publishDraftWorkflowScheme({ id, validateOnly, publishDraftWorkflowScheme, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+        /** Whether the request only performs a validation. */
+        validateOnly?: boolean;
+        /**
+         * Details of the status mappings.
+         *
+         * @example {
+         *     "statusMappings": [
+         *         {
+         *             "issueTypeId": "10001",
+         *             "newStatusId": "1",
+         *             "statusId": "3"
+         *         },
+         *         {
+         *             "issueTypeId": "10001",
+         *             "newStatusId": "2",
+         *             "statusId": "2"
+         *         },
+         *         {
+         *             "issueTypeId": "10002",
+         *             "newStatusId": "10003",
+         *             "statusId": "10005"
+         *         },
+         *         {
+         *             "issueTypeId": "10003",
+         *             "newStatusId": "1",
+         *             "statusId": "4"
+         *         }
+         *     ]
+         * }
+         */
+        publishDraftWorkflowScheme: PublishDraftWorkflowScheme;
+    }): Promise<void>;
+    /**
+     * Sets the workflow for an issue type in a workflow scheme's draft.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}/draft/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
+     */
+    setWorkflowSchemeDraftIssueType({ id, issueType, issueTypeWorkflowMapping, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        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's draft.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}/draft/default
+     * @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
+     */
+    updateDraftDefaultWorkflow({ id, defaultWorkflow, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+        /**
+         * The object for the new default workflow.
+         *
+         * @example {
+         *     "updateDraftIfNeeded": false,
+         *     "workflow": "jira"
+         * }
+         */
+        defaultWorkflow: DefaultWorkflow;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Sets the issue types for a workflow in a workflow scheme's draft. The workflow
+     * can also be set as the default workflow for the draft workflow scheme. Unmapped
+     * issues types are mapped to the default workflow.
+     *
+     * **[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}/draft/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
+     */
+    updateDraftWorkflowMapping({ id, workflowName, issueTypesWorkflowMapping, }: {
+        /** The ID of the workflow scheme that the draft belongs to. */
+        id: number;
+        /** The name of the workflow. */
+        workflowName: string;
+        /**
+         * @example {
+         *     "issueTypes": [
+         *         "10000"
+         *     ],
+         *     "updateDraftIfNeeded": true,
+         *     "workflow": "jira"
+         * }
+         */
+        issueTypesWorkflowMapping: IssueTypesWorkflowMapping;
+    }): Promise<WorkflowScheme>;
+    /**
+     * Updates a draft workflow scheme. If a draft workflow scheme does not exist for
+     * the active workflow scheme, then a draft is created. Note that an active
+     * workflow scheme can only have one draft workflow scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultWorkflow": "scrum workflow",
+     *   "description": "The description of the example workflow scheme.",
+     *   "draft": true,
+     *   "id": 17218781,
+     *   "issueTypeMappings": {
+     *     "10000": "jira",
+     *     "10001": "jira"
+     *   },
+     *   "lastModified": "Today 6:38 PM",
+     *   "lastModifiedUser": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": true,
+     *     "applicationRoles": {
+     *       "items": [],
+     *       "size": 1
+     *     },
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "emailAddress": "mia@example.com",
+     *     "groups": {
+     *       "items": [],
+     *       "size": 3
+     *     },
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *     "timeZone": "Australia/Sydney"
+     *   },
+     *   "name": "Example workflow scheme",
+     *   "originalDefaultWorkflow": "jira",
+     *   "originalIssueTypeMappings": {
+     *     "10001": "builds workflow"
+     *   },
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
+     * }
+     * @path {PUT} /rest/api/3/workflowscheme/{id}/draft
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:group:jira, read:issue-security-level:jira, read:project-role:jira,
+     * read:screen:jira, read:status:jira, read:user:jira, read:workflow-scheme:jira,
+     * read:workflow:jira, write:workflow-scheme:jira, read:application-role:jira,
+     * read:avatar:jira, read:issue-type:jira, read:project-category:jira,
+     * read:project:jira
+     */
+    updateWorkflowSchemeDraft({ id, workflowScheme, }: {
+        /** The ID of the active workflow scheme that the draft was created from. */
+        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>;
+    static initialize(): void;
+}