Added PhpDoc to methods and variables

Author: klimesf

src/IntercomAdmins.php

@@ -2,16 +2,26 @@
 
 namespace Intercom;
 
-use GuzzleHttp\Client;
-
 class IntercomAdmins {
+
+  /** @var IntercomClient */
   private $client;
 
+  /**
+   * IntercomAdmins constructor.
+   * @param IntercomClient $client
+   */
   public function __construct($client)
   {
     $this->client = $client;
   }
 
+  /**
+   * Returns list of Admins.
+   * @see https://developers.intercom.io/reference#list-admins
+   * @param array $options
+   * @return mixed
+   */
   public function getAdmins($options = [])
   {
     return $this->client->get("admins", $options);

src/IntercomBulk.php

@@ -2,21 +2,37 @@
 
 namespace Intercom;
 
-use GuzzleHttp\Client;
-
 class IntercomBulk {
+
+  /** @var IntercomClient */
   private $client;
 
+  /**
+   * IntercomBulk constructor.
+   * @param IntercomClient $client
+   */
   public function __construct($client)
   {
     $this->client = $client;
   }
 
+  /**
+   * Creates Users in bulk.
+   * @see https://developers.intercom.io/reference#bulk-user-operations
+   * @param array $options
+   * @return mixed
+   */
   public function users($options)
   {
     return $this->client->post("bulk/users", $options);
   }
 
+  /**
+   * Creates Events in bulk.
+   * @see https://developers.intercom.io/reference#bulk-event-operations
+   * @param array $options
+   * @return mixed
+   */
   public function events($options)
   {
     return $this->client->post("bulk/events", $options);

src/IntercomClient.php

@@ -5,6 +5,7 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Response;
 use function GuzzleHttp\Psr7\stream_for;
+use Psr\Http\Message\ResponseInterface;
 
 class IntercomClient {
 
@@ -47,6 +48,11 @@ class IntercomClient {
   /** @var IntercomBulk $bulk */
   public $bulk;
 
+  /**
+   * IntercomClient constructor.
+   * @param string $usernamePart App ID.
+   * @param string $passwordPart Api Key.
+   */
   public function __construct($usernamePart, $passwordPart)
   {
     $this->setDefaultClient();
@@ -70,11 +76,21 @@ private function setDefaultClient()
     $this->http_client = new Client();
   }
 
+  /**
+   * Sets GuzzleHttp client.
+   * @param Client $client
+   */
   public function setClient($client)
   {
     $this->http_client = $client;
   }
 
+  /**
+   * Sends POST request to Intercom API.
+   * @param string $endpoint
+   * @param string $json
+   * @return mixed
+   */
   public function post($endpoint, $json)
   {
     $response = $this->http_client->request('POST', "https://api.intercom.io/$endpoint", [
@@ -87,6 +103,12 @@ public function post($endpoint, $json)
     return $this->handleResponse($response);
   }
 
+  /**
+   * Sends DELETE request to Intercom API.
+   * @param string $endpoint
+   * @param string $json
+   * @return mixed
+   */
   public function delete($endpoint, $json)
   {
     $response = $this->http_client->request('DELETE', "https://api.intercom.io/$endpoint", [
@@ -99,6 +121,11 @@ public function delete($endpoint, $json)
     return $this->handleResponse($response);
   }
 
+  /**
+   * @param string $endpoint
+   * @param string $query
+   * @return mixed
+   */
   public function get($endpoint, $query)
   {
     $response = $this->http_client->request('GET', "https://api.intercom.io/$endpoint", [
@@ -111,6 +138,11 @@ public function get($endpoint, $query)
     return $this->handleResponse($response);
   }
 
+  /**
+   * Returns next page of the result.
+   * @param array $pages
+   * @return mixed
+   */
   public function nextPage($pages)
   {
     $response = $this->http_client->request('GET', $pages['next'], [
@@ -122,11 +154,19 @@ public function nextPage($pages)
     return $this->handleResponse($response);
   }
 
+  /**
+   * Returns authentication parameters.
+   * @return array
+   */
   public function getAuth()
   {
     return [$this->usernamePart, $this->passwordPart];
   }
 
+  /**
+   * @param Response $response
+   * @return mixed
+   */
   private function handleResponse(Response $response){
     $stream = stream_for($response->getBody());
     $data = json_decode($stream->getContents());

src/IntercomCompanies.php

@@ -2,21 +2,37 @@
 
 namespace Intercom;
 
-use GuzzleHttp\Client;
-
 class IntercomCompanies {
+
+  /** @var IntercomClient */
   private $client;
 
+  /**
+   * IntercomCompanies constructor.
+   * @param IntercomClient $client
+   */
   public function __construct($client)
   {
     $this->client = $client;
   }
 
+  /**
+   * Creates a Company.
+   * @see https://developers.intercom.io/reference#create-or-update-company
+   * @param array $options
+   * @return mixed
+   */
   public function create($options)
   {
     return $this->client->post("companies", $options);
   }
 
+  /**
+   * Returns list of Companies.
+   * @see https://developers.intercom.io/reference#list-companies
+   * @param array $options
+   * @return mixed
+   */
   public function getCompanies($options)
   {
     return $this->client->get("companies", $options);

src/IntercomConversations.php

@@ -2,36 +2,69 @@
 
 namespace Intercom;
 
-use GuzzleHttp\Client;
-
 class IntercomConversations {
+
+  /** @var IntercomClient  */
   private $client;
 
+  /**
+   * IntercomConversations constructor.
+   * @param IntercomClient $client
+   */
   public function __construct($client)
   {
     $this->client = $client;
   }
 
+  /**
+   * Returns list of Conversations.
+   * @see https://developers.intercom.io/reference#list-conversations
+   * @param array $options
+   * @return mixed
+   */
   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
+   * @return mixed
+   */
   public function getConversation($id) {
     $path = $this->conversationPath($id);
     return $this->client->get($path, []);
   }
 
+  /**
+   * 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 mixed
+   */
   public function replyToConversation($id, $options) {
     $path = $this->conversationReplyPath($id);
     return $this->client->post($path, $options);
   }
 
+  /**
+   * 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";

src/IntercomCounts.php

@@ -2,16 +2,26 @@
 
 namespace Intercom;
 
-use GuzzleHttp\Client;
-
 class IntercomCounts {
+
+  /** @var IntercomClient */
   private $client;
 
+  /**
+   * IntercomCounts constructor.
+   * @param IntercomClient $client
+   */
   public function __construct($client)
   {
     $this->client = $client;
   }
 
+  /**
+   * Returns list of Counts.
+   * @see https://developers.intercom.io/reference#getting-counts
+   * @param array $options
+   * @return mixed
+   */
   public function getCounts($options = [])
   {
     return $this->client->get("counts", $options);

src/IntercomEvents.php

@@ -2,21 +2,37 @@
 
 namespace Intercom;
 
-use GuzzleHttp\Client;
-
 class IntercomEvents {
+
+  /** @var IntercomClient */
   private $client;
 
+  /**
+   * IntercomEvents constructor.
+   * @param IntercomClient $client
+   */
   public function __construct($client)
   {
     $this->client = $client;
   }
 
+  /**
+   * Creates Event.
+   * @see https://developers.intercom.io/reference#submitting-events
+   * @param array $options
+   * @return mixed
+   */
   public function create($options)
   {
     return $this->client->post("events", $options);
   }
 
+  /**
+   * Lists User Events.
+   * @see https://developers.intercom.io/reference#list-user-events
+   * @param array $options
+   * @return mixed
+   */
   public function getEvents($options)
   {
     return $this->client->get("events", array_merge(["type" => "user"], $options));