intercom-php/src/IntercomConversations.php at 027baf1eb05ecf613d2bbb6e699b6efc0dbf3ff8 · 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<?php

namespace Intercom;

use Http\Client\Exception;
use stdClass;

class IntercomConversations extends IntercomResource
{
    /**
     * Returns list of Conversations.
     *
     * @see    https://developers.intercom.io/reference#list-conversations
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function getConversations($options)
    {
        return $this->client->get('conversations', $options);
    }

    /**
     * Returns single Conversation.
     *
     * @see    https://developers.intercom.io/reference#get-a-single-conversation
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function getConversation($id, $options = [])
    {
        $path = $this->conversationPath($id);
        return $this->client->get($path, $options);
    }

    /**
     * Returns list of Conversations that match search query.
     *
     * @see    https://developers.intercom.com/intercom-api-reference/reference#search-for-conversations
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function search(array $options)
    {
        $path = 'conversations/search';
        return $this->client->post($path, $options);
    }

    /**
     * Returns next page of Conversations that match search query.
     *
     * @see    https://developers.intercom.com/intercom-api-reference/reference#pagination-search
     * @param  array $query
     * @param  stdClass $pages
     * @return stdClass
     * @throws Exception
     */
    public function nextSearch(array $query, $pages)
    {
        $path = 'conversations/search';
        return $this->client->nextSearchPage($path, $query, $pages);
    }

    /**
     * Creates Conversation Reply to Conversation with given ID.
     *
     * @see    https://developers.intercom.io/reference#replying-to-a-conversation
     * @param  string $id
     * @param  array  $options
     * @return stdClass
     * @throws Exception
     */
    public function replyToConversation($id, $options)
    {
        $path = $this->conversationReplyPath($id);
        return $this->client->post($path, $options);
    }

    /**
     * Creates Conversation Reply to last conversation. (no need to specify Conversation ID.)
     *
     * @see    https://developers.intercom.io/reference#replying-to-users-last-conversation
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function replyToLastConversation($options)
    {
        $path = 'conversations/last/reply';
        return $this->client->post($path, $options);
    }

    /**
     * Marks a Conversation as read based on the given Conversation ID.
     *
     * @see    https://developers.intercom.io/reference#marking-a-conversation-as-read
     * @param  string $id
     * @return stdClass
     * @throws Exception
     */
    public function markConversationAsRead($id)
    {
        $path = $this->conversationPath($id);
        $data = ['read' => true];
        return $this->client->put($path, $data);
    }

    /**
     * Adds a tag to a Conversation based on the provided Tag and Admin ID
     *
     * @see    https://developers.intercom.com/intercom-api-reference/reference#attach-a-tag-to-a-conversation
     * @param string $id
     * @param string $tagId
     * @param string $adminId
     * @return stdClass
     */

    public function addTag($id, $tagId, $adminId) {

        $path = $this->conversationPath($id);

        return $this->client->post($path.'/tags', ['id' => $tagId, 'admin' => $adminId]);
    }

    /**
     * Removes a tag to a Conversation based on the provided Tag and Admin ID
     *
     * @see    https://developers.intercom.com/intercom-api-reference/reference#attach-a-tag-to-a-conversation
     * @param string $id
     * @param string $tagId
     * @param string $adminId
     * @return stdClass
     */

    public function removeTag($id, $tagId) {

        $path = $this->conversationPath($id);

        return $this->client->delete($path.'/tags', ['id' => $tagId]);
    }

    /**
     * Returns endpoint path to Conversation with given ID.
     *
     * @param  string $id
     * @return string
     */
    public function conversationPath($id)
    {
        return 'conversations/' . $id;
    }

    /**
     * Returns endpoint path to Conversation Reply for Conversation with given ID.
     *
     * @param  string $id
     * @return string
     */
    public function conversationReplyPath($id)
    {
        return 'conversations/' . $id . '/reply';
    }
}