active_campaign v0.2.5

View Source ActiveCampaign.User (active_campaign v0.2.5)

Documentation for ActiveCampaign.User.

Link to this section Summary

Functions

create(user)

Create a user

delete(id)

Delete a user

get(id)

Retrieve a user

get_by_email(email)

Retrieve a user by email

get_by_username(username)

Retrieve a user by username

list(query_params \\ %{})

List all users

me()

Retrieve logged-in user

update(id, user)

Update a user

Link to this section Functions

Link to this function

create(user)

View Source 
@spec create(map()) :: {:ok, map()} | {:error, any()}

Create a user

Link to this function

delete(id)

View Source 
@spec delete(integer()) :: {:ok, map()} | {:error, any()}

Delete a user

Link to this function

get(id)

View Source 
@spec get(integer()) :: {:ok, map()} | {:error, any()}

Retrieve a user

Link to this function

get_by_email(email)

View Source 
@spec get_by_email(String.t()) :: {:ok, map()} | {:error, any()}

Retrieve a user by email

Link to this function

get_by_username(username)

View Source 
@spec get_by_username(String.t()) :: {:ok, map()} | {:error, any()}

Retrieve a user by username

Link to this function

list(query_params \\ %{})

View Source 
@spec list(map()) :: {:ok, map()} | {:error, any()}

List all users

Link to this function

me()

View Source 
@spec me() :: {:ok, map()} | {:error, any()}

Retrieve logged-in user

Link to this function

update(id, user)

View Source 
@spec update(integer(), map()) :: {:ok, map()} | {:error, any()}

Update a user