ExClubhouse v0.6.0 ExClubhouse.Api.Epic View Source
Epic API
Link to this section Summary
Functions
Lists all Epic comments
Create an Epic
Create an Epic comment
Delete an Epic
Delete a comment
Get a single Epic by id
Get a single Epic by id
Lists all epics
Lists all stories from an epic
Update an Epic
Update an Epic comment
Link to this section Functions
Link to this function
comments_list(epic_public_id)
View Sourcecomments_list(integer()) :: {:ok, [ExClubhouse.Model.ThreadedComment.t()]} | {:error, ExClubhouse.Error.t()}
Lists all Epic comments
Example
iex> ExClubhouse.Api.Epic.comments_list(1)
{:ok, [%ExClubhouse.Model.ThreadedComment{...}, ...]}
Link to this function
comments_list(sess, epic_public_id)
View Sourcecomments_list(ExClubhouse.Session.t(), integer()) :: {:ok, [ExClubhouse.Model.ThreadedComment.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
create(epic_input)
View Sourcecreate(ExClubhouse.Model.Input.Epic.t()) :: {:ok, ExClubhouse.Model.Epic.t()} | {:error, ExClubhouse.Error.t()}
Create an Epic
Example
iex> ExClubhouse.Api.Epic.create(ExClubhouse.Model.Input.Epic{...})
{:ok, %ExClubhouse.Model.Epic{...}}
Link to this function
create(session, epic_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Epic.t()) :: {:ok, ExClubhouse.Model.Epic.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
create_comment(epic_public_id, comment_input)
View Sourcecreate_comment(integer(), ExClubhouse.Model.Input.Comment.t()) :: {:ok, ExClubhouse.Model.ThreadedComment.t()} | {:error, ExClubhouse.Error.t()}
Create an Epic comment
Example
iex> ExClubhouse.Api.Epic.create(1, ExClubhouse.Model.Input.Comment{...})
{:ok, %ExClubhouse.Model.ThreadedComment{...}}
Link to this function
create_comment(session, epic_public_id, comment_input)
View Sourcecreate_comment( ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.Comment.t() ) :: {:ok, ExClubhouse.Model.ThreadedComment.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
create_comment_comment(epic_public_id, comment_public_id, comment_input)
View Sourcecreate_comment_comment( integer(), integer(), ExClubhouse.Model.Input.Comment.t() ) :: {:ok, ExClubhouse.Model.ThreadedComment.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
create_comment_comment(session, epic_public_id, comment_public_id, comment_input)
View Sourcecreate_comment_comment( ExClubhouse.Session.t(), integer(), integer(), ExClubhouse.Model.Input.Comment.t() ) :: {:ok, ExClubhouse.Model.ThreadedComment.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(epic_public_id)
View Sourcedelete(integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Delete an Epic
## Example
iex> ExClubhouse.Api.Epic.delete(1)
:ok
Link to this function
delete(session, epic_public_id)
View Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
delete_comment(epic_public_id, comment_public_id)
View Sourcedelete_comment(integer(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Delete a comment
## Example
iex> ExClubhouse.Api.Epic.delete_comment(1, 2)
:ok
Link to this function
delete_comment(session, epic_public_id, comment_public_id)
View Sourcedelete_comment(ExClubhouse.Session.t(), integer(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
get(category_public_id)
View Sourceget(integer()) :: {:ok, nil | ExClubhouse.Model.Epic.t()} | {:error, ExClubhouse.Error.t()}
Get a single Epic by id
Example
iex> ExClubhouse.Api.Epic.get(1)
{:ok, %ExClubhouse.Model.Epic{...}}
Link to this function
get(session, epic_public_id)
View Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.Epic.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
get_comment(epic_public_id, comment_public_id)
View Sourceget_comment(integer(), integer()) :: {:ok, ExClubhouse.Model.ThreadedComment.t() | nil} | {:error, ExClubhouse.Error.t()}
Get a single Epic by id
Example
iex> ExClubhouse.Api.Epic.get_comment(1, 2)
{:ok, %ExClubhouse.Model.ThreadedComment{...}}
Link to this function
get_comment(session, epic_public_id, comment_public_id)
View Sourceget_comment(ExClubhouse.Session.t(), integer(), integer()) :: {:ok, ExClubhouse.Model.Epic.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}
Lists all epics
Example
iex> ExClubhouse.Api.Epic.list()
{:ok, [%ExClubhouse.Model.EpicSlim{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.EpicSlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
stories_list(epic_public_id)
View Sourcestories_list(integer()) :: {:ok, [ExClubhouse.Model.StorySlim.t()]} | {:error, ExClubhouse.Error.t()}
Lists all stories from an epic
Example
iex> ExClubhouse.Api.Epic.stories_list(1)
{:ok, [%ExClubhouse.Model.EpicSlim{...}, ...]}
Link to this function
stories_list(sess, epic_public_id)
View Sourcestories_list(ExClubhouse.Session.t(), integer()) :: {:ok, [ExClubhouse.Model.StorySlim.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
update(epic_public_id, epic_input)
View Sourceupdate(integer(), ExClubhouse.Model.Input.Epic.t()) :: {:ok, ExClubhouse.Model.Epic.t()} | {:error, ExClubhouse.Error.t()}
Update an Epic
Example
iex> ExClubhouse.Api.Epic.update(1, ExClubhouse.Model.Input.Epic{...})
{:ok, %ExClubhouse.Model.Epic{...}}
Link to this function
update(session, epic_public_id, epic_input)
View Sourceupdate(ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.Epic.t()) :: {:ok, ExClubhouse.Model.Epic.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
update_comment(epic_public_id, comment_public_id, update_comment_input)
View Sourceupdate_comment(integer(), integer(), ExClubhouse.Model.Input.UpdateComment.t()) :: {:ok, ExClubhouse.Model.ThreadedComment.t()} | {:error, ExClubhouse.Error.t()}
Update an Epic comment
Example
iex> ExClubhouse.Api.Epic.update_comment(1, 2, ExClubhouse.Model.Input.UpdateComment{...})
{:ok, %ExClubhouse.Model.Epic{...}}
Link to this function
update_comment(session, epic_public_id, comment_public_id, update_comment_input)
View Sourceupdate_comment( ExClubhouse.Session.t(), integer(), integer(), ExClubhouse.Model.Input.UpdateComment.t() ) :: {:ok, ExClubhouse.Model.Epic.t()} | {:error, ExClubhouse.Error.t()}