upvest v0.1.1 Upvest.Tenancy.User View Source

Handles operations related to the user

You can:

  • Create a user
  • Retrieve a user
  • Change user password
  • List all users
  • List specific number of users
  • Delete a user

For more details see https://doc.upvest.co/reference#tenancy_user_list

Link to this section Summary

Functions

Delete a(n) User

List all User

List specific number of User

Retrive a(n) User by its ID

Link to this section Types

Link to this type

t()

View Source
t() :: %Upvest.Tenancy.User{
  recoverykit: term(),
  username: term(),
  wallets: term()
}

Link to this section Functions

Link to this function

change_password(client, username, old_password, new_password)

View Source
change_password(Upvest.Client.t(), binary(), binary(), binary()) ::
  {:ok, t()} | {:error, Upvest.error()}

Change password for a user

For more details see https://doc.upvest.co/reference#tenancy_user_password_update

Link to this function

create(client, username, password)

View Source
create(Upvest.Client.t(), binary(), binary()) ::
  {:ok, t()} | {:error, Upvest.error()}

Create a user.

For more details https://doc.upvest.co/reference#tenancy_user_create

Link to this function

delete(client, id)

View Source
delete(Upvest.Client.t(), binary()) :: {:ok, nil} | {:error, Upvest.error()}

Delete a(n) User

List all User

Link to this function

list_n(client, count)

View Source
list_n(Upvest.Client.t(), non_neg_integer()) ::
  {:ok, [Upvest.Tenancy.User.t()]} | {:error, Upvest.error()}

List specific number of User

Link to this function

retrieve(client, id)

View Source
retrieve(Upvest.Client.t(), binary()) ::
  {:ok, Upvest.Tenancy.User.t()} | {:error, Upvest.error()}

Retrive a(n) User by its ID