Merge pull request #214 from intercom/timlim/add-visitors

Add support for visitors endpoint

Author: thewheat

README.md

@@ -128,6 +128,44 @@ $client->leads->convertLead([
   ]
 ]);
 ```
+## Visitors
+Retrieve `user_id` of a visitor via [the Javscript API](https://developers.intercom.com/docs/intercom-javascript#section-intercomgetvisitorid)
+
+```php
+// Update a visitor
+$client->visitors->update([
+  "user_id" => "8a88a590-e1c3-41e2-a502-e0649dbf721c",
+  "custom_attributes" => ['foo' => 'bar']
+]);
+
+// Find a visitor by ID
+$client->visitors->getVisitor("570680a8a1bcbca8a90000a9");
+
+// Find a visitor by User ID
+$client->visitors->getVisitor("", ["user_id" => "8a88a590-e1c3-41e2-a502-e0649dbf721c"]);
+
+// Delete a visitor by ID
+$client->visitors->deleteVisitor("570680a8a1bcbca8a90000a9");
+
+// Convert a Visitor to a Lead
+$client->visitors->convertVisitor([
+  "visitor" => [
+    "user_id" => "8a88a590-e1c3-41e2-a502-e0649dbf721c"
+  ],
+  "type" => "lead"
+]);
+
+// Convert a Visitor to a User
+$client->visitors->convertVisitor([
+  "visitor" => [
+    "user_id" => "8a88a590-e1c3-41e2-a502-e0649dbf721c"
+  ],
+  "user" => [
+    "email" => "[email protected]"
+  ],
+  "type" => "user"
+]);
+```
 
 ## Tags
 

src/IntercomClient.php

@@ -66,6 +66,7 @@ public function __construct($usernamePart, $passwordPart)
         $this->messages = new IntercomMessages($this);
         $this->conversations = new IntercomConversations($this);
         $this->leads = new IntercomLeads($this);
+        $this->visitors = new IntercomVisitors($this);
         $this->admins = new IntercomAdmins($this);
         $this->tags = new IntercomTags($this);
         $this->segments = new IntercomSegments($this);

src/IntercomVisitors.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Intercom;
+
+class IntercomVisitors {
+
+  /** @var IntercomClient */
+  private $client;
+
+  /**
+   * IntercomVisitors constructor.
+   * @param IntercomClient $client
+   */
+  public function __construct($client)
+  {
+    $this->client = $client;
+  }
+
+  /**
+   * Updates Visitor.
+   * @see https://developers.intercom.com/reference#update-a-visitor
+   * @param array $options
+   * @return mixed
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  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 mixed
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  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 mixed
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  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 mixed
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  public function convertVisitor($options)
+  {
+    return $this->client->post("visitors/convert", $options);
+  }
+
+  /**
+   * Returns endpoint path to Visitor with given ID.
+   * @param string $id
+   * @return string
+   */
+  public function visitorPath($id)
+  {
+    return "visitors/" . $id;
+  }
+}

test/IntercomVisitorsTest.php

@@ -0,0 +1,49 @@
+<?php
+
+use Intercom\IntercomVisitors;
+
+class IntercomVisitorsTest extends PHPUnit_Framework_TestCase {
+
+  public function testVisitorUpdate()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $stub->method('put')->willReturn('foo');
+
+    $visitors = new IntercomVisitors($stub);
+    $this->assertEquals('foo', $visitors->update([]));
+  }
+
+  public function testVisitorPath()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $visitors = new IntercomVisitors($stub);
+    $this->assertEquals($visitors->visitorPath("foo"), "visitors/foo");
+  }
+
+  public function testVisitorsGet()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $stub->method('get')->willReturn('foo');
+
+    $visitors = new IntercomVisitors($stub);
+    $this->assertEquals('foo', $visitors->getVisitor("bar"));
+  }
+
+  public function testVisitorsConvert()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $stub->method('post')->will($this->returnArgument(0));
+
+    $visitors = new IntercomVisitors($stub);
+    $this->assertEquals('visitors/convert', $visitors->convertVisitor([]));
+  }
+
+  public function testVisitorsDelete()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $stub->method('delete')->willReturn('foo');
+
+    $visitors = new IntercomVisitors($stub);
+    $this->assertEquals('foo', $visitors->deleteVisitor("bar"));
+  }
+}