ExClubhouse v0.5.1 ExClubhouse.Api.Iteration View Source
Iteration API
Link to this section Summary
Functions
Create an Iteration
Delete an iteration
Disable a category
Enable a category
Get a single iteration by id
Lists all iterations
Lists all iterations
Update an iteration
Link to this section Functions
Link to this function
create(iteration_input)
View Sourcecreate(ExClubhouse.Model.Input.Iteration.t()) :: {:ok, ExClubhouse.Model.Iteration.t()} | {:error, ExClubhouse.Error.t()}
Create an Iteration
Example
iex> ExClubhouse.Api.Iteration.create(ExClubhouse.Model.Input.Iteration{...})
{:ok, %ExClubhouse.Model.Iteration{...}}
Link to this function
create(session, iteration_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Iteration.t()) :: {:ok, ExClubhouse.Model.IterationSlim.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(iteration_public_id)
View Sourcedelete(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 Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Disable a category
## Example
iex> ExClubhouse.Api.Iteration.disable()
:ok
Link to this function
disable(session)
View Sourcedisable(ExClubhouse.Session.t()) :: :ok | {:error, ExClubhouse.Error.t()}
Enable a category
## Example
iex> ExClubhouse.Api.Iteration.enable()
:ok
Link to this function
enable(session)
View Sourceenable(ExClubhouse.Session.t()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
get(iteration_public_id)
View Sourceget(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 Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.IterationSlim.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.IterationSlim.t()]} | {:error, ExClubhouse.Error.t()}
Lists all iterations
Example
iex> ExClubhouse.Api.Iteration.list()
{:ok, [%ExClubhouse.Model.Iteration{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.IterationSlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
stories_list(iteration_public_id)
View Sourcestories_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 Sourcestories_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 Sourceupdate(integer(), ExClubhouse.Model.Input.Iteration.t()) :: {:ok, ExClubhouse.Model.Iteration.t()} | {:error, ExClubhouse.Error.t()}
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 Sourceupdate( ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.Iteration.t() ) :: {:ok, ExClubhouse.Model.IterationSlim.t()} | {:error, ExClubhouse.Error.t()}