aboutsummaryrefslogtreecommitdiff
path: root/lib/zendex/user.ex
blob: 719d2ab7bd43c31da2cf87dd5df9a4a113af7939 (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
64
65
66
67
68
69
70
71
72
73
74
defmodule Zendex.User do
  @moduledoc """
  Interact with Zendesk user.
  """

  alias Zendex.CommonHelpers

  @url "/api/v2/users"

  @doc """
  List all users.
  """
  @spec list(Zendex.Connection.t) :: map
  def list(connection) do
    "#{connection.base_url}#{@url}.json"
    |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication))
    |> CommonHelpers.decode_response
  end

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

  @doc """
  Show many user, given their ids.
  """
  @spec show_many(Zendex.Connection.t, [integer]) :: map
  def show_many(connection, ids) do
    ids = Enum.join(ids, ",")

    "#{connection.base_url}#{@url}/show_many.json?ids=#{ids}"
    |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication))
    |> CommonHelpers.decode_response
  end

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

  @doc """
  Create a new user.
  """
  @spec create(Zendex.Connection.t, map) :: map
  def create(connection, user) do
    "#{connection.base_url}#{@url}.json"
    |> HTTPoison.post!(Poison.encode!(user),
                          CommonHelpers.get_headers(connection.authentication,
                                                    %{content_type: :json}))
    |> CommonHelpers.decode_response
  end

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

end