View Source PlacetelAPI.Api.Users (placetel_api v2.0.1)
API calls for all endpoints tagged Users
.
Link to this section Summary
Functions
Delete a subuser Delete a subuser by its ID
Me Information about the current API user
Fetch all users Fetch a list of all users of the account
Fetch user by ID Fetch a single user from your account by its ID
Create new subuser Create a new subuser for your account
Reset password for account Reset password for account
Update a subuser Update an existing subuser for your account
Link to this section Functions
@spec delete_users_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.User.t()} | {:error, Tesla.Env.t()}
Delete a subuser Delete a subuser by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): Subuser IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.User.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_me( Tesla.Env.client(), keyword() ) :: {:ok, PlacetelAPI.Model.Me.t()} | {:error, Tesla.Env.t()}
Me Information about the current API user
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.Me.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_users( Tesla.Env.client(), keyword() ) :: {:ok, [PlacetelAPI.Model.User.t()]} | {:error, Tesla.Env.t()}
Fetch all users Fetch a list of all users of the account
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serveropts
(keyword): Optional parameters:"filter[first_name]"
(String.t)::"filter[last_name]"
(String.t)::"filter[email]"
(String.t)::"filter[login]"
(String.t)::page
(integer()): Page of results to fetch.:per_page
(integer()): Number of results to return per page.
returns
Returns
{:ok, [%User{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec get_users_id(Tesla.Env.client(), integer(), keyword()) :: {:ok, PlacetelAPI.Model.User.t()} | {:error, Tesla.Env.t()}
Fetch user by ID Fetch a single user from your account by its ID
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): User IDopts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.User.t}
on success{:error, Tesla.Env.t}
on failure
@spec post_users(Tesla.Env.client(), PlacetelAPI.Model.PostUsers.t(), keyword()) :: {:ok, PlacetelAPI.Model.User.t()} | {:error, Tesla.Env.t()}
Create new subuser Create a new subuser for your account
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverusers
(PostUsers):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.User.t}
on success{:error, Tesla.Env.t}
on failure
@spec post_users_id_password_reset(Tesla.Env.client(), integer(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Reset password for account Reset password for account
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): User IDopts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec put_users_id( Tesla.Env.client(), integer(), PlacetelAPI.Model.PutUsers.t(), keyword() ) :: {:ok, PlacetelAPI.Model.User.t()} | {:error, Tesla.Env.t()}
Update a subuser Update an existing subuser for your account
parameters
Parameters
connection
(PlacetelAPI.Connection): Connection to serverid
(integer()): User IDusers
(PutUsers):opts
(keyword): Optional parameters
returns
Returns
{:ok, PlacetelAPI.Model.User.t}
on success{:error, Tesla.Env.t}
on failure