ExClubhouse v0.6.0 ExClubhouse.Api.Project View Source
Project API
Link to this section Summary
Functions
Create a Project
Delete a Project
Get a single project by id
Lists all Project
Lists all project's stories
Update a Project
Link to this section Functions
Link to this function
create(project_input)
View Sourcecreate(ExClubhouse.Model.Input.Project.t()) :: {:ok, ExClubhouse.Model.Project.t()} | {:error, ExClubhouse.Error.t()}
Create a Project
Example
iex> ExClubhouse.Api.Project.create(ExClubhouse.Model.Input.Project{...})
{:ok, %ExClubhouse.Model.Project{...}}
Link to this function
create(session, project_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Project.t()) :: {:ok, ExClubhouse.Model.Project.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(project_public_id)
View Sourcedelete(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 Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
get(project_public_id)
View Sourceget(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 Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.Project.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.Project.t()]} | {:error, ExClubhouse.Error.t()}
Lists all Project
Example
iex> ExClubhouse.Api.Project.list()
{:ok, [%ExClubhouse.Model.Project{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.Project.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
story_list(project_public_id)
View Sourcestory_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 Sourcestory_list(ExClubhouse.Session.t(), integer()) :: {:ok, [ExClubhouse.Model.StorySlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
update(project_public_id, project_input)
View Sourceupdate(integer(), ExClubhouse.Model.Input.Project.t()) :: {:ok, ExClubhouse.Model.Project.t()} | {:error, ExClubhouse.Error.t()}
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 Sourceupdate(ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.Project.t()) :: {:ok, ExClubhouse.Model.Project.t()} | {:error, ExClubhouse.Error.t()}