/** * Jira Software Cloud API * Jira Software Cloud REST API documentation * * The version of the OpenAPI document: 1001.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { BodiesCreateSprint, BodiesSwapSprint, MoveIssuesToBacklogForBoard, PartiallyUpdateSprint } from '../models'; export interface CreateSprintRequest { BodiesCreateSprint: BodiesCreateSprint; } export interface DeletePropertyRequest { sprintId: string; propertyKey: string; } export interface DeleteSprintRequest { sprintId: number; } export interface GetIssuesForSprint1Request { sprintId: number; startAt?: number; maxResults?: number; jql?: string; validateQuery?: boolean; fields?: Array; expand?: string; } export interface GetPropertiesKeysRequest { sprintId: string; } export interface GetPropertyRequest { sprintId: string; propertyKey: string; } export interface GetSprintRequest { sprintId: number; } export interface MoveIssuesToSprintAndRankRequest { sprintId: number; MoveIssuesToBacklogForBoard: MoveIssuesToBacklogForBoard; } export interface PartiallyUpdateSprintRequest { sprintId: number; PartiallyUpdateSprint: PartiallyUpdateSprint; } export interface SetPropertyRequest { sprintId: string; propertyKey: string; } export interface SwapSprintRequest { sprintId: number; BodiesSwapSprint: BodiesSwapSprint; } export interface UpdateSprintRequest { sprintId: number; PartiallyUpdateSprint: PartiallyUpdateSprint; } /** * no description */ export declare class SprintApi extends runtime.BaseAPI { /** * Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional. Note, the sprint name is trimmed. * Create sprint */ createSprintRaw(requestParameters: CreateSprintRequest): Promise>; /** * Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional. Note, the sprint name is trimmed. * Create sprint */ createSprint(requestParameters: CreateSprintRequest): Promise; /** * Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint. * Delete property */ deletePropertyRaw(requestParameters: DeletePropertyRequest): Promise>; /** * Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint. * Delete property */ deleteProperty(requestParameters: DeletePropertyRequest): Promise; /** * Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog. * Delete sprint */ deleteSprintRaw(requestParameters: DeleteSprintRequest): Promise>; /** * Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog. * Delete sprint */ deleteSprint(requestParameters: DeleteSprintRequest): Promise; /** * 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. * Get issues for sprint */ getIssuesForSprint1Raw(requestParameters: GetIssuesForSprint1Request): Promise>; /** * 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. * Get issues for sprint */ getIssuesForSprint1(requestParameters: GetIssuesForSprint1Request): Promise; /** * 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. * Get properties keys */ getPropertiesKeysRaw(requestParameters: GetPropertiesKeysRequest): Promise>; /** * 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. * Get properties keys */ getPropertiesKeys(requestParameters: GetPropertiesKeysRequest): Promise; /** * 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. * Get property */ getPropertyRaw(requestParameters: GetPropertyRequest): Promise>; /** * 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. * Get property */ getProperty(requestParameters: GetPropertyRequest): Promise; /** * 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. * Get sprint */ getSprintRaw(requestParameters: GetSprintRequest): Promise>; /** * 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. * Get sprint */ getSprint(requestParameters: GetSprintRequest): Promise; /** * 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. * Move issues to sprint and rank */ moveIssuesToSprintAndRankRaw(requestParameters: MoveIssuesToSprintAndRankRequest): Promise>; /** * 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. * Move issues to sprint and rank */ moveIssuesToSprintAndRank(requestParameters: MoveIssuesToSprintAndRankRequest): Promise; /** * Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated. Notes: * Sprints that are in a closed state cannot be updated. * 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. * Partially update sprint */ partiallyUpdateSprintRaw(requestParameters: PartiallyUpdateSprintRequest): Promise>; /** * Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated. Notes: * Sprints that are in a closed state cannot be updated. * 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. * Partially update sprint */ partiallyUpdateSprint(requestParameters: PartiallyUpdateSprintRequest): Promise; /** * 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. * Set property */ setPropertyRaw(requestParameters: SetPropertyRequest): Promise>; /** * 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. * Set property */ setProperty(requestParameters: SetPropertyRequest): Promise; /** * Swap the position of the sprint with the second sprint. * Swap sprint */ swapSprintRaw(requestParameters: SwapSprintRequest): Promise>; /** * Swap the position of the sprint with the second sprint. * Swap sprint */ swapSprint(requestParameters: SwapSprintRequest): Promise; /** * 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: * Sprints that are in a closed state cannot be updated. * 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. * Update sprint */ updateSprintRaw(requestParameters: UpdateSprintRequest): Promise>; /** * 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: * Sprints that are in a closed state cannot be updated. * 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. * Update sprint */ updateSprint(requestParameters: UpdateSprintRequest): Promise; }