X3m System v0.4.7 X3m.System.Response View Source

Link to this section Summary

Link to this section Types

Link to this type

t()

View Source
t() ::
  :ok
  | {:ok, any()}
  | {:ok, any(), integer()}
  | {:created, any()}
  | {:service_unavailable, atom()}
  | {:service_timeout, atom(), String.t(), non_neg_integer()}
  | {:validation_error, map()}
  | {:missing_id, atom() | String.t()}
  | {:error, any()}

Link to this section Functions

Link to this function

created(id)

View Source
created(any()) :: {:created, any()}
Link to this function

error(any)

View Source
error(any()) :: {:error, any()}
Link to this function

missing_id(id_field)

View Source
missing_id(atom() | String.t()) :: {:missing_id, atom() | String.t()}
Link to this function

ok(payload)

View Source
ok(any()) :: {:ok, any()}
Link to this function

service_timeout(msg_name, req_id, timeout)

View Source
service_timeout(atom(), String.t(), non_neg_integer()) ::
  {:service_timeout, atom(), String.t(), non_neg_integer()}
Link to this function

service_unavailable(msg_name)

View Source
service_unavailable(atom()) :: {:service_unavailable, atom()}
Link to this function

unauthorized(msg)

View Source
unauthorized(String.t()) :: {:unauthorized, String.t()}
Link to this function

validation_error(request)

View Source
validation_error(map()) :: {:validation_error, map()}