View Source Zendesk.User (zendesk v0.0.1)

Link to this section Summary

Functions

Delete a specific Zendesk.User.

Get information for the specific Zendesk.User whose credentials are being used.

Get a list of Zendesk.Users.

Permanently delete a specific Zendesk.User.

Get a specific Zendesk.User.

Link to this section Functions

@spec delete(String.t()) :: Zendesk.Client.Operation.t()

Delete a specific Zendesk.User.

@spec get_requestor() :: Zendesk.Client.Operation.t()

Get information for the specific Zendesk.User whose credentials are being used.

@spec list() :: Zendesk.Client.Operation.t()

Get a list of Zendesk.Users.

If passed to Zendesk.request!/1 it will return only the first results from the list. You can create a Stream to paginate over all results by calling Zendesk.stream!/1.

For instance:

 # get 400 users
 Zendesk.User.list()
 |> Zendesk.stream!()
 |> Stream.take(400)
 |> Enum.to_list()
 |> IO.inspect()
@spec permanently_delete(String.t()) :: Zendesk.Client.Operation.t()

Permanently delete a specific Zendesk.User.

Note that Zendesk.User.delete/1 must be called first for this user.

Get a specific Zendesk.User.