ExClubhouse v0.6.0 ExClubhouse.Api.Epic View Source

Epic API

Link to this section Summary

Link to this section Functions

Link to this function

comments_list(epic_public_id)

View Source
comments_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 Source

Create an Epic

Example

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

create_comment(epic_public_id, comment_input)

View Source

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 Source
Link to this function

create_comment_comment(epic_public_id, comment_public_id, comment_input)

View Source
Link to this function

create_comment_comment(session, epic_public_id, comment_public_id, comment_input)

View Source
Link to this function

delete(epic_public_id)

View Source
delete(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 Source
delete(ExClubhouse.Session.t(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

delete_comment(epic_public_id, comment_public_id)

View Source
delete_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 Source
delete_comment(ExClubhouse.Session.t(), integer(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

get(category_public_id)

View Source
get(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 Source
Link to this function

get_comment(epic_public_id, comment_public_id)

View Source
get_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 Source
get_comment(ExClubhouse.Session.t(), integer(), integer()) ::
  {:ok, ExClubhouse.Model.Epic.t() | nil} | {:error, ExClubhouse.Error.t()}

Lists all epics

Example

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

stories_list(epic_public_id)

View Source
stories_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 Source
stories_list(ExClubhouse.Session.t(), integer()) ::
  {:ok, [ExClubhouse.Model.StorySlim.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_comment(epic_public_id, comment_public_id, update_comment_input)

View Source

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 Source