ExDoppler.ProjectMembers (ExDoppler v1.0.0)

View Source

Module for interacting with ExDoppler.ProjectMember

๐Ÿ“– Resources

Summary

Functions

get_project_member(project, member_type, member_slug)

Retrieves a ExDoppler.ProjectMember

๐Ÿท๏ธ Params

  • project: The ExDoppler.Project for which you want the environments (e.g %Project{name: "example-project"})
  • member_type: type of member (e.g "workplace_user")
  • member_slug: slug of member (e.g "e32d0dcd-c094-4606-aefa-c4127e2a1282")

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.ProjectMembers
iex> alias ExDoppler.Projects
iex> [project | _]= Projects.list_projects!()
iex> {:ok, [member | _]} = ProjectMembers.list_project_members(project, page: 1, per_page: 20)
iex> {:ok, _member} = ProjectMembers.get_project_member(project,  member.type, member.slug)

๐Ÿ“– Resources

get_project_member!(project, member_type, member_slug)

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

list_project_members(project, opts \\ [])

Lists ExDoppler.ProjectMember using pagination

๐Ÿท๏ธ Params

  • project: The ExDoppler.Project for which you want the environments (e.g %Project{name: "example-project"})
  • opts: Optional modifications to the list call
    • page - which page to list (starts at 1) (e.g page: 2). Default: 1
    • per_page - the number of ExDoppler.ProjectMember to return for this page (e.g per_page: 50). Default: 20

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.ProjectMembers
iex> alias ExDoppler.Projects
iex> [project | _]= Projects.list_projects!()
iex> {:ok, _members} = ProjectMembers.list_project_members(project, page: 1, per_page: 20)

๐Ÿ“– Resources

list_project_members!(project, opts \\ [])

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