ExClubhouse v0.5.2 ExClubhouse.Api.Label View Source
Label API
Link to this section Summary
Functions
Create a Label
Delete a label
Lists all epics for a label
Get a single label by id
Lists all labels
Lists all stories for a label
Update a label
Link to this section Functions
Link to this function
create(label_input)
View Sourcecreate(ExClubhouse.Model.Input.Label.t()) :: {:ok, ExClubhouse.Model.Label.t()} | {:error, ExClubhouse.Error.t()}
Create a Label
Example
iex> ExClubhouse.Api.Label.create(ExClubhouse.Model.Input.Label{...})
{:ok, %ExClubhouse.Model.Label{...}}
Link to this function
create(session, label_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Label.t()) :: {:ok, ExClubhouse.Model.Label.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(label_public_id)
View Sourcedelete(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 Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
epics_list(label_public_id)
View Sourceepics_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 Sourceepics_list(ExClubhouse.Session.t(), integer()) :: {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
get(label_public_id)
View Sourceget(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 Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.Label.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.Label.t()]} | {:error, ExClubhouse.Error.t()}
Lists all labels
Example
iex> ExClubhouse.Api.Label.list()
{:ok, [%ExClubhouse.Model.Label{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.Label.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
stories_list(label_public_id)
View Sourcestories_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 Sourcestories_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 Sourceupdate(integer(), ExClubhouse.Model.Input.Label.t()) :: {:ok, ExClubhouse.Model.Label.t()} | {:error, ExClubhouse.Error.t()}
Update a label
Example
iex> ExClubhouse.Api.Label.update(1, ExClubhouse.Model.Input.Label{...})
{:ok, %ExClubhouse.Model.Label{...}}
Link to this function
update(session, label_public_id, label_input)
View Sourceupdate(ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.Label.t()) :: {:ok, ExClubhouse.Model.Label.t()} | {:error, ExClubhouse.Error.t()}