ExDoppler.Workplaces (ExDoppler v1.0.1)
View SourceModule for interacting with ExDoppler.Workplace
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Retrieves a ExDoppler.Workplace
, given options
Same as get_workplace/0
but won't wrap a successful response in {:ok, response}
Lists permissions known in ExDoppler.Workplace
Same as list_permissions/0
but won't wrap a successful response in {:ok, response}
Updates an ExDoppler.Workplace
Same as update_workplace/1
but won't wrap a successful response in {:ok, response}
Functions
Retrieves a ExDoppler.Workplace
, given options
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Workplace{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Workplaces
iex> {:ok, _wp} = Workplaces.get_workplace()
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_workplace/0
but won't wrap a successful response in {:ok, response}
Lists permissions known in ExDoppler.Workplace
โคต๏ธ Returns
โ On Success
{:ok, ["perm1"...]}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Workplaces
iex> {:ok, _perms} = Workplaces.list_permissions()
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_permissions/0
but won't wrap a successful response in {:ok, response}
Updates an ExDoppler.Workplace
๐ท๏ธ Params
- opts: Optional modifications
- billing_email - New billing email for the workplace
- security_email - New security email for the workplace
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Workplace{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Workplaces
iex> {:ok, wp} = Workplaces.get_workplace()
iex> {:ok, _wp} = Workplaces.update_workplace(billing_email: wp.billing_email, security_email: wp.security_email)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as update_workplace/1
but won't wrap a successful response in {:ok, response}