ExClubhouse v0.5.2 ExClubhouse.Api.StoryLink View Source
Story link API
Link to this section Summary
Link to this section Functions
Link to this function
create(story_link_input)
View Sourcecreate(ExClubhouse.Model.Input.StoryLink.t()) :: {:ok, ExClubhouse.Model.StoryLink.t()} | {:error, ExClubhouse.Error.t()}
Create a milestone
Example
iex> ExClubhouse.Api.StoryLink.create(ExClubhouse.Model.Input.StoryLink{...})
{:ok, %ExClubhouse.StoryLink.Group{...}}
Link to this function
create(session, story_link_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.StoryLink.t()) :: {:ok, ExClubhouse.Model.StoryLink.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(story_link_public_id)
View Sourcedelete(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 Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
get(story_link_public_id)
View Sourceget(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 Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.StoryLink.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
update(story_link_public_id, story_link_input)
View Sourceupdate(integer(), ExClubhouse.Model.Input.StoryLink.t()) :: {:ok, ExClubhouse.Model.StoryLink.t()} | {:error, ExClubhouse.Error.t()}
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 Sourceupdate( ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.StoryLink.t() ) :: {:ok, ExClubhouse.Model.StoryLink.t()} | {:error, ExClubhouse.Error.t()}