ExClubhouse v0.5.1 ExClubhouse.Api.EntityTemplate View Source
Entity template API
Link to this section Summary
Functions
Creates an entity template
Deletes an entity template
Disable entity templates
Enable entity templates
Get an entity template by UUID
Lists all entity templates
Updates an entity template
Link to this section Functions
Link to this function
create(epic_input)
View Sourcecreate(ExClubhouse.Model.Input.EntityTemplate.t()) :: {:ok, ExClubhouse.Model.EntityTemplate.t()} | {:error, ExClubhouse.Error.t()}
Creates an entity template
Example
iex> ExClubhouse.Api.EntityTemplate.create(%Input.EntityTemplate{...})
{:ok, %ExClubhouse.Model.EntityTemplate{...}}
Link to this function
create(session, epic_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.EntityTemplate.t()) :: {:ok, ExClubhouse.Model.EntityTemplate.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(entity_template_public_id)
View Sourcedelete(binary()) :: :ok | {:error, ExClubhouse.Error.t()}
Deletes an entity template
Example
iex> ExClubhouse.Api.EntityTemplate.delete("E6DE045E-3A51-4116-85B6-9449801A002E")
:ok
Link to this function
delete(session, entity_template_public_id)
View Sourcedelete(ExClubhouse.Session.t(), binary()) :: :ok | {:error, ExClubhouse.Error.t()}
Disable entity templates
Example
iex> ExClubhouse.Api.EntityTemplate.disable()
:ok
Link to this function
disable(session)
View Sourcedisable(ExClubhouse.Session.t()) :: :ok | {:error, ExClubhouse.Error.t()}
Enable entity templates
Example
iex> ExClubhouse.Api.EntityTemplate.enable()
:ok
Link to this function
enable(session)
View Sourceenable(ExClubhouse.Session.t()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
get(entity_template_public_id)
View Sourceget(binary()) :: {:ok, ExClubhouse.Model.EntityTemplate.t() | nil} | {:error, ExClubhouse.Error.t()}
Get an entity template by UUID
Example
iex> ExClubhouse.Api.EntityTemplate.get("E6DE045E-3A51-4116-85B6-9449801A002E")
{:ok, %ExClubhouse.Model.EntityTemplate{...}}
Link to this function
get(session, entity_template_public_id)
View Sourceget(ExClubhouse.Session.t(), binary()) :: {:ok, ExClubhouse.Model.EntityTemplate.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.EntityTemplate.t()]} | {:error, ExClubhouse.Error.t()}
Lists all entity templates
Example
iex> ExClubhouse.Api.EntityTemplate.list()
{:ok, [%ExClubhouse.Model.EntityTemplate{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.EntityTemplate.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
update(entity_template_public_id, epic_input)
View Sourceupdate(binary(), ExClubhouse.Model.Input.EntityTemplate.t()) :: {:ok, ExClubhouse.Model.EntityTemplate.t()} | {:error, ExClubhouse.Error.t()}
Updates an entity template
Example
iex> ExClubhouse.Api.EntityTemplate.update(%Input.EntityTemplate{...})
{:ok, %ExClubhouse.Model.EntityTemplate{...}}
Link to this function
update(session, entity_template_public_id, epic_input)
View Sourceupdate( ExClubhouse.Session.t(), binary(), ExClubhouse.Model.Input.EntityTemplate.t() ) :: {:ok, ExClubhouse.Model.EntityTemplate.t()} | {:error, ExClubhouse.Error.t()}