@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/workflow-transition-properties-service.js

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowTransitionPropertiesService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const workflow_transition_properties_1 = require("../models/workflow-transition-properties");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * This resource represents workflow transition properties, which provides for
+ * storing custom data against a workflow transition. Use it to get, create, and
+ * delete workflow transition properties as well as get a list of property keys
+ * for a workflow transition. Workflow transition properties are a type of [entity
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
+ */
+class WorkflowTransitionPropertiesService extends common_http_service_1.CommonHttpService {
+    /**
+     * Adds a property to a workflow transition. Transition properties are used to
+     * change the behavior of a transition. For more information, see [Transition
+     * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
+     * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns 200 response
+     *
+     * example: {
+     *   "key": "jira.i18n.title",
+     *   "value": "some.title",
+     *   "id": "jira.i18n.title"
+     * }
+     * @path {POST} /rest/api/3/workflow/transitions/{transitionId}/properties
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow.property:jira, read:workflow.property:jira
+     */
+    createWorkflowTransitionProperty({ transitionId, key, workflowName, workflowMode, workflowTransitionProperty, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
+            method: "POST",
+            pathParams: {
+                transitionId,
+            },
+            query: {
+                key,
+                workflowName,
+                workflowMode,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowTransitionProperty,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowTransitionPropertiesService.createWorkflowTransitionProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a property from a workflow transition. Transition properties are used
+     * to change the behavior of a transition. For more information, see [Transition
+     * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
+     * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE} /rest/api/3/workflow/transitions/{transitionId}/properties
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:workflow.property:jira
+     */
+    deleteWorkflowTransitionProperty({ transitionId, key, workflowName, workflowMode, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
+            method: "DELETE",
+            pathParams: {
+                transitionId,
+            },
+            query: {
+                key,
+                workflowName,
+                workflowMode,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns the properties on a workflow transition. Transition properties are used
+     * to change the behavior of a transition. For more information, see [Transition
+     * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
+     * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns 200 response
+     *
+     * example: [
+     *   {
+     *     "id": "jira.i18n.title",
+     *     "key": "jira.i18n.title",
+     *     "value": "some.title"
+     *   },
+     *   {
+     *     "id": "jira.permission",
+     *     "key": "jira.permission",
+     *     "value": "createissue"
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/workflow/transitions/{transitionId}/properties
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow.property:jira
+     */
+    getWorkflowTransitionProperties({ transitionId, includeReservedKeys, key, workflowName, workflowMode, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
+            method: "GET",
+            pathParams: {
+                transitionId,
+            },
+            query: {
+                includeReservedKeys,
+                key,
+                workflowName,
+                workflowMode,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowTransitionPropertiesService.getWorkflowTransitionProperties.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates a workflow transition by changing the property value. Trying to update
+     * a property that does not exist results in a new property being added to the
+     * transition. Transition properties are used to change the behavior of a
+     * transition. For more information, see [Transition
+     * properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties)
+     * and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns 200 response
+     *
+     * example: {
+     *   "key": "jira.i18n.title",
+     *   "value": "some.title",
+     *   "id": "jira.i18n.title"
+     * }
+     * @path {PUT} /rest/api/3/workflow/transitions/{transitionId}/properties
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow.property:jira, read:workflow.property:jira
+     */
+    updateWorkflowTransitionProperty({ transitionId, key, workflowName, workflowMode, workflowTransitionProperty, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/workflow/transitions/{transitionId}/properties",
+            method: "PUT",
+            pathParams: {
+                transitionId,
+            },
+            query: {
+                key,
+                workflowName,
+                workflowMode,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: workflowTransitionProperty,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("WorkflowTransitionPropertiesService.updateWorkflowTransitionProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowTransitionPropertiesService.getWorkflowTransitionProperties.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowTransitionProperty"),
+        })
+            .describe("WorkflowTransitionPropertiesService.getWorkflowTransitionProperties.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowTransitionPropertiesService.updateWorkflowTransitionProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowTransitionProperty"),
+        })
+            .describe("WorkflowTransitionPropertiesService.updateWorkflowTransitionProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("WorkflowTransitionPropertiesService.createWorkflowTransitionProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("WorkflowTransitionProperty"),
+        })
+            .describe("WorkflowTransitionPropertiesService.createWorkflowTransitionProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([
+            workflow_transition_properties_1.registerWorkflowTransitionPropertiesValidationSchemas,
+        ]);
+    }
+}
+exports.WorkflowTransitionPropertiesService = WorkflowTransitionPropertiesService;
+//# sourceMappingURL=workflow-transition-properties-service.js.map

package/lib/openapi/platform/services/workflow-transition-properties-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-transition-properties-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/workflow-transition-properties-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,6FAGkD;AAClD,4EAAuE;AACvE;;;;;;GAMG;AACH,MAAa,mCAAoC,SAAQ,uCAAiB;IACxE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gCAAgC,CAAC,EAC/B,YAAY,EACZ,GAAG,EACH,YAAY,EACZ,YAAY,EACZ,0BAA0B,GAyB3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4DAA4D;YAClE,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,YAAY;aACb;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,YAAY;gBACZ,YAAY;aACb;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,+EAA+E,CAChF,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,gCAAgC,CAAC,EAC/B,YAAY,EACZ,GAAG,EACH,YAAY,EACZ,YAAY,GAmBb;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4DAA4D;YAClE,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,YAAY;aACb;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,YAAY;gBACZ,YAAY;aACb;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,+BAA+B,CAAC,EAC9B,YAAY,EACZ,mBAAmB,EACnB,GAAG,EACH,YAAY,EACZ,YAAY,GA0Bb;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4DAA4D;YAClE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;aACb;YACD,KAAK,EAAE;gBACL,mBAAmB;gBACnB,GAAG;gBACH,YAAY;gBACZ,YAAY;aACb;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,8EAA8E,CAC/E,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gCAAgC,CAAC,EAC/B,YAAY,EACZ,GAAG,EACH,YAAY,EACZ,YAAY,EACZ,0BAA0B,GAyB3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4DAA4D;YAClE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;aACb;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,YAAY;gBACZ,YAAY;aACb;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,+EAA+E,CAChF,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,8EAA8E,EAC9E,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,4BAA4B,CAAC;SACjE,CAAC;aACD,QAAQ,CACP,8EAA8E,CAC/E,CACJ,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,+EAA+E,EAC/E,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,4BAA4B,CAAC;SACjE,CAAC;aACD,QAAQ,CACP,+EAA+E,CAChF,CACJ,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,+EAA+E,EAC/E,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,4BAA4B,CAAC;SACjE,CAAC;aACD,QAAQ,CACP,+EAA+E,CAChF,CACJ,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC;YACnC,sFAAqD;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AAhXD,kFAgXC"}

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

@@ -0,0 +1,319 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type PageBeanWorkflowTransitionRules, type WorkflowsWithTransitionRulesDetails, type WorkflowTransitionRulesUpdate, type WorkflowTransitionRulesUpdateErrors } from "../models/workflow-transition-rules";
+/**
+ * This resource represents workflow transition rules. Workflow transition rules
+ * define a Connect or a Forge app routine, such as a [workflow post
+ * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
+ * that is executed in association with the workflow. Use it to read and modify
+ * configuration of workflow transition rules.
+ */
+export declare class WorkflowTransitionRulesService extends CommonHttpService {
+    /**
+     * Deletes workflow transition rules from one or more workflows. These rule types
+     * are supported:
+     *
+     *  *  [post
+     * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
+     *  *
+     * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/)
+     *  *
+     * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/)
+     *
+     * Only rules created by the calling Connect app can be deleted.
+     *
+     * **[Permissions](#permissions) required:** Only Connect apps can use this
+     * operation.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "updateResults": [
+     *     {
+     *       "workflowId": {
+     *         "name": "Workflow with one rule not updated",
+     *         "draft": false
+     *       },
+     *       "ruleUpdateErrors": {
+     *         "example-rule-id": [
+     *           "The rule with this id does not exist: example-rule-id"
+     *         ]
+     *       },
+     *       "updateErrors": []
+     *     },
+     *     {
+     *       "workflowId": {
+     *         "name": "Workflow with all rules successfully updated",
+     *         "draft": true
+     *       },
+     *       "ruleUpdateErrors": {},
+     *       "updateErrors": []
+     *     },
+     *     {
+     *       "workflowId": {
+     *         "name": "Non-existing workflow",
+     *         "draft": false
+     *       },
+     *       "ruleUpdateErrors": {},
+     *       "updateErrors": [
+     *         "Workflow not found: WorkflowIdBean{name=Non-existing workflow,
+     * draft=false}"
+     *       ]
+     *     }
+     *   ]
+     * }
+     * @path {PUT} /rest/api/3/workflow/rule/config/delete
+     */
+    deleteWorkflowTransitionRuleConfigurations({ workflowsWithTransitionRulesDetails, }: {
+        /**
+         * @example {
+         *     "workflows": [
+         *         {
+         *             "workflowId": {
+         *                 "draft": false,
+         *                 "name": "Internal support workflow"
+         *             },
+         *             "workflowRuleIds": [
+         *                 "b4d6cbdc-59f5-11e9-8647-d663bd873d93",
+         *                 "d663bd873d93-59f5-11e9-8647-b4d6cbdc",
+         *                 "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
+         *             ]
+         *         }
+         *     ]
+         * }
+         */
+        workflowsWithTransitionRulesDetails: WorkflowsWithTransitionRulesDetails;
+    }): Promise<WorkflowTransitionRulesUpdateErrors>;
+    /**
+     * Returns a [paginated](#pagination) list of workflows with transition rules. The
+     * workflows can be filtered to return only those containing workflow transition
+     * rules:
+     *
+     *  *  of one or more transition rule types, such as [workflow post
+     * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/).
+     *  *  matching one or more transition rule keys.
+     *
+     * Only workflows containing transition rules created by the calling
+     * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)
+     * or
+     * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps)
+     * app are returned.
+     *
+     * Due to server-side optimizations, workflows with an empty list of rules may be
+     * returned; these workflows can be ignored.
+     *
+     * **[Permissions](#permissions) required:** Only
+     * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)
+     * or
+     * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps)
+     * apps can use this operation.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 10,
+     *   "startAt": 0,
+     *   "total": 1,
+     *   "values": [
+     *     {
+     *       "workflowId": {
+     *         "name": "My Workflow name",
+     *         "draft": false
+     *       },
+     *       "postFunctions": [
+     *         {
+     *           "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93",
+     *           "key": "postfunction-key",
+     *           "configuration": {
+     *             "value": "{ \"color\": \"red\" }",
+     *             "disabled": false,
+     *             "tag": "Sample tag"
+     *           },
+     *           "transition": {
+     *             "id": 1,
+     *             "name": "Open"
+     *           }
+     *         }
+     *       ],
+     *       "conditions": [
+     *         {
+     *           "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc",
+     *           "key": "condition-key",
+     *           "configuration": {
+     *             "value": "{ \"size\": \"medium\" }",
+     *             "disabled": false,
+     *             "tag": "Another tag"
+     *           },
+     *           "transition": {
+     *             "id": 1,
+     *             "name": "Open"
+     *           }
+     *         }
+     *       ],
+     *       "validators": [
+     *         {
+     *           "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93",
+     *           "key": "validator-key",
+     *           "configuration": {
+     *             "value": "\"{ \\\"shape\\\": \\\"square\\\" }\"",
+     *             "disabled": false
+     *           },
+     *           "transition": {
+     *             "id": 1,
+     *             "name": "Open"
+     *           }
+     *         }
+     *       ]
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/workflow/rule/config
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow:jira
+     */
+    getWorkflowTransitionRuleConfigurations({ startAt, maxResults, types, keys, workflowNames, withTags, draft, expand, }: {
+        /** 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 types of the transition rules to return. */
+        types: ("postfunction" | "condition" | "validator")[];
+        /**
+         * The transition rule class keys, as defined in the Connect or the Forge app
+         * descriptor, of the transition rules to return.
+         */
+        keys?: string[];
+        /** The list of workflow names to filter by. */
+        workflowNames?: string[];
+        /** The list of `tags` to filter by. */
+        withTags?: string[];
+        /**
+         * Whether draft or published workflows are returned. If not provided, both
+         * workflow types are returned.
+         */
+        draft?: boolean;
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts `transition`, which, for each rule, returns information
+         * about the transition the rule is assigned to.
+         */
+        expand?: string;
+    }): Promise<PageBeanWorkflowTransitionRules>;
+    /**
+     * Updates configuration of workflow transition rules. The following rule types
+     * are supported:
+     *
+     *  *  [post
+     * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
+     *  *
+     * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/)
+     *  *
+     * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/)
+     *
+     * Only rules created by the calling
+     * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)
+     * or
+     * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps)
+     * app can be updated.
+     *
+     * To assist with app migration, this operation can be used to:
+     *
+     *  *  Disable a rule.
+     *  *  Add a `tag`. Use this to filter rules in the [Get workflow transition rule
+     * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get).
+     *
+     * Rules are enabled if the `disabled` parameter is not provided.
+     *
+     * **[Permissions](#permissions) required:** Only
+     * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)
+     * or
+     * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps)
+     * apps can use this operation.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "updateResults": [
+     *     {
+     *       "workflowId": {
+     *         "name": "Workflow with one rule not updated",
+     *         "draft": false
+     *       },
+     *       "ruleUpdateErrors": {
+     *         "example-rule-id": [
+     *           "The rule with this id does not exist: example-rule-id"
+     *         ]
+     *       },
+     *       "updateErrors": []
+     *     },
+     *     {
+     *       "workflowId": {
+     *         "name": "Workflow with all rules successfully updated",
+     *         "draft": true
+     *       },
+     *       "ruleUpdateErrors": {},
+     *       "updateErrors": []
+     *     },
+     *     {
+     *       "workflowId": {
+     *         "name": "Non-existing workflow",
+     *         "draft": false
+     *       },
+     *       "ruleUpdateErrors": {},
+     *       "updateErrors": [
+     *         "Workflow not found: WorkflowIdBean{name=Non-existing workflow,
+     * draft=false}"
+     *       ]
+     *     }
+     *   ]
+     * }
+     * @path {PUT} /rest/api/3/workflow/rule/config
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    updateWorkflowTransitionRuleConfigurations({ workflowTransitionRulesUpdate, }: {
+        /**
+         * @example {
+         *     "workflows": [
+         *         {
+         *             "conditions": [
+         *                 {
+         *                     "configuration": {
+         *                         "disabled": false,
+         *                         "tag": "Another tag",
+         *                         "value": "{ \"size\": \"medium\" }"
+         *                     },
+         *                     "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc"
+         *                 }
+         *             ],
+         *             "postFunctions": [
+         *                 {
+         *                     "configuration": {
+         *                         "disabled": false,
+         *                         "tag": "Sample tag",
+         *                         "value": "{ \"color\": \"red\" }"
+         *                     },
+         *                     "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93"
+         *                 }
+         *             ],
+         *             "validators": [
+         *                 {
+         *                     "configuration": {
+         *                         "disabled": false,
+         *                         "value": "{ \"shape\": \"square\" }"
+         *                     },
+         *                     "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
+         *                 }
+         *             ],
+         *             "workflowId": {
+         *                 "draft": false,
+         *                 "name": "My Workflow name"
+         *             }
+         *         }
+         *     ]
+         * }
+         */
+        workflowTransitionRulesUpdate: WorkflowTransitionRulesUpdate;
+    }): Promise<WorkflowTransitionRulesUpdateErrors>;
+    static initialize(): void;
+}