@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/software/services/SprintService.js

@@ -15,597 +15,600 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint
  */
 class SprintService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Creates a future sprint. Sprint name and origin board id are required. Start
-     * date, end date, and goal are optional.
-     *
-     * Note that the sprint name is trimmed. Also, when starting sprints from the UI,
-     * the "endDate" set through this call is ignored and instead the last sprint's
-     * duration is used to fill the form.
-     *
-     * @returns Created sprint
-     *
-     * example: {
-     *   "id": 37,
-     *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
-     *   "state": "future",
-     *   "name": "sprint 1",
-     *   "startDate": "2015-04-11T15:22:00.000+10:00",
-     *   "endDate": "2015-04-20T01:22:00.000+10:00",
-     *   "originBoardId": 5,
-     *   "goal": "sprint 1 goal"
-     * }
-     * @path {POST} /rest/agile/1.0/sprint
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-post
-     */
-    createSprint({ sprintCreateBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: sprintCreateBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            201: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.createSprint.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Removes the property from the sprint identified by the id. Ths user removing
-     * the property is required to have permissions to modify the sprint.
-     *
-     * @path {DELETE} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-delete
-     */
-    deleteProperty({ sprintId, propertyKey, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}",
-            method: "DELETE",
-            pathParams: {
-                sprintId,
-                propertyKey,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will
-     * be moved to the backlog.
-     *
-     * @path {DELETE} /rest/agile/1.0/sprint/{sprintId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-delete
-     */
-    deleteSprint({ sprintId, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}",
-            method: "DELETE",
-            pathParams: {
-                sprintId,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Returns all issues in a sprint, for a given sprint ID. This only includes
-     * issues that the user has permission to view. By default, the returned issues
-     * are ordered by rank.
-     *
-     * @returns Returns the requested issues, at the specified page of the results.
-     *
-     * example: {
-     *   "expand": "",
-     *   "fields": {
-     *     "flagged": true,
-     *     "sprint": {
-     *       "id": 37,
-     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
-     *       "state": "future",
-     *       "name": "sprint 2",
-     *       "goal": "sprint 2 goal"
-     *     },
-     *     "closedSprints": [
-     *       {
-     *         "id": 37,
-     *         "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",
-     *         "endDate": "2015-04-20T01:22:00.000+10:00",
-     *         "completeDate": "2015-04-20T11:04:00.000+10:00",
-     *         "goal": "sprint 1 goal"
-     *       }
-     *     ],
-     *     "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"
-     *       },
-     *       "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": {
-     *           "type": "doc",
-     *           "version": 1,
-     *           "content": [
-     *             {
-     *               "type": "paragraph",
-     *               "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."
-     *                 }
-     *               ]
-     *             }
-     *           ]
-     *         },
-     *         "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"
-     *         }
-     *       }
-     *     ],
-     *     "epic": {
-     *       "id": 37,
-     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
-     *       "name": "epic 1",
-     *       "summary": "epic 1 summary",
-     *       "color": {
-     *         "key": "color_4"
-     *       },
-     *       "done": true
-     *     },
-     *     "worklog": [
-     *       {
-     *         "author": {
-     *           "accountId": "5b10a2844c20165700ede21g",
-     *           "active": false,
-     *           "displayName": "Mia Krystof",
-     *           "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-     *         },
-     *         "comment": {
-     *           "type": "doc",
-     *           "version": 1,
-     *           "content": [
-     *             {
-     *               "type": "paragraph",
-     *               "content": [
-     *                 {
-     *                   "type": "text",
-     *                   "text": "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": "10001",
-     *   "key": "HSP-1",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
-     * }
-     * @path {GET} /rest/agile/1.0/sprint/{sprintId}/issue
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-issue-get
-     */
-    getIssuesForSprint({ sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/issue",
-            method: "GET",
-            pathParams: {
-                sprintId,
-            },
-            query: {
-                startAt,
-                maxResults,
-                jql,
-                validateQuery,
-                fields,
-                expand,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getIssuesForSprint.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns the keys of all properties for the sprint identified by the id. The
-     * user who retrieves the property keys is required to have permissions to view
-     * the sprint.
-     *
-     * @returns Returned if the sprint with given id exists.
-     *
-     * example: {
-     *   "keys": [
-     *     {
-     *       "key": "issue.support",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
-     *     }
-     *   ]
-     * }
-     * @path {GET} /rest/agile/1.0/sprint/{sprintId}/properties
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-get
-     */
-    getPropertiesKeys({ sprintId, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/properties",
-            method: "GET",
-            pathParams: {
-                sprintId,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getPropertiesKeys.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns the value of the property with a given key from the sprint identified
-     * by the provided id. The user who retrieves the property is required to have
-     * permissions to view the sprint.
-     *
-     * @returns Returned if the sprint exists and the property was found.
-     *
-     * example: {
-     *   "key": "issue.support",
-     *   "value": {
-     *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
-     *     "system.support.time": "1m"
-     *   }
-     * }
-     * @path {GET} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-get
-     */
-    getProperty({ sprintId, propertyKey, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}",
-            method: "GET",
-            pathParams: {
-                sprintId,
-                propertyKey,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getProperty.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns the sprint for a given sprint ID. The sprint will only be returned if
-     * the user can view the board that the sprint was created on, or view at least
-     * one of the issues in the sprint.
-     *
-     * @returns Returns the requested sprint.
-     *
-     * example: {
-     *   "id": 37,
-     *   "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",
-     *   "endDate": "2015-04-20T01:22:00.000+10:00",
-     *   "completeDate": "2015-04-20T11:04:00.000+10:00",
-     *   "originBoardId": 5,
-     *   "goal": "sprint 1 goal"
-     * }
-     * @path {GET} /rest/agile/1.0/sprint/{sprintId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-get
-     */
-    getSprint({ sprintId, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}",
-            method: "GET",
-            pathParams: {
-                sprintId,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getSprint.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Moves issues to a sprint, for a given sprint ID. Issues can only be moved to
-     * open or active sprints. The maximum number of issues that can be moved in one
-     * operation is 50.
-     *
-     * @path {POST} /rest/agile/1.0/sprint/{sprintId}/issue
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-issue-post
-     */
-    moveIssuesToSprintAndRank({ sprintId, issueRankRequestBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/issue",
-            method: "POST",
-            pathParams: {
-                sprintId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: issueRankRequestBean,
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Performs a partial update of a sprint. A partial update means that fields not
-     * present in the request JSON will not be updated.
-     *
-     * Notes:
-     *
-     *  *  For closed sprints, only the name and goal can be updated; changes to other
-     * fields will be ignored.
-     *  *  A sprint can be started by updating the state to 'active'. This requires
-     * the sprint to be in the 'future' state and have a startDate and endDate set.
-     *  *  A sprint can be completed by updating the state to 'closed'. This action
-     * requires the sprint to be in the 'active' state. This sets the completeDate to
-     * the time of the request.
-     *  *  Other changes to state are not allowed.
-     *  *  The completeDate field cannot be updated manually.
-     *
-     * @returns Updated sprint
-     *
-     * example: {
-     *   "id": 37,
-     *   "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",
-     *   "endDate": "2015-04-20T01:22:00.000+10:00",
-     *   "completeDate": "2015-04-20T11:04:00.000+10:00",
-     *   "originBoardId": 5,
-     *   "goal": "sprint 1 goal"
-     * }
-     * @path {POST} /rest/agile/1.0/sprint/{sprintId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-post
-     */
-    partiallyUpdateSprint({ sprintId, sprintBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}",
-            method: "POST",
-            pathParams: {
-                sprintId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: sprintBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.partiallyUpdateSprint.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Sets the value of the specified sprint's property.
-     *
-     * You can use this resource to store a custom data against the sprint identified
-     * by the id. The user who stores the data is required to have permissions to
-     * modify the sprint.
-     *
-     * @returns * status: 200, mediaType: application/json
-     *
-     *    Returned if the sprint property is successfully updated.
-     *
-     *  * status: 201, mediaType: application/json
-     *
-     *    Returned if the sprint property is successfully created.
-     * @path {PUT} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-put
-     */
-    setProperty({ sprintId, propertyKey, requestBody, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}",
-            method: "PUT",
-            pathParams: {
-                sprintId,
-                propertyKey,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: requestBody,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-            201: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.setProperty.response"))
-            .then(commonHttpClient.asCreatedResponse("body"));
-    }
-    /**
-     * Swap the position of the sprint with the second sprint.
-     *
-     * @path {POST} /rest/agile/1.0/sprint/{sprintId}/swap
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-swap-post
-     */
-    swapSprint({ sprintId, sprintSwapBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}/swap",
-            method: "POST",
-            pathParams: {
-                sprintId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: sprintSwapBean,
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Performs a full update of a sprint. A full update means that the result will be
-     * exactly the same as the request body. Any fields not present in the request
-     * JSON will be set to null.
-     *
-     * Notes:
-     *
-     *  *  For closed sprints, only the name and goal can be updated; changes to other
-     * fields will be ignored.
-     *  *  A sprint can be started by updating the state to 'active'. This requires
-     * the sprint to be in the 'future' state and have a startDate and endDate set.
-     *  *  A sprint can be completed by updating the state to 'closed'. This action
-     * requires the sprint to be in the 'active' state. This sets the completeDate to
-     * the time of the request.
-     *  *  Other changes to state are not allowed.
-     *  *  The completeDate field cannot be updated manually.
-     *
-     * @returns Updated sprint
-     *
-     * example: {
-     *   "id": 37,
-     *   "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",
-     *   "endDate": "2015-04-20T01:22:00.000+10:00",
-     *   "completeDate": "2015-04-20T11:04:00.000+10:00",
-     *   "originBoardId": 5,
-     *   "goal": "sprint 1 goal"
-     * }
-     * @path {PUT} /rest/agile/1.0/sprint/{sprintId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-put
-     */
-    updateSprint({ sprintId, sprintBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/agile/1.0/sprint/{sprintId}",
-            method: "PUT",
-            pathParams: {
-                sprintId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: sprintBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.updateSprint.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Creates a future sprint. Sprint name and origin board id are required. Start
+         * date, end date, and goal are optional.
+         *
+         * Note that the sprint name is trimmed. Also, when starting sprints from the UI,
+         * the "endDate" set through this call is ignored and instead the last sprint's
+         * duration is used to fill the form.
+         *
+         * @returns Created sprint
+         *
+         * example: {
+         *   "id": 37,
+         *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+         *   "state": "future",
+         *   "name": "sprint 1",
+         *   "startDate": "2015-04-11T15:22:00.000+10:00",
+         *   "endDate": "2015-04-20T01:22:00.000+10:00",
+         *   "originBoardId": 5,
+         *   "goal": "sprint 1 goal"
+         * }
+         * @path {POST} /rest/agile/1.0/sprint
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-post
+         */
+        this.createSprint = ({ sprintCreateBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: sprintCreateBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                201: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.createSprint.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Removes the property from the sprint identified by the id. Ths user removing
+         * the property is required to have permissions to modify the sprint.
+         *
+         * @path {DELETE} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-delete
+         */
+        this.deleteProperty = ({ sprintId, propertyKey, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}",
+                method: "DELETE",
+                pathParams: {
+                    sprintId,
+                    propertyKey,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will
+         * be moved to the backlog.
+         *
+         * @path {DELETE} /rest/agile/1.0/sprint/{sprintId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-delete
+         */
+        this.deleteSprint = ({ sprintId, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}",
+                method: "DELETE",
+                pathParams: {
+                    sprintId,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Returns all issues in a sprint, for a given sprint ID. This only includes
+         * issues that the user has permission to view. By default, the returned issues
+         * are ordered by rank.
+         *
+         * @returns Returns the requested issues, at the specified page of the results.
+         *
+         * example: {
+         *   "expand": "",
+         *   "fields": {
+         *     "flagged": true,
+         *     "sprint": {
+         *       "id": 37,
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
+         *       "state": "future",
+         *       "name": "sprint 2",
+         *       "goal": "sprint 2 goal"
+         *     },
+         *     "closedSprints": [
+         *       {
+         *         "id": 37,
+         *         "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",
+         *         "endDate": "2015-04-20T01:22:00.000+10:00",
+         *         "completeDate": "2015-04-20T11:04:00.000+10:00",
+         *         "goal": "sprint 1 goal"
+         *       }
+         *     ],
+         *     "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"
+         *       },
+         *       "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": {
+         *           "type": "doc",
+         *           "version": 1,
+         *           "content": [
+         *             {
+         *               "type": "paragraph",
+         *               "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."
+         *                 }
+         *               ]
+         *             }
+         *           ]
+         *         },
+         *         "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"
+         *         }
+         *       }
+         *     ],
+         *     "epic": {
+         *       "id": 37,
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
+         *       "name": "epic 1",
+         *       "summary": "epic 1 summary",
+         *       "color": {
+         *         "key": "color_4"
+         *       },
+         *       "done": true
+         *     },
+         *     "worklog": [
+         *       {
+         *         "author": {
+         *           "accountId": "5b10a2844c20165700ede21g",
+         *           "active": false,
+         *           "displayName": "Mia Krystof",
+         *           "self":
+         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *         },
+         *         "comment": {
+         *           "type": "doc",
+         *           "version": 1,
+         *           "content": [
+         *             {
+         *               "type": "paragraph",
+         *               "content": [
+         *                 {
+         *                   "type": "text",
+         *                   "text": "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": "10001",
+         *   "key": "HSP-1",
+         *   "self":
+         * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+         * }
+         * @path {GET} /rest/agile/1.0/sprint/{sprintId}/issue
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-issue-get
+         */
+        this.getIssuesForSprint = ({ sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/issue",
+                method: "GET",
+                pathParams: {
+                    sprintId,
+                },
+                query: {
+                    startAt,
+                    maxResults,
+                    jql,
+                    validateQuery,
+                    fields,
+                    expand,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getIssuesForSprint.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns the keys of all properties for the sprint identified by the id. The
+         * user who retrieves the property keys is required to have permissions to view
+         * the sprint.
+         *
+         * @returns Returned if the sprint with given id exists.
+         *
+         * example: {
+         *   "keys": [
+         *     {
+         *       "key": "issue.support",
+         *       "self":
+         * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
+         *     }
+         *   ]
+         * }
+         * @path {GET} /rest/agile/1.0/sprint/{sprintId}/properties
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-get
+         */
+        this.getPropertiesKeys = ({ sprintId, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/properties",
+                method: "GET",
+                pathParams: {
+                    sprintId,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getPropertiesKeys.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns the value of the property with a given key from the sprint identified
+         * by the provided id. The user who retrieves the property is required to have
+         * permissions to view the sprint.
+         *
+         * @returns Returned if the sprint exists and the property was found.
+         *
+         * example: {
+         *   "key": "issue.support",
+         *   "value": {
+         *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
+         *     "system.support.time": "1m"
+         *   }
+         * }
+         * @path {GET} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-get
+         */
+        this.getProperty = ({ sprintId, propertyKey, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}",
+                method: "GET",
+                pathParams: {
+                    sprintId,
+                    propertyKey,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getProperty.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns the sprint for a given sprint ID. The sprint will only be returned if
+         * the user can view the board that the sprint was created on, or view at least
+         * one of the issues in the sprint.
+         *
+         * @returns Returns the requested sprint.
+         *
+         * example: {
+         *   "id": 37,
+         *   "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",
+         *   "endDate": "2015-04-20T01:22:00.000+10:00",
+         *   "completeDate": "2015-04-20T11:04:00.000+10:00",
+         *   "originBoardId": 5,
+         *   "goal": "sprint 1 goal"
+         * }
+         * @path {GET} /rest/agile/1.0/sprint/{sprintId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-get
+         */
+        this.getSprint = ({ sprintId, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}",
+                method: "GET",
+                pathParams: {
+                    sprintId,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.getSprint.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Moves issues to a sprint, for a given sprint ID. Issues can only be moved to
+         * open or active sprints. The maximum number of issues that can be moved in one
+         * operation is 50.
+         *
+         * @path {POST} /rest/agile/1.0/sprint/{sprintId}/issue
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-issue-post
+         */
+        this.moveIssuesToSprintAndRank = ({ sprintId, issueRankRequestBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/issue",
+                method: "POST",
+                pathParams: {
+                    sprintId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: issueRankRequestBean,
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Performs a partial update of a sprint. A partial update means that fields not
+         * present in the request JSON will not be updated.
+         *
+         * Notes:
+         *
+         *  *  For closed sprints, only the name and goal can be updated; changes to other
+         * fields will be ignored.
+         *  *  A sprint can be started by updating the state to 'active'. This requires
+         * the sprint to be in the 'future' state and have a startDate and endDate set.
+         *  *  A sprint can be completed by updating the state to 'closed'. This action
+         * requires the sprint to be in the 'active' state. This sets the completeDate to
+         * the time of the request.
+         *  *  Other changes to state are not allowed.
+         *  *  The completeDate field cannot be updated manually.
+         *
+         * @returns Updated sprint
+         *
+         * example: {
+         *   "id": 37,
+         *   "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",
+         *   "endDate": "2015-04-20T01:22:00.000+10:00",
+         *   "completeDate": "2015-04-20T11:04:00.000+10:00",
+         *   "originBoardId": 5,
+         *   "goal": "sprint 1 goal"
+         * }
+         * @path {POST} /rest/agile/1.0/sprint/{sprintId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-post
+         */
+        this.partiallyUpdateSprint = ({ sprintId, sprintBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}",
+                method: "POST",
+                pathParams: {
+                    sprintId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: sprintBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.partiallyUpdateSprint.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Sets the value of the specified sprint's property.
+         *
+         * You can use this resource to store a custom data against the sprint identified
+         * by the id. The user who stores the data is required to have permissions to
+         * modify the sprint.
+         *
+         * @returns * status: 200, mediaType: application/json
+         *
+         *    Returned if the sprint property is successfully updated.
+         *
+         *  * status: 201, mediaType: application/json
+         *
+         *    Returned if the sprint property is successfully created.
+         * @path {PUT} /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-properties-propertykey-put
+         */
+        this.setProperty = ({ sprintId, propertyKey, requestBody, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}",
+                method: "PUT",
+                pathParams: {
+                    sprintId,
+                    propertyKey,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: requestBody,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+                201: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.setProperty.response"))
+                .then(commonHttpClient.asCreatedResponse("body"));
+        };
+        /**
+         * Swap the position of the sprint with the second sprint.
+         *
+         * @path {POST} /rest/agile/1.0/sprint/{sprintId}/swap
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-swap-post
+         */
+        this.swapSprint = ({ sprintId, sprintSwapBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}/swap",
+                method: "POST",
+                pathParams: {
+                    sprintId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: sprintSwapBean,
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Performs a full update of a sprint. A full update means that the result will be
+         * exactly the same as the request body. Any fields not present in the request
+         * JSON will be set to null.
+         *
+         * Notes:
+         *
+         *  *  For closed sprints, only the name and goal can be updated; changes to other
+         * fields will be ignored.
+         *  *  A sprint can be started by updating the state to 'active'. This requires
+         * the sprint to be in the 'future' state and have a startDate and endDate set.
+         *  *  A sprint can be completed by updating the state to 'closed'. This action
+         * requires the sprint to be in the 'active' state. This sets the completeDate to
+         * the time of the request.
+         *  *  Other changes to state are not allowed.
+         *  *  The completeDate field cannot be updated manually.
+         *
+         * @returns Updated sprint
+         *
+         * example: {
+         *   "id": 37,
+         *   "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",
+         *   "endDate": "2015-04-20T01:22:00.000+10:00",
+         *   "completeDate": "2015-04-20T11:04:00.000+10:00",
+         *   "originBoardId": 5,
+         *   "goal": "sprint 1 goal"
+         * }
+         * @path {PUT} /rest/agile/1.0/sprint/{sprintId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint#api-rest-agile-1-0-sprint-sprintid-put
+         */
+        this.updateSprint = ({ sprintId, sprintBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/agile/1.0/sprint/{sprintId}",
+                method: "PUT",
+                pathParams: {
+                    sprintId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: sprintBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SprintService.updateSprint.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SprintService.createSprint.response", zod_1.z