ExDoppler.WorkplaceUsers (ExDoppler v1.0.1)

View Source

Module for interacting with ExDoppler.WorkplaceUser

๐Ÿ“– Resources

Summary

Functions

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

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

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

Updates an ExDoppler.WorkplaceUser, given a workplace user and new access

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

Functions

get_workplace_user(id)

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

๐Ÿท๏ธ Params

  • id - ID of the Workplace User to retrieve

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.WorkplaceUsers
iex> {:ok, [user | _]} = WorkplaceUsers.list_workplace_users()
iex> {:ok, _user} = WorkplaceUsers.get_workplace_user(user.id)

๐Ÿ“– Resources

get_workplace_user!(id)

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

list_workplace_users(opts \\ [])

Lists ExDoppler.WorkplaceUser using pagination.

๐Ÿท๏ธ Params

  • opts: Optional modifications to the list call
    • page - which page to list (starts at 1) (e.g page: 2). Default: 1
    • email - Filter results to only include the user with the provided email address. Default: nil

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.WorkplaceUsers
iex> {:ok, _users} = WorkplaceUsers.list_workplace_users()

๐Ÿ“– Resources

list_workplace_users!(opts \\ [])

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

update_workplace_user(workplace_user, new_access)

Updates an ExDoppler.WorkplaceUser, given a workplace user and new access

๐Ÿท๏ธ Params

  • workplace_user: The relevant environment (e.g %WorkplaceUser{id: "98370f9a-0675-430a-abbc-dbb02b78c5a8" ...})
  • new_access: E.g., :owner, :collaborator, etc.

โคต๏ธ Returns

โœ… On Success

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

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.WorkplaceUsers
iex> {:ok, [user | _]} = WorkplaceUsers.list_workplace_users()
iex> {:ok, _user} = WorkplaceUsers.update_workplace_user(user, :owner)

๐Ÿ“– Resources

update_workplace_user!(wp_user, new_access)

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