noizu_core v1.0.28

View Source Noizu.ElixirCore.CallerEntity (noizu_core v1.0.28)

The Noizu.ElixirCore.CallerEntity module provides a convenience structure for tracking API caller authentication levels. It supports the levels :internal, :restricted, :system, and :admin.

types

 Types

  • t: A structure representing the CallerEntity with fields identifier and vsn.

functions

 Functions

Link to this section Summary

Types

t()

Functions

entity!(ref, options \\ %{})

Noizu.ERP handler

entity(ref, options \\ %{})

Returns the CallerEntity as an entity struct. Raises an error if the conversion fails.

entity_ok!(o, options \\ %{})

Returns the CallerEntity as an entity struct as an :ok tuple or raises an error if the conversion fails.

entity_ok(o, options \\ %{})

Returns the CallerEntity as an entity struct as an :ok tuple or the original object as an :error tuple.

id(e)

Returns the identifier of the CallerEntity.

id_ok(o)

Returns the identifier of the CallerEntity as an :ok tuple or the original object as an :error tuple.

record!(ref, options \\ %{})

Noizu.ERP handler

record(ref, options \\ %{})

Returns the CallerEntity as a record.

ref(e)

Returns the reference tuple for the CallerEntity.

ref_ok(o)

Returns the reference tuple of the CallerEntity as an :ok tuple or the original object as an :error tuple.

sref(e)

Returns the string reference for the CallerEntity.

sref_ok(o)

Returns the string reference of the CallerEntity as an :ok tuple or the original object as an :error tuple.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Noizu.ElixirCore.CallerEntity{identifier: any(), vsn: float()}

Link to this section Functions

Link to this function

entity!(ref, options \\ %{})

View Source

Noizu.ERP handler

Link to this function

entity(ref, options \\ %{})

View Source

Returns the CallerEntity as an entity struct. Raises an error if the conversion fails.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.entity!(%Noizu.ElixirCore.CallerEntity{identifier: :system})
%Noizu.ElixirCore.CallerEntity{identifier: :system}

iex> Noizu.ElixirCore.CallerEntity.entity!({:ref, Noizu.ElixirCore.CallerEntity, :system})
%Noizu.ElixirCore.CallerEntity{identifier: :system}

iex> Noizu.ElixirCore.CallerEntity.entity!("ref.noizu-caller.system")
%Noizu.ElixirCore.CallerEntity{identifier: :system}

iex> Noizu.ElixirCore.CallerEntity.entity!(:system)
%Noizu.ElixirCore.CallerEntity{identifier: :system}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

entity_ok!(o, options \\ %{})

View Source

Returns the CallerEntity as an entity struct as an :ok tuple or raises an error if the conversion fails.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.entity_ok!(%Noizu.ElixirCore.CallerEntity{identifier: :system})
{:ok, %Noizu.ElixirCore.CallerEntity{identifier: :system}}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

entity_ok(o, options \\ %{})

View Source

Returns the CallerEntity as an entity struct as an :ok tuple or the original object as an :error tuple.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.entity_ok(%Noizu.ElixirCore.CallerEntity{identifier: :system})
{:ok, %Noizu.ElixirCore.CallerEntity{identifier: :system}}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

id(e)

View Source 
@spec id(any()) :: any()

Returns the identifier of the CallerEntity.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.id(%Noizu.ElixirCore.CallerEntity{identifier: :system})
:system

iex> Noizu.ElixirCore.CallerEntity.id({:ref, Noizu.ElixirCore.CallerEntity, :system})
:system

iex> Noizu.ElixirCore.CallerEntity.id("ref.noizu-caller.system")
:system

iex> Noizu.ElixirCore.CallerEntity.id(:system)
:system

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

id_ok(o)

View Source

Returns the identifier of the CallerEntity as an :ok tuple or the original object as an :error tuple.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.id_ok(%Noizu.ElixirCore.CallerEntity{identifier: :system})
{:ok, :system}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

record!(ref, options \\ %{})

View Source

Noizu.ERP handler

Link to this function

record(ref, options \\ %{})

View Source

Returns the CallerEntity as a record.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.record(%Noizu.ElixirCore.CallerEntity{identifier: :system})
%Noizu.ElixirCore.CallerEntity{identifier: :system}

iex> Noizu.ElixirCore.CallerEntity.record({:ref, Noizu.ElixirCore.CallerEntity, :system})
%Noizu.ElixirCore.CallerEntity{identifier: :system}

iex> Noizu.ElixirCore.CallerEntity.record("ref.noizu-caller.system")
%Noizu.ElixirCore.CallerEntity{identifier: :system}

iex> Noizu.ElixirCore.CallerEntity.record(:system)
%Noizu.ElixirCore.CallerEntity{identifier: :system}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

ref(e)

View Source 
@spec ref(any()) :: tuple()

Returns the reference tuple for the CallerEntity.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.ref(%Noizu.ElixirCore.CallerEntity{identifier: :system})
{:ref, Noizu.ElixirCore.CallerEntity, :system}

iex> Noizu.ElixirCore.CallerEntity.ref({:ref, Noizu.ElixirCore.CallerEntity, :system})
{:ref, Noizu.ElixirCore.CallerEntity, :system}

iex> Noizu.ElixirCore.CallerEntity.ref("ref.noizu-caller.system")
{:ref, Noizu.ElixirCore.CallerEntity, :system}

iex> Noizu.ElixirCore.CallerEntity.ref(:system)
{:ref, Noizu.ElixirCore.CallerEntity, :system}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

ref_ok(o)

View Source

Returns the reference tuple of the CallerEntity as an :ok tuple or the original object as an :error tuple.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.ref_ok(%Noizu.ElixirCore.CallerEntity{identifier: :system})
{:ok, {:ref, Noizu.ElixirCore.CallerEntity, :system}}

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

sref(e)

View Source 
@spec sref(t()) :: String.t()

Returns the string reference for the CallerEntity.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.sref(%Noizu.ElixirCore.CallerEntity{identifier: :system})
"ref.noizu-caller.system"

iex> Noizu.ElixirCore.CallerEntity.sref({:ref, Noizu.ElixirCore.CallerEntity, :system})
"ref.noizu-caller.system"

iex> Noizu.ElixirCore.CallerEntity.sref("ref.noizu-caller.system")
"ref.noizu-caller.system"

iex> Noizu.ElixirCore.CallerEntity.sref(:system)
"ref.noizu-caller.system"

Code Review

  • The function could benefit from more detailed documentation.
Link to this function

sref_ok(o)

View Source

Returns the string reference of the CallerEntity as an :ok tuple or the original object as an :error tuple.

examples

 Examples 

iex> Noizu.ElixirCore.CallerEntity.sref_ok(%Noizu.ElixirCore.CallerEntity{identifier: :system})
{:ok, "ref.noizu-caller.system"}

Code Review

  • The function could benefit from more detailed documentation.