intercom-php/src/IntercomUsers.php at fe9047622da002a7a4a3943900fa589f54353e5b · intercom/intercom-php · GitHub

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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?php

namespace Intercom;

use Http\Client\Exception;
use stdClass;

class IntercomUsers extends IntercomResource
{
    /**
     * Creates a User.
     *
     * @see    https://developers.intercom.io/reference#create-or-update-user
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function create(array $options)
    {
        return $this->client->post("users", $options);
    }

    /**
     * Creates a User.
     *
     * @see    https://developers.intercom.io/reference#create-or-update-user
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function update(array $options)
    {
        return $this->create($options);
    }

    /**
     * Lists Users.
     *
     * @see    https://developers.intercom.io/reference#list-users
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function getUsers(array $options)
    {
        return $this->client->get('users', $options);
    }

    /**
     * Gets a single User based on the Intercom ID.
     *
     * @see    https://developers.intercom.com/reference#view-a-user
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function getUser($id, $options = [])
    {
        $path = $this->userPath($id);
        return $this->client->get($path, $options);
    }

    /**
     * Gets a list of Users through the user scroll API.
     *
     * @see    https://developers.intercom.com/reference#iterating-over-all-users
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function scrollUsers(array $options = [])
    {
        return $this->client->get('users/scroll', $options);
    }

    /**
     * Deletes a single User based on the Intercom ID.
     *
     * @see    https://developers.intercom.com/reference#archive-a-user
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function archiveUser(string $id, array $options = [])
    {
        $path = $this->userPath($id);
        return $this->client->delete($path, $options);
    }

    /**
     * Deletes a single User based on the Intercom ID.
     *
     * @see    https://developers.intercom.com/reference#archive-a-user
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function deleteUser(string $id, array $options = [])
    {
        return $this->archiveUser($id, $options);
    }

    /**
     * Permanently deletes a single User based on the Intercom ID.
     *
     * @see   https://developers.intercom.com/reference#delete-users
     * @param string $id
     * @return stdClass
     * @throws Exception
     */
    public function permanentlyDeleteUser(string $id)
    {
        return $this->client->post('user_delete_requests', [
            'intercom_user_id' => $id
        ]);
    }

    /**
     * @param string $id
     * @return string
     */
    private function userPath(string $id)
    {
        return 'users/' . $id;
    }
}