@resolution/jira-api-client 0.7.8 → 0.10.0

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

@@ -1,5 +1,5 @@
 import { CommonHttpService } from "../../core/CommonHttpService";
-import { type BulkEditGetFields, type BulkOperationProgress, type IssueBulkEditPayload, type IssueBulkMovePayload, type SubmittedBulkOperation } from "../models/issueBulkOperations";
+import { type BulkEditGetFields, type BulkOperationProgress, type BulkTransitionGetAvailableTransitions, type IssueBulkDeletePayload, type IssueBulkEditPayload, type IssueBulkMovePayload, type IssueBulkTransitionPayload, type SubmittedBulkOperation } from "../models/issueBulkOperations";
 /**
  * This resource represents the issue bulk operations. Use it to move multiple
  * issues from one project to another project or edit fields of multiple issues in
@@ -29,6 +29,117 @@ import { type BulkEditGetFields, type BulkOperationProgress, type IssueBulkEditP
  * @category Services
  */
 export declare class IssueBulkOperationsService extends CommonHttpService {
+    /**
+     * Use this API to retrieve a list of transitions available for the specified
+     * issues that can be used or bulk transition operations. You can submit either
+     * single or multiple issues in the query to obtain the available transitions.
+     *
+     * The response will provide the available transitions for issues, organized by
+     * their respective workflows. **Only the transitions that are common among the
+     * issues within that workflow and do not involve any additional field updates
+     * will be included.** For bulk transitions that require additional field updates,
+     * please utilise the Jira Cloud UI.
+     *
+     * You can request available transitions for up to 1,000 issues in a single
+     * operation. This API uses pagination to return responses, delivering 50
+     * workflows at a time.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  Global bulk change
+     * [permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).
+     *  *  Transition [issues
+     * permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/#Transition-issues/)
+     * in all projects that contain the selected issues.
+     *  *  Browse [project
+     * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/)
+     * in all projects that contain the selected issues.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "availableTransitions": [
+     *     {
+     *       "isTransitionsFiltered": false,
+     *       "issues": [
+     *         "EPIC-1",
+     *         "TASK-1"
+     *       ],
+     *       "transitions": [
+     *         {
+     *           "to": {
+     *             "statusId": 10001,
+     *             "statusName": "To Do"
+     *           },
+     *           "transitionId": 11,
+     *           "transitionName": "To Do"
+     *         },
+     *         {
+     *           "to": {
+     *             "statusId": 10002,
+     *             "statusName": "In Progress"
+     *           },
+     *           "transitionId": 21,
+     *           "transitionName": "In Progress"
+     *         },
+     *         {
+     *           "to": {
+     *             "statusId": 10003,
+     *             "statusName": "Done"
+     *           },
+     *           "transitionId": 31,
+     *           "transitionName": "Done"
+     *         }
+     *       ]
+     *     },
+     *     {
+     *       "isTransitionsFiltered": true,
+     *       "issues": [
+     *         "BUG-1"
+     *       ],
+     *       "transitions": [
+     *         {
+     *           "to": {
+     *             "statusId": 10004,
+     *             "statusName": "To Do bug"
+     *           },
+     *           "transitionId": 41,
+     *           "transitionName": "To Do bug"
+     *         },
+     *         {
+     *           "to": {
+     *             "statusId": 10005,
+     *             "statusName": "Triage"
+     *           },
+     *           "transitionId": 51,
+     *           "transitionName": "Triage"
+     *         }
+     *       ]
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/api/3/bulk/issues/transition`
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations#api-rest-api-3-bulk-issues-transition-get
+     * @param params
+     */
+    getAvailableTransitions: ({ issueIdsOrKeys, endingBefore, startingAfter, }: {
+        /**
+         * Comma (,) separated Ids or keys of the issues to get transitions available for
+         * them.
+         */
+        issueIdsOrKeys: string;
+        /** (Optional)The end cursor for use in pagination. */
+        endingBefore?: string | undefined;
+        /** (Optional)The start cursor for use in pagination. */
+        startingAfter?: string | undefined;
+    }) => Promise<BulkTransitionGetAvailableTransitions>;
     /**
      * Use this API to get a list of fields visible to the user to perform bulk edit
      * operations. You can pass single or multiple issues in the query to get eligible
@@ -169,6 +280,52 @@ export declare class IssueBulkOperationsService extends CommonHttpService {
         /** The ID of the task. */
         taskId: string;
     }) => Promise<BulkOperationProgress>;
+    /**
+     * Use this API to submit a bulk delete request. You can delete up to 1,000 issues
+     * in a single operation.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  Global bulk change
+     * [permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).
+     *  *  Delete [issues
+     * permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/#Delete-issues/)
+     * in all projects that contain the selected issues.
+     *  *  Browse [project
+     * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/)
+     * in all projects that contain the selected issues.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "taskId": "10641"
+     * }
+     * ```
+     * @path POST `/rest/api/3/bulk/issues/delete`
+     * @scopes-current write:jira-work
+     * @scopes-beta write:issue:jira, read:issue:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations#api-rest-api-3-bulk-issues-delete-post
+     * @param params
+     */
+    submitBulkDelete: ({ issueBulkDeletePayload, }: {
+        /**
+         * The request body containing the issues to be deleted.
+         *
+         * @example
+         * {
+         *   "selectedIssueIdsOrKeys": [
+         *     "10001",
+         *     "10002"
+         *   ],
+         *   "sendBulkNotification": false
+         * }
+         */
+        issueBulkDeletePayload: IssueBulkDeletePayload;
+    }) => Promise<SubmittedBulkOperation>;
     /**
      * Use this API to submit a bulk edit request and simultaneously edit multiple
      * issues. There are limits applied to the number of issues and fields that can be
@@ -275,89 +432,147 @@ export declare class IssueBulkOperationsService extends CommonHttpService {
         /**
          * @example
          * {
-         *     "sendBulkNotification": true,
-         *     "targetToSourcesMapping": {
-         *         "PROJECT-KEY,10001": {
-         *             "inferClassificationDefaults": false,
-         *             "inferFieldDefaults": false,
-         *             "inferStatusDefaults": false,
-         *             "inferSubtaskTypeDefault": true,
-         *             "issueIdsOrKeys": [
-         *                 "ISSUE-1"
-         *             ],
-         *             "targetClassification": [
-         *                 {
-         *                     "classifications": {
-         *                         "5bfa70f7-4af1-44f5-9e12-1ce185f15a38": [
-         *                             "bd58e74c-c31b-41a7-ba69-9673ebd9dae9",
-         *                             "-1"
-         *                         ]
-         *                     }
-         *                 }
-         *             ],
-         *             "targetMandatoryFields": [
-         *                 {
-         *                     "fields": {
-         *                         "customfield_10000": {
-         *                             "retain": false,
-         *                             "type": "raw",
-         *                             "value": [
-         *                                 "value-1",
-         *                                 "value-2"
-         *                             ]
-         *                         },
-         *                         "description": {
-         *                             "retain": true,
-         *                             "type": "adf",
-         *                             "value": {
-         *                                 "content": [
-         *                                     {
-         *                                         "content": [
-         *                                             {
-         *                                                 "text": "New description value",
-         *                                                 "type": "text"
-         *                                             }
-         *                                         ],
-         *                                         "type": "paragraph"
-         *                                     }
-         *                                 ],
-         *                                 "type": "doc",
-         *                                 "version": 1
-         *                             }
-         *                         },
-         *                         "fixVersions": {
-         *                             "retain": false,
-         *                             "type": "raw",
-         *                             "value": [
-         *                                 "10009"
-         *                             ]
-         *                         },
-         *                         "labels": {
-         *                             "retain": false,
-         *                             "type": "raw",
-         *                             "value": [
-         *                                 "label-1",
-         *                                 "label-2"
-         *                             ]
-         *                         }
-         *                     }
-         *                 }
-         *             ],
-         *             "targetStatus": [
-         *                 {
-         *                     "statuses": {
-         *                         "10001": [
-         *                             "10002",
-         *                             "10003"
-         *                         ]
-         *                     }
-         *                 }
+         *   "sendBulkNotification": true,
+         *   "targetToSourcesMapping": {
+         *     "PROJECT-KEY,10001": {
+         *       "inferClassificationDefaults": false,
+         *       "inferFieldDefaults": false,
+         *       "inferStatusDefaults": false,
+         *       "inferSubtaskTypeDefault": true,
+         *       "issueIdsOrKeys": [
+         *         "ISSUE-1"
+         *       ],
+         *       "targetClassification": [
+         *         {
+         *           "classifications": {
+         *             "5bfa70f7-4af1-44f5-9e12-1ce185f15a38": [
+         *               "bd58e74c-c31b-41a7-ba69-9673ebd9dae9",
+         *               "-1"
+         *             ]
+         *           }
+         *         }
+         *       ],
+         *       "targetMandatoryFields": [
+         *         {
+         *           "fields": {
+         *             "customfield_10000": {
+         *               "retain": false,
+         *               "type": "raw",
+         *               "value": [
+         *                 "value-1",
+         *                 "value-2"
+         *               ]
+         *             },
+         *             "description": {
+         *               "retain": true,
+         *               "type": "adf",
+         *               "value": {
+         *                 "content": [
+         *                   {
+         *                     "content": [
+         *                       {
+         *                         "text": "New description value",
+         *                         "type": "text"
+         *                       }
+         *                     ],
+         *                     "type": "paragraph"
+         *                   }
+         *                 ],
+         *                 "type": "doc",
+         *                 "version": 1
+         *               }
+         *             },
+         *             "fixVersions": {
+         *               "retain": false,
+         *               "type": "raw",
+         *               "value": [
+         *                 "10009"
+         *               ]
+         *             },
+         *             "labels": {
+         *               "retain": false,
+         *               "type": "raw",
+         *               "value": [
+         *                 "label-1",
+         *                 "label-2"
+         *               ]
+         *             }
+         *           }
+         *         }
+         *       ],
+         *       "targetStatus": [
+         *         {
+         *           "statuses": {
+         *             "10001": [
+         *               "10002",
+         *               "10003"
          *             ]
+         *           }
          *         }
+         *       ]
          *     }
+         *   }
          * }
          */
         issueBulkMovePayload: IssueBulkMovePayload;
     }) => Promise<SubmittedBulkOperation>;
+    /**
+     * Use this API to submit a bulk issue status transition request. You can
+     * transition multiple issues, alongside with their valid transition Ids. You can
+     * transition up to 1,000 issues in a single operation.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  Global bulk change
+     * [permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).
+     *  *  Transition [issues
+     * permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/#Transition-issues/)
+     * in all projects that contain the selected issues.
+     *  *  Browse [project
+     * permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-permissions/)
+     * in all projects that contain the selected issues.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "taskId": "10641"
+     * }
+     * ```
+     * @path POST `/rest/api/3/bulk/issues/transition`
+     * @scopes-current write:jira-work
+     * @scopes-beta write:issue:jira, read:issue:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations#api-rest-api-3-bulk-issues-transition-post
+     * @param params
+     */
+    submitBulkTransition: ({ issueBulkTransitionPayload, }: {
+        /**
+         * The request body containing the issues to be transitioned.
+         *
+         * @example
+         * {
+         *   "bulkTransitionInputs": [
+         *     {
+         *       "selectedIssueIdsOrKeys": [
+         *         "10001",
+         *         "10002"
+         *       ],
+         *       "transitionId": "11"
+         *     },
+         *     {
+         *       "selectedIssueIdsOrKeys": [
+         *         "TEST-1"
+         *       ],
+         *       "transitionId": "2"
+         *     }
+         *   ],
+         *   "sendBulkNotification": false
+         * }
+         */
+        issueBulkTransitionPayload: IssueBulkTransitionPayload;
+    }) => Promise<SubmittedBulkOperation>;
     protected static initialize(): void;
 }