intercom-php/src/IntercomConversations.php at 8b0d332fedb44f09e2d84451165929458a15835d · 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
<?php

namespace Intercom;

use Http\Client\Exception;
use stdClass;

class IntercomConversations extends IntercomResource
{
    /**
     * Creates a Conversation.
     *
     * @see    https://developers.intercom.com/intercom-api-reference/reference#create-a-conversation
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function create(array $options)
    {
        return $this->client->post('conversations', $options);
    }

    /**
     * Returns list of Conversations.
     *
     * @see    https://developers.intercom.io/reference#list-conversations
     * @param  array $options
     * @return stdClass
     * @throws Exception
     */
    public function getConversations(array $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(string $id, array $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(string $id, array $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(array $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(string $id)
    {
        $path = $this->conversationPath($id);
        $data = ['read' => true];
        return $this->client->put($path, $data);
    }

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

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