@resolution/jira-api-client 0.16.8 → 0.16.9

package/lib/openapi/software/services/EpicService.d.ts

@@ -1,5 +1,5 @@
 import { CommonHttpService } from "../../core/CommonHttpService";
-import type { IssueAssignRequestBean } from "../models/common";
+import { type IssueAssignRequestBean, type SoftwareIssueResults } from "../models/common";
 import type { EpicUpdateBean, EpicRankRequestBean } from "../models/epic";
 /**
  * Apis related to epics
@@ -48,6 +48,7 @@ export declare class EpicService extends CommonHttpService {
      * `parent` clause. For more information on the `parent` JQL field, see [Advanced
      * searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
      *
+     * @deprecated
      * @returns Returns the requested issues, at the specified page of the results.
      *
      * example:
@@ -253,6 +254,268 @@ export declare class EpicService extends CommonHttpService {
         /** A comma-separated list of the parameters to expand. */
         expand?: string | undefined;
     }) => Promise<unknown>;
+    /**
+     * Returns all issues that belong to the epic, for the given epic ID. Result
+     * pagination is token based, using `nextPageToken` and `maxResults`. This only
+     * includes issues that the user has permission to view. Issues returned from this
+     * resource include Software project fields, like sprint, closedSprints, flagged,
+     * and epic. By default, the returned issues are ordered by rank. **Note:** If you
+     * are querying a Team Managed project, do not use this operation. Instead, search
+     * for issues that belong to an epic by using the [Search for issues using JQL
+     * enhanced
+     * search](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get)
+     * operation in the Jira platform REST API. Build your JQL query using the
+     * `parent` clause. For more information on the `parent` JQL field, see [Advanced
+     * searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
+     *
+     * @returns Returns the requested issues, at the specified page of the results.
+     *
+     * example:
+     * ```
+     * {
+     *   "expand": "names,schema",
+     *   "isLast": true,
+     *   "issues": [
+     *     {
+     *       "expand": "",
+     *       "fields": {
+     *         "watcher": {
+     *           "isWatching": false,
+     *           "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
+     *           "watchCount": 1
+     *         },
+     *         "attachment": [
+     *           {
+     *             "author": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "accountType": "atlassian",
+     *               "active": false,
+     *               "avatarUrls": {
+     *                 "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *                 "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *                 "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *                 "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *               },
+     *               "displayName": "Mia Krystof",
+     *               "key": "",
+     *               "name": "",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
+     *             "created": "2023-06-24T19:24:50.000+0000",
+     *             "filename": "debuglog.txt",
+     *             "id": 10001,
+     *             "mimeType": "text/plain",
+     *             "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
+     *             "size": 2460
+     *           }
+     *         ],
+     *         "sub-tasks": [
+     *           {
+     *             "id": "10000",
+     *             "outwardIssue": {
+     *               "fields": {
+     *                 "status": {
+     *                   "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+     *                   "name": "Open"
+     *                 }
+     *               },
+     *               "id": "10003",
+     *               "key": "ED-2",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
+     *             },
+     *             "type": {
+     *               "id": "10000",
+     *               "inward": "Parent",
+     *               "name": "",
+     *               "outward": "Sub-task"
+     *             }
+     *           }
+     *         ],
+     *         "description": "Main order flow broken",
+     *         "project": {
+     *           "avatarUrls": {
+     *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *           },
+     *           "id": "10000",
+     *           "insight": {
+     *             "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *             "totalIssueCount": 100
+     *           },
+     *           "key": "EX",
+     *           "name": "Example",
+     *           "projectCategory": {
+     *             "description": "First Project Category",
+     *             "id": "10000",
+     *             "name": "FIRST",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *           },
+     *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+     *           "simplified": false,
+     *           "style": "classic"
+     *         },
+     *         "comment": [
+     *           {
+     *             "author": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
+     *             "created": "2021-01-17T12:34:00.000+0000",
+     *             "id": "10000",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+     *             "updateAuthor": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "updated": "2021-01-18T23:45:00.000+0000",
+     *             "visibility": {
+     *               "identifier": "Administrators",
+     *               "type": "role",
+     *               "value": "Administrators"
+     *             }
+     *           }
+     *         ],
+     *         "issuelinks": [
+     *           {
+     *             "id": "10001",
+     *             "outwardIssue": {
+     *               "fields": {
+     *                 "status": {
+     *                   "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+     *                   "name": "Open"
+     *                 }
+     *               },
+     *               "id": "10004L",
+     *               "key": "PR-2",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
+     *             },
+     *             "type": {
+     *               "id": "10000",
+     *               "inward": "depends on",
+     *               "name": "Dependent",
+     *               "outward": "is depended by"
+     *             }
+     *           },
+     *           {
+     *             "id": "10002",
+     *             "inwardIssue": {
+     *               "fields": {
+     *                 "status": {
+     *                   "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+     *                   "name": "Open"
+     *                 }
+     *               },
+     *               "id": "10004",
+     *               "key": "PR-3",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
+     *             },
+     *             "type": {
+     *               "id": "10000",
+     *               "inward": "depends on",
+     *               "name": "Dependent",
+     *               "outward": "is depended by"
+     *             }
+     *           }
+     *         ],
+     *         "worklog": [
+     *           {
+     *             "author": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "comment": "I did some work here.",
+     *             "id": "100028",
+     *             "issueId": "10002",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *             "started": "2021-01-17T12:34:00.000+0000",
+     *             "timeSpent": "3h 20m",
+     *             "timeSpentSeconds": 12000,
+     *             "updateAuthor": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "updated": "2021-01-18T23:45:00.000+0000",
+     *             "visibility": {
+     *               "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *               "type": "group",
+     *               "value": "jira-developers"
+     *             }
+     *           }
+     *         ],
+     *         "updated": 1,
+     *         "timetracking": {
+     *           "originalEstimate": "10m",
+     *           "originalEstimateSeconds": 600,
+     *           "remainingEstimate": "3m",
+     *           "remainingEstimateSeconds": 200,
+     *           "timeSpent": "6m",
+     *           "timeSpentSeconds": 400
+     *         }
+     *       },
+     *       "id": "10002",
+     *       "key": "ED-1",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/software/1.0/epic/{epicIdOrKey}/issue`
+     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-software-1-0-epic-epicidorkey-issue-get
+     * @param params
+     */
+    getIssuesForEpicJsis: ({ epicIdOrKey, nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }: {
+        /** The ID or key of the epic that contains the requested issues. */
+        epicIdOrKey: string;
+        /**
+         * The token for a page to fetch that is not the first page. The first page has a
+         * `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
+         * issues.
+         *
+         * Note: The `nextPageToken` field is **not included** in the response for the
+         * last page, indicating there is no next page.
+         */
+        nextPageToken?: string | undefined;
+        /**
+         * The maximum number of items to return per page. To manage page size, the API
+         * may return fewer items per page where there is a large number of fields or
+         * properties returned. It returns max 5000 issues.
+         */
+        maxResults?: number | undefined;
+        /**
+         * Strong consistency issue IDs to be reconciled with search results. Accepts max
+         * 50 IDs. This list of IDs should be consistent with each paginated request
+         * across different pages.
+         */
+        reconcileIssues?: number[] | undefined;
+        /**
+         * Filters results using a JQL query. If you define an order in your JQL query, it
+         * will override the default order of the returned issues.
+         * Note that `username` and `userkey` can't be used as search terms for this
+         * parameter due to privacy reasons. Use `accountId` instead.
+         */
+        jql?: string | undefined;
+        /** Specifies whether to validate the JQL query or not. Default: true. */
+        validateQuery?: boolean | undefined;
+        /**
+         * The list of fields to return for each issue. By default, all navigable and
+         * Software project fields are returned.
+         */
+        fields?: {}[] | undefined;
+        /** A comma-separated list of the parameters to expand. */
+        expand?: string | undefined;
+    }) => Promise<SoftwareIssueResults>;
     /**
      * Returns all issues that do not belong to any epic. This only includes issues
      * that the user has permission to view. Issues returned from this resource
@@ -265,6 +528,7 @@ export declare class EpicService extends CommonHttpService {
      * is empty` clause. For more information on the `parent` JQL field, see [Advanced
      * searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
      *
+     * @deprecated
      * @returns Returns the requested issues, at the specified page of the results.
      *
      * example:
@@ -465,6 +729,265 @@ export declare class EpicService extends CommonHttpService {
         /** A comma-separated list of the parameters to expand. */
         expand?: string | undefined;
     }) => Promise<unknown>;
+    /**
+     * Returns all issues that do not belong to any epic. Result pagination is token
+     * based, using `nextPageToken` and `maxResults`. This only includes issues that
+     * the user has permission to view. Issues returned from this resource include
+     * Software project fields, like sprint, closedSprints, flagged, and epic. By
+     * default, the returned issues are ordered by rank. **Note:** If you are querying
+     * a Team Managed project, do not use this operation. Instead, search for issues
+     * that don't belong to an epic by using the [Search for issues using JQL enhanced
+     * search](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get)
+     * operation in the Jira platform REST API. Build your JQL query using the `parent
+     * is empty` clause. For more information on the `parent` JQL field, see [Advanced
+     * searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
+     *
+     * @returns Returns the requested issues, at the specified page of the results.
+     *
+     * example:
+     * ```
+     * {
+     *   "expand": "names,schema",
+     *   "isLast": true,
+     *   "issues": [
+     *     {
+     *       "expand": "",
+     *       "fields": {
+     *         "watcher": {
+     *           "isWatching": false,
+     *           "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
+     *           "watchCount": 1
+     *         },
+     *         "attachment": [
+     *           {
+     *             "author": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "accountType": "atlassian",
+     *               "active": false,
+     *               "avatarUrls": {
+     *                 "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *                 "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *                 "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *                 "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *               },
+     *               "displayName": "Mia Krystof",
+     *               "key": "",
+     *               "name": "",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
+     *             "created": "2023-06-24T19:24:50.000+0000",
+     *             "filename": "debuglog.txt",
+     *             "id": 10001,
+     *             "mimeType": "text/plain",
+     *             "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
+     *             "size": 2460
+     *           }
+     *         ],
+     *         "sub-tasks": [
+     *           {
+     *             "id": "10000",
+     *             "outwardIssue": {
+     *               "fields": {
+     *                 "status": {
+     *                   "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+     *                   "name": "Open"
+     *                 }
+     *               },
+     *               "id": "10003",
+     *               "key": "ED-2",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
+     *             },
+     *             "type": {
+     *               "id": "10000",
+     *               "inward": "Parent",
+     *               "name": "",
+     *               "outward": "Sub-task"
+     *             }
+     *           }
+     *         ],
+     *         "description": "Main order flow broken",
+     *         "project": {
+     *           "avatarUrls": {
+     *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *           },
+     *           "id": "10000",
+     *           "insight": {
+     *             "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *             "totalIssueCount": 100
+     *           },
+     *           "key": "EX",
+     *           "name": "Example",
+     *           "projectCategory": {
+     *             "description": "First Project Category",
+     *             "id": "10000",
+     *             "name": "FIRST",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *           },
+     *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+     *           "simplified": false,
+     *           "style": "classic"
+     *         },
+     *         "comment": [
+     *           {
+     *             "author": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
+     *             "created": "2021-01-17T12:34:00.000+0000",
+     *             "id": "10000",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+     *             "updateAuthor": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "updated": "2021-01-18T23:45:00.000+0000",
+     *             "visibility": {
+     *               "identifier": "Administrators",
+     *               "type": "role",
+     *               "value": "Administrators"
+     *             }
+     *           }
+     *         ],
+     *         "issuelinks": [
+     *           {
+     *             "id": "10001",
+     *             "outwardIssue": {
+     *               "fields": {
+     *                 "status": {
+     *                   "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+     *                   "name": "Open"
+     *                 }
+     *               },
+     *               "id": "10004L",
+     *               "key": "PR-2",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
+     *             },
+     *             "type": {
+     *               "id": "10000",
+     *               "inward": "depends on",
+     *               "name": "Dependent",
+     *               "outward": "is depended by"
+     *             }
+     *           },
+     *           {
+     *             "id": "10002",
+     *             "inwardIssue": {
+     *               "fields": {
+     *                 "status": {
+     *                   "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
+     *                   "name": "Open"
+     *                 }
+     *               },
+     *               "id": "10004",
+     *               "key": "PR-3",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
+     *             },
+     *             "type": {
+     *               "id": "10000",
+     *               "inward": "depends on",
+     *               "name": "Dependent",
+     *               "outward": "is depended by"
+     *             }
+     *           }
+     *         ],
+     *         "worklog": [
+     *           {
+     *             "author": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "comment": "I did some work here.",
+     *             "id": "100028",
+     *             "issueId": "10002",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *             "started": "2021-01-17T12:34:00.000+0000",
+     *             "timeSpent": "3h 20m",
+     *             "timeSpentSeconds": 12000,
+     *             "updateAuthor": {
+     *               "accountId": "5b10a2844c20165700ede21g",
+     *               "active": false,
+     *               "displayName": "Mia Krystof",
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *             },
+     *             "updated": "2021-01-18T23:45:00.000+0000",
+     *             "visibility": {
+     *               "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *               "type": "group",
+     *               "value": "jira-developers"
+     *             }
+     *           }
+     *         ],
+     *         "updated": 1,
+     *         "timetracking": {
+     *           "originalEstimate": "10m",
+     *           "originalEstimateSeconds": 600,
+     *           "remainingEstimate": "3m",
+     *           "remainingEstimateSeconds": 200,
+     *           "timeSpent": "6m",
+     *           "timeSpentSeconds": 400
+     *         }
+     *       },
+     *       "id": "10002",
+     *       "key": "ED-1",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/software/1.0/epic/none/issue`
+     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-software-1-0-epic-none-issue-get
+     * @param params
+     */
+    getIssuesWithoutEpicJsis: ({ nextPageToken, maxResults, reconcileIssues, jql, validateQuery, fields, expand }?: {
+        /**
+         * The token for a page to fetch that is not the first page. The first page has a
+         * `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of
+         * issues.
+         *
+         * Note: The `nextPageToken` field is **not included** in the response for the
+         * last page, indicating there is no next page.
+         */
+        nextPageToken?: string | undefined;
+        /**
+         * The maximum number of items to return per page. To manage page size, the API
+         * may return fewer items per page where there is a large number of fields or
+         * properties returned. It returns max 5000 issues.
+         */
+        maxResults?: number | undefined;
+        /**
+         * Strong consistency issue IDs to be reconciled with search results. Accepts max
+         * 50 IDs. This list of IDs should be consistent with each paginated request
+         * across different pages.
+         */
+        reconcileIssues?: number[] | undefined;
+        /**
+         * Filters results using a JQL query. If you define an order in your JQL query, it
+         * will override the default order of the returned issues.
+         * Note that `username` and `userkey` can't be used as search terms for this
+         * parameter due to privacy reasons. Use `accountId` instead.
+         */
+        jql?: string | undefined;
+        /** Specifies whether to validate the JQL query or not. Default: true. */
+        validateQuery?: boolean | undefined;
+        /**
+         * The list of fields to return for each issue. By default, all navigable and
+         * Software project fields are returned.
+         */
+        fields?: {}[] | undefined;
+        /** A comma-separated list of the parameters to expand. */
+        expand?: string | undefined;
+    }) => Promise<SoftwareIssueResults>;
     /**
      * Moves issues to an epic, for a given epic id. Issues can be only in a single
      * epic at the same time. That means that already assigned issues to an epic, will