ExDoppler.ProjectRoles (ExDoppler v1.0.0)

View Source

Module for interacting with ExDoppler.ProjectRole

๐Ÿ“– Resources

Summary

Functions

Creates a new ExDoppler.ProjectRole, given a name and list of permissions

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

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

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

Functions

create_project_role(name, permissions)

Creates a new ExDoppler.ProjectRole, given a name and list of permissions

๐Ÿท๏ธ Params

  • name: Role name (e.g "viewer_but_different")
  • permissions: List of permissions given to the role. See Doppler Docs

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:err, err}

๐Ÿ“– Resources

create_project_role!(name, permissions)

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

get_project_role(identifier)

Retrieves a ExDoppler.ProjectRole

๐Ÿท๏ธ Params

  • identifier - identifier for role - e.g "collaborator" or "admin" or "viewer" or "no_access"

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.ProjectRoles
iex> {:ok, [role | _]}= ProjectRoles.list_project_roles()
iex> {:ok,  _role} = ProjectRoles.get_project_role(role.identifier)

๐Ÿ“– Resources

get_project_role!(identifier)

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

list_project_roles()

Lists ExDoppler.ProjectRole

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.ProjectRoles
iex> {:ok, _roles} = ProjectRoles.list_project_roles()

๐Ÿ“– Resources

list_project_roles!()

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