ExClubhouse v0.5.2 ExClubhouse.Api.Milestone View Source
milestone API
Link to this section Summary
Functions
Create a milestone
Delete a milestone
Lists all milestone epics
Get a single milestone by id
Lists all milestones
Update a milestone
Link to this section Functions
Link to this function
create(milestone_input)
View Sourcecreate(ExClubhouse.Model.Input.Milestone.t()) :: {:ok, ExClubhouse.Model.Milestone.t()} | {:error, ExClubhouse.Error.t()}
Create a milestone
Example
iex> ExClubhouse.Api.Milestone.create(ExClubhouse.Model.Input.Milestone{...})
{:ok, %ExClubhouse.Milestone.Group{...}}
Link to this function
create(session, milestone_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Milestone.t()) :: {:ok, ExClubhouse.Model.Milestone.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(milestone_public_id)
View Sourcedelete(integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Delete a milestone
## Example
iex> ExClubhouse.Api.Milestone.delete(1)
:ok
Link to this function
delete(session, milestone_public_id)
View Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
epic_list(milestone_public_id)
View Sourceepic_list(integer()) :: {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}
Lists all milestone epics
Example
iex> ExClubhouse.Api.Milestone.list()
{:ok, [%ExClubhouse.Model.EpicSlim{...}, ...]}
Link to this function
epic_list(session, milestone_public_id)
View Sourceepic_list(ExClubhouse.Session.t(), integer()) :: {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
get(milestone_public_id)
View Sourceget(integer()) :: {:ok, nil | ExClubhouse.Model.Milestone.t()} | {:error, ExClubhouse.Error.t()}
Get a single milestone by id
Example
iex> ExClubhouse.Api.Milestone.get(1)
{:ok, %ExClubhouse.Model.Milestone{...}}
Link to this function
get(session, milestone_public_id)
View Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.Milestone.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.Milestone.t()]} | {:error, ExClubhouse.Error.t()}
Lists all milestones
Example
iex> ExClubhouse.Api.Milestone.list()
{:ok, [%ExClubhouse.Model.Milestone{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.Milestone.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
update(milestone_public_id, milestone_input)
View Sourceupdate(integer(), ExClubhouse.Model.Input.Milestone.t()) :: {:ok, ExClubhouse.Model.Milestone.t()} | {:error, ExClubhouse.Error.t()}
Update a milestone
Example
iex> ExClubhouse.Api.Milestone.update(1, ExClubhouse.Model.Input.Milestone{...})
{:ok, %ExClubhouse.Model.Milestone{...}}
Link to this function
update(session, milestone_public_id, milestone_input)
View Sourceupdate( ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.Milestone.t() ) :: {:ok, ExClubhouse.Model.Milestone.t()} | {:error, ExClubhouse.Error.t()}