ExClubhouse v0.6.0 ExClubhouse.Api.EntityTemplate View Source

Entity template API

Link to this section Summary

Link to this section Functions

Creates an entity template

Example

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

delete(entity_template_public_id)

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

disable()

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

Disable entity templates

Example

iex> ExClubhouse.Api.EntityTemplate.disable()
:ok
Link to this function

enable()

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

Enable entity templates

Example

iex> ExClubhouse.Api.EntityTemplate.enable()
:ok
Link to this function

get(entity_template_public_id)

View Source
get(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 Source

Lists all entity templates

Example

iex> ExClubhouse.Api.EntityTemplate.list()
{:ok, [%ExClubhouse.Model.EntityTemplate{...}, ...]}

Updates an entity template

Example

iex> ExClubhouse.Api.EntityTemplate.update(%Input.EntityTemplate{...})
{:ok, %ExClubhouse.Model.EntityTemplate{...}}