annon_api v0.16.2 Annon.Requests.Log

The boundary for the Requests Log system.

Link to this section Summary

Functions

Returns an %Ecto.Changeset{} for tracking Request changes

Creates a Request

Deletes a Request

Gets a single Request

Gets a single Request by a selector

Writes request to a database

Link to this section Functions

Link to this function change_request(attrs)

Returns an %Ecto.Changeset{} for tracking Request changes.

Examples

iex> change_template(request_attrs)
%Ecto.Changeset{source: %Request{}}
Link to this function create_request(attrs \\ %{})

Creates a Request.

Examples

iex> create_request(%{field: value})
{:ok, %Annon.Requests.Request{}}

iex> create_request(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Link to this function delete_request(request)

Deletes a Request.

Examples

iex> delete_request(123)
{:ok, %Request{}}

iex> delete_request(007)
{:ok, %Request{}}
Link to this function get_request(id)

Gets a single Request.

Examples

iex> get_request(123)
{:ok, %Annon.Requests.Request{}}

iex> get_request(456)
{:error, :not_found}
Link to this function get_request_by(selector)

Gets a single Request by a selector.

Examples

iex> get_request_by([idempotency_key: "my_key"])
{:ok, %Annon.Requests.Request{}}

iex> get_request_by([idempotency_key: "bad_my_key"])
{:error, :not_found}
Link to this function insert_request(changeset)

Writes request to a database.

Examples

iex> create_request(%Ecto.Changeset{})
{:ok, %Annon.Requests.Request{}}

iex> create_request(%Ecto.Changeset{valid?: false})
{:error, %Ecto.Changeset{}}
Link to this function list_requests(conditions \\ %{}, paging \\ %Paging{limit: 50})

Returns the list of Logs.

Response can be filtered by title if there is a "title" filed in conditions.

Examples

iex> list_requests()
{[%Annon.Requests.Request{}, ...], %Ecto.Paging{}}