ExClubhouse v0.6.0 ExClubhouse.Api.StoryLink View Source

Story link API

Link to this section Summary

Link to this section Functions

Create a milestone

Example

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

delete(story_link_public_id)

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

Delete a milestone

## Example

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

delete(session, story_link_public_id)

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

get(story_link_public_id)

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

Get a single milestone by id

Example

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

get(session, story_link_public_id)

View Source
Link to this function

update(story_link_public_id, story_link_input)

View Source

Update a StoryLink

Example

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

update(session, story_link_public_id, story_link_input)

View Source