Elixir Arkvatar Client

v1.0.0

Elixir Arkvatar Client v1.0.0 Arkvatar.Api View Source

Documentation for Arkvatar.Api

Link to this section Summary

Functions

show(identifier)

Show the Arkvatar matching the given identifier. Identifier can be a crypto or email address.

store(data)

Create an Arkvatar from the given data.

verify(identifier)

Verify the given identifier. Identifier can be a crypto or email address.

Link to this section Functions

Link to this function

show(identifier) View Source (since 1.0.0)

Show the Arkvatar matching the given identifier. Identifier can be a crypto or email address.

Examples 

iex> Arkvatar.Api.show('validIdentifier')
:ok
Link to this function

store(data) View Source (since 1.0.0) 
store(Map.t()) :: Arkvatar.Client.response()

Create an Arkvatar from the given data.

Examples

Without specifying the type or any other parameters

iex> Arkvatar.Api.store(%{identifier: 'validIdentifier'})

With type and parameters

iex> Arkvatar.Api.store(%{type: 'validType', identifier: 'validIdentifier', qr_code: bool, vertical_gradient: bool, no_background: bool})

Link to this function

verify(identifier) View Source (since 1.0.0) 
verify(String.t()) :: Arkvatar.Client.response()
verify(String.t()) :: Arkvatar.Client.response()

Verify the given identifier. Identifier can be a crypto or email address.

Examples 

iex> Arkvatar.Api.verify('validIdentifier')
:ok