elidactyl

v0.1.2

elidactyl v0.1.2 Elidactyl.Users

This module is responsible for listing and modifying Pterodactyl users.

Link to this section Summary

Functions

create_user(params)
delete_user(id)
edit_user(id, params)
get_user_by_external_id(id)
get_user_by_id(id)
list_users()

Request all users from server.

Link to this section Functions

Link to this function

create_user(params)

Specs

create_user(map()) :: Elidactyl.Schemas.User.t()
Link to this function

delete_user(id)

Specs

delete_user(binary() | integer()) :: :ok
Link to this function

edit_user(id, params)

Specs

edit_user(binary() | integer(), map()) :: Elidactyl.Schemas.User.t()
Link to this function

get_user_by_external_id(id)

Specs

get_user_by_external_id(binary() | integer()) :: Elidactyl.Schemas.User.t()
Link to this function

get_user_by_id(id)

Specs

get_user_by_id(binary() | integer()) :: Elidactyl.Schemas.User.t()
Link to this function

list_users()

Specs

list_users() ::
  {:ok, [Elidactyl.Schemas.User.t()]} | {:error, Elidactyl.Error.t()}

Request all users from server.