@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import type { IssueAssignRequestBean } from "../models/common";
 import type { EpicRankRequestBean, EpicUpdateBean } from "../models/epic";
 /**
@@ -14,7 +14,9 @@ export declare class EpicService extends CommonHttpService {
      *
      * @returns Returns the requested epic.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": 37,
      *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
      *   "name": "epic 1",
@@ -24,8 +26,10 @@ export declare class EpicService extends CommonHttpService {
      *   },
      *   "done": true
      * }
-     * @path {GET} /rest/agile/1.0/epic/{epicIdOrKey}
+     * ```
+     * @path GET `/rest/agile/1.0/epic/{epicIdOrKey}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-epicidorkey-get
+     * @param params
      */
     getEpic: ({ epicIdOrKey, }: {
         /** The id or key of the requested epic. */
@@ -45,7 +49,9 @@ export declare class EpicService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -62,8 +68,7 @@ export declare class EpicService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -75,14 +80,10 @@ export declare class EpicService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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"
+     *             "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": {
@@ -95,8 +96,7 @@ export declare class EpicService extends CommonHttpService {
      *             "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/projectCategory/10000"
      *           },
      *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *           "simplified": false,
@@ -108,8 +108,7 @@ export declare class EpicService extends CommonHttpService {
      *               "accountId": "5b10a2844c20165700ede21g",
      *               "active": false,
      *               "displayName": "Mia Krystof",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "body": {
      *               "type": "doc",
@@ -120,10 +119,7 @@ export declare class EpicService extends CommonHttpService {
      *                   "content": [
      *                     {
      *                       "type": "text",
-     *                       "text": "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."
+     *                       "text": "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."
      *                     }
      *                   ]
      *                 }
@@ -131,14 +127,12 @@ export declare class EpicService extends CommonHttpService {
      *             },
      *             "created": "2021-01-17T12:34:00.000+0000",
      *             "id": "10000",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "updated": "2021-01-18T23:45:00.000+0000",
      *             "visibility": {
@@ -164,8 +158,7 @@ export declare class EpicService extends CommonHttpService {
      *               "accountId": "5b10a2844c20165700ede21g",
      *               "active": false,
      *               "displayName": "Mia Krystof",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "comment": {
      *               "type": "doc",
@@ -184,8 +177,7 @@ export declare class EpicService extends CommonHttpService {
      *             },
      *             "id": "100028",
      *             "issueId": "10002",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *             "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,
@@ -193,8 +185,7 @@ export declare class EpicService extends CommonHttpService {
      *               "accountId": "5b10a2844c20165700ede21g",
      *               "active": false,
      *               "displayName": "Mia Krystof",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "updated": "2021-01-18T23:45:00.000+0000",
      *             "visibility": {
@@ -216,16 +207,17 @@ export declare class EpicService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/epic/{epicIdOrKey}/issue
+     * ```
+     * @path GET `/rest/agile/1.0/epic/{epicIdOrKey}/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-epicidorkey-issue-get
+     * @param params
      */
     getIssuesForEpic: ({ epicIdOrKey, startAt, maxResults, jql, validateQuery, fields, expand, }: {
         /** The id or key of the epic that contains the requested issues. */
@@ -274,7 +266,9 @@ export declare class EpicService extends CommonHttpService {
      *
      * @returns Returns the requested issues, at the specified page of the results.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "expand": "names,schema",
      *   "issues": [
      *     {
@@ -291,8 +285,7 @@ export declare class EpicService extends CommonHttpService {
      *         "closedSprints": [
      *           {
      *             "id": 37,
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      *             "state": "closed",
      *             "name": "sprint 1",
      *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -304,14 +297,10 @@ export declare class EpicService extends CommonHttpService {
      *         "description": "example bug report",
      *         "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"
+     *             "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": {
@@ -324,8 +313,7 @@ export declare class EpicService extends CommonHttpService {
      *             "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/projectCategory/10000"
      *           },
      *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *           "simplified": false,
@@ -337,8 +325,7 @@ export declare class EpicService extends CommonHttpService {
      *               "accountId": "5b10a2844c20165700ede21g",
      *               "active": false,
      *               "displayName": "Mia Krystof",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "body": {
      *               "type": "doc",
@@ -349,10 +336,7 @@ export declare class EpicService extends CommonHttpService {
      *                   "content": [
      *                     {
      *                       "type": "text",
-     *                       "text": "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."
+     *                       "text": "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."
      *                     }
      *                   ]
      *                 }
@@ -360,14 +344,12 @@ export declare class EpicService extends CommonHttpService {
      *             },
      *             "created": "2021-01-17T12:34:00.000+0000",
      *             "id": "10000",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/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"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "updated": "2021-01-18T23:45:00.000+0000",
      *             "visibility": {
@@ -393,8 +375,7 @@ export declare class EpicService extends CommonHttpService {
      *               "accountId": "5b10a2844c20165700ede21g",
      *               "active": false,
      *               "displayName": "Mia Krystof",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "comment": {
      *               "type": "doc",
@@ -413,8 +394,7 @@ export declare class EpicService extends CommonHttpService {
      *             },
      *             "id": "100028",
      *             "issueId": "10002",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *             "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,
@@ -422,8 +402,7 @@ export declare class EpicService extends CommonHttpService {
      *               "accountId": "5b10a2844c20165700ede21g",
      *               "active": false,
      *               "displayName": "Mia Krystof",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *             },
      *             "updated": "2021-01-18T23:45:00.000+0000",
      *             "visibility": {
@@ -445,16 +424,17 @@ export declare class EpicService extends CommonHttpService {
      *       },
      *       "id": "10001",
      *       "key": "HSP-1",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
      *     }
      *   ],
      *   "maxResults": 50,
      *   "startAt": 0,
      *   "total": 1
      * }
-     * @path {GET} /rest/agile/1.0/epic/none/issue
+     * ```
+     * @path GET `/rest/agile/1.0/epic/none/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-none-issue-get
+     * @param params
      */
     getIssuesWithoutEpic: ({ startAt, maxResults, jql, validateQuery, fields, expand, }?: {
         /**
@@ -492,14 +472,16 @@ export declare class EpicService extends CommonHttpService {
      * number of issues that can be moved in one operation is 50. **Note:** This
      * operation does not work for epics in next-gen projects.
      *
-     * @path {POST} /rest/agile/1.0/epic/{epicIdOrKey}/issue
+     * @path POST `/rest/agile/1.0/epic/{epicIdOrKey}/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-epicidorkey-issue-post
+     * @param params
      */
     moveIssuesToEpic: ({ epicIdOrKey, issueAssignRequestBean, }: {
         /** The id or key of the epic that you want to assign issues to. */
         epicIdOrKey: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "issues": [
          *         "10001",
          *         "PR-1",
@@ -517,7 +499,9 @@ export declare class EpicService extends CommonHttpService {
      *
      * @returns Updated epic
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": 37,
      *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
      *   "name": "epic 1",
@@ -527,14 +511,17 @@ export declare class EpicService extends CommonHttpService {
      *   },
      *   "done": true
      * }
-     * @path {POST} /rest/agile/1.0/epic/{epicIdOrKey}
+     * ```
+     * @path POST `/rest/agile/1.0/epic/{epicIdOrKey}`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-epicidorkey-post
+     * @param params
      */
     partiallyUpdateEpic: ({ epicIdOrKey, epicUpdateBean, }: {
         /** The id or key of the epic to update. */
         epicIdOrKey: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "color": {
          *         "key": "color_6"
          *     },
@@ -552,8 +539,9 @@ export declare class EpicService extends CommonHttpService {
      *
      * **Note:** This operation does not work for epics in next-gen projects.
      *
-     * @path {PUT} /rest/agile/1.0/epic/{epicIdOrKey}/rank
+     * @path PUT `/rest/agile/1.0/epic/{epicIdOrKey}/rank`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-epicidorkey-rank-put
+     * @param params
      */
     rankEpics: ({ epicIdOrKey, epicRankRequestBean, }: {
         /** The id or key of the epic to rank. */
@@ -561,7 +549,8 @@ export declare class EpicService extends CommonHttpService {
         /**
          * bean which contains the information where the given epic should be ranked.
          *
-         * @example {
+         * @example
+         * {
          *     "rankBeforeEpic": "10000",
          *     "rankCustomFieldId": 10521
          * }
@@ -575,12 +564,14 @@ export declare class EpicService extends CommonHttpService {
      * epics in next-gen projects. Instead, update the issue using `\{ fields: \{
      * parent: \{\} \} \}`
      *
-     * @path {POST} /rest/agile/1.0/epic/none/issue
+     * @path POST `/rest/agile/1.0/epic/none/issue`
      * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic#api-rest-agile-1-0-epic-none-issue-post
+     * @param params
      */
     removeIssuesFromEpic: ({ issueAssignRequestBean, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "issues": [
          *         "10001",
          *         "PR-1",