ExClubhouse v0.5.1 ExClubhouse.Api.Label View Source

Label API

Link to this section Summary

Link to this section Functions

Create a Label

Example

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

delete(label_public_id)

View Source
delete(integer()) :: :ok | {:error, ExClubhouse.Error.t()}

Delete a label

## Example

iex> ExClubhouse.Api.Label.delete(1)
:ok
Link to this function

delete(session, label_public_id)

View Source
delete(ExClubhouse.Session.t(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

epics_list(label_public_id)

View Source
epics_list(integer()) ::
  {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}

Lists all epics for a label

Example

iex> ExClubhouse.Api.Label.epics_list(1)
{:ok, [%ExClubhouse.Model.EpicSlim{...}, ...]}
Link to this function

epics_list(sess, label_public_id)

View Source
epics_list(ExClubhouse.Session.t(), integer()) ::
  {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function

get(label_public_id)

View Source
get(integer()) ::
  {:ok, nil | ExClubhouse.Model.Label.t()} | {:error, ExClubhouse.Error.t()}

Get a single label by id

Example

iex> ExClubhouse.Api.Label.get(1)
{:ok, %ExClubhouse.Model.Label{...}}
Link to this function

get(session, label_public_id)

View Source

Lists all labels

Example

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

stories_list(label_public_id)

View Source
stories_list(integer()) ::
  {:ok, [ExClubhouse.Model.StorySlim.t()]} | {:error, ExClubhouse.Error.t()}

Lists all stories for a label

Example

iex> ExClubhouse.Api.Label.stories_list(1)
{:ok, [%ExClubhouse.Model.StorySlim{...}, ...]}
Link to this function

stories_list(sess, label_public_id)

View Source
stories_list(ExClubhouse.Session.t(), integer()) ::
  {:ok, [ExClubhouse.Model.StorySlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function

update(label_public_id, label_input)

View Source

Update a label

Example

iex> ExClubhouse.Api.Label.update(1, ExClubhouse.Model.Input.Label{...})
{:ok, %ExClubhouse.Model.Label{...}}