@resolution/jira-api-client 0.1.0

package/src/openapi/software/services/sprint-service.ts

@@ -0,0 +1,969 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/** Apis related to sprints */
+export class SprintService extends 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
+   */
+  createSprint({
+    requestBody,
+  }: {
+    /**
+     * @example {
+     *     "endDate": "2015-04-20T01:22:00.000+10:00",
+     *     "goal": "sprint 1 goal",
+     *     "name": "sprint 1",
+     *     "originBoardId": 5,
+     *     "startDate": "2015-04-11T15:22:00.000+10:00"
+     * }
+     */
+    requestBody: {
+      endDate?: string;
+      goal?: string;
+      name?: string;
+      originBoardId?: number;
+      startDate?: string;
+    };
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/agile/1.0/sprint",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 201;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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}
+   */
+  deleteProperty({
+    sprintId,
+    propertyKey,
+  }: {
+    /** the ID of the sprint from which the property will be removed. */
+    sprintId: string;
+    /** the key of the property to remove. */
+    propertyKey: string;
+  }): Promise<void> {
+    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}
+   */
+  deleteSprint({
+    sprintId,
+  }: {
+    /** The ID of the sprint to delete. */
+    sprintId: number;
+  }): Promise<void> {
+    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
+   */
+  getIssuesForSprint({
+    sprintId,
+    startAt,
+    maxResults,
+    jql,
+    validateQuery,
+    fields,
+    expand,
+  }: {
+    /** The ID of the sprint that contains the requested issues. */
+    sprintId: number;
+    /**
+     * The starting index of the returned issues. Base index: 0. See the 'Pagination'
+     * section at the top of this page for more details.
+     */
+    startAt?: number;
+    /**
+     * The maximum number of issues to return per page. See the 'Pagination' section
+     * at the top of this page for more details. Note, the total number of issues
+     * returned is limited by the property 'jira.search.views.default.max' in your
+     * Jira instance. If you exceed this limit, your results will be truncated.
+     */
+    maxResults?: number;
+    /**
+     * 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;
+    /** Specifies whether to validate the JQL query or not. Default: true. */
+    validateQuery?: boolean;
+    /**
+     * The list of fields to return for each issue. By default, all navigable and
+     * Agile fields are returned.
+     */
+    fields?: {}[];
+    /** A comma-separated list of the parameters to expand. */
+    expand?: string;
+  }): Promise<unknown> {
+    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<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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
+   */
+  getPropertiesKeys({
+    sprintId,
+  }: {
+    /** the ID of the sprint from which property keys will be returned. */
+    sprintId: string;
+  }): Promise<unknown> {
+    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<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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}
+   */
+  getProperty({
+    sprintId,
+    propertyKey,
+  }: {
+    /** the ID of the sprint from which the property will be returned. */
+    sprintId: string;
+    /** the key of the property to return. */
+    propertyKey: string;
+  }): Promise<unknown> {
+    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<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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}
+   */
+  getSprint({
+    sprintId,
+  }: {
+    /** The ID of the requested sprint. */
+    sprintId: number;
+  }): Promise<unknown> {
+    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<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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
+   */
+  moveIssuesToSprintAndRank({
+    sprintId,
+    requestBody,
+  }: {
+    /** The ID of the sprint that you want to assign issues to. */
+    sprintId: number;
+    /**
+     * @example {
+     *     "issues": [
+     *         "PR-1",
+     *         "10001",
+     *         "PR-3"
+     *     ],
+     *     "rankBeforeIssue": "PR-4",
+     *     "rankCustomFieldId": 10521
+     * }
+     */
+    requestBody: {
+      issues?: string[];
+      rankAfterIssue?: string;
+      rankBeforeIssue?: string;
+      rankCustomFieldId?: number;
+    };
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/agile/1.0/sprint/{sprintId}/issue",
+        method: "POST",
+        pathParams: {
+          sprintId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .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}
+   */
+  partiallyUpdateSprint({
+    sprintId,
+    requestBody,
+  }: {
+    /** The ID of the sprint to update. */
+    sprintId: number;
+    /**
+     * @example {
+     *     "name": "new name"
+     * }
+     */
+    requestBody: {
+      completeDate?: string;
+      createdDate?: string;
+      endDate?: string;
+      goal?: string;
+      id?: number;
+      name?: string;
+      originBoardId?: number;
+      self?: string;
+      startDate?: string;
+      state?: string;
+    };
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/agile/1.0/sprint/{sprintId}",
+        method: "POST",
+        pathParams: {
+          sprintId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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}
+   */
+  setProperty({
+    sprintId,
+    propertyKey,
+    requestBody,
+  }: {
+    /** the ID of the sprint on which the property will be set. */
+    sprintId: string;
+    /** the key of the sprint's property. The maximum length of the key is 255 bytes. */
+    propertyKey: string;
+    /**
+     * The value of the property. The value has to be a valid, non-empty
+     * [JSON](https://tools.ietf.org/html/rfc4627) value. The maximum length of the
+     * property value is 32768 bytes.
+     */
+    requestBody: unknown;
+  }): Promise<{
+    created: boolean;
+    body: unknown;
+  }> {
+    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<{
+          status: 200 | 201;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        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
+   */
+  swapSprint({
+    sprintId,
+    requestBody,
+  }: {
+    /** The ID of the sprint to swap. */
+    sprintId: number;
+    /**
+     * @example {
+     *     "sprintToSwapWith": 3
+     * }
+     */
+    requestBody: {
+      sprintToSwapWith?: number;
+    };
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/agile/1.0/sprint/{sprintId}/swap",
+        method: "POST",
+        pathParams: {
+          sprintId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .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}
+   */
+  updateSprint({
+    sprintId,
+    requestBody,
+  }: {
+    /** the ID of the sprint to update. */
+    sprintId: number;
+    /**
+     * @example {
+     *     "completeDate": "2015-04-20T11:11:28.008+10:00",
+     *     "endDate": "2015-04-16T14:01:00.000+10:00",
+     *     "goal": "sprint 1 goal",
+     *     "name": "sprint 1",
+     *     "startDate": "2015-04-11T15:36:00.000+10:00",
+     *     "state": "closed"
+     * }
+     */
+    requestBody: {
+      completeDate?: string;
+      createdDate?: string;
+      endDate?: string;
+      goal?: string;
+      id?: number;
+      name?: string;
+      originBoardId?: number;
+      self?: string;
+      startDate?: string;
+      state?: string;
+    };
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/agile/1.0/sprint/{sprintId}",
+        method: "PUT",
+        pathParams: {
+          sprintId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: requestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "SprintService.updateSprint.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "SprintService.createSprint.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.createSprint.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.getSprint.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.getSprint.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.updateSprint.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.updateSprint.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.partiallyUpdateSprint.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.partiallyUpdateSprint.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.getIssuesForSprint.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.getIssuesForSprint.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.getPropertiesKeys.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.getPropertiesKeys.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.getProperty.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("SprintService.getProperty.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "SprintService.setProperty.response",
+      z
+        .object({
+          status: z.number(),
+          mediaType: z.string(),
+          body: z.unknown(),
+        })
+        .superRefine(({ status: status, body: body }, ctx) => {
+          if (status === 200 || status === 201) {
+            z.unknown().parse(body);
+          } else {
+            ctx.addIssue({
+              code: z.ZodIssueCode.custom,
+              path: ["status"],
+              message: `Unexpected status code: ${status}`,
+            });
+          }
+        })
+        .describe("SprintService.setProperty.response"),
+    );
+  }
+}