@resolution/jira-api-client 0.13.4 → 0.14.0

package/lib/openapi/platform/services/WorkflowsService.d.ts

@@ -893,8 +893,9 @@ export declare class WorkflowsService extends CommonHttpService {
          * The workflow details.
          *
          * @example
+         * ```
          * {
-         *   "description": "This is a workflow used for Stories and Tasks",
+         * "description": "This is a workflow used for Stories and Tasks",
          *   "name": "Workflow 1",
          *   "statuses": [
          *     {
@@ -990,6 +991,7 @@ export declare class WorkflowsService extends CommonHttpService {
          *     }
          *   ]
          * }
+         * ```
          */
         createWorkflowDetails: CreateWorkflowDetails;
     }) => Promise<WorkflowIds>;
@@ -1088,13 +1090,11 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
-     *           "id": "31",
-     *           "name": "Done",
+     *           "id": "11",
+     *           "links": [],
+     *           "name": "To Do",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10003"
-     *           },
+     *           "toStatusReference": "10001",
      *           "triggers": [],
      *           "type": "GLOBAL",
      *           "validators": []
@@ -1102,43 +1102,43 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
-     *           "id": "1",
-     *           "name": "Create",
+     *           "id": "21",
+     *           "links": [],
+     *           "name": "In Progress",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10001"
-     *           },
+     *           "toStatusReference": "10002",
      *           "triggers": [],
-     *           "type": "INITIAL",
+     *           "type": "GLOBAL",
      *           "validators": []
      *         },
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
-     *           "id": "21",
-     *           "name": "In Progress",
+     *           "id": "1",
+     *           "links": [],
+     *           "name": "Create",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10002"
-     *           },
+     *           "toStatusReference": "10001",
      *           "triggers": [],
-     *           "type": "GLOBAL",
+     *           "type": "INITIAL",
      *           "validators": []
      *         },
      *         {
      *           "actions": [],
-     *           "description": "",
-     *           "from": [],
-     *           "id": "11",
-     *           "name": "To Do",
+     *           "description": "Move a work item from in progress to done",
+     *           "id": "31",
+     *           "links": [
+     *             {
+     *               "fromPort": 0,
+     *               "fromStatusReference": "10002",
+     *               "toPort": 1
+     *             }
+     *           ],
+     *           "name": "Done",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10001"
-     *           },
+     *           "toStatusReference": "10003",
      *           "triggers": [],
-     *           "type": "GLOBAL",
+     *           "type": "DIRECTED",
      *           "validators": []
      *         }
      *       ],
@@ -1160,8 +1160,9 @@ export declare class WorkflowsService extends CommonHttpService {
     createWorkflows: ({ workflowCreateRequest }: {
         /**
          * @example
+         * ```
          * {
-         *   "scope": {
+         * "scope": {
          *     "type": "GLOBAL"
          *   },
          *   "statuses": [
@@ -1222,13 +1223,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "1",
+         *           "links": [],
          *           "name": "Create",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *           },
+         *           "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *           "triggers": [],
          *           "type": "INITIAL",
          *           "validators": []
@@ -1236,13 +1235,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "11",
+         *           "links": [],
          *           "name": "To Do",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *           },
+         *           "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
@@ -1250,35 +1247,38 @@ export declare class WorkflowsService extends CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "21",
+         *           "links": [],
          *           "name": "In Progress",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
-         *           },
+         *           "toStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
          *         },
          *         {
          *           "actions": [],
-         *           "description": "",
-         *           "from": [],
+         *           "description": "Move a work item from in progress to done",
          *           "id": "31",
+         *           "links": [
+         *             {
+         *               "fromPort": 0,
+         *               "fromStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
+         *               "toPort": 1
+         *             }
+         *           ],
          *           "name": "Done",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
-         *           },
+         *           "toStatusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849",
          *           "triggers": [],
-         *           "type": "GLOBAL",
+         *           "type": "DIRECTED",
          *           "validators": []
          *         }
          *       ]
          *     }
          *   ]
          * }
+         * ```
          */
         workflowCreateRequest: WorkflowCreateRequest;
     }) => Promise<WorkflowCreateResponse>;
@@ -1740,18 +1740,6 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "id": "21",
-     *           "links": [],
-     *           "name": "In Progress",
-     *           "properties": {},
-     *           "toStatusReference": "10002",
-     *           "triggers": [],
-     *           "type": "GLOBAL",
-     *           "validators": []
-     *         },
-     *         {
-     *           "actions": [],
-     *           "description": "",
      *           "id": "11",
      *           "links": [],
      *           "name": "To Do",
@@ -1764,11 +1752,11 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "id": "31",
+     *           "id": "21",
      *           "links": [],
-     *           "name": "Done",
+     *           "name": "In Progress",
      *           "properties": {},
-     *           "toStatusReference": "10003",
+     *           "toStatusReference": "10002",
      *           "triggers": [],
      *           "type": "GLOBAL",
      *           "validators": []
@@ -1802,6 +1790,18 @@ export declare class WorkflowsService extends CommonHttpService {
      *           "triggers": [],
      *           "type": "INITIAL",
      *           "validators": []
+     *         },
+     *         {
+     *           "actions": [],
+     *           "description": "",
+     *           "id": "31",
+     *           "links": [],
+     *           "name": "Done",
+     *           "properties": {},
+     *           "toStatusReference": "10003",
+     *           "triggers": [],
+     *           "type": "GLOBAL",
+     *           "validators": []
      *         }
      *       ],
      *       "usages": [],
@@ -1819,7 +1819,7 @@ export declare class WorkflowsService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflows-post
      * @param params
      */
-    readWorkflows: ({ expand, useTransitionLinksFormat, useApprovalConfiguration, workflowReadRequest }: {
+    readWorkflows: ({ expand, useApprovalConfiguration, workflowReadRequest }: {
         /**
          * Deprecated. See the [deprecation
          * notice](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2298)
@@ -1834,11 +1834,6 @@ export declare class WorkflowsService extends CommonHttpService {
          * associated with.
          */
         expand?: string | undefined;
-        /**
-         * Return the new fields (`toStatusReference`/`links`) instead of the deprecated
-         * fields (`to`/`from`) for workflow transition port mappings.
-         */
-        useTransitionLinksFormat?: boolean | undefined;
         /**
          * Return the new field `approvalConfiguration` instead of the deprecated status
          * properties for approval configuration.
@@ -1846,14 +1841,16 @@ export declare class WorkflowsService extends CommonHttpService {
         useApprovalConfiguration?: boolean | undefined;
         /**
          * @example
+         * ```
          * {
-         *   "projectAndIssueTypes": [],
+         * "projectAndIssueTypes": [],
          *   "workflowIds": [],
          *   "workflowNames": [
          *     "Workflow 1",
          *     "Workflow 2"
          *   ]
          * }
+         * ```
          */
         workflowReadRequest: WorkflowReadRequest;
     }) => Promise<WorkflowReadResponse>;
@@ -1961,18 +1958,6 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "id": "21",
-     *           "links": [],
-     *           "name": "In Progress",
-     *           "properties": {},
-     *           "toStatusReference": "10002",
-     *           "triggers": [],
-     *           "type": "GLOBAL",
-     *           "validators": []
-     *         },
-     *         {
-     *           "actions": [],
-     *           "description": "",
      *           "id": "11",
      *           "links": [],
      *           "name": "To Do",
@@ -1985,11 +1970,11 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "id": "31",
+     *           "id": "21",
      *           "links": [],
-     *           "name": "Done",
+     *           "name": "In Progress",
      *           "properties": {},
-     *           "toStatusReference": "10003",
+     *           "toStatusReference": "10002",
      *           "triggers": [],
      *           "type": "GLOBAL",
      *           "validators": []
@@ -2023,6 +2008,18 @@ export declare class WorkflowsService extends CommonHttpService {
      *           "triggers": [],
      *           "type": "INITIAL",
      *           "validators": []
+     *         },
+     *         {
+     *           "actions": [],
+     *           "description": "",
+     *           "id": "31",
+     *           "links": [],
+     *           "name": "Done",
+     *           "properties": {},
+     *           "toStatusReference": "10003",
+     *           "triggers": [],
+     *           "type": "GLOBAL",
+     *           "validators": []
      *         }
      *       ],
      *       "usages": [],
@@ -2167,13 +2164,11 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
-     *           "id": "31",
-     *           "name": "Done",
+     *           "id": "21",
+     *           "links": [],
+     *           "name": "In Progress",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10003"
-     *           },
+     *           "toStatusReference": "10002",
      *           "triggers": [],
      *           "type": "GLOBAL",
      *           "validators": []
@@ -2181,41 +2176,41 @@ export declare class WorkflowsService extends CommonHttpService {
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
-     *           "id": "1",
-     *           "name": "Create",
+     *           "id": "31",
+     *           "links": [
+     *             {
+     *               "fromPort": 0,
+     *               "fromStatusReference": "10002",
+     *               "toPort": 1
+     *             }
+     *           ],
+     *           "name": "Done",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10001"
-     *           },
+     *           "toStatusReference": "10003",
      *           "triggers": [],
-     *           "type": "INITIAL",
+     *           "type": "DIRECTED",
      *           "validators": []
      *         },
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
-     *           "id": "21",
-     *           "name": "In Progress",
+     *           "id": "1",
+     *           "links": [],
+     *           "name": "Create",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10002"
-     *           },
+     *           "toStatusReference": "10001",
      *           "triggers": [],
-     *           "type": "GLOBAL",
+     *           "type": "INITIAL",
      *           "validators": []
      *         },
      *         {
      *           "actions": [],
      *           "description": "",
-     *           "from": [],
      *           "id": "11",
+     *           "links": [],
      *           "name": "To Do",
      *           "properties": {},
-     *           "to": {
-     *             "statusReference": "10001"
-     *           },
+     *           "toStatusReference": "10002",
      *           "triggers": [],
      *           "type": "GLOBAL",
      *           "validators": []
@@ -2249,8 +2244,9 @@ export declare class WorkflowsService extends CommonHttpService {
         expand?: string | undefined;
         /**
          * @example
+         * ```
          * {
-         *   "statuses": [
+         * "statuses": [
          *     {
          *       "description": "",
          *       "name": "To Do",
@@ -2326,13 +2322,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "1",
+         *           "links": [],
          *           "name": "Create",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *           },
+         *           "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *           "triggers": [],
          *           "type": "INITIAL",
          *           "validators": []
@@ -2340,13 +2334,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "11",
+         *           "links": [],
          *           "name": "To Do",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *           },
+         *           "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
@@ -2354,29 +2346,31 @@ export declare class WorkflowsService extends CommonHttpService {
          *         {
          *           "actions": [],
          *           "description": "",
-         *           "from": [],
          *           "id": "21",
+         *           "links": [],
          *           "name": "In Progress",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
-         *           },
+         *           "toStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
          *           "triggers": [],
          *           "type": "GLOBAL",
          *           "validators": []
          *         },
          *         {
          *           "actions": [],
-         *           "description": "",
-         *           "from": [],
+         *           "description": "Move a work item from in progress to done",
          *           "id": "31",
+         *           "links": [
+         *             {
+         *               "fromPort": 0,
+         *               "fromStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
+         *               "toPort": 1
+         *             }
+         *           ],
          *           "name": "Done",
          *           "properties": {},
-         *           "to": {
-         *             "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
-         *           },
+         *           "toStatusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849",
          *           "triggers": [],
-         *           "type": "GLOBAL",
+         *           "type": "DIRECTED",
          *           "validators": []
          *         }
          *       ],
@@ -2387,6 +2381,7 @@ export declare class WorkflowsService extends CommonHttpService {
          *     }
          *   ]
          * }
+         * ```
          */
         workflowUpdateRequest: WorkflowUpdateRequest;
     }) => Promise<WorkflowUpdateResponse>;
@@ -2426,8 +2421,9 @@ export declare class WorkflowsService extends CommonHttpService {
     validateCreateWorkflows: ({ workflowCreateValidateRequest }: {
         /**
          * @example
+         * ```
          * {
-         *   "payload": {
+         * "payload": {
          *     "scope": {
          *       "type": "GLOBAL"
          *     },
@@ -2489,13 +2485,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *           {
          *             "actions": [],
          *             "description": "",
-         *             "from": [],
          *             "id": "1",
+         *             "links": [],
          *             "name": "Create",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *             },
+         *             "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *             "triggers": [],
          *             "type": "INITIAL",
          *             "validators": []
@@ -2503,13 +2497,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *           {
          *             "actions": [],
          *             "description": "",
-         *             "from": [],
          *             "id": "11",
+         *             "links": [],
          *             "name": "To Do",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *             },
+         *             "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *             "triggers": [],
          *             "type": "GLOBAL",
          *             "validators": []
@@ -2517,29 +2509,31 @@ export declare class WorkflowsService extends CommonHttpService {
          *           {
          *             "actions": [],
          *             "description": "",
-         *             "from": [],
          *             "id": "21",
+         *             "links": [],
          *             "name": "In Progress",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
-         *             },
+         *             "toStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
          *             "triggers": [],
          *             "type": "GLOBAL",
          *             "validators": []
          *           },
          *           {
          *             "actions": [],
-         *             "description": "",
-         *             "from": [],
+         *             "description": "Move a work item from in progress to done",
          *             "id": "31",
+         *             "links": [
+         *               {
+         *                 "fromPort": 0,
+         *                 "fromStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
+         *                 "toPort": 1
+         *               }
+         *             ],
          *             "name": "Done",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
-         *             },
+         *             "toStatusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849",
          *             "triggers": [],
-         *             "type": "GLOBAL",
+         *             "type": "DIRECTED",
          *             "validators": []
          *           }
          *         ]
@@ -2553,6 +2547,7 @@ export declare class WorkflowsService extends CommonHttpService {
          *     ]
          *   }
          * }
+         * ```
          */
         workflowCreateValidateRequest: WorkflowCreateValidateRequest;
     }) => Promise<WorkflowValidationErrorList>;
@@ -2592,8 +2587,9 @@ export declare class WorkflowsService extends CommonHttpService {
     validateUpdateWorkflows: ({ workflowUpdateValidateRequestBean }: {
         /**
          * @example
+         * ```
          * {
-         *   "payload": {
+         * "payload": {
          *     "statuses": [
          *       {
          *         "description": "",
@@ -2670,13 +2666,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *           {
          *             "actions": [],
          *             "description": "",
-         *             "from": [],
          *             "id": "1",
+         *             "links": [],
          *             "name": "Create",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *             },
+         *             "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *             "triggers": [],
          *             "type": "INITIAL",
          *             "validators": []
@@ -2684,13 +2678,11 @@ export declare class WorkflowsService extends CommonHttpService {
          *           {
          *             "actions": [],
          *             "description": "",
-         *             "from": [],
          *             "id": "11",
+         *             "links": [],
          *             "name": "To Do",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
-         *             },
+         *             "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
          *             "triggers": [],
          *             "type": "GLOBAL",
          *             "validators": []
@@ -2698,29 +2690,31 @@ export declare class WorkflowsService extends CommonHttpService {
          *           {
          *             "actions": [],
          *             "description": "",
-         *             "from": [],
          *             "id": "21",
+         *             "links": [],
          *             "name": "In Progress",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
-         *             },
+         *             "toStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
          *             "triggers": [],
          *             "type": "GLOBAL",
          *             "validators": []
          *           },
          *           {
          *             "actions": [],
-         *             "description": "",
-         *             "from": [],
+         *             "description": "Move a work item from in progress to done",
          *             "id": "31",
+         *             "links": [
+         *               {
+         *                 "fromPort": 0,
+         *                 "fromStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
+         *                 "toPort": 1
+         *               }
+         *             ],
          *             "name": "Done",
          *             "properties": {},
-         *             "to": {
-         *               "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
-         *             },
+         *             "toStatusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849",
          *             "triggers": [],
-         *             "type": "GLOBAL",
+         *             "type": "DIRECTED",
          *             "validators": []
          *           }
          *         ],
@@ -2738,6 +2732,7 @@ export declare class WorkflowsService extends CommonHttpService {
          *     ]
          *   }
          * }
+         * ```
          */
         workflowUpdateValidateRequestBean: WorkflowUpdateValidateRequestBean;
     }) => Promise<WorkflowValidationErrorList>;
@@ -2970,7 +2965,7 @@ export declare class WorkflowsService extends CommonHttpService {
      *  *  DateFieldValidator
      *  *  WindowsDateValidator
      *
-     * ##### Proforma: Forms attached validator #####
+     * ##### Pro forma: Forms attached validator #####
      *
      * Validates that one or more forms are attached to the issue.
      * ```