ExDoppler.WorkplaceRoles (ExDoppler v1.0.0)

View Source

Module for interacting with ExDoppler.WorkplaceRole

๐Ÿ“– Resources

Summary

Functions

Retrieves a ExDoppler.WorkplaceRole, given a project and a webhook id

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

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

Functions

get_workplace_role(identifier)

Retrieves a ExDoppler.WorkplaceRole, given a project and a webhook id

๐Ÿท๏ธ Params

  • id - ID of the role to retrieve

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.WorkplaceRoles
iex> {:ok, _role} = WorkplaceRoles.get_workplace_role("owner")

๐Ÿ“– Resources

get_workplace_role!(identifier)

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

list_workplace_roles()

Lists ExDoppler.WorkplaceRole

โคต๏ธ Returns

โœ… On Success

  {:ok, [%ExDoppler.WorkplaceRole{...} ...]}

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.WorkplaceRoles
iex> {:ok, _roles} = WorkplaceRoles.list_workplace_roles()

๐Ÿ“– Resources

list_workplace_roles!()

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