View Source Jiraffe.Agile.Sprint (Jiraffe v0.1.2)
APIs related to sprints
Summary
Functions
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.
Converts a map (received from Jira API) to Jiraffe.Agile.Sprint
struct.
Types
@type t() :: %Jiraffe.Agile.Sprint{ complete_date: String.t() | nil, created_date: String.t() | nil, end_date: String.t() | nil, goal: String.t(), id: non_neg_integer(), name: String.t(), origin_board_id: non_neg_integer() | nil, self: String.t() | nil, start_date: String.t() | nil, state: String.t() }
Functions
@spec get( client :: Jiraffe.Client.t(), id :: String.t() ) :: {:ok, t()} | {:error, Jiraffe.Error.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.
Converts a map (received from Jira API) to Jiraffe.Agile.Sprint
struct.