ExClubhouse v0.5.1 ExClubhouse.Api.Project View Source

Project API

Link to this section Summary

Link to this section Functions

Create a Project

Example

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

delete(project_public_id)

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

Delete a Project

## Example

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

delete(session, project_public_id)

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

get(project_public_id)

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

Get a single project by id

Example

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

get(session, project_public_id)

View Source

Lists all Project

Example

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

story_list(project_public_id)

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

Lists all project's stories

Example

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

story_list(session, project_public_id)

View Source
Link to this function

update(project_public_id, project_input)

View Source

Update a Project

Example

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

update(session, project_public_id, project_input)

View Source