@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/workflows-service.ts

@@ -0,0 +1,3477 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type CreateWorkflowDetails,
+  type DeprecatedWorkflow,
+  type PageBeanWorkflow,
+  registerWorkflowsValidationSchemas,
+  type WorkflowCapabilities,
+  type WorkflowCreateRequest,
+  type WorkflowCreateResponse,
+  type WorkflowCreateValidateRequest,
+  type WorkflowIds,
+  type WorkflowReadRequest,
+  type WorkflowReadResponse,
+  type WorkflowUpdateRequest,
+  type WorkflowUpdateResponse,
+  type WorkflowUpdateValidateRequestBean,
+  type WorkflowValidationErrorList,
+} from "../models/workflows";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents workflows. Use it to:
+ *
+ *  *  Get workflows
+ *  *  Create workflows
+ *  *  Update workflows
+ *  *  Delete inactive workflows
+ *  *  Get workflow capabilities
+ */
+export class WorkflowsService extends CommonHttpService {
+  /**
+   * Creates a workflow. You can define transition rules using the shapes detailed
+   * in the following sections. If no transitional rules are specified the default
+   * system transition rules are used. Note: This only applies to company-managed
+   * scoped workflows. Use [bulk create
+   * workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-create-post)
+   * to create both team and company-managed scoped workflows.
+   *
+   * #### Conditions ####
+   *
+   * Conditions enable workflow rules that govern whether a transition can execute.
+   *
+   * ##### Always false condition #####
+   *
+   * A condition that always fails.
+   *
+   *     {
+   *        "type": "AlwaysFalseCondition"
+   *      }
+   *
+   * ##### Block transition until approval #####
+   *
+   * A condition that blocks issue transition if there is a pending approval.
+   *
+   *     {
+   *        "type": "BlockInProgressApprovalCondition"
+   *      }
+   *
+   * ##### Compare number custom field condition #####
+   *
+   * A condition that allows transition if a comparison between a number custom
+   * field and a value is true.
+   *
+   *     {
+   *        "type": "CompareNumberCFCondition",
+   *        "configuration": {
+   *          "comparator": "=",
+   *          "fieldId": "customfield_10029",
+   *          "fieldValue": 2
+   *        }
+   *      }
+   *
+   *  *  `comparator` One of the supported comparator: `=`, `>`, and `<`.
+   *  *  `fieldId` The custom numeric field ID. Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:float`
+   *      *  `com.pyxis.greenhopper.jira:jsw-story-points`
+   *  *  `fieldValue` The value for comparison.
+   *
+   * ##### Hide from user condition #####
+   *
+   * A condition that hides a transition from users. The transition can only be
+   * triggered from a workflow function or REST API operation.
+   *
+   *     {
+   *        "type": "RemoteOnlyCondition"
+   *      }
+   *
+   * ##### Only assignee condition #####
+   *
+   * A condition that allows only the assignee to execute a transition.
+   *
+   *     {
+   *        "type": "AllowOnlyAssignee"
+   *      }
+   *
+   * ##### Only Bamboo notifications workflow condition (deprecated) #####
+   *
+   * A condition that makes the transition available only to Bamboo build
+   * notifications.
+   *
+   *     {
+   *        "type": "OnlyBambooNotificationsCondition"
+   *      }
+   *
+   * ##### Only reporter condition #####
+   *
+   * A condition that allows only the reporter to execute a transition.
+   *
+   *     {
+   *        "type": "AllowOnlyReporter"
+   *      }
+   *
+   * ##### Permission condition #####
+   *
+   * A condition that allows only users with a permission to execute a transition.
+   *
+   *     {
+   *        "type": "PermissionCondition",
+   *        "configuration": {
+   *            "permissionKey": "BROWSE_PROJECTS"
+   *        }
+   *      }
+   *
+   *  *  `permissionKey` The permission required to perform the transition. Allowed
+   * values:
+   * [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions)
+   * or app defined permissions.
+   *
+   * ##### Previous status condition #####
+   *
+   * A condition that allows a transition based on whether an issue has or has not
+   * transitioned through a status.
+   *
+   *     {
+   *        "type": "PreviousStatusCondition",
+   *        "configuration": {
+   *          "ignoreLoopTransitions": true,
+   *          "includeCurrentStatus": true,
+   *          "mostRecentStatusOnly": true,
+   *          "reverseCondition": true,
+   *          "previousStatus": {
+   *            "id": "5"
+   *          }
+   *        }
+   *      }
+   *
+   * By default this condition allows the transition if the status, as defined by
+   * its ID in the `previousStatus` object, matches any previous issue status,
+   * unless:
+   *
+   *  *  `ignoreLoopTransitions` is `true`, then loop transitions (from and to the
+   * same status) are ignored.
+   *  *  `includeCurrentStatus` is `true`, then the current issue status is also
+   * checked.
+   *  *  `mostRecentStatusOnly` is `true`, then only the issue's preceding status
+   * (the one immediately before the current status) is checked.
+   *  *  `reverseCondition` is `true`, then the status must not be present.
+   *
+   * ##### Separation of duties condition #####
+   *
+   * A condition that prevents a user to perform the transition, if the user has
+   * already performed a transition on the issue.
+   *
+   *     {
+   *        "type": "SeparationOfDutiesCondition",
+   *        "configuration": {
+   *          "fromStatus": {
+   *            "id": "5"
+   *          },
+   *          "toStatus": {
+   *            "id": "6"
+   *          }
+   *        }
+   *      }
+   *
+   *  *  `fromStatus` OPTIONAL. An object containing the ID of the source status of
+   * the transition that is blocked. If omitted any transition to `toStatus` is
+   * blocked.
+   *  *  `toStatus` An object containing the ID of the target status of the
+   * transition that is blocked.
+   *
+   * ##### Subtask blocking condition #####
+   *
+   * A condition that blocks transition on a parent issue if any of its subtasks are
+   * in any of one or more statuses.
+   *
+   *     {
+   *        "type": "SubTaskBlockingCondition",
+   *        "configuration": {
+   *          "statuses": [
+   *            {
+   *              "id": "1"
+   *            },
+   *            {
+   *              "id": "3"
+   *            }
+   *          ]
+   *        }
+   *      }
+   *
+   *  *  `statuses` A list of objects containing status IDs.
+   *
+   * ##### User is in any group condition #####
+   *
+   * A condition that allows users belonging to any group from a list of groups to
+   * execute a transition.
+   *
+   *     {
+   *        "type": "UserInAnyGroupCondition",
+   *        "configuration": {
+   *          "groups": [
+   *            "administrators",
+   *            "atlassian-addons-admin"
+   *          ]
+   *        }
+   *      }
+   *
+   *  *  `groups` A list of group names.
+   *
+   * ##### User is in any project role condition #####
+   *
+   * A condition that allows only users with at least one project roles from a list
+   * of project roles to execute a transition.
+   *
+   *     {
+   *        "type": "InAnyProjectRoleCondition",
+   *        "configuration": {
+   *          "projectRoles": [
+   *            {
+   *              "id": "10002"
+   *            },
+   *            {
+   *              "id": "10003"
+   *            },
+   *            {
+   *              "id": "10012"
+   *            },
+   *            {
+   *              "id": "10013"
+   *            }
+   *          ]
+   *        }
+   *      }
+   *
+   *  *  `projectRoles` A list of objects containing project role IDs.
+   *
+   * ##### User is in custom field condition #####
+   *
+   * A condition that allows only users listed in a given custom field to execute
+   * the transition.
+   *
+   *     {
+   *        "type": "UserIsInCustomFieldCondition",
+   *        "configuration": {
+   *          "allowUserInField": false,
+   *          "fieldId": "customfield_10010"
+   *        }
+   *      }
+   *
+   *  *  `allowUserInField` If `true` only a user who is listed in `fieldId` can
+   * perform the transition, otherwise, only a user who is not listed in `fieldId`
+   * can perform the transition.
+   *  *  `fieldId` The ID of the field containing the list of users.
+   *
+   * ##### User is in group condition #####
+   *
+   * A condition that allows users belonging to a group to execute a transition.
+   *
+   *     {
+   *        "type": "UserInGroupCondition",
+   *        "configuration": {
+   *          "group": "administrators"
+   *        }
+   *      }
+   *
+   *  *  `group` The name of the group.
+   *
+   * ##### User is in group custom field condition #####
+   *
+   * A condition that allows users belonging to a group specified in a custom field
+   * to execute a transition.
+   *
+   *     {
+   *        "type": "InGroupCFCondition",
+   *        "configuration": {
+   *          "fieldId": "customfield_10012"
+   *        }
+   *      }
+   *
+   *  *  `fieldId` The ID of the field. Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:select`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:multiselect`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`
+   *      *  `com.pyxis.greenhopper.jira:gh-epic-status`
+   *
+   * ##### User is in project role condition #####
+   *
+   * A condition that allows users with a project role to execute a transition.
+   *
+   *     {
+   *        "type": "InProjectRoleCondition",
+   *        "configuration": {
+   *          "projectRole": {
+   *            "id": "10002"
+   *          }
+   *        }
+   *      }
+   *
+   *  *  `projectRole` An object containing the ID of a project role.
+   *
+   * ##### Value field condition #####
+   *
+   * A conditions that allows a transition to execute if the value of a field is
+   * equal to a constant value or simply set.
+   *
+   *     {
+   *        "type": "ValueFieldCondition",
+   *        "configuration": {
+   *          "fieldId": "assignee",
+   *          "fieldValue":
+   * "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",
+   *          "comparisonType": "NUMBER",
+   *          "comparator": "="
+   *        }
+   *      }
+   *
+   *  *  `fieldId` The ID of a field used in the comparison.
+   *  *  `fieldValue` The expected value of the field.
+   *  *  `comparisonType` The type of the comparison. Allowed values: `STRING`,
+   * `NUMBER`, `DATE`, `DATE_WITHOUT_TIME`, or `OPTIONID`.
+   *  *  `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`,
+   * `!=`.
+   *
+   * **Notes:**
+   *
+   *  *  If you choose the comparison type `STRING`, only `=` and `!=` are valid
+   * options.
+   *  *  You may leave `fieldValue` empty when comparison type is `!=` to indicate
+   * that a value is required in the field.
+   *  *  For date fields without time format values as `yyyy-MM-dd`, and for those
+   * with time as `yyyy-MM-dd HH:mm`. For example, for July 16 2021 use
+   * `2021-07-16`, for 8:05 AM use `2021-07-16 08:05`, and for 4 PM: `2021-07-16
+   * 16:00`.
+   *
+   * #### Validators ####
+   *
+   * Validators check that any input made to the transition is valid before the
+   * transition is performed.
+   *
+   * ##### Date field validator #####
+   *
+   * A validator that compares two dates.
+   *
+   *     {
+   *        "type": "DateFieldValidator",
+   *        "configuration": {
+   *            "comparator": ">",
+   *            "date1": "updated",
+   *            "date2": "created",
+   *            "expression": "1d",
+   *            "includeTime": true
+   *          }
+   *      }
+   *
+   *  *  `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, or
+   * `!=`.
+   *  *  `date1` The date field to validate. Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-end`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-start`
+   *      *  `duedate`
+   *      *  `created`
+   *      *  `updated`
+   *      *  `resolutiondate`
+   *  *  `date2` The second date field. Required, if `expression` is not passed.
+   * Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-end`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-start`
+   *      *  `duedate`
+   *      *  `created`
+   *      *  `updated`
+   *      *  `resolutiondate`
+   *  *  `expression` An expression specifying an offset. Required, if `date2` is
+   * not passed. Offsets are built with a number, with `-` as prefix for the past,
+   * and one of these time units: `d` for day, `w` for week, `m` for month, or `y`
+   * for year. For example, -2d means two days into the past and 1w means one week
+   * into the future. The `now` keyword enables a comparison with the current date.
+   *  *  `includeTime` If `true`, then the time part of the data is included for the
+   * comparison. If the field doesn't have a time part, 00:00:00 is used.
+   *
+   * ##### Windows date validator #####
+   *
+   * A validator that checks that a date falls on or after a reference date and
+   * before or on the reference date plus a number of days.
+   *
+   *     {
+   *        "type": "WindowsDateValidator",
+   *        "configuration": {
+   *            "date1": "customfield_10009",
+   *            "date2": "created",
+   *            "windowsDays": 5
+   *          }
+   *      }
+   *
+   *  *  `date1` The date field to validate. Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-end`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-start`
+   *      *  `duedate`
+   *      *  `created`
+   *      *  `updated`
+   *      *  `resolutiondate`
+   *  *  `date2` The reference date. Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-end`
+   *      *  `com.atlassian.jpo:jpo-custom-field-baseline-start`
+   *      *  `duedate`
+   *      *  `created`
+   *      *  `updated`
+   *      *  `resolutiondate`
+   *  *  `windowsDays` A positive integer indicating a number of days.
+   *
+   * ##### Field required validator #####
+   *
+   * A validator that checks fields are not empty. By default, if a field is not
+   * included in the current context it's ignored and not validated.
+   *
+   *     {
+   *          "type": "FieldRequiredValidator",
+   *          "configuration": {
+   *              "ignoreContext": true,
+   *              "errorMessage": "Hey",
+   *              "fieldIds": [
+   *                  "versions",
+   *                  "customfield_10037",
+   *                  "customfield_10003"
+   *              ]
+   *          }
+   *      }
+   *
+   *  *  `ignoreContext` If `true`, then the context is ignored and all the fields
+   * are validated.
+   *  *  `errorMessage` OPTIONAL. The error message displayed when one or more
+   * fields are empty. A default error message is shown if an error message is not
+   * provided.
+   *  *  `fieldIds` The list of fields to validate.
+   *
+   * ##### Field changed validator #####
+   *
+   * A validator that checks that a field value is changed. However, this validation
+   * can be ignored for users from a list of groups.
+   *
+   *     {
+   *          "type": "FieldChangedValidator",
+   *          "configuration": {
+   *              "fieldId": "comment",
+   *              "errorMessage": "Hey",
+   *              "exemptedGroups": [
+   *                  "administrators",
+   *                  "atlassian-addons-admin"
+   *              ]
+   *          }
+   *      }
+   *
+   *  *  `fieldId` The ID of a field.
+   *  *  `errorMessage` OPTIONAL. The error message displayed if the field is not
+   * changed. A default error message is shown if the error message is not provided.
+   *  *  `exemptedGroups` OPTIONAL. The list of groups.
+   *
+   * ##### Field has single value validator #####
+   *
+   * A validator that checks that a multi-select field has only one value.
+   * Optionally, the validation can ignore values copied from subtasks.
+   *
+   *     {
+   *          "type": "FieldHasSingleValueValidator",
+   *          "configuration": {
+   *              "fieldId": "attachment,
+   *              "excludeSubtasks": true
+   *          }
+   *      }
+   *
+   *  *  `fieldId` The ID of a field.
+   *  *  `excludeSubtasks` If `true`, then values copied from subtasks are ignored.
+   *
+   * ##### Parent status validator #####
+   *
+   * A validator that checks the status of the parent issue of a subtask. Ìf the
+   * issue is not a subtask, no validation is performed.
+   *
+   *     {
+   *          "type": "ParentStatusValidator",
+   *          "configuration": {
+   *              "parentStatuses": [
+   *                  {
+   *                    "id":"1"
+   *                  },
+   *                  {
+   *                    "id":"2"
+   *                  }
+   *              ]
+   *          }
+   *      }
+   *
+   *  *  `parentStatus` The list of required parent issue statuses.
+   *
+   * ##### Permission validator #####
+   *
+   * A validator that checks the user has a permission.
+   *
+   *     {
+   *        "type": "PermissionValidator",
+   *        "configuration": {
+   *            "permissionKey": "ADMINISTER_PROJECTS"
+   *        }
+   *      }
+   *
+   *  *  `permissionKey` The permission required to perform the transition. Allowed
+   * values:
+   * [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions)
+   * or app defined permissions.
+   *
+   * ##### Previous status validator #####
+   *
+   * A validator that checks if the issue has held a status.
+   *
+   *     {
+   *        "type": "PreviousStatusValidator",
+   *        "configuration": {
+   *            "mostRecentStatusOnly": false,
+   *            "previousStatus": {
+   *                "id": "15"
+   *            }
+   *        }
+   *      }
+   *
+   *  *  `mostRecentStatusOnly` If `true`, then only the issue's preceding status
+   * (the one immediately before the current status) is checked.
+   *  *  `previousStatus` An object containing the ID of an issue status.
+   *
+   * ##### Regular expression validator #####
+   *
+   * A validator that checks the content of a field against a regular expression.
+   *
+   *     {
+   *        "type": "RegexpFieldValidator",
+   *        "configuration": {
+   *            "regExp": "[0-9]",
+   *            "fieldId": "customfield_10029"
+   *        }
+   *      }
+   *
+   *  *  `regExp`A regular expression.
+   *  *  `fieldId` The ID of a field. Allowed field types:
+   *
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:select`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:multiselect`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:textarea`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:textfield`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:url`
+   *      *  `com.atlassian.jira.plugin.system.customfieldtypes:float`
+   *      *  `com.pyxis.greenhopper.jira:jsw-story-points`
+   *      *  `com.pyxis.greenhopper.jira:gh-epic-status`
+   *      *  `description`
+   *      *  `summary`
+   *
+   * ##### User permission validator #####
+   *
+   * A validator that checks if a user has a permission. Obsolete. You may encounter
+   * this validator when getting transition rules and can pass it when updating or
+   * creating rules, for example, when you want to duplicate the rules from a
+   * workflow on a new workflow.
+   *
+   *     {
+   *          "type": "UserPermissionValidator",
+   *          "configuration": {
+   *              "permissionKey": "BROWSE_PROJECTS",
+   *              "nullAllowed": false,
+   *              "username": "TestUser"
+   *          }
+   *      }
+   *
+   *  *  `permissionKey` The permission to be validated. Allowed values:
+   * [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions)
+   * or app defined permissions.
+   *  *  `nullAllowed` If `true`, allows the transition when `username` is empty.
+   *  *  `username` The username to validate against the `permissionKey`.
+   *
+   * #### Post functions ####
+   *
+   * Post functions carry out any additional processing required after a Jira
+   * workflow transition is executed.
+   *
+   * ##### Fire issue event function #####
+   *
+   * A post function that fires an event that is processed by the listeners.
+   *
+   *     {
+   *        "type": "FireIssueEventFunction",
+   *        "configuration": {
+   *          "event": {
+   *            "id":"1"
+   *          }
+   *        }
+   *      }
+   *
+   * **Note:** If provided, this post function overrides the default
+   * `FireIssueEventFunction`. Can be included once in a transition.
+   *
+   *  *  `event` An object containing the ID of the issue event.
+   *
+   * ##### Update issue status #####
+   *
+   * A post function that sets issue status to the linked status of the destination
+   * workflow status.
+   *
+   *     {
+   *        "type": "UpdateIssueStatusFunction"
+   *      }
+   *
+   * **Note:** This post function is a default function in global and directed
+   * transitions. It can only be added to the initial transition and can only be
+   * added once.
+   *
+   * ##### Create comment #####
+   *
+   * A post function that adds a comment entered during the transition to an issue.
+   *
+   *     {
+   *        "type": "CreateCommentFunction"
+   *      }
+   *
+   * **Note:** This post function is a default function in global and directed
+   * transitions. It can only be added to the initial transition and can only be
+   * added once.
+   *
+   * ##### Store issue #####
+   *
+   * A post function that stores updates to an issue.
+   *
+   *     {
+   *        "type": "IssueStoreFunction"
+   *      }
+   *
+   * **Note:** This post function can only be added to the initial transition and
+   * can only be added once.
+   *
+   * ##### Assign to current user function #####
+   *
+   * A post function that assigns the issue to the current user if the current user
+   * has the `ASSIGNABLE_USER` permission.
+   *
+   *     {
+   *          "type": "AssignToCurrentUserFunction"
+   *      }
+   *
+   * **Note:** This post function can be included once in a transition.
+   *
+   * ##### Assign to lead function #####
+   *
+   * A post function that assigns the issue to the project or component lead
+   * developer.
+   *
+   *     {
+   *          "type": "AssignToLeadFunction"
+   *      }
+   *
+   * **Note:** This post function can be included once in a transition.
+   *
+   * ##### Assign to reporter function #####
+   *
+   * A post function that assigns the issue to the reporter.
+   *
+   *     {
+   *          "type": "AssignToReporterFunction"
+   *      }
+   *
+   * **Note:** This post function can be included once in a transition.
+   *
+   * ##### Clear field value function #####
+   *
+   * A post function that clears the value from a field.
+   *
+   *     {
+   *        "type": "ClearFieldValuePostFunction",
+   *        "configuration": {
+   *          "fieldId": "assignee"
+   *        }
+   *      }
+   *
+   *  *  `fieldId` The ID of the field.
+   *
+   * ##### Copy value from other field function #####
+   *
+   * A post function that copies the value of one field to another, either within an
+   * issue or from parent to subtask.
+   *
+   *     {
+   *        "type": "CopyValueFromOtherFieldPostFunction",
+   *        "configuration": {
+   *          "sourceFieldId": "assignee",
+   *          "destinationFieldId": "creator",
+   *          "copyType": "same"
+   *        }
+   *      }
+   *
+   *  *  `sourceFieldId` The ID of the source field.
+   *  *  `destinationFieldId` The ID of the destination field.
+   *  *  `copyType` Use `same` to copy the value from a field inside the issue, or
+   * `parent` to copy the value from the parent issue.
+   *
+   * ##### Create Crucible review workflow function (deprecated) #####
+   *
+   * A post function that creates a Crucible review for all unreviewed code for the
+   * issue.
+   *
+   *     {
+   *          "type": "CreateCrucibleReviewWorkflowFunction"
+   *      }
+   *
+   * **Note:** This post function can be included once in a transition.
+   *
+   * ##### Set issue security level based on user's project role function #####
+   *
+   * A post function that sets the issue's security level if the current user has a
+   * project role.
+   *
+   *     {
+   *        "type": "SetIssueSecurityFromRoleFunction",
+   *        "configuration": {
+   *          "projectRole": {
+   *              "id":"10002"
+   *          },
+   *          "issueSecurityLevel": {
+   *              "id":"10000"
+   *          }
+   *        }
+   *      }
+   *
+   *  *  `projectRole` An object containing the ID of the project role.
+   *  *  `issueSecurityLevel` OPTIONAL. The object containing the ID of the security
+   * level. If not passed, then the security level is set to `none`.
+   *
+   * ##### Trigger a webhook function #####
+   *
+   * A post function that triggers a webhook.
+   *
+   *     {
+   *        "type": "TriggerWebhookFunction",
+   *        "configuration": {
+   *          "webhook": {
+   *            "id": "1"
+   *          }
+   *        }
+   *      }
+   *
+   *  *  `webhook` An object containing the ID of the webhook listener to trigger.
+   *
+   * ##### Update issue custom field function #####
+   *
+   * A post function that updates the content of an issue custom field.
+   *
+   *     {
+   *        "type": "UpdateIssueCustomFieldPostFunction",
+   *        "configuration": {
+   *          "mode": "append",
+   *          "fieldId": "customfield_10003",
+   *          "fieldValue": "yikes"
+   *        }
+   *      }
+   *
+   *  *  `mode` Use `replace` to override the field content with `fieldValue` or
+   * `append` to add `fieldValue` to the end of the field content.
+   *  *  `fieldId` The ID of the field.
+   *  *  `fieldValue` The update content.
+   *
+   * ##### Update issue field function #####
+   *
+   * A post function that updates a simple issue field.
+   *
+   *     {
+   *        "type": "UpdateIssueFieldFunction",
+   *        "configuration": {
+   *          "fieldId": "assignee",
+   *          "fieldValue": "5f0c277e70b8a90025a00776"
+   *        }
+   *      }
+   *
+   *  *  `fieldId` The ID of the field. Allowed field types:
+   *
+   *      *  `assignee`
+   *      *  `description`
+   *      *  `environment`
+   *      *  `priority`
+   *      *  `resolution`
+   *      *  `summary`
+   *      *  `timeoriginalestimate`
+   *      *  `timeestimate`
+   *      *  `timespent`
+   *  *  `fieldValue` The update value.
+   *  *  If the `fieldId` is `assignee`, the `fieldValue` should be one of these
+   * values:
+   *
+   *      *  an account ID.
+   *      *  `automatic`.
+   *      *  a blank string, which sets the value to `unassigned`.
+   *
+   * #### Connect rules ####
+   *
+   * Connect rules are conditions, validators, and post functions of a transition
+   * that are registered by Connect apps. To create a rule registered by the app,
+   * the app must be enabled and the rule's module must exist.
+   *
+   *     {
+   *        "type": "appKey__moduleKey",
+   *        "configuration": {
+   *          "value":"{\"isValid\":\"true\"}"
+   *        }
+   *      }
+   *
+   *  *  `type` A Connect rule key in a form of `appKey__moduleKey`.
+   *  *  `value` The stringified JSON configuration of a Connect rule.
+   *
+   * #### Forge rules ####
+   *
+   * Forge transition rules are not yet supported.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @deprecated
+   * @returns Returned if the workflow is created.
+   *
+   * example: {
+   *   "entityId": "d7178e8d-bf6c-4c0c-9e90-758a0b965b67",
+   *   "name": "Workflow 1"
+   * }
+   * @path {POST} /rest/api/3/workflow
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira, read:workflow:jira
+   */
+  createWorkflow({
+    createWorkflowDetails,
+  }: {
+    /**
+     * The workflow details.
+     *
+     * @example {
+     *     "description": "This is a workflow used for Stories and Tasks",
+     *     "name": "Workflow 1",
+     *     "statuses": [
+     *         {
+     *             "id": "1",
+     *             "properties": {
+     *                 "jira.issue.editable": "false"
+     *             }
+     *         },
+     *         {
+     *             "id": "2"
+     *         },
+     *         {
+     *             "id": "3"
+     *         }
+     *     ],
+     *     "transitions": [
+     *         {
+     *             "from": [],
+     *             "name": "Created",
+     *             "to": "1",
+     *             "type": "initial"
+     *         },
+     *         {
+     *             "from": [
+     *                 "1"
+     *             ],
+     *             "name": "In progress",
+     *             "properties": {
+     *                 "custom-property": "custom-value"
+     *             },
+     *             "rules": {
+     *                 "conditions": {
+     *                     "conditions": [
+     *                         {
+     *                             "type": "RemoteOnlyCondition"
+     *                         },
+     *                         {
+     *                             "configuration": {
+     *                                 "groups": [
+     *                                     "developers",
+     *                                     "qa-testers"
+     *                                 ]
+     *                             },
+     *                             "type": "UserInAnyGroupCondition"
+     *                         }
+     *                     ],
+     *                     "operator": "AND"
+     *                 },
+     *                 "postFunctions": [
+     *                     {
+     *                         "type": "AssignToCurrentUserFunction"
+     *                     }
+     *                 ]
+     *             },
+     *             "screen": {
+     *                 "id": "10001"
+     *             },
+     *             "to": "2",
+     *             "type": "directed"
+     *         },
+     *         {
+     *             "name": "Completed",
+     *             "rules": {
+     *                 "postFunctions": [
+     *                     {
+     *                         "configuration": {
+     *                             "fieldId": "assignee"
+     *                         },
+     *                         "type": "ClearFieldValuePostFunction"
+     *                     }
+     *                 ],
+     *                 "validators": [
+     *                     {
+     *                         "configuration": {
+     *                             "parentStatuses": [
+     *                                 {
+     *                                     "id": "3"
+     *                                 }
+     *                             ]
+     *                         },
+     *                         "type": "ParentStatusValidator"
+     *                     },
+     *                     {
+     *                         "configuration": {
+     *                             "permissionKey": "ADMINISTER_PROJECTS"
+     *                         },
+     *                         "type": "PermissionValidator"
+     *                     }
+     *                 ]
+     *             },
+     *             "to": "3",
+     *             "type": "global"
+     *         }
+     *     ]
+     * }
+     */
+    createWorkflowDetails: CreateWorkflowDetails;
+  }): Promise<WorkflowIds> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflow",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: createWorkflowDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 201;
+          mediaType: "application/json";
+          body: WorkflowIds;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.createWorkflow.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Create workflows and related statuses.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* project permission to create all, including
+   * global-scoped, workflows
+   *  *  *Administer projects* project permissions to create project-scoped workflows
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "statuses": [
+   *     {
+   *       "description": "",
+   *       "id": "10001",
+   *       "name": "To Do",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "TODO",
+   *       "statusReference": "10001",
+   *       "usages": []
+   *     },
+   *     {
+   *       "description": "",
+   *       "id": "10002",
+   *       "name": "In Progress",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "IN_PROGRESS",
+   *       "statusReference": "10002",
+   *       "usages": []
+   *     },
+   *     {
+   *       "description": "",
+   *       "id": "10003",
+   *       "name": "Done",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "DONE",
+   *       "statusReference": "10003",
+   *       "usages": []
+   *     }
+   *   ],
+   *   "workflows": [
+   *     {
+   *       "description": "",
+   *       "id": "b9ff2384-d3b6-4d4e-9509-3ee19f607168",
+   *       "isEditable": true,
+   *       "name": "Software workflow 1",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "startPointLayout": {
+   *         "x": -100.00030899047852,
+   *         "y": -153.00020599365234
+   *       },
+   *       "statuses": [
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 114.99993896484375,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10001"
+   *         },
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 317.0000915527344,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10002"
+   *         },
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 508.000244140625,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10003"
+   *         }
+   *       ],
+   *       "transitions": [
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "31",
+   *           "name": "Done",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10003"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "11",
+   *           "name": "To Do",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10001"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "21",
+   *           "name": "In Progress",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10002"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "1",
+   *           "name": "Create",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10001"
+   *           },
+   *           "triggers": [],
+   *           "type": "INITIAL",
+   *           "validators": []
+   *         }
+   *       ],
+   *       "usages": [],
+   *       "version": {
+   *         "id": "f010ac1b-3dd3-43a3-aa66-0ee8a447f76e",
+   *         "versionNumber": 0
+   *       }
+   *     }
+   *   ]
+   * }
+   * @path {POST} /rest/api/3/workflows/create
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  createWorkflows({
+    workflowCreateRequest,
+  }: {
+    /**
+     * @example {
+     *     "scope": {
+     *         "type": "GLOBAL"
+     *     },
+     *     "statuses": [
+     *         {
+     *             "description": "",
+     *             "name": "To Do",
+     *             "statusCategory": "TODO",
+     *             "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *         },
+     *         {
+     *             "description": "",
+     *             "name": "In Progress",
+     *             "statusCategory": "IN_PROGRESS",
+     *             "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *         },
+     *         {
+     *             "description": "",
+     *             "name": "Done",
+     *             "statusCategory": "DONE",
+     *             "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *         }
+     *     ],
+     *     "workflows": [
+     *         {
+     *             "description": "",
+     *             "name": "Software workflow 1",
+     *             "startPointLayout": {
+     *                 "x": -100.00030899047852,
+     *                 "y": -153.00020599365234
+     *             },
+     *             "statuses": [
+     *                 {
+     *                     "layout": {
+     *                         "x": 114.99993896484375,
+     *                         "y": -16
+     *                     },
+     *                     "properties": {},
+     *                     "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                 },
+     *                 {
+     *                     "layout": {
+     *                         "x": 317.0000915527344,
+     *                         "y": -16
+     *                     },
+     *                     "properties": {},
+     *                     "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                 },
+     *                 {
+     *                     "layout": {
+     *                         "x": 508.000244140625,
+     *                         "y": -16
+     *                     },
+     *                     "properties": {},
+     *                     "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                 }
+     *             ],
+     *             "transitions": [
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "1",
+     *                     "name": "Create",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "INITIAL",
+     *                     "validators": []
+     *                 },
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "11",
+     *                     "name": "To Do",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "GLOBAL",
+     *                     "validators": []
+     *                 },
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "21",
+     *                     "name": "In Progress",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "GLOBAL",
+     *                     "validators": []
+     *                 },
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "31",
+     *                     "name": "Done",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "GLOBAL",
+     *                     "validators": []
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     */
+    workflowCreateRequest: WorkflowCreateRequest;
+  }): Promise<WorkflowCreateResponse> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflows/create",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: workflowCreateRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowCreateResponse;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.createWorkflows.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes a workflow.
+   *
+   * The workflow cannot be deleted if it is:
+   *
+   *  *  an active workflow.
+   *  *  a system workflow.
+   *  *  associated with any workflow scheme.
+   *  *  associated with any draft workflow scheme.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @path {DELETE} /rest/api/3/workflow/{entityId}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta delete:workflow:jira
+   */
+  deleteInactiveWorkflow({
+    entityId,
+  }: {
+    /** The entity ID of the workflow. */
+    entityId: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflow/{entityId}",
+        method: "DELETE",
+        pathParams: {
+          entityId,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows
+   * paginated](#api-rest-api-3-workflow-search-get).
+   *
+   * If the `workflowName` parameter is specified, the workflow is returned as an
+   * object (not in an array). Otherwise, an array of workflow objects is returned.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @deprecated
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "default": true,
+   *     "description": "A classic Jira workflow",
+   *     "lastModifiedDate": "01-01-2011",
+   *     "lastModifiedUser": "admin",
+   *     "lastModifiedUserAccountId": "5b10a2844c20165700ede21g",
+   *     "name": "classic workflow",
+   *     "steps": 5
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/workflow
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:workflow:jira, read:project:jira, read:project-category:jira,
+   * read:avatar:jira
+   */
+  getAllWorkflows({
+    workflowName,
+  }: {
+    /** The name of the workflow to be returned. Only one workflow can be specified. */
+    workflowName?: string;
+  }): Promise<DeprecatedWorkflow[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflow",
+        method: "GET",
+        query: {
+          workflowName,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: DeprecatedWorkflow[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.getAllWorkflows.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of published classic workflows. When
+   * workflow names are specified, details of those workflows are returned.
+   * Otherwise, all published classic workflows are returned.
+   *
+   * This operation does not return next-gen workflows.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": false,
+   *   "maxResults": 1,
+   *   "startAt": 0,
+   *   "total": 5,
+   *   "values": [
+   *     {
+   *       "id": {
+   *         "name": "SCRUM Workflow",
+   *         "entityId": "5ed312c5-f7a6-4a78-a1f6-8ff7f307d063"
+   *       },
+   *       "description": "A workflow used for Software projects in the SCRUM
+   * methodology",
+   *       "transitions": [
+   *         {
+   *           "id": "5",
+   *           "name": "In Progress",
+   *           "description": "Start working on the issue.",
+   *           "from": [
+   *             "10",
+   *             "13"
+   *           ],
+   *           "to": "14",
+   *           "type": "directed",
+   *           "screen": {
+   *             "id": "10000",
+   *             "name": "Issue screen"
+   *           },
+   *           "rules": {
+   *             "conditionsTree": {
+   *               "nodeType": "compound",
+   *               "operator": "AND",
+   *               "conditions": [
+   *                 {
+   *                   "nodeType": "simple",
+   *                   "type": "PermissionCondition",
+   *                   "configuration": {
+   *                     "permissionKey": "WORK_ON_ISSUES"
+   *                   }
+   *                 },
+   *                 {
+   *                   "nodeType": "simple",
+   *                   "type": "PermissionCondition",
+   *                   "configuration": {
+   *                     "permissionKey": "RESOLVE_ISSUES"
+   *                   }
+   *                 }
+   *               ]
+   *             },
+   *             "validators": [
+   *               {
+   *                 "type": "FieldRequiredValidator",
+   *                 "configuration": {
+   *                   "errorMessage": "A custom error message",
+   *                   "fields": [
+   *                     "description",
+   *                     "assignee"
+   *                   ],
+   *                   "ignoreContext": true
+   *                 }
+   *               }
+   *             ],
+   *             "postFunctions": [
+   *               {
+   *                 "type": "UpdateIssueStatusFunction"
+   *               },
+   *               {
+   *                 "type": "GenerateChangeHistoryFunction"
+   *               },
+   *               {
+   *                 "type": "FireIssueEventFunction"
+   *               }
+   *             ]
+   *           },
+   *           "properties": {
+   *             "jira.fieldscreen.id": 1
+   *           }
+   *         }
+   *       ],
+   *       "statuses": [
+   *         {
+   *           "id": "3",
+   *           "name": "In Progress",
+   *           "properties": {
+   *             "issueEditable": false,
+   *             "jira.issue.editable": "false"
+   *           }
+   *         }
+   *       ],
+   *       "isDefault": false,
+   *       "schemes": [
+   *         {
+   *           "id": "10001",
+   *           "name": "Test Workflow Scheme"
+   *         }
+   *       ],
+   *       "projects": [
+   *         {
+   *           "avatarUrls": {
+   *             "16x16": "secure/projectavatar?size=xsmall&pid=10000",
+   *             "24x24": "secure/projectavatar?size=small&pid=10000",
+   *             "32x32": "secure/projectavatar?size=medium&pid=10000",
+   *             "48x48": "secure/projectavatar?size=large&pid=10000"
+   *           },
+   *           "id": "10000",
+   *           "key": "EX",
+   *           "name": "Example",
+   *           "projectCategory": {
+   *             "description": "Project category description",
+   *             "id": "10000",
+   *             "name": "A project category"
+   *           },
+   *           "projectTypeKey": "ProjectTypeKey{key='software'}",
+   *           "self": "project/EX",
+   *           "simplified": false
+   *         }
+   *       ],
+   *       "hasDraftWorkflow": true,
+   *       "operations": {
+   *         "canEdit": true,
+   *         "canDelete": false
+   *       },
+   *       "created": "2018-12-10T16:30:15.000+0000",
+   *       "updated": "2018-12-11T11:45:13.000+0000"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/workflow/search
+   * @scopes-current manage:jira-project
+   * @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:jira,
+   * read:webhook:jira, read:avatar:jira, read:project-category:jira,
+   * read:project:jira
+   */
+  getWorkflowsPaginated({
+    startAt,
+    maxResults,
+    workflowName,
+    expand,
+    queryString,
+    orderBy,
+    isActive,
+  }: {
+    /** 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;
+    /**
+     * The name of a workflow to return. To include multiple workflows, provide an
+     * ampersand-separated list. For example, `workflowName=name1&workflowName=name2`.
+     */
+    workflowName?: string[];
+    /**
+     * Use [expand](#expansion) to include additional information in the response.
+     * This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `transitions` For each workflow, returns information about the transitions
+     * inside the workflow.
+     *  *  `transitions.rules` For each workflow transition, returns information about
+     * its rules. Transitions are included automatically if this expand is requested.
+     *  *  `transitions.properties` For each workflow transition, returns information
+     * about its properties. Transitions are included automatically if this expand is
+     * requested.
+     *  *  `statuses` For each workflow, returns information about the statuses inside
+     * the workflow.
+     *  *  `statuses.properties` For each workflow status, returns information about
+     * its properties. Statuses are included automatically if this expand is requested.
+     *  *  `default` For each workflow, returns information about whether this is the
+     * default workflow.
+     *  *  `schemes` For each workflow, returns information about the workflow schemes
+     * the workflow is assigned to.
+     *  *  `projects` For each workflow, returns information about the projects the
+     * workflow is assigned to, through workflow schemes.
+     *  *  `hasDraftWorkflow` For each workflow, returns information about whether the
+     * workflow has a draft version.
+     *  *  `operations` For each workflow, returns information about the actions that
+     * can be undertaken on the workflow.
+     */
+    expand?: string;
+    /** String used to perform a case-insensitive partial match with workflow name. */
+    queryString?: string;
+    /**
+     * [Order](#ordering) the results by a field:
+     *
+     *  *  `name` Sorts by workflow name.
+     *  *  `created` Sorts by create time.
+     *  *  `updated` Sorts by update time.
+     */
+    orderBy?:
+      | "name"
+      | "-name"
+      | "+name"
+      | "created"
+      | "-created"
+      | "+created"
+      | "updated"
+      | "+updated"
+      | "-updated";
+    /** Filters active and inactive workflows. */
+    isActive?: boolean;
+  }): Promise<PageBeanWorkflow> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflow/search",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          workflowName,
+          expand,
+          queryString,
+          orderBy,
+          isActive,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanWorkflow;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.getWorkflowsPaginated.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a list of workflows and related statuses by providing workflow names,
+   * workflow IDs, or project and issue types.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* global permission to access all, including
+   * project-scoped, workflows
+   *  *  At least one of the *Administer projects* and *View (read-only) workflow*
+   * project permissions to access project-scoped workflows
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "statuses": [
+   *     {
+   *       "description": "",
+   *       "id": "10001",
+   *       "name": "To Do",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "TODO",
+   *       "statusReference": "10001",
+   *       "usages": []
+   *     },
+   *     {
+   *       "description": "",
+   *       "id": "10002",
+   *       "name": "In Progress",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "IN_PROGRESS",
+   *       "statusReference": "10002",
+   *       "usages": []
+   *     },
+   *     {
+   *       "description": "",
+   *       "id": "10003",
+   *       "name": "Done",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "DONE",
+   *       "statusReference": "10003",
+   *       "usages": []
+   *     }
+   *   ],
+   *   "workflows": [
+   *     {
+   *       "description": "",
+   *       "id": "b9ff2384-d3b6-4d4e-9509-3ee19f607168",
+   *       "isEditable": true,
+   *       "name": "Workflow 1",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "startPointLayout": {
+   *         "x": -100.00030899047852,
+   *         "y": -153.00020599365234
+   *       },
+   *       "statuses": [
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 114.99993896484375,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10001"
+   *         },
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 317.0000915527344,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10002"
+   *         },
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 508.000244140625,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10003"
+   *         }
+   *       ],
+   *       "transitions": [
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "31",
+   *           "name": "Done",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10003"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "11",
+   *           "name": "To Do",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10001"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "21",
+   *           "name": "In Progress",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10002"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "1",
+   *           "name": "Create",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10001"
+   *           },
+   *           "triggers": [],
+   *           "type": "INITIAL",
+   *           "validators": []
+   *         }
+   *       ],
+   *       "usages": [],
+   *       "version": {
+   *         "id": "f010ac1b-3dd3-43a3-aa66-0ee8a447f76e",
+   *         "versionNumber": 0
+   *       }
+   *     }
+   *   ]
+   * }
+   * @path {POST} /rest/api/3/workflows
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:workflow:jira
+   */
+  readWorkflows({
+    expand,
+    workflowReadRequest,
+  }: {
+    /**
+     * 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
+     * is associated with.
+     *  *  `statuses.usages` Returns the project and issue types that each status is
+     * associated with.
+     */
+    expand?: string;
+    /**
+     * @example {
+     *     "projectAndIssueTypes": [],
+     *     "workflowIds": [],
+     *     "workflowNames": [
+     *         "Workflow 1",
+     *         "Workflow 2"
+     *     ]
+     * }
+     */
+    workflowReadRequest: WorkflowReadRequest;
+  }): Promise<WorkflowReadResponse> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflows",
+        method: "POST",
+        query: {
+          expand,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: workflowReadRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowReadResponse;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.readWorkflows.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Update workflows and related statuses.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* project permission to create all, including
+   * global-scoped, workflows
+   *  *  *Administer projects* project permissions to create project-scoped workflows
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "statuses": [
+   *     {
+   *       "description": "",
+   *       "id": "10001",
+   *       "name": "To Do",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "TODO",
+   *       "statusReference": "10001",
+   *       "usages": []
+   *     },
+   *     {
+   *       "description": "",
+   *       "id": "10002",
+   *       "name": "In Progress",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "IN_PROGRESS",
+   *       "statusReference": "10002",
+   *       "usages": []
+   *     },
+   *     {
+   *       "description": "",
+   *       "id": "10003",
+   *       "name": "Done",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "statusCategory": "DONE",
+   *       "statusReference": "10003",
+   *       "usages": []
+   *     }
+   *   ],
+   *   "taskId": "10001",
+   *   "workflows": [
+   *     {
+   *       "description": "",
+   *       "id": "b9ff2384-d3b6-4d4e-9509-3ee19f607168",
+   *       "isEditable": true,
+   *       "name": "Software workflow 1",
+   *       "scope": {
+   *         "type": "GLOBAL"
+   *       },
+   *       "startPointLayout": {
+   *         "x": -100.00030899047852,
+   *         "y": -153.00020599365234
+   *       },
+   *       "statuses": [
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 114.99993896484375,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10001"
+   *         },
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 317.0000915527344,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10002"
+   *         },
+   *         {
+   *           "deprecated": false,
+   *           "layout": {
+   *             "x": 508.000244140625,
+   *             "y": -16
+   *           },
+   *           "properties": {},
+   *           "statusReference": "10003"
+   *         }
+   *       ],
+   *       "transitions": [
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "31",
+   *           "name": "Done",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10003"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "11",
+   *           "name": "To Do",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10001"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "21",
+   *           "name": "In Progress",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10002"
+   *           },
+   *           "triggers": [],
+   *           "type": "GLOBAL",
+   *           "validators": []
+   *         },
+   *         {
+   *           "actions": [],
+   *           "description": "",
+   *           "from": [],
+   *           "id": "1",
+   *           "name": "Create",
+   *           "properties": {},
+   *           "to": {
+   *             "statusReference": "10001"
+   *           },
+   *           "triggers": [],
+   *           "type": "INITIAL",
+   *           "validators": []
+   *         }
+   *       ],
+   *       "usages": [],
+   *       "version": {
+   *         "id": "f010ac1b-3dd3-43a3-aa66-0ee8a447f76e",
+   *         "versionNumber": 0
+   *       }
+   *     }
+   *   ]
+   * }
+   * @path {POST} /rest/api/3/workflows/update
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  updateWorkflows({
+    expand,
+    workflowUpdateRequest,
+  }: {
+    /**
+     * 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
+     * is associated with.
+     *  *  `statuses.usages` Returns the project and issue types that each status is
+     * associated with.
+     */
+    expand?: string;
+    /**
+     * @example {
+     *     "statuses": [
+     *         {
+     *             "description": "",
+     *             "name": "To Do",
+     *             "statusCategory": "TODO",
+     *             "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *         },
+     *         {
+     *             "description": "",
+     *             "name": "In Progress",
+     *             "statusCategory": "IN_PROGRESS",
+     *             "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *         },
+     *         {
+     *             "description": "",
+     *             "name": "Done",
+     *             "statusCategory": "DONE",
+     *             "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *         }
+     *     ],
+     *     "workflows": [
+     *         {
+     *             "defaultStatusMappings": [
+     *                 {
+     *                     "newStatusReference": "10011",
+     *                     "oldStatusReference": "10010"
+     *                 }
+     *             ],
+     *             "description": "",
+     *             "id": "10001",
+     *             "startPointLayout": {
+     *                 "x": -100.00030899047852,
+     *                 "y": -153.00020599365234
+     *             },
+     *             "statusMappings": [
+     *                 {
+     *                     "issueTypeId": "10002",
+     *                     "projectId": "10003",
+     *                     "statusMigrations": [
+     *                         {
+     *                             "newStatusReference": "10011",
+     *                             "oldStatusReference": "10010"
+     *                         }
+     *                     ]
+     *                 }
+     *             ],
+     *             "statuses": [
+     *                 {
+     *                     "layout": {
+     *                         "x": 114.99993896484375,
+     *                         "y": -16
+     *                     },
+     *                     "properties": {},
+     *                     "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                 },
+     *                 {
+     *                     "layout": {
+     *                         "x": 317.0000915527344,
+     *                         "y": -16
+     *                     },
+     *                     "properties": {},
+     *                     "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                 },
+     *                 {
+     *                     "layout": {
+     *                         "x": 508.000244140625,
+     *                         "y": -16
+     *                     },
+     *                     "properties": {},
+     *                     "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                 }
+     *             ],
+     *             "transitions": [
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "1",
+     *                     "name": "Create",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "INITIAL",
+     *                     "validators": []
+     *                 },
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "11",
+     *                     "name": "To Do",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "GLOBAL",
+     *                     "validators": []
+     *                 },
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "21",
+     *                     "name": "In Progress",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "GLOBAL",
+     *                     "validators": []
+     *                 },
+     *                 {
+     *                     "actions": [],
+     *                     "description": "",
+     *                     "from": [],
+     *                     "id": "31",
+     *                     "name": "Done",
+     *                     "properties": {},
+     *                     "to": {
+     *                         "statusReference":
+     * "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                     },
+     *                     "triggers": [],
+     *                     "type": "GLOBAL",
+     *                     "validators": []
+     *                 }
+     *             ],
+     *             "version": {
+     *                 "id": "6f6c988b-2590-4358-90c2-5f7960265592",
+     *                 "versionNumber": 1
+     *             }
+     *         }
+     *     ]
+     * }
+     */
+    workflowUpdateRequest: WorkflowUpdateRequest;
+  }): Promise<WorkflowUpdateResponse> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflows/update",
+        method: "POST",
+        query: {
+          expand,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: workflowUpdateRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowUpdateResponse;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.updateWorkflows.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Validate the payload for bulk create workflows.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* project permission to create all, including
+   * global-scoped, workflows
+   *  *  *Administer projects* project permissions to create project-scoped workflows
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "errors": [
+   *     {
+   *       "code": "NON_UNIQUE_STATUS_NAME",
+   *       "elementReference": {
+   *         "statusReference": "1f0443ff-47e4-4306-9c26-0af696059a43"
+   *       },
+   *       "level": "ERROR",
+   *       "message": "You must use a unique status name.",
+   *       "type": "STATUS"
+   *     }
+   *   ]
+   * }
+   * @path {POST} /rest/api/3/workflows/create/validation
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  validateCreateWorkflows({
+    workflowCreateValidateRequest,
+  }: {
+    /**
+     * @example {
+     *     "payload": {
+     *         "scope": {
+     *             "type": "GLOBAL"
+     *         },
+     *         "statuses": [
+     *             {
+     *                 "description": "",
+     *                 "name": "To Do",
+     *                 "statusCategory": "TODO",
+     *                 "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *             },
+     *             {
+     *                 "description": "",
+     *                 "name": "In Progress",
+     *                 "statusCategory": "IN_PROGRESS",
+     *                 "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *             },
+     *             {
+     *                 "description": "",
+     *                 "name": "Done",
+     *                 "statusCategory": "DONE",
+     *                 "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *             }
+     *         ],
+     *         "workflows": [
+     *             {
+     *                 "description": "",
+     *                 "name": "Software workflow 1",
+     *                 "startPointLayout": {
+     *                     "x": -100.00030899047852,
+     *                     "y": -153.00020599365234
+     *                 },
+     *                 "statuses": [
+     *                     {
+     *                         "layout": {
+     *                             "x": 114.99993896484375,
+     *                             "y": -16
+     *                         },
+     *                         "properties": {},
+     *                         "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                     },
+     *                     {
+     *                         "layout": {
+     *                             "x": 317.0000915527344,
+     *                             "y": -16
+     *                         },
+     *                         "properties": {},
+     *                         "statusReference":
+     * "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                     },
+     *                     {
+     *                         "layout": {
+     *                             "x": 508.000244140625,
+     *                             "y": -16
+     *                         },
+     *                         "properties": {},
+     *                         "statusReference":
+     * "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                     }
+     *                 ],
+     *                 "transitions": [
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "1",
+     *                         "name": "Create",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "INITIAL",
+     *                         "validators": []
+     *                     },
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "11",
+     *                         "name": "To Do",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "GLOBAL",
+     *                         "validators": []
+     *                     },
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "21",
+     *                         "name": "In Progress",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "GLOBAL",
+     *                         "validators": []
+     *                     },
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "31",
+     *                         "name": "Done",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "GLOBAL",
+     *                         "validators": []
+     *                     }
+     *                 ]
+     *             }
+     *         ]
+     *     },
+     *     "validationOptions": {
+     *         "levels": [
+     *             "ERROR",
+     *             "WARNING"
+     *         ]
+     *     }
+     * }
+     */
+    workflowCreateValidateRequest: WorkflowCreateValidateRequest;
+  }): Promise<WorkflowValidationErrorList> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflows/create/validation",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: workflowCreateValidateRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowValidationErrorList;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.validateCreateWorkflows.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Validate the payload for bulk update workflows.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* project permission to create all, including
+   * global-scoped, workflows
+   *  *  *Administer projects* project permissions to create project-scoped workflows
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "errors": [
+   *     {
+   *       "code": "NON_UNIQUE_STATUS_NAME",
+   *       "elementReference": {
+   *         "statusReference": "1f0443ff-47e4-4306-9c26-0af696059a43"
+   *       },
+   *       "level": "ERROR",
+   *       "message": "You must use a unique status name.",
+   *       "type": "STATUS"
+   *     }
+   *   ]
+   * }
+   * @path {POST} /rest/api/3/workflows/update/validation
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  validateUpdateWorkflows({
+    workflowUpdateValidateRequestBean,
+  }: {
+    /**
+     * @example {
+     *     "payload": {
+     *         "statuses": [
+     *             {
+     *                 "description": "",
+     *                 "name": "To Do",
+     *                 "statusCategory": "TODO",
+     *                 "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *             },
+     *             {
+     *                 "description": "",
+     *                 "name": "In Progress",
+     *                 "statusCategory": "IN_PROGRESS",
+     *                 "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *             },
+     *             {
+     *                 "description": "",
+     *                 "name": "Done",
+     *                 "statusCategory": "DONE",
+     *                 "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *             }
+     *         ],
+     *         "workflows": [
+     *             {
+     *                 "defaultStatusMappings": [
+     *                     {
+     *                         "newStatusReference": "10011",
+     *                         "oldStatusReference": "10010"
+     *                     }
+     *                 ],
+     *                 "description": "",
+     *                 "id": "10001",
+     *                 "startPointLayout": {
+     *                     "x": -100.00030899047852,
+     *                     "y": -153.00020599365234
+     *                 },
+     *                 "statusMappings": [
+     *                     {
+     *                         "issueTypeId": "10002",
+     *                         "projectId": "10003",
+     *                         "statusMigrations": [
+     *                             {
+     *                                 "newStatusReference": "10011",
+     *                                 "oldStatusReference": "10010"
+     *                             }
+     *                         ]
+     *                     }
+     *                 ],
+     *                 "statuses": [
+     *                     {
+     *                         "layout": {
+     *                             "x": 114.99993896484375,
+     *                             "y": -16
+     *                         },
+     *                         "properties": {},
+     *                         "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                     },
+     *                     {
+     *                         "layout": {
+     *                             "x": 317.0000915527344,
+     *                             "y": -16
+     *                         },
+     *                         "properties": {},
+     *                         "statusReference":
+     * "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                     },
+     *                     {
+     *                         "layout": {
+     *                             "x": 508.000244140625,
+     *                             "y": -16
+     *                         },
+     *                         "properties": {},
+     *                         "statusReference":
+     * "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                     }
+     *                 ],
+     *                 "transitions": [
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "1",
+     *                         "name": "Create",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "INITIAL",
+     *                         "validators": []
+     *                     },
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "11",
+     *                         "name": "To Do",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "GLOBAL",
+     *                         "validators": []
+     *                     },
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "21",
+     *                         "name": "In Progress",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "GLOBAL",
+     *                         "validators": []
+     *                     },
+     *                     {
+     *                         "actions": [],
+     *                         "description": "",
+     *                         "from": [],
+     *                         "id": "31",
+     *                         "name": "Done",
+     *                         "properties": {},
+     *                         "to": {
+     *                             "statusReference":
+     * "6b3fc04d-3316-46c5-a257-65751aeb8849"
+     *                         },
+     *                         "triggers": [],
+     *                         "type": "GLOBAL",
+     *                         "validators": []
+     *                     }
+     *                 ],
+     *                 "version": {
+     *                     "id": "6f6c988b-2590-4358-90c2-5f7960265592",
+     *                     "versionNumber": 1
+     *                 }
+     *             }
+     *         ]
+     *     },
+     *     "validationOptions": {
+     *         "levels": [
+     *             "ERROR",
+     *             "WARNING"
+     *         ]
+     *     }
+     * }
+     */
+    workflowUpdateValidateRequestBean: WorkflowUpdateValidateRequestBean;
+  }): Promise<WorkflowValidationErrorList> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflows/update/validation",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: workflowUpdateValidateRequestBean,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowValidationErrorList;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.validateUpdateWorkflows.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Get the list of workflow capabilities for a specific workflow using either the
+   * workflow ID, or the project and issue type ID pair. The response includes the
+   * scope of the workflow, defined as global/project-based, and a list of project
+   * types that the workflow is scoped to. It also includes all rules organised into
+   * their broad categories (conditions, validators, actions, triggers, screens) as
+   * well as the source location (Atlassian-provided, Connect, Forge).
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* project permission to access all, including
+   * global-scoped, workflows
+   *  *  *Administer projects* project permissions to access project-scoped workflows
+   *
+   * The current list of Atlassian-provided rules:
+   *
+   * #### Validators ####
+   *
+   * A validator rule that checks if a user has the required permissions to execute
+   * the transition in the workflow.
+   *
+   * ##### Permission validator #####
+   *
+   * A validator rule that checks if a user has the required permissions to execute
+   * the transition in the workflow.
+   *
+   *     {
+   *        "ruleKey": "system:check-permission-validator",
+   *        "parameters": {
+   *          "permissionKey": "ADMINISTER_PROJECTS"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `permissionKey` The permission required to perform the transition. Allowed
+   * values: [built-in Jira
+   * permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions).
+   *
+   * ##### Parent or child blocking validator #####
+   *
+   * A validator to block the child issue\\u2019s transition depending on the parent
+   * issue\\u2019s status.
+   *
+   *     {
+   *        "ruleKey" : "system:parent-or-child-blocking-validator"
+   *        "parameters" : {
+   *          "blocker" : "PARENT"
+   *          "statusIds" : "1,2,3"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `blocker` currently only supports `PARENT`.
+   *  *  `statusIds` a comma-separated list of status IDs.
+   *
+   * ##### Previous status validator #####
+   *
+   * A validator that checks if an issue has transitioned through specified previous
+   * status(es) before allowing the current transition to occur.
+   *
+   *     {
+   *        "ruleKey": "system:previous-status-validator",
+   *        "parameters": {
+   *          "previousStatusIds": "10014",
+   *          "mostRecentStatusOnly": "true"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `previousStatusIds` a comma-separated list of status IDs, currently only
+   * support one ID.
+   *  *  `mostRecentStatusOnly` when `true` only considers the most recent status
+   * for the condition evaluation. Allowed values: `true`, `false`.
+   *
+   * ##### Validate a field value #####
+   *
+   * A validation that ensures a specific field's value meets the defined criteria
+   * before allowing an issue to transition in the workflow.
+   *
+   * Depending on the rule type, the result will vary:
+   *
+   * ###### Field required ######
+   *
+   *     {
+   *        "ruleKey": "system:validate-field-value",
+   *        "parameters": {
+   *          "ruleType": "fieldRequired",
+   *          "fieldsRequired": "assignee",
+   *          "ignoreContext": "true",
+   *          "errorMessage": "An assignee must be set!"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `fieldsRequired` the ID of the field that is required. For a custom field,
+   * it would look like `customfield_123`.
+   *  *  `ignoreContext` controls the impact of context settings on field
+   * validation. When set to `true`, the validator doesn't check a required field if
+   * its context isn't configured for the current issue. When set to `false`, the
+   * validator requires a field even if its context is invalid. Allowed values:
+   * `true`, `false`.
+   *  *  `errorMessage` is the error message to display if the user does not provide
+   * a value during the transition. A default error message will be shown if you
+   * don't provide one (Optional).
+   *
+   * ###### Field changed ######
+   *
+   *     {
+   *        "ruleKey": "system:validate-field-value",
+   *        "parameters": {
+   *          "ruleType": "fieldChanged",
+   *          "groupsExemptFromValidation": "6862ac20-8672-4f68-896d-4854f5efb79e",
+   *          "fieldKey": "versions",
+   *          "errorMessage": "Affect versions must be modified before transition"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `groupsExemptFromValidation` a comma-separated list of group IDs to be
+   * exempt from the validation.
+   *  *  `fieldKey` the ID of the field that has changed. For a custom field, it
+   * would look like `customfield_123`.
+   *  *  `errorMessage` the error message to display if the user does not provide a
+   * value during the transition. A default error message will be shown if you don't
+   * provide one (Optional).
+   *
+   * ###### Field has a single value ######
+   *
+   *     {
+   *        "ruleKey": "system:validate-field-value",
+   *        "parameters": {
+   *          "ruleType": "fieldHasSingleValue",
+   *          "fieldKey": "created",
+   *          "excludeSubtasks": "true"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `fieldKey` the ID of the field to validate. For a custom field, it would
+   * look like `customfield_123`.
+   *  *  `excludeSubtasks` Option to exclude values copied from sub-tasks. Allowed
+   * values: `true`, `false`.
+   *
+   * ###### Field matches regular expression ######
+   *
+   *     {
+   *        "ruleKey": "system:validate-field-value",
+   *        "parameters": {
+   *          "ruleType": "fieldMatchesRegularExpression",
+   *          "regexp": "[0-9]{4}",
+   *          "fieldKey": "description"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `regexp` the regular expression used to validate the field\\u2019s content.
+   *  *  `fieldKey` the ID of the field to validate. For a custom field, it would
+   * look like `customfield_123`.
+   *
+   * ###### Date field comparison ######
+   *
+   *     {
+   *        "ruleKey": "system:validate-field-value",
+   *        "parameters": {
+   *          "ruleType": "dateFieldComparison",
+   *          "date1FieldKey": "duedate",
+   *          "date2FieldKey": "customfield_10054",
+   *          "includeTime": "true",
+   *          "conditionSelected": ">="
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `date1FieldKey` the ID of the first field to compare. For a custom field,
+   * it would look like `customfield_123`.
+   *  *  `date2FieldKey` the ID of the second field to compare. For a custom field,
+   * it would look like `customfield_123`.
+   *  *  `includeTime` if `true`, compares both date and time. Allowed values:
+   * `true`, `false`.
+   *  *  `conditionSelected` the condition to compare with. Allowed values: `>`,
+   * `>=`, `=`, `<=`, `<`, `!=`.
+   *
+   * ###### Date range comparison ######
+   *
+   *     {
+   *        "ruleKey": "system:validate-field-value",
+   *        "parameters": {
+   *          "ruleType": "windowDateComparison",
+   *          "date1FieldKey": "customfield_10009",
+   *          "date2FieldKey": "customfield_10054",
+   *          "numberOfDays": "3"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `date1FieldKey` the ID of the first field to compare. For a custom field,
+   * it would look like `customfield_123`.
+   *  *  `date2FieldKey` the ID of the second field to compare. For a custom field,
+   * it would look like `customfield_123`.
+   *  *  `numberOfDays` maximum number of days past the reference date
+   * (`date2FieldKey`) to pass validation.
+   *
+   * This rule is composed by aggregating the following legacy rules:
+   *
+   *  *  FieldRequiredValidator
+   *  *  FieldChangedValidator
+   *  *  FieldHasSingleValueValidator
+   *  *  RegexpFieldValidator
+   *  *  DateFieldValidator
+   *  *  WindowsDateValidator
+   *
+   * ##### Proforma: Forms attached validator #####
+   *
+   * Validates that one or more forms are attached to the issue.
+   *
+   *     {
+   *        "ruleKey" : "system:proforma-forms-attached"
+   *        "parameters" : {}
+   *      }
+   *
+   * ##### Proforma: Forms submitted validator #####
+   *
+   * Validates that all forms attached to the issue have been submitted.
+   *
+   *     {
+   *        "ruleKey" : "system:proforma-forms-submitted"
+   *        "parameters" : {}
+   *      }
+   *
+   * #### Conditions ####
+   *
+   * Conditions enable workflow rules that govern whether a transition can execute.
+   *
+   * ##### Check field value #####
+   *
+   * A condition rule evaluates as true if a specific field's value meets the
+   * defined criteria. This rule ensures that an issue can only transition to the
+   * next step in the workflow if the field's value matches the desired condition.
+   *
+   *     {
+   *        "ruleKey": "system:check-field-value",
+   *        "parameters": {
+   *          "fieldId": "description",
+   *          "fieldValue": "[\"Done\"]",
+   *          "comparator": "=",
+   *          "comparisonType": "STRING"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `fieldId` The ID of the field to check the value of. For non-system fields,
+   * it will look like `customfield_123`. Note: `fieldId` is used interchangeably
+   * with the idea of `fieldKey` here, they refer to the same field.
+   *  *  `fieldValue` the list of values to check against the field\\u2019s value.
+   *  *  `comparator` The comparison logic. Allowed values: `>`, `>=`, `=`, `<=`,
+   * `<`, `!=`.
+   *  *  `comparisonType` The type of data being compared. Allowed values: `STRING`,
+   * `NUMBER`, `DATE`, `DATE_WITHOUT_TIME`, `OPTIONID`.
+   *
+   * ##### Restrict issue transition #####
+   *
+   * This rule ensures that issue transitions are restricted based on user accounts,
+   * roles, group memberships, and permissions, maintaining control over who can
+   * transition an issue. This condition evaluates as `true` if any of the following
+   * criteria is met.
+   *
+   *     {
+   *        "ruleKey": "system:restrict-issue-transition",
+   *        "parameters": {
+   *          "accountIds": "allow-reporter,5e68ac137d64450d01a77fa0",
+   *          "roleIds": "10002,10004",
+   *          "groupIds": "703ff44a-7dc8-4f4b-9aa6-a65bf3574fa4",
+   *          "permissionKeys": "ADMINISTER_PROJECTS",
+   *          "groupCustomFields": "customfield_10028",
+   *          "allowUserCustomFields":
+   * "customfield_10072,customfield_10144,customfield_10007",
+   *          "denyUserCustomFields": "customfield_10107"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `accountIds` a comma-separated list of the user account IDs. It also allows
+   * generic values like: `allow-assignee`, `allow-reporter`, and `accountIds` Note:
+   * This is only supported in team-managed projects
+   *  *  `roleIds` a comma-separated list of role IDs.
+   *  *  `groupIds` a comma-separated list of group IDs.
+   *  *  `permissionKeys` a comma-separated list of permission keys. Allowed values:
+   * [built-in Jira
+   * permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions).
+   *  *  `groupCustomFields` a comma-separated list of group custom field IDs.
+   *  *  `allowUserCustomFields` a comma-separated list of user custom field IDs to
+   * allow for issue transition.
+   *  *  `denyUserCustomFields` a comma-separated list of user custom field IDs to
+   * deny for issue transition.
+   *
+   * This rule is composed by aggregating the following legacy rules:
+   *
+   *  *  AllowOnlyAssignee
+   *  *  AllowOnlyReporter
+   *  *  InAnyProjectRoleCondition
+   *  *  InProjectRoleCondition
+   *  *  UserInAnyGroupCondition
+   *  *  UserInGroupCondition
+   *  *  PermissionCondtion
+   *  *  InGroupCFCondition
+   *  *  UserIsInCustomFieldCondition
+   *
+   * ##### Previous status condition #####
+   *
+   * A condition that evaluates based on an issue's previous status(es) and specific
+   * criteria.
+   *
+   *     {
+   *        "ruleKey" : "system:previous-status-condition"
+   *        "parameters" : {
+   *          "previousStatusIds" : "10004",
+   *          "not": "true",
+   *          "mostRecentStatusOnly" : "true",
+   *          "includeCurrentStatus": "true",
+   *          "ignoreLoopTransitions": "true"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `previousStatusIds` a comma-separated list of status IDs, current only
+   * support one ID.
+   *  *  `not` indicates if the condition should be reversed. When `true` it checks
+   * that the issue has not been in the selected statuses. Allowed values: `true`,
+   * `false`.
+   *  *  `mostRecentStatusOnly` when true only considers the most recent status for
+   * the condition evaluation. Allowed values: `true`, `false`.
+   *  *  `includeCurrentStatus` includes the current status when evaluating if the
+   * issue has been through the selected statuses. Allowed values: `true`, `false`.
+   *  *  `ignoreLoopTransitions` ignore loop transitions. Allowed values: `true`,
+   * `false`.
+   *
+   * ##### Parent or child blocking condition #####
+   *
+   * A condition to block the parent\\u2019s issue transition depending on the
+   * child\\u2019s issue status.
+   *
+   *     {
+   *        "ruleKey" : "system:parent-or-child-blocking-condition"
+   *        "parameters" : {
+   *          "blocker" : "CHILD",
+   *          "statusIds" : "1,2,3"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `blocker` currently only supports `CHILD`.
+   *  *  `statusIds` a comma-separated list of status IDs.
+   *
+   * ##### Separation of duties #####
+   *
+   * A condition preventing the user from performing, if the user has already
+   * performed a transition on the issue.
+   *
+   *     {
+   *        "ruleKey": "system:separation-of-duties",
+   *        "parameters": {
+   *          "fromStatusId": "10161",
+   *          "toStatusId": "10160"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `fromStatusId` represents the status ID from which the issue is
+   * transitioning. It ensures that the user performing the current transition has
+   * not performed any actions when the issue was in the specified status.
+   *  *  `toStatusId` represents the status ID to which the issue is transitioning.
+   * It ensures that the user performing the current transition is not the same user
+   * who has previously transitioned the issue.
+   *
+   * ##### Restrict transitions #####
+   *
+   * A condition preventing all users from transitioning the issue can also
+   * optionally include APIs as well.
+   *
+   *     {
+   *        "ruleKey": "system:restrict-from-all-users",
+   *        "parameters": {
+   *          "restrictMode": "users"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `restrictMode` restricts the issue transition including/excluding APIs.
+   * Allowed values: `"users"`, `"usersAndAPI"`.
+   *
+   * ##### Jira Service Management block until approved #####
+   *
+   * Block an issue transition until approval. Note: This is only supported in
+   * team-managed projects.
+   *
+   *     {
+   *        "ruleKey": "system:jsd-approvals-block-until-approved",
+   *        "parameters": {
+   *          "approvalConfigurationJson": "{"statusExternalUuid...}"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `approvalConfigurationJson` a stringified JSON holding the Jira Service
+   * Management approval configuration.
+   *
+   * ##### Jira Service Management block until rejected #####
+   *
+   * Block an issue transition until rejected. Note: This is only supported in
+   * team-managed projects.
+   *
+   *     {
+   *        "ruleKey": "system:jsd-approvals-block-until-rejected",
+   *        "parameters": {
+   *          "approvalConfigurationJson": "{"statusExternalUuid...}"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `approvalConfigurationJson` a stringified JSON holding the Jira Service
+   * Management approval configuration.
+   *
+   * ##### Block in progress approval #####
+   *
+   * Condition to block issue transition if there is pending approval. Note: This is
+   * only supported in company-managed projects.
+   *
+   *     {
+   *        "ruleKey": "system:block-in-progress-approval",
+   *        "parameters": {}
+   *      }
+   *
+   * #### Post functions ####
+   *
+   * Post functions carry out any additional processing required after a workflow
+   * transition is executed.
+   *
+   * ##### Change assignee #####
+   *
+   * A post function rule that changes the assignee of an issue after a transition.
+   *
+   *     {
+   *        "ruleKey": "system:change-assignee",
+   *        "parameters": {
+   *          "type": "to-selected-user",
+   *          "accountId": "example-account-id"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `type` the parameter used to determine the new assignee. Allowed values:
+   * `to-selected-user`, `to-unassigned`, `to-current-user`, `to-current-user`,
+   * `to-default-user`, `to-default-user`
+   *  *  `accountId` the account ID of the user to assign the issue to. This
+   * parameter is required only when the type is `"to-selected-user"`.
+   *
+   * ##### Copy field value #####
+   *
+   * A post function that automates the process of copying values between fields
+   * during a specific transition, ensuring data consistency and reducing manual
+   * effort.
+   *
+   *     {
+   *        "ruleKey": "system:copy-value-from-other-field",
+   *        "parameters": {
+   *          "sourceFieldKey": "description",
+   *          "targetFieldKey": "components",
+   *          "issueSource": "SAME"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `sourceFieldKey` the field key to copy from. For a custom field, it would
+   * look like `customfield_123`
+   *  *  `targetFieldKey` the field key to copy to. For a custom field, it would
+   * look like `customfield_123`
+   *  *  `issueSource` `SAME` or `PARENT`. Defaults to `SAME` if no value is
+   * provided.
+   *
+   * ##### Update field #####
+   *
+   * A post function that updates or appends a specific field with the given value.
+   *
+   *     {
+   *        "ruleKey": "system:update-field",
+   *        "parameters": {
+   *          "field": "customfield_10056",
+   *          "value": "asdf",
+   *          "mode": "append"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `field` the ID of the field to update. For a custom field, it would look
+   * like `customfield_123`
+   *  *  `value` the value to update the field with.
+   *  *  `mode` `append` or `replace`. Determines if a value will be appended to the
+   * current value, or if the current value will be replaced.
+   *
+   * ##### Trigger webhook #####
+   *
+   * A post function that automatically triggers a predefined webhook when a
+   * transition occurs in the workflow.
+   *
+   *     {
+   *        "ruleKey": "system:trigger-webhook",
+   *        "parameters": {
+   *          "webhookId": "1"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `webhookId` the ID of the webhook.
+   *
+   * #### Screen ####
+   *
+   * ##### Remind people to update fields #####
+   *
+   * A screen rule that prompts users to update a specific field when they interact
+   * with an issue screen during a transition. This rule is useful for ensuring that
+   * users provide or modify necessary information before moving an issue to the
+   * next step in the workflow.
+   *
+   *     {
+   *        "ruleKey": "system:remind-people-to-update-fields",
+   *        "params": {
+   *          "remindingFieldIds": "assignee,customfield_10025",
+   *          "remindingMessage": "The message",
+   *          "remindingAlwaysAsk": "true"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `remindingFieldIds` a comma-separated list of field IDs. Note: `fieldId` is
+   * used interchangeably with the idea of `fieldKey` here, they refer to the same
+   * field.
+   *  *  `remindingMessage` the message to display when prompting the users to
+   * update the fields.
+   *  *  `remindingAlwaysAsk` always remind to update fields. Allowed values:
+   * `true`, `false`.
+   *
+   * ##### Shared transition screen #####
+   *
+   * A common screen that is shared between transitions in a workflow.
+   *
+   *     {
+   *        "ruleKey": "system:transition-screen",
+   *        "params": {
+   *          "screenId": "3"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `screenId` the ID of the screen.
+   *
+   * #### Connect & Forge ####
+   *
+   * ##### Connect rules #####
+   *
+   * Validator/Condition/Post function for Connect app.
+   *
+   *     {
+   *        "ruleKey": "connect:expression-validator",
+   *        "parameters": {
+   *          "appKey": "com.atlassian.app",
+   *          "config": "",
+   *          "id": "90ce590f-e90c-4cd3-8281-165ce41f2ac3",
+   *          "disabled": "false",
+   *          "tag": ""
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `ruleKey` Validator: `connect:expression-validator`, Condition:
+   * `connect:expression-condition`, and Post function:
+   * `connect:remote-workflow-function`
+   *  *  `appKey` the reference to the Connect app
+   *  *  `config` a JSON payload string describing the configuration
+   *  *  `id` the ID of the rule
+   *  *  `disabled` determine if the Connect app is disabled. Allowed values:
+   * `true`, `false`.
+   *  *  `tag` additional tags for the Connect app
+   *
+   * ##### Forge rules #####
+   *
+   * Validator/Condition/Post function for Forge app.
+   *
+   *     {
+   *        "ruleKey": "forge:expression-validator",
+   *        "parameters": {
+   *          "key":
+   * "ari:cloud:ecosystem::extension/{appId}/{environmentId}/static/{moduleKey}",
+   *          "config": "{"searchString":"workflow validator"}",
+   *          "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2"
+   *        }
+   *      }
+   *
+   * Parameters:
+   *
+   *  *  `ruleKey` Validator: `forge:expression-validator`, Condition:
+   * `forge:expression-condition`, and Post function: `forge:workflow-post-function`
+   *  *  `key` the identifier for the Forge app
+   *  *  `config` the persistent stringified JSON configuration for the Forge rule
+   *  *  `id` the ID of the Forge rule
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "connectRules": [
+   *     {
+   *       "addonKey": "com.atlassian.jira.refapp",
+   *       "createUrl": "/validators/jira-expression/create?id={validator.id}",
+   *       "description": "Validates if the given Jira expression is true.",
+   *       "editUrl": "/validators/jira-expression/edit?id={validator.id}",
+   *       "moduleKey": "jiraExpressionValidator",
+   *       "name": "Jira expression validator (by APPNAME)",
+   *       "ruleKey": "connect:expression-validator",
+   *       "ruleType": "Validator",
+   *       "viewUrl": "/validators/jira-expression/view?id={validator.id}"
+   *     }
+   *   ],
+   *   "editorScope": "GLOBAL",
+   *   "forgeRules": [
+   *     {
+   *       "description": "A Jira workflow validator example.",
+   *       "id":
+   * "ari:cloud:ecosystem::extension/9df6d15f-1bbe-443e-be08-150309e8dbb0/f6a3bed3-737f-4e7a-8942-130df302b749/static/workflow-validator-example-workflow-validator",
+   *       "name": "workflow-validator",
+   *       "ruleKey": "forge:expression-validator",
+   *       "ruleType": "Validator"
+   *     }
+   *   ],
+   *   "projectTypes": [
+   *     "software",
+   *     "business"
+   *   ],
+   *   "systemRules": [
+   *     {
+   *       "description": "Automatically assign a request to someone after moving
+   * the request using a particular transition.",
+   *       "incompatibleRuleKeys": [],
+   *       "isAvailableForInitialTransition": true,
+   *       "isVisible": true,
+   *       "name": "Assign a request",
+   *       "ruleKey": "system:change-assignee",
+   *       "ruleType": "Function"
+   *     }
+   *   ],
+   *   "triggerRules": [
+   *     {
+   *       "availableTypes": [
+   *         {
+   *           "description": "Automatically transitions the issue when a related
+   * branch is created in a connected repository",
+   *           "name": "Branch created",
+   *           "type":
+   * "com.atlassian.jira.plugins.jira-development-integration-plugin:branch-created-trigger"
+   *         }
+   *       ],
+   *       "ruleKey": "system:development-triggers"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/workflows/capabilities
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:workflow:jira
+   */
+  workflowCapabilities({
+    workflowId,
+    projectId,
+    issueTypeId,
+  }: {
+    workflowId?: string;
+    projectId?: string;
+    issueTypeId?: string;
+  }): Promise<WorkflowCapabilities> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/workflows/capabilities",
+        method: "GET",
+        query: {
+          workflowId,
+          projectId,
+          issueTypeId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: WorkflowCapabilities;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "WorkflowsService.workflowCapabilities.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.getAllWorkflows.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("DeprecatedWorkflow")),
+        })
+        .describe("WorkflowsService.getAllWorkflows.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.createWorkflow.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowIds"),
+        })
+        .describe("WorkflowsService.createWorkflow.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.getWorkflowsPaginated.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PageBeanWorkflow"),
+        })
+        .describe("WorkflowsService.getWorkflowsPaginated.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.readWorkflows.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowReadResponse"),
+        })
+        .describe("WorkflowsService.readWorkflows.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.workflowCapabilities.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowCapabilities"),
+        })
+        .describe("WorkflowsService.workflowCapabilities.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.createWorkflows.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowCreateResponse"),
+        })
+        .describe("WorkflowsService.createWorkflows.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.validateCreateWorkflows.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowValidationErrorList"),
+        })
+        .describe("WorkflowsService.validateCreateWorkflows.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.updateWorkflows.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowUpdateResponse"),
+        })
+        .describe("WorkflowsService.updateWorkflows.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "WorkflowsService.validateUpdateWorkflows.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("WorkflowValidationErrorList"),
+        })
+        .describe("WorkflowsService.validateUpdateWorkflows.response"),
+    );
+    validationSchemaStorage.registerOnce([registerWorkflowsValidationSchemas]);
+  }
+}