ex_jira v0.0.5 ExJira.Project View Source
Provides access to the Project resource.
Link to this section Summary
Functions
Returns all projects. Request parameters as described here
Same as all/1
but raises error if it fails
Returns the specified project as described here
Same as get/1
but raises error if it fails
Returns a single issue based on specified ticket number
Same as get_issue/1
but raises error if it fails
Returns the issues for the specified project
Same as get_issues/1
but raises error if it fails
Link to this section Functions
all(query_params \\ [])
View Source
all([{atom(), String.t()}]) :: ExJira.Request.request_response()
all([{atom(), String.t()}]) :: ExJira.Request.request_response()
Returns all projects. Request parameters as described here
Examples
iex> ExJira.Project.all()
{:ok, [%{"id" => "1010"}, %{"id" => "1011"}]}
all!(query_params \\ []) View Source
Same as all/1
but raises error if it fails
Examples
iex> ExJira.Project.all!()
[%{"id" => "1010"}, %{"id" => "1011"}]
get(id, query_params \\ [])
View Source
get(String.t(), [{atom(), String.t()}]) :: ExJira.Request.request_response()
get(String.t(), [{atom(), String.t()}]) :: ExJira.Request.request_response()
Returns the specified project as described here.
Examples
iex> ExJira.Project.get("1012")
{:ok, %{"id" => "1012"}}
iex> ExJira.Project.get("1012", expand: "lead,url,description")
{:ok, %{"id" => "1012"}}
get!(id, query_params \\ []) View Source
Same as get/1
but raises error if it fails
Examples
iex> ExJira.Project.get!("1012")
%{"id" => "1012"}
iex> ExJira.Project.get!("1012", expand: "lead,url,description")
%{"id" => "1012"}
get_issue(id, query_params \\ [])
View Source
get_issue(String.t(), [{atom(), String.t()}]) ::
ExJira.Request.request_response()
get_issue(String.t(), [{atom(), String.t()}]) :: ExJira.Request.request_response()
Returns a single issue based on specified ticket number.
Examples
iex> ExJira.Project.get_issue("ISSUE-1012") {:ok, %{"id" => "1012"}}
iex> ExJira.Project.get_issue("ISSUE-1012", expand: "lead,url,description") {:ok, %{"id" => "1012"}}
get_issue!(id, query_params \\ []) View Source
Same as get_issue/1
but raises error if it fails
Examples
iex> ExJira.Project.get_issue!("ISSUE-1012") %{"id" => "1012"}
iex> ExJira.Project.get_issue!("ISSUE-1012", expand: "lead,url,description") %{"id" => "1012"}
get_issues(id, query_params \\ [])
View Source
get_issues(String.t(), [{atom(), String.t()}]) ::
ExJira.Request.request_response()
get_issues(String.t(), [{atom(), String.t()}]) :: ExJira.Request.request_response()
Returns the issues for the specified project.
Examples
iex> ExJira.Project.get_issues("1013")
{:ok, [%{"id" => "100040"}, %{"id" => "100041"}]}
iex> ExJira.Project.get_issues("1013", expand: "operations")
{:ok, [%{"id" => "100040"}, %{"id" => "100041"}]}
get_issues!(id, query_params \\ []) View Source
Same as get_issues/1
but raises error if it fails
Examples
iex> ExJira.Project.get_issues!("1013")
[%{"id" => "100040"}, %{"id" => "100041"}]
iex> ExJira.Project.get_issues!("1013", expand: "operations")
[%{"id" => "100040"}, %{"id" => "100041"}]