ExDoppler.WorkplaceUsers (ExDoppler v1.0.1)
View SourceModule for interacting with ExDoppler.WorkplaceUser
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Retrieves a ExDoppler.WorkplaceUser
, given a project and a webhook id
Same as get_workplace_user/1
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.WorkplaceUser
using pagination.
Same as list_workplace_users/1
but won't wrap a successful response in {:ok, response}
Updates an ExDoppler.WorkplaceUser
, given a workplace user and new access
Same as update_workplace_user/1
but won't wrap a successful response in {:ok, response}
Functions
Retrieves a ExDoppler.WorkplaceUser
, given a project and a webhook id
๐ท๏ธ Params
- id - ID of the Workplace User to retrieve
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.WorkplaceUser{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.WorkplaceUsers
iex> {:ok, [user | _]} = WorkplaceUsers.list_workplace_users()
iex> {:ok, _user} = WorkplaceUsers.get_workplace_user(user.id)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_workplace_user/1
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.WorkplaceUser
using pagination.
๐ท๏ธ Params
- opts: Optional modifications to the list call
- page - which page to list (starts at 1) (e.g
page: 2
). Default:1
- email - Filter results to only include the user with the provided email address. Default:
nil
- page - which page to list (starts at 1) (e.g
โคต๏ธ Returns
โ On Success
{:ok, [%ExDoppler.WorkplaceUser{...} ...]}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.WorkplaceUsers
iex> {:ok, _users} = WorkplaceUsers.list_workplace_users()
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_workplace_users/1
but won't wrap a successful response in {:ok, response}
Updates an ExDoppler.WorkplaceUser
, given a workplace user and new access
๐ท๏ธ Params
- workplace_user: The relevant environment (e.g
%WorkplaceUser{id: "98370f9a-0675-430a-abbc-dbb02b78c5a8" ...}
) - new_access: E.g.,
:owner
,:collaborator
, etc.
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.WorkplaceUser{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.WorkplaceUsers
iex> {:ok, [user | _]} = WorkplaceUsers.list_workplace_users()
iex> {:ok, _user} = WorkplaceUsers.update_workplace_user(user, :owner)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as update_workplace_user/1
but won't wrap a successful response in {:ok, response}