Skip to content

Commit f5f3cb3

Browse files
committed
Added @throws clause to methods PhpDoc
1 parent a722f7f commit f5f3cb3

12 files changed

+28
-0
lines changed

src/IntercomAdmins.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#list-admins
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function getAdmins($options = [])
2627
{

src/IntercomBulk.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#bulk-user-operations
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function users($options)
2627
{
@@ -32,6 +33,7 @@ public function users($options)
3233
* @see https://developers.intercom.io/reference#bulk-event-operations
3334
* @param array $options
3435
* @return mixed
36+
* @throws \GuzzleHttp\Exception\GuzzleException
3537
*/
3638
public function events($options)
3739
{

src/IntercomClient.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public function setClient($client)
9090
* @param string $endpoint
9191
* @param string $json
9292
* @return mixed
93+
* @throws \GuzzleHttp\Exception\GuzzleException
9394
*/
9495
public function post($endpoint, $json)
9596
{
@@ -108,6 +109,7 @@ public function post($endpoint, $json)
108109
* @param string $endpoint
109110
* @param string $json
110111
* @return mixed
112+
* @throws \GuzzleHttp\Exception\GuzzleException
111113
*/
112114
public function delete($endpoint, $json)
113115
{
@@ -125,6 +127,7 @@ public function delete($endpoint, $json)
125127
* @param string $endpoint
126128
* @param string $query
127129
* @return mixed
130+
* @throws \GuzzleHttp\Exception\GuzzleException
128131
*/
129132
public function get($endpoint, $query)
130133
{
@@ -142,6 +145,7 @@ public function get($endpoint, $query)
142145
* Returns next page of the result.
143146
* @param array $pages
144147
* @return mixed
148+
* @throws \GuzzleHttp\Exception\GuzzleException
145149
*/
146150
public function nextPage($pages)
147151
{

src/IntercomCompanies.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#create-or-update-company
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function create($options)
2627
{
@@ -32,6 +33,7 @@ public function create($options)
3233
* @see https://developers.intercom.io/reference#list-companies
3334
* @param array $options
3435
* @return mixed
36+
* @throws \GuzzleHttp\Exception\GuzzleException
3537
*/
3638
public function getCompanies($options)
3739
{

src/IntercomConversations.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#list-conversations
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function getConversations($options)
2627
{
@@ -32,6 +33,7 @@ public function getConversations($options)
3233
* @see https://developers.intercom.io/reference#get-a-single-conversation
3334
* @param string $id
3435
* @return mixed
36+
* @throws \GuzzleHttp\Exception\GuzzleException
3537
*/
3638
public function getConversation($id) {
3739
$path = $this->conversationPath($id);
@@ -44,6 +46,7 @@ public function getConversation($id) {
4446
* @param string $id
4547
* @param array $options
4648
* @return mixed
49+
* @throws \GuzzleHttp\Exception\GuzzleException
4750
*/
4851
public function replyToConversation($id, $options) {
4952
$path = $this->conversationReplyPath($id);

src/IntercomCounts.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#getting-counts
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function getCounts($options = [])
2627
{

src/IntercomEvents.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#submitting-events
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function create($options)
2627
{
@@ -32,6 +33,7 @@ public function create($options)
3233
* @see https://developers.intercom.io/reference#list-user-events
3334
* @param array $options
3435
* @return mixed
36+
* @throws \GuzzleHttp\Exception\GuzzleException
3537
*/
3638
public function getEvents($options)
3739
{

src/IntercomLeads.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#create-lead
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function create($options)
2627
{
@@ -32,6 +33,7 @@ public function create($options)
3233
* @see https://developers.intercom.io/reference#list-leads
3334
* @param array $options
3435
* @return mixed
36+
* @throws \GuzzleHttp\Exception\GuzzleException
3537
*/
3638
public function getLeads($options)
3739
{
@@ -44,6 +46,7 @@ public function getLeads($options)
4446
* @param string $id
4547
* @param array $options
4648
* @return mixed
49+
* @throws \GuzzleHttp\Exception\GuzzleException
4750
*/
4851
public function getLead($id, $options = [])
4952
{
@@ -57,6 +60,7 @@ public function getLead($id, $options = [])
5760
* @param string $id
5861
* @param array $options
5962
* @return mixed
63+
* @throws \GuzzleHttp\Exception\GuzzleException
6064
*/
6165
public function deleteLead($id, $options = [])
6266
{
@@ -69,6 +73,7 @@ public function deleteLead($id, $options = [])
6973
* @see https://developers.intercom.io/reference#convert-a-lead
7074
* @param $options
7175
* @return mixed
76+
* @throws \GuzzleHttp\Exception\GuzzleException
7277
*/
7378
public function convertLead($options)
7479
{

src/IntercomMessages.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#conversations
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function create($options)
2627
{

src/IntercomNotes.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public function __construct($client)
2121
* @see https://developers.intercom.io/reference#create-a-note
2222
* @param array $options
2323
* @return mixed
24+
* @throws \GuzzleHttp\Exception\GuzzleException
2425
*/
2526
public function create($options)
2627
{
@@ -32,6 +33,7 @@ public function create($options)
3233
* @see https://developers.intercom.io/reference#list-notes-for-a-user
3334
* @param array $options
3435
* @return mixed
36+
* @throws \GuzzleHttp\Exception\GuzzleException
3537
*/
3638
public function getNotes($options)
3739
{
@@ -43,6 +45,7 @@ public function getNotes($options)
4345
* @see https://developers.intercom.io/reference#view-a-note
4446
* @param string $id
4547
* @return mixed
48+
* @throws \GuzzleHttp\Exception\GuzzleException
4649
*/
4750
public function getNote($id)
4851
{

0 commit comments

Comments
 (0)