ExDoppler.Workplaces (ExDoppler v1.0.0)

View Source

Module for interacting with ExDoppler.Workplace

๐Ÿ“– Resources

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}

Same as update_workplace/1 but won't wrap a successful response in {:ok, response}

Functions

get_workplace()

Retrieves a ExDoppler.Workplace, given options

โคต๏ธ Returns

โœ… On Success

  {:ok, %ExDoppler.Workplace{...}}

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.Workplaces
iex> {:ok, _wp} = Workplaces.get_workplace()

๐Ÿ“– Resources

get_workplace!()

Same as get_workplace/0 but won't wrap a successful response in {:ok, response}

list_permissions()

Lists permissions known in ExDoppler.Workplace

โคต๏ธ Returns

โœ… On Success

  {:ok, ["perm1"...]}

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.Workplaces
iex> {:ok, _perms} = Workplaces.list_permissions()

๐Ÿ“– Resources

list_permissions!()

Same as list_permissions/0 but won't wrap a successful response in {:ok, response}

update_workplace(opts \\ [])

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

  {:err, 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

update_workplace!(opts \\ [])

Same as update_workplace/1 but won't wrap a successful response in {:ok, response}