@resolution/jira-api-client 0.5.2 → 0.5.4

package/lib/openapi/platform/services/WorkflowsService.js

@@ -5,8 +5,8 @@ exports.WorkflowsService = void 0;
 // This file is generated by "api-typescript-generator".
 // To update this file run "yarn build:openapi".
 const zod_1 = require("zod");
-const commonHttpClient = require("../core/CommonHttpClient");
-const CommonHttpService_1 = require("../core/CommonHttpService");
+const commonHttpClient = require("../../core/CommonHttpClient");
+const CommonHttpService_1 = require("../../core/CommonHttpService");
 const workflows_1 = require("../models/workflows");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /**
@@ -38,32 +38,35 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Always false condition #####
          *
          * A condition that always fails.
-         *
-         *     {
-         *        "type": "AlwaysFalseCondition"
-         *      }
+         * ```
+         * {
+         *    "type": "AlwaysFalseCondition"
+         *  }
+         * ```
          *
          * ##### Block transition until approval #####
          *
          * A condition that blocks issue transition if there is a pending approval.
-         *
-         *     {
-         *        "type": "BlockInProgressApprovalCondition"
-         *      }
+         * ```
+         * {
+         *    "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
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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:
@@ -76,46 +79,51 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A condition that hides a transition from users. The transition can only be
          * triggered from a workflow function or REST API operation.
-         *
-         *     {
-         *        "type": "RemoteOnlyCondition"
-         *      }
+         * ```
+         * {
+         *    "type": "RemoteOnlyCondition"
+         *  }
+         * ```
          *
          * ##### Only assignee condition #####
          *
          * A condition that allows only the assignee to execute a transition.
-         *
-         *     {
-         *        "type": "AllowOnlyAssignee"
-         *      }
+         * ```
+         * {
+         *    "type": "AllowOnlyAssignee"
+         *  }
+         * ```
          *
          * ##### Only Bamboo notifications workflow condition (deprecated) #####
          *
          * A condition that makes the transition available only to Bamboo build
          * notifications.
-         *
-         *     {
-         *        "type": "OnlyBambooNotificationsCondition"
-         *      }
+         * ```
+         * {
+         *    "type": "OnlyBambooNotificationsCondition"
+         *  }
+         * ```
          *
          * ##### Only reporter condition #####
          *
          * A condition that allows only the reporter to execute a transition.
-         *
-         *     {
-         *        "type": "AllowOnlyReporter"
-         *      }
+         * ```
+         * {
+         *    "type": "AllowOnlyReporter"
+         *  }
+         * ```
          *
          * ##### Permission condition #####
          *
          * A condition that allows only users with a permission to execute a transition.
-         *
-         *     {
-         *        "type": "PermissionCondition",
-         *        "configuration": {
-         *            "permissionKey": "BROWSE_PROJECTS"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "PermissionCondition",
+         *    "configuration": {
+         *        "permissionKey": "BROWSE_PROJECTS"
+         *    }
+         *  }
+         * ```
          *
          *  *  `permissionKey` The permission required to perform the transition. Allowed
          * values:
@@ -126,19 +134,20 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *          }
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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,
@@ -156,18 +165,19 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *          }
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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
@@ -179,20 +189,21 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *            }
-         *          ]
+         * ```
+         * {
+         *    "type": "SubTaskBlockingCondition",
+         *    "configuration": {
+         *      "statuses": [
+         *        {
+         *          "id": "1"
+         *        },
+         *        {
+         *          "id": "3"
          *        }
-         *      }
+         *      ]
+         *    }
+         *  }
+         * ```
          *
          *  *  `statuses` A list of objects containing status IDs.
          *
@@ -200,16 +211,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *          ]
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "UserInAnyGroupCondition",
+         *    "configuration": {
+         *      "groups": [
+         *        "administrators",
+         *        "atlassian-addons-admin"
+         *      ]
+         *    }
+         *  }
+         * ```
          *
          *  *  `groups` A list of group names.
          *
@@ -217,26 +229,27 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *            }
-         *          ]
+         * ```
+         * {
+         *    "type": "InAnyProjectRoleCondition",
+         *    "configuration": {
+         *      "projectRoles": [
+         *        {
+         *          "id": "10002"
+         *        },
+         *        {
+         *          "id": "10003"
+         *        },
+         *        {
+         *          "id": "10012"
+         *        },
+         *        {
+         *          "id": "10013"
          *        }
-         *      }
+         *      ]
+         *    }
+         *  }
+         * ```
          *
          *  *  `projectRoles` A list of objects containing project role IDs.
          *
@@ -244,14 +257,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A condition that allows only users listed in a given custom field to execute
          * the transition.
-         *
-         *     {
-         *        "type": "UserIsInCustomFieldCondition",
-         *        "configuration": {
-         *          "allowUserInField": false,
-         *          "fieldId": "customfield_10010"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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`
@@ -261,13 +275,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### User is in group condition #####
          *
          * A condition that allows users belonging to a group to execute a transition.
-         *
-         *     {
-         *        "type": "UserInGroupCondition",
-         *        "configuration": {
-         *          "group": "administrators"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "UserInGroupCondition",
+         *    "configuration": {
+         *      "group": "administrators"
+         *    }
+         *  }
+         * ```
          *
          *  *  `group` The name of the group.
          *
@@ -275,13 +290,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A condition that allows users belonging to a group specified in a custom field
          * to execute a transition.
-         *
-         *     {
-         *        "type": "InGroupCFCondition",
-         *        "configuration": {
-         *          "fieldId": "customfield_10012"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "InGroupCFCondition",
+         *    "configuration": {
+         *      "fieldId": "customfield_10012"
+         *    }
+         *  }
+         * ```
          *
          *  *  `fieldId` The ID of the field. Allowed field types:
          *
@@ -296,15 +312,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### 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"
-         *          }
-         *        }
+         * ```
+         * {
+         *    "type": "InProjectRoleCondition",
+         *    "configuration": {
+         *      "projectRole": {
+         *        "id": "10002"
          *      }
+         *    }
+         *  }
+         * ```
          *
          *  *  `projectRole` An object containing the ID of a project role.
          *
@@ -312,17 +329,18 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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":
+         * ```
+         * {
+         *    "type": "ValueFieldCondition",
+         *    "configuration": {
+         *      "fieldId": "assignee",
+         *      "fieldValue":
          * "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",
-         *          "comparisonType": "NUMBER",
-         *          "comparator": "="
-         *        }
-         *      }
+         *      "comparisonType": "NUMBER",
+         *      "comparator": "="
+         *    }
+         *  }
+         * ```
          *
          *  *  `fieldId` The ID of a field used in the comparison.
          *  *  `fieldValue` The expected value of the field.
@@ -350,17 +368,18 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Date field validator #####
          *
          * A validator that compares two dates.
-         *
-         *     {
-         *        "type": "DateFieldValidator",
-         *        "configuration": {
-         *            "comparator": ">",
-         *            "date1": "updated",
-         *            "date2": "created",
-         *            "expression": "1d",
-         *            "includeTime": true
-         *          }
-         *      }
+         * ```
+         * {
+         *    "type": "DateFieldValidator",
+         *    "configuration": {
+         *        "comparator": ">",
+         *        "date1": "updated",
+         *        "date2": "created",
+         *        "expression": "1d",
+         *        "includeTime": true
+         *      }
+         *  }
+         * ```
          *
          *  *  `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, or
          * `!=`.
@@ -397,15 +416,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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
-         *          }
+         * ```
+         * {
+         *    "type": "WindowsDateValidator",
+         *    "configuration": {
+         *        "date1": "customfield_10009",
+         *        "date2": "created",
+         *        "windowsDays": 5
          *      }
+         *  }
+         * ```
          *
          *  *  `date1` The date field to validate. Allowed field types:
          *
@@ -433,19 +453,20 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *              ]
-         *          }
+         * ```
+         * {
+         *      "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.
@@ -458,18 +479,19 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *              ]
-         *          }
+         * ```
+         * {
+         *      "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
@@ -480,14 +502,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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
-         *          }
+         * ```
+         * {
+         *      "type": "FieldHasSingleValueValidator",
+         *      "configuration": {
+         *          "fieldId": "attachment,
+         *          "excludeSubtasks": true
          *      }
+         *  }
+         * ```
          *
          *  *  `fieldId` The ID of a field.
          *  *  `excludeSubtasks` If `true`, then values copied from subtasks are ignored.
@@ -496,33 +519,35 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *                  }
-         *              ]
-         *          }
+         * ```
+         * {
+         *      "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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "PermissionValidator",
+         *    "configuration": {
+         *        "permissionKey": "ADMINISTER_PROJECTS"
+         *    }
+         *  }
+         * ```
          *
          *  *  `permissionKey` The permission required to perform the transition. Allowed
          * values:
@@ -532,16 +557,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Previous status validator #####
          *
          * A validator that checks if the issue has held a status.
-         *
-         *     {
-         *        "type": "PreviousStatusValidator",
-         *        "configuration": {
-         *            "mostRecentStatusOnly": false,
-         *            "previousStatus": {
-         *                "id": "15"
-         *            }
+         * ```
+         * {
+         *    "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.
@@ -550,14 +576,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "RegexpFieldValidator",
+         *    "configuration": {
+         *        "regExp": "[0-9]",
+         *        "fieldId": "customfield_10029"
+         *    }
+         *  }
+         * ```
          *
          *  *  `regExp`A regular expression.
          *  *  `fieldId` The ID of a field. Allowed field types:
@@ -581,15 +608,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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"
-         *          }
+         * ```
+         * {
+         *      "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)
@@ -605,15 +633,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Fire issue event function #####
          *
          * A post function that fires an event that is processed by the listeners.
-         *
-         *     {
-         *        "type": "FireIssueEventFunction",
-         *        "configuration": {
-         *          "event": {
-         *            "id":"1"
-         *          }
-         *        }
+         * ```
+         * {
+         *    "type": "FireIssueEventFunction",
+         *    "configuration": {
+         *      "event": {
+         *        "id":"1"
          *      }
+         *    }
+         *  }
+         * ```
          *
          * **Note:** If provided, this post function overrides the default
          * `FireIssueEventFunction`. Can be included once in a transition.
@@ -624,10 +653,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A post function that sets issue status to the linked status of the destination
          * workflow status.
-         *
-         *     {
-         *        "type": "UpdateIssueStatusFunction"
-         *      }
+         * ```
+         * {
+         *    "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
@@ -636,10 +666,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Create comment #####
          *
          * A post function that adds a comment entered during the transition to an issue.
-         *
-         *     {
-         *        "type": "CreateCommentFunction"
-         *      }
+         * ```
+         * {
+         *    "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
@@ -648,10 +679,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Store issue #####
          *
          * A post function that stores updates to an issue.
-         *
-         *     {
-         *        "type": "IssueStoreFunction"
-         *      }
+         * ```
+         * {
+         *    "type": "IssueStoreFunction"
+         *  }
+         * ```
          *
          * **Note:** This post function can only be added to the initial transition and
          * can only be added once.
@@ -660,10 +692,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A post function that assigns the issue to the current user if the current user
          * has the `ASSIGNABLE_USER` permission.
-         *
-         *     {
-         *          "type": "AssignToCurrentUserFunction"
-         *      }
+         * ```
+         * {
+         *      "type": "AssignToCurrentUserFunction"
+         *  }
+         * ```
          *
          * **Note:** This post function can be included once in a transition.
          *
@@ -671,33 +704,36 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A post function that assigns the issue to the project or component lead
          * developer.
-         *
-         *     {
-         *          "type": "AssignToLeadFunction"
-         *      }
+         * ```
+         * {
+         *      "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"
-         *      }
+         * ```
+         * {
+         *      "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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "ClearFieldValuePostFunction",
+         *    "configuration": {
+         *      "fieldId": "assignee"
+         *    }
+         *  }
+         * ```
          *
          *  *  `fieldId` The ID of the field.
          *
@@ -705,15 +741,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "CopyValueFromOtherFieldPostFunction",
+         *    "configuration": {
+         *      "sourceFieldId": "assignee",
+         *      "destinationFieldId": "creator",
+         *      "copyType": "same"
+         *    }
+         *  }
+         * ```
          *
          *  *  `sourceFieldId` The ID of the source field.
          *  *  `destinationFieldId` The ID of the destination field.
@@ -724,10 +761,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A post function that creates a Crucible review for all unreviewed code for the
          * issue.
-         *
-         *     {
-         *          "type": "CreateCrucibleReviewWorkflowFunction"
-         *      }
+         * ```
+         * {
+         *      "type": "CreateCrucibleReviewWorkflowFunction"
+         *  }
+         * ```
          *
          * **Note:** This post function can be included once in a transition.
          *
@@ -735,18 +773,19 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *          }
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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
@@ -755,30 +794,32 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Trigger a webhook function #####
          *
          * A post function that triggers a webhook.
-         *
-         *     {
-         *        "type": "TriggerWebhookFunction",
-         *        "configuration": {
-         *          "webhook": {
-         *            "id": "1"
-         *          }
-         *        }
+         * ```
+         * {
+         *    "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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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.
@@ -788,14 +829,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Update issue field function #####
          *
          * A post function that updates a simple issue field.
-         *
-         *     {
-         *        "type": "UpdateIssueFieldFunction",
-         *        "configuration": {
-         *          "fieldId": "assignee",
-         *          "fieldValue": "5f0c277e70b8a90025a00776"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "type": "UpdateIssueFieldFunction",
+         *    "configuration": {
+         *      "fieldId": "assignee",
+         *      "fieldValue": "5f0c277e70b8a90025a00776"
+         *    }
+         *  }
+         * ```
          *
          *  *  `fieldId` The ID of the field. Allowed field types:
          *
@@ -821,13 +863,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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": "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.
@@ -842,14 +885,18 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * @deprecated
          * @returns Returned if the workflow is created.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "entityId": "d7178e8d-bf6c-4c0c-9e90-758a0b965b67",
          *   "name": "Workflow 1"
          * }
-         * @path {POST} /rest/api/3/workflow
+         * ```
+         * @path POST `/rest/api/3/workflow`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:workflow:jira, read:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflow-post
+         * @param params
          */
         this.createWorkflow = ({ createWorkflowDetails, }) => {
             return this.getClientInstance()
@@ -881,7 +928,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "statuses": [
          *     {
          *       "description": "",
@@ -978,14 +1027,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *           "actions": [],
          *           "description": "",
          *           "from": [],
-         *           "id": "11",
-         *           "name": "To Do",
+         *           "id": "1",
+         *           "name": "Create",
          *           "properties": {},
          *           "to": {
          *             "statusReference": "10001"
          *           },
          *           "triggers": [],
-         *           "type": "GLOBAL",
+         *           "type": "INITIAL",
          *           "validators": []
          *         },
          *         {
@@ -1006,14 +1055,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *           "actions": [],
          *           "description": "",
          *           "from": [],
-         *           "id": "1",
-         *           "name": "Create",
+         *           "id": "11",
+         *           "name": "To Do",
          *           "properties": {},
          *           "to": {
          *             "statusReference": "10001"
          *           },
          *           "triggers": [],
-         *           "type": "INITIAL",
+         *           "type": "GLOBAL",
          *           "validators": []
          *         }
          *       ],
@@ -1025,10 +1074,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/api/3/workflows/create
+         * ```
+         * @path POST `/rest/api/3/workflows/create`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-create-post
+         * @param params
          */
         this.createWorkflows = ({ workflowCreateRequest, }) => {
             return this.getClientInstance()
@@ -1062,10 +1113,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * **[Permissions](#permissions) required:** *Administer Jira* [global
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
-         * @path {DELETE} /rest/api/3/workflow/{entityId}
+         * @path DELETE `/rest/api/3/workflow/{entityId}`
          * @scopes-current manage:jira-configuration
          * @scopes-beta delete:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflow-entityid-delete
+         * @param params
          */
         this.deleteInactiveWorkflow = ({ entityId, }) => {
             return this.getClientInstance()
@@ -1091,7 +1143,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * @deprecated
          * @returns Returned if the request is successful.
          *
-         * example: [
+         * example:
+         * ```
+         * [
          *   {
          *     "default": true,
          *     "description": "A classic Jira workflow",
@@ -1102,11 +1156,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     "steps": 5
          *   }
          * ]
-         * @path {GET} /rest/api/3/workflow
+         * ```
+         * @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
+         * @scopes-beta read:workflow:jira, read:project:jira, read:project-category:jira, read:avatar:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflow-get
+         * @param params
          */
         this.getAllWorkflows = ({ workflowName, } = {}) => {
             return this.getClientInstance()
@@ -1138,7 +1193,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 1,
          *   "startAt": 0,
@@ -1149,8 +1206,7 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *         "name": "SCRUM Workflow",
          *         "entityId": "5ed312c5-f7a6-4a78-a1f6-8ff7f307d063"
          *       },
-         *       "description": "A workflow used for Software projects in the SCRUM
-         * methodology",
+         *       "description": "A workflow used for Software projects in the SCRUM methodology",
          *       "transitions": [
          *         {
          *           "id": "5",
@@ -1265,13 +1321,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/workflow/search
+         * ```
+         * @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
+         * @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
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflow-search-get
+         * @param params
          */
         this.getWorkflowsPaginated = ({ startAt, maxResults, workflowName, expand, queryString, orderBy, isActive, } = {}) => {
             return this.getClientInstance()
@@ -1310,7 +1365,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "statuses": [
          *     {
          *       "description": "",
@@ -1392,13 +1449,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
-         *           "id": "31",
-         *           "name": "Done",
+         *           "id": "21",
+         *           "links": [],
+         *           "name": "In Progress",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "10003"
-         *           },
+         *           "toStatusReference": "10002",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
@@ -1406,13 +1461,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "11",
+         *           "links": [],
          *           "name": "To Do",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "10001"
-         *           },
+         *           "toStatusReference": "10001",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
@@ -1420,13 +1473,11 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
-         *           "id": "21",
-         *           "name": "In Progress",
+         *           "id": "31",
+         *           "links": [],
+         *           "name": "Done",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "10002"
-         *           },
+         *           "toStatusReference": "10003",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
@@ -1434,13 +1485,29 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
+         *           "id": "41",
+         *           "links": [
+         *             {
+         *               "fromPort": 0,
+         *               "fromStatusReference": "10001",
+         *               "toPort": 1
+         *             }
+         *           ],
+         *           "name": "Start work",
+         *           "properties": {},
+         *           "toStatusReference": "10002",
+         *           "triggers": [],
+         *           "type": "DIRECTED",
+         *           "validators": []
+         *         },
+         *         {
+         *           "actions": [],
+         *           "description": "",
          *           "id": "1",
+         *           "links": [],
          *           "name": "Create",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "10001"
-         *           },
+         *           "toStatusReference": "10001",
          *           "triggers": [],
          *           "type": "INITIAL",
          *           "validators": []
@@ -1454,18 +1521,21 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/api/3/workflows
+         * ```
+         * @path POST `/rest/api/3/workflows`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-post
+         * @param params
          */
-        this.readWorkflows = ({ expand, workflowReadRequest, }) => {
+        this.readWorkflows = ({ expand, useTransitionLinksFormat, workflowReadRequest, }) => {
             return this.getClientInstance()
                 .request({
                 path: "/rest/api/3/workflows",
                 method: "POST",
                 query: {
                     expand,
+                    useTransitionLinksFormat,
                 },
                 headers: {
                     "Content-Type": "application/json",
@@ -1492,7 +1562,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "statuses": [
          *     {
          *       "description": "",
@@ -1590,14 +1662,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *           "actions": [],
          *           "description": "",
          *           "from": [],
-         *           "id": "11",
-         *           "name": "To Do",
+         *           "id": "1",
+         *           "name": "Create",
          *           "properties": {},
          *           "to": {
          *             "statusReference": "10001"
          *           },
          *           "triggers": [],
-         *           "type": "GLOBAL",
+         *           "type": "INITIAL",
          *           "validators": []
          *         },
          *         {
@@ -1618,14 +1690,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *           "actions": [],
          *           "description": "",
          *           "from": [],
-         *           "id": "1",
-         *           "name": "Create",
+         *           "id": "11",
+         *           "name": "To Do",
          *           "properties": {},
          *           "to": {
          *             "statusReference": "10001"
          *           },
          *           "triggers": [],
-         *           "type": "INITIAL",
+         *           "type": "GLOBAL",
          *           "validators": []
          *         }
          *       ],
@@ -1637,10 +1709,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/api/3/workflows/update
+         * ```
+         * @path POST `/rest/api/3/workflows/update`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-update-post
+         * @param params
          */
         this.updateWorkflows = ({ expand, workflowUpdateRequest, }) => {
             return this.getClientInstance()
@@ -1675,7 +1749,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "errors": [
          *     {
          *       "code": "NON_UNIQUE_STATUS_NAME",
@@ -1688,10 +1764,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/api/3/workflows/create/validation
+         * ```
+         * @path POST `/rest/api/3/workflows/create/validation`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-create-validation-post
+         * @param params
          */
         this.validateCreateWorkflows = ({ workflowCreateValidateRequest, }) => {
             return this.getClientInstance()
@@ -1723,7 +1801,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "errors": [
          *     {
          *       "code": "NON_UNIQUE_STATUS_NAME",
@@ -1736,10 +1816,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/api/3/workflows/update/validation
+         * ```
+         * @path POST `/rest/api/3/workflows/update/validation`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-update-validation-post
+         * @param params
          */
         this.validateUpdateWorkflows = ({ workflowUpdateValidateRequestBean, }) => {
             return this.getClientInstance()
@@ -1785,13 +1867,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:check-permission-validator",
+         *    "parameters": {
+         *      "permissionKey": "ADMINISTER_PROJECTS"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1803,14 +1886,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey" : "system:parent-or-child-blocking-validator"
+         *    "parameters" : {
+         *      "blocker" : "PARENT"
+         *      "statusIds" : "1,2,3"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1821,14 +1905,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:previous-status-validator",
+         *    "parameters": {
+         *      "previousStatusIds": "10014",
+         *      "mostRecentStatusOnly": "true"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1845,16 +1930,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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!"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:validate-field-value",
+         *    "parameters": {
+         *      "ruleType": "fieldRequired",
+         *      "fieldsRequired": "assignee",
+         *      "ignoreContext": "true",
+         *      "errorMessage": "An assignee must be set!"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1870,16 +1956,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "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:
          *
@@ -1892,15 +1979,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * provide one (Optional).
          *
          * ###### Field has a single value ######
-         *
-         *     {
-         *        "ruleKey": "system:validate-field-value",
-         *        "parameters": {
-         *          "ruleType": "fieldHasSingleValue",
-         *          "fieldKey": "created",
-         *          "excludeSubtasks": "true"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:validate-field-value",
+         *    "parameters": {
+         *      "ruleType": "fieldHasSingleValue",
+         *      "fieldKey": "created",
+         *      "excludeSubtasks": "true"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1910,15 +1998,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * values: `true`, `false`.
          *
          * ###### Field matches regular expression ######
-         *
-         *     {
-         *        "ruleKey": "system:validate-field-value",
-         *        "parameters": {
-         *          "ruleType": "fieldMatchesRegularExpression",
-         *          "regexp": "[0-9]{4}",
-         *          "fieldKey": "description"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:validate-field-value",
+         *    "parameters": {
+         *      "ruleType": "fieldMatchesRegularExpression",
+         *      "regexp": "[0-9]{4}",
+         *      "fieldKey": "description"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1927,17 +2016,18 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * look like `customfield_123`.
          *
          * ###### Date field comparison ######
-         *
-         *     {
-         *        "ruleKey": "system:validate-field-value",
-         *        "parameters": {
-         *          "ruleType": "dateFieldComparison",
-         *          "date1FieldKey": "duedate",
-         *          "date2FieldKey": "customfield_10054",
-         *          "includeTime": "true",
-         *          "conditionSelected": ">="
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:validate-field-value",
+         *    "parameters": {
+         *      "ruleType": "dateFieldComparison",
+         *      "date1FieldKey": "duedate",
+         *      "date2FieldKey": "customfield_10054",
+         *      "includeTime": "true",
+         *      "conditionSelected": ">="
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1951,16 +2041,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * `>=`, `=`, `<=`, `<`, `!=`.
          *
          * ###### Date range comparison ######
-         *
-         *     {
-         *        "ruleKey": "system:validate-field-value",
-         *        "parameters": {
-         *          "ruleType": "windowDateComparison",
-         *          "date1FieldKey": "customfield_10009",
-         *          "date2FieldKey": "customfield_10054",
-         *          "numberOfDays": "3"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:validate-field-value",
+         *    "parameters": {
+         *      "ruleType": "windowDateComparison",
+         *      "date1FieldKey": "customfield_10009",
+         *      "date2FieldKey": "customfield_10054",
+         *      "numberOfDays": "3"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -1983,20 +2074,22 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Proforma: Forms attached validator #####
          *
          * Validates that one or more forms are attached to the issue.
-         *
-         *     {
-         *        "ruleKey" : "system:proforma-forms-attached"
-         *        "parameters" : {}
-         *      }
+         * ```
+         * {
+         *    "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" : {}
-         *      }
+         * ```
+         * {
+         *    "ruleKey" : "system:proforma-forms-submitted"
+         *    "parameters" : {}
+         *  }
+         * ```
          *
          * #### Conditions ####
          *
@@ -2007,16 +2100,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:check-field-value",
+         *    "parameters": {
+         *      "fieldId": "description",
+         *      "fieldValue": "[\"Done\"]",
+         *      "comparator": "=",
+         *      "comparisonType": "STRING"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2035,20 +2129,21 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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":
+         * ```
+         * {
+         *    "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"
-         *        }
-         *      }
+         *      "denyUserCustomFields": "customfield_10107"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2082,17 +2177,18 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey" : "system:previous-status-condition"
+         *    "parameters" : {
+         *      "previousStatusIds" : "10004",
+         *      "not": "true",
+         *      "mostRecentStatusOnly" : "true",
+         *      "includeCurrentStatus": "true",
+         *      "ignoreLoopTransitions": "true"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2112,14 +2208,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey" : "system:parent-or-child-blocking-condition"
+         *    "parameters" : {
+         *      "blocker" : "CHILD",
+         *      "statusIds" : "1,2,3"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2130,14 +2227,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:separation-of-duties",
+         *    "parameters": {
+         *      "fromStatusId": "10161",
+         *      "toStatusId": "10160"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2152,13 +2250,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:restrict-from-all-users",
+         *    "parameters": {
+         *      "restrictMode": "users"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2169,13 +2268,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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...}"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:jsd-approvals-block-until-approved",
+         *    "parameters": {
+         *      "approvalConfigurationJson": "{"statusExternalUuid...}"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2186,13 +2286,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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...}"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:jsd-approvals-block-until-rejected",
+         *    "parameters": {
+         *      "approvalConfigurationJson": "{"statusExternalUuid...}"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2203,11 +2304,12 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * 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": {}
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:block-in-progress-approval",
+         *    "parameters": {}
+         *  }
+         * ```
          *
          * #### Post functions ####
          *
@@ -2217,14 +2319,15 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:change-assignee",
+         *    "parameters": {
+         *      "type": "to-selected-user",
+         *      "accountId": "example-account-id"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2239,15 +2342,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:copy-value-from-other-field",
+         *    "parameters": {
+         *      "sourceFieldKey": "description",
+         *      "targetFieldKey": "components",
+         *      "issueSource": "SAME"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2261,15 +2365,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:update-field",
+         *    "parameters": {
+         *      "field": "customfield_10056",
+         *      "value": "asdf",
+         *      "mode": "append"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2283,13 +2388,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * A post function that automatically triggers a predefined webhook when a
          * transition occurs in the workflow.
-         *
-         *     {
-         *        "ruleKey": "system:trigger-webhook",
-         *        "parameters": {
-         *          "webhookId": "1"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:trigger-webhook",
+         *    "parameters": {
+         *      "webhookId": "1"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2303,15 +2409,16 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * 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"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:remind-people-to-update-fields",
+         *    "params": {
+         *      "remindingFieldIds": "assignee,customfield_10025",
+         *      "remindingMessage": "The message",
+         *      "remindingAlwaysAsk": "true"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2326,13 +2433,14 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Shared transition screen #####
          *
          * A common screen that is shared between transitions in a workflow.
-         *
-         *     {
-         *        "ruleKey": "system:transition-screen",
-         *        "params": {
-         *          "screenId": "3"
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "system:transition-screen",
+         *    "params": {
+         *      "screenId": "3"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2343,17 +2451,18 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### 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": ""
-         *        }
-         *      }
+         * ```
+         * {
+         *    "ruleKey": "connect:expression-validator",
+         *    "parameters": {
+         *      "appKey": "com.atlassian.app",
+         *      "config": "",
+         *      "id": "90ce590f-e90c-4cd3-8281-165ce41f2ac3",
+         *      "disabled": "false",
+         *      "tag": ""
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2370,16 +2479,17 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          * ##### Forge rules #####
          *
          * Validator/Condition/Post function for Forge app.
-         *
-         *     {
-         *        "ruleKey": "forge:expression-validator",
-         *        "parameters": {
-         *          "key":
+         * ```
+         * {
+         *    "ruleKey": "forge:expression-validator",
+         *    "parameters": {
+         *      "key":
          * "ari:cloud:ecosystem::extension/{appId}/{environmentId}/static/{moduleKey}",
-         *          "config": "{"searchString":"workflow validator"}",
-         *          "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2"
-         *        }
-         *      }
+         *      "config": "{"searchString":"workflow validator"}",
+         *      "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2"
+         *    }
+         *  }
+         * ```
          *
          * Parameters:
          *
@@ -2391,7 +2501,9 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "connectRules": [
          *     {
          *       "addonKey": "com.atlassian.jira.refapp",
@@ -2409,8 +2521,7 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *   "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",
+         *       "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"
@@ -2422,8 +2533,7 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *   ],
          *   "systemRules": [
          *     {
-         *       "description": "Automatically assign a request to someone after moving
-         * the request using a particular transition.",
+         *       "description": "Automatically assign a request to someone after moving the request using a particular transition.",
          *       "incompatibleRuleKeys": [],
          *       "isAvailableForInitialTransition": true,
          *       "isVisible": true,
@@ -2436,21 +2546,21 @@ class WorkflowsService extends CommonHttpService_1.CommonHttpService {
          *     {
          *       "availableTypes": [
          *         {
-         *           "description": "Automatically transitions the issue when a related
-         * branch is created in a connected repository",
+         *           "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"
+         *           "type": "com.atlassian.jira.plugins.jira-development-integration-plugin:branch-created-trigger"
          *         }
          *       ],
          *       "ruleKey": "system:development-triggers"
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/workflows/capabilities
+         * ```
+         * @path GET `/rest/api/3/workflows/capabilities`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:workflow:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-capabilities-get
+         * @param params
          */
         this.workflowCapabilities = ({ workflowId, projectId, issueTypeId, } = {}) => {
             return this.getClientInstance()