ExClubhouse v0.5.2 ExClubhouse.Api.Iteration View Source

Iteration API

Link to this section Summary

Link to this section Functions

Create an Iteration

Example

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

delete(iteration_public_id)

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

Delete an iteration

## Example

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

delete(session, iteration_public_id)

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

disable()

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

Disable a category

## Example

iex> ExClubhouse.Api.Iteration.disable()
:ok
Link to this function

enable()

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

Enable a category

## Example

iex> ExClubhouse.Api.Iteration.enable()
:ok
Link to this function

get(iteration_public_id)

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

Get a single iteration by id

Example

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

get(session, iteration_public_id)

View Source

Lists all iterations

Example

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

stories_list(iteration_public_id)

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

Lists all iterations

Example

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

stories_list(sess, iteration_public_id)

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

update(iteration_public_id, iteration_input)

View Source

Update an iteration

Example

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

update(session, iteration_public_id, iteration_input)

View Source