Class Sprint

Constructors

constructor

Properties

client

Methods

createSprint deleteProperty deleteSprint getIssuesForSprint getPropertiesKeys getProperty getSprint moveIssuesToSprintAndRank partiallyUpdateSprint setProperty swapSprint updateSprint

Constructors

constructor

Properties

Private client

client: Client

Methods

createSprint

  • createSprint<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<void>

  • createSprint<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<T>

deleteProperty

  • deleteProperty<T>(parameters, callback): Promise<void>

  • Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • deleteProperty<T>(parameters, callback?): Promise<T>

  • Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

deleteSprint

  • deleteSprint<T>(parameters, callback): Promise<void>

  • Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • deleteSprint<T>(parameters, callback?): Promise<T>

  • Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

getIssuesForSprint

  • getIssuesForSprint<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getIssuesForSprint<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<T>

getPropertiesKeys

  • getPropertiesKeys<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<void>

  • getPropertiesKeys<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<T>

getProperty

  • getProperty<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<void>

  • getProperty<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<T>

getSprint

  • getSprint<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getSprint<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    Parameters

    • parameters: GetSprint
    • Optional callback: undefined

    Returns Promise<T>

moveIssuesToSprintAndRank

  • moveIssuesToSprintAndRank<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • moveIssuesToSprintAndRank<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

partiallyUpdateSprint

  • partiallyUpdateSprint<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<void>

  • partiallyUpdateSprint<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<T>

setProperty

  • setProperty<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<void>

  • setProperty<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<T>

swapSprint

  • swapSprint<T>(parameters, callback): Promise<void>

  • Swap the position of the sprint with the second sprint.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • swapSprint<T>(parameters, callback?): Promise<T>

  • Swap the position of the sprint with the second sprint.

    Type Parameters

    • T = void

    Parameters

    • parameters: SwapSprint
    • Optional callback: undefined

    Returns Promise<T>

updateSprint

  • updateSprint<T>(parameters, callback): Promise<void>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<void>

  • updateSprint<T>(parameters, callback?): Promise<T>

  • 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.

    Type Parameters

    Parameters

    Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

constructorclientcreateSprintdeletePropertydeleteSprintgetIssuesForSprintgetPropertiesKeysgetPropertygetSprintmoveIssuesToSprintAndRankpartiallyUpdateSprintsetPropertyswapSprintupdateSprint