Merge pull request #105 from simcen/master

Added support to delete device

Author: norkunas

src/Devices.php

@@ -100,6 +100,29 @@ public function update($id, array $data)
         return $this->api->request('PUT', '/players/'.$id, [], json_encode($data));
     }
 
+    /**
+     * Delete existing registered device from your application.
+     *
+     * OneSignal supports DELETE on the players API endpoint which is not documented in their official documentation
+     * Reference: https://documentation.onesignal.com/docs/handling-personal-data#section-deleting-users-or-other-data-from-onesignal
+     *
+     * Application auth key must be set.
+     *
+     * @param string $id Device ID
+     *
+     * @return array
+     */
+    public function delete($id)
+    {
+        $query = [
+            'app_id' => $this->api->getConfig()->getApplicationId(),
+        ];
+
+        return $this->api->request('DELETE', '/players/'.$id.'?'.http_build_query($query), [
+            'Authorization' => 'Basic '.$this->api->getConfig()->getApplicationAuthKey(),
+        ]);
+    }
+
     /**
      * Call on new device session in your app.
      *

tests/OneSignal/Tests/DevicesTest.php

@@ -70,6 +70,19 @@ public function testUpdate()
         $this->assertEquals($expectedRequest, $this->devices->update($fakeId, ['data' => 'myData']));
     }
 
+    public function testDelete()
+    {
+        $fakeId = 1234;
+        $expectedRequest = [
+            'DELETE',
+            '/players/'.$fakeId.'?app_id=fakeApplicationId',
+            ['Authorization' => 'Basic fakeApplicationAuthKey'],
+            null,
+        ];
+
+        $this->assertEquals($expectedRequest, $this->devices->delete($fakeId));
+    }
+
     public function testOnSession()
     {
         $fakeId = 1234;