View Source Zendesk.User (zendesk v0.0.3)
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.User
s.
Permanently delete a specific Zendesk.User
.
Get a specific Zendesk.User
.
Link to this section Types
@type t() :: %Zendesk.User{ active: term(), alias: term(), authenticity_token: term(), created_at: term(), custom_role_id: term(), default_group_id: term(), details: term(), email: term(), external_id: term(), iana_time_zone: term(), id: term(), last_login_at: term(), locale: term(), locale_id: term(), moderator: term(), name: term(), notes: term(), only_private_comments: term(), organization_id: term(), phone: term(), photo: term(), report_csv: term(), restricted_agent: term(), role: term(), role_type: term(), shared: term(), shared_agent: term(), shared_phone_number: term(), signature: term(), suspended: term(), tags: term(), ticket_restriction: term(), time_zone: term(), two_factor_auth_enabled: term(), updated_at: term(), url: term(), user_fields: term(), verified: term() }
Link to this section Functions
@spec delete(pos_integer() | 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(Keyword.t()) :: Zendesk.Client.Operation.t()
Get a list of Zendesk.User
s.
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(pos_integer() | t()) :: Zendesk.Client.Operation.t()
Permanently delete a specific Zendesk.User
.
Note that Zendesk.User.delete/1
must be called first for this user.
@spec show(pos_integer()) :: Zendesk.Client.Operation.t()
Get a specific Zendesk.User
.