ExClubhouse v0.6.0 ExClubhouse.Api.Milestone View Source

milestone API

Link to this section Summary

Link to this section Functions

Create a milestone

Example

iex> ExClubhouse.Api.Milestone.create(ExClubhouse.Model.Input.Milestone{...})
{:ok, %ExClubhouse.Milestone.Group{...}}
Link to this function

delete(milestone_public_id)

View Source
delete(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 Source
delete(ExClubhouse.Session.t(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

epic_list(milestone_public_id)

View Source
epic_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 Source
Link to this function

get(milestone_public_id)

View Source
get(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 Source

Lists all milestones

Example

iex> ExClubhouse.Api.Milestone.list()
{:ok, [%ExClubhouse.Model.Milestone{...}, ...]}
Link to this function

update(milestone_public_id, milestone_input)

View Source

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 Source