aboutsummaryrefslogtreecommitdiff
path: root/lib/zendex/user.ex
blob: a36f62687be55152c4d1e3547c699c7a5513844b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
defmodule Zendex.User do
  @moduledoc """
  Interact with Zendesk user.
  """

  @url "/api/v2/users"

  @doc """
  List all users.
  """
  @spec list(Zendex.Connection.t, Keyword.t) :: map | [map]
  def list(connection, opts \\ []) do
    "#{@url}.json"
    |> Zendex.get!(connection, [], opts)
  end

  @doc """
  Show a specific user, given their id.
  """
  @spec show(Zendex.Connection.t, integer) :: map
  def show(connection, id) do
    "#{@url}/#{id}.json"
    |> Zendex.get!(connection)
  end

  @doc """
  Show many user, given their ids.
  """
  @spec show_many(Zendex.Connection.t, [integer]) :: no_return
  def show_many(connection, ids) do
    ids = Enum.join(ids, ",")
    "#{@url}/show_many.json?ids=#{ids}"
    |> Zendex.get!(connection)
  end

  @doc """
  Show information relating to the user, example: number of assigned tickets.
  """
  @spec related_information(Zendex.Connection.t, integer) :: no_return
  def related_information(connection, id) do
    "#{@url}/#{id}/related.json"
    |> Zendex.get!(connection)
  end

  @doc """
  Create a new user.
  """
  @spec create(Zendex.Connection.t, map) :: any
  def create(connection, user) do
    "#{@url}.json"
    |> Zendex.post!(connection, Poison.encode!(user))
  end

  @doc """
  Delete a user.
  """
  @spec delete(Zendex.Connection.t, integer) :: {integer, map} | map
  def delete(connection, id) do
    "#{@url}/#{id}.json"
    |> Zendex.delete!(connection)
  end

end