intercom-php/src/IntercomVisitors.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
<?php

namespace Intercom;

use Http\Client\Exception;
use stdClass;

class IntercomVisitors extends IntercomResource
{
     /**
     * Updates Visitor.
     *
     * @see    https://developers.intercom.com/reference#update-a-visitor
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function update($options)
    {
        return $this->client->put("visitors", $options);
    }


    /**
     * Returns single Visitor.
     *
     * @see    https://developers.intercom.com/reference#view-a-visitor
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function getVisitor($id, $options = [])
    {
        $path = $this->visitorPath($id);
        return $this->client->get($path, $options);
    }

    /**
     * Deletes Visitor.
     *
     * @see    https://developers.intercom.com/reference#delete-a-visitor
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function deleteVisitor($id, $options = [])
    {
        $path = $this->visitorPath($id);
        return $this->client->delete($path, $options);
    }

    /**
     * Converts Visitor.
     *
     * @see    https://developers.intercom.io/reference#convert-a-lead
     * @param  $options
     * @return stdClass
     * @throws Exception
     */
    public function convertVisitor($options)
    {
        return $this->client->post("visitors/convert", $options);
    }

    /**
     * Returns endpoint path to Visitor with given ID.
     *
     * @param  string $id
     * @return string
     */
    private function visitorPath($id)
    {
        return "visitors/" . $id;
    }
}