Merge pull request #195 from intercom/AK/add-update-methods-for-users-and-leads

Ak/add update methods for users and leads

Author: Kevin Antoine

README.md

@@ -46,12 +46,18 @@ If you are building a third party application you can get your OAuth token by [s
 ## Users
 
 ```php
-// Create/update a user
+// Create a user
 $client->users->create([
   "email" => "[email protected]",
   "custom_attributes" => ['foo' => 'bar']
 ]);
 
+// Update a user (Note: This method is an alias to the create method. In practice you can use create to update users if you wish)
+$client->users->update([
+  "email" => "[email protected]",
+  "custom_attributes" => ['foo' => 'bar']
+]);
+
 // Delete a user by ID
 $client->users->deleteUser("570680a8a1bcbca8a90001b9");
 
@@ -89,13 +95,19 @@ $client->users->getUsers([]);
 ## Leads
 
 ```php
-// Create/update a lead
+// Create a lead
 // See more options here: https://developers.intercom.io/reference#create-lead
 $client->leads->create([
   "email" => "[email protected]",
   "custom_attributes" => ['foo' => 'bar']
 ]);
 
+// Update a lead (Note: This method is an alias to the create method. In practice you can use create to update leads if you wish)
+$client->leads->update([
+  "email" => "[email protected]",
+  "custom_attributes" => ['foo' => 'bar']
+]);
+
 // List leads
 // See more options here: https://developers.intercom.io/reference#list-leads
 $client->leads->getLeads([]);

src/IntercomLeads.php

@@ -28,6 +28,18 @@ public function create($options)
     return $this->client->post("contacts", $options);
   }
 
+  /**
+   * Creates Lead.
+   * @see https://developers.intercom.io/reference#create-lead
+   * @param array $options
+   * @return mixed
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  public function update($options)
+  {
+    return $this->create($options);
+  }
+
   /**
    * Lists Leads.
    * @see https://developers.intercom.io/reference#list-leads

src/IntercomUsers.php

@@ -28,6 +28,18 @@ public function create($options)
     return $this->client->post("users", $options);
   }
 
+  /**
+   * Creates a User.
+   * @see https://developers.intercom.io/reference#create-or-update-user
+   * @param array $options
+   * @return mixed
+   * @throws \GuzzleHttp\Exception\GuzzleException
+   */
+  public function update($options)
+  {
+    return $this->create($options);
+  }
+
   /**
    * Lists Users.
    * @see https://developers.intercom.io/reference#list-users
@@ -53,14 +65,14 @@ public function getUser($id, $options = [])
     $path = $this->userPath($id);
     return $this->client->get($path, $options);
   }
-  
+
   /**
    * Gets a list of Users through the user scroll API.
    * @see https://developers.intercom.com/reference#iterating-over-all-users
    * @param array $options
    * @return mixed
    * @throws \GuzzleHttp\Exception\GuzzleException
-   */  
+   */
   public function scrollUsers($options = [])
   {
     return $this->client->get('users/scroll', $options);

test/IntercomLeadsTest.php

@@ -12,6 +12,15 @@ public function testLeadCreate()
     $this->assertEquals('foo', $leads->create([]));
   }
 
+  public function testLeadUpdate()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $stub->method('post')->willReturn('foo');
+
+    $leads = new IntercomLeads($stub);
+    $this->assertEquals('foo', $leads->update([]));
+  }
+
   public function testLeadsList()
   {
     $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();

test/IntercomUsersTest.php

@@ -14,16 +14,25 @@ public function testUserCreate()
     $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
     $stub->method('post')->willReturn('foo');
 
-    $events = new IntercomUsers($stub);
-    $this->assertEquals('foo', $events->create([]));
+    $users = new IntercomUsers($stub);
+    $this->assertEquals('foo', $users->create([]));
+  }
+
+  public function testUserUpdate()
+  {
+    $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+    $stub->method('post')->willReturn('foo');
+
+    $users = new IntercomUsers($stub);
+    $this->assertEquals('foo', $users->update([]));
   }
 
   public function testUserGet()
   {
     $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
     $stub->method('get')->willReturn('foo');
 
-    $events = new IntercomUsers($stub);
-    $this->assertEquals('foo', $events->getUsers([]));
+    $users = new IntercomUsers($stub);
+    $this->assertEquals('foo', $users->getUsers([]));
   }
 }