Tweaked a few things and added a README

upwebdesign · upwebdesign · commit a0d4fead8b90 · 2021-03-17T11:20:49.000-04:00
diff --git a/README.md b/README.md
@@ -0,0 +1,51 @@
+# Laravel Freshworks CRM API Wrapperd
+
+This Laravel package will allow you to connect to Freshworks CRM API using a Laravel like syntax.
+
+See [Freshworks CRM API](https://developers.freshworks.com/crm/api) documentation for details on what can be done with their API.
+
+## Installation
+
+```shell
+composer require codegreencreative/laravel-freshworks
+```
+
+## Configuration
+
+```shell
+php artisan vendor:publish --tag="laravel-freshworks"
+```
+
+## Environment
+
+Add your Freshworks API key and domain. Your domain will be the subdomain you chose when creating yoour account. `{subdomain}`.myfreshworks.com
+
+```
+FRESHWORKS_API_KEY=
+FRESHWORKS_DOMAIN=
+```
+
+## Examples
+
+When an object is returned back from Freshworks, you have two options when returning that object. `->toObject()` or `->toArray()`
+
+```php
+// Create a new contact=
+\Freshworks::contacts()->create([
+    'first_name' => 'Jane',
+    'last_name' => 'Doe',
+    'email' => 'jane@janedoe.com',
+    'phone' => '555-555-5555'
+]);
+
+// Update an existing contact
+\Freshworks::contacts()->update($contact_id, ['email' => 'jd@janedoe.com']);
+
+// Get all views/filters for contacts
+$views = \Freshworks::contacts()->filters()->toObject();
+
+// List all contacts using a view
+\Freshworks::contacts()->all($view_id)->toObject()
+```
+
+See [Freshworks CRM API](https://developers.freshworks.com/crm/api) documentation for details on what can be done with their API.
diff --git a/src/Api/Accounts.php b/src/Api/Accounts.php
@@ -3,17 +3,19 @@
 namespace CodeGreenCreative\Freshworks\Api;
 
 use CodeGreenCreative\Freshworks\Client;
-use CodeGreenCreative\Freshworks\Traits\HasFilters;
 use CodeGreenCreative\Freshworks\Traits\CanBeForgotten;
 use CodeGreenCreative\Freshworks\Traits\CanBulkDestroy;
 use CodeGreenCreative\Freshworks\Traits\CanCloneItself;
+use CodeGreenCreative\Freshworks\Traits\CanPaginate;
+use CodeGreenCreative\Freshworks\Traits\HasFilters;
 use CodeGreenCreative\Freshworks\Traits\PerformsCrudOperations;
 
 class Accounts extends Client
 {
     use PerformsCrudOperations;
     use CanCloneItself;
     use CanBulkDestroy;
+    use CanPaginate;
     use HasFilters;
     use HasFields;
     use CanBeForgotten;
diff --git a/src/Api/Appointments.php b/src/Api/Appointments.php
@@ -2,18 +2,14 @@
 
 namespace CodeGreenCreative\Freshworks\Api;
 
-use Psr\Http\Message\ResponseInterface;
 use CodeGreenCreative\Freshworks\Client;
+use CodeGreenCreative\Freshworks\Traits\CanPaginate;
 use CodeGreenCreative\Freshworks\Traits\PerformsCrudOperations;
 
 class Appointments extends Client
 {
     use PerformsCrudOperations;
+    use CanPaginate;
 
     private $resource = 'appointments';
-
-    public function all(array $query = []): ResponseInterface
-    {
-        return $this->client->request('GET', '{$this->resource}', ['query' => $query]);
-    }
 }
diff --git a/src/Api/Configuration.php b/src/Api/Configuration.php
@@ -13,8 +13,8 @@ class Configuration extends Client
      * @param  array  $arguments [description]
      * @return [type]            [description]
      */
-    public function __call(string $name, array $arguments = [])
+    public function __call(string $name, array $arguments = []) \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('GET', 'selector/' . Str::snake($name));
+        return $this->request('GET', 'selector/' . Str::snake($name));
     }
 }
diff --git a/src/Api/Contacts.php b/src/Api/Contacts.php
@@ -2,28 +2,29 @@
 
 namespace CodeGreenCreative\Freshworks\Api;
 
-use Psr\Http\Message\ResponseInterface;
 use CodeGreenCreative\Freshworks\Client;
-use CodeGreenCreative\Freshworks\Traits\HasFields;
-use CodeGreenCreative\Freshworks\Traits\HasFilters;
 use CodeGreenCreative\Freshworks\Traits\CanBeForgotten;
 use CodeGreenCreative\Freshworks\Traits\CanBulkDestroy;
 use CodeGreenCreative\Freshworks\Traits\CanCloneItself;
+use CodeGreenCreative\Freshworks\Traits\CanPaginate;
+use CodeGreenCreative\Freshworks\Traits\HasFields;
+use CodeGreenCreative\Freshworks\Traits\HasFilters;
 use CodeGreenCreative\Freshworks\Traits\PerformsCrudOperations;
 
 class Contacts extends Client
 {
     use PerformsCrudOperations;
     use CanCloneItself;
     use CanBulkDestroy;
+    use CanPaginate;
     use HasFilters;
     use HasFields;
     use CanBeForgotten;
 
     private $resource = 'contacts';
 
-    public function activities(int $id): ResponseInterface
+    public function activities(int $id): \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('GET', '{$this->resource}/{$id}/activities');
+        return $this->request('GET', "{$this->resource}/{$id}/activities");
     }
 }
diff --git a/src/Api/Deals.php b/src/Api/Deals.php
@@ -3,17 +3,19 @@
 namespace CodeGreenCreative\Freshworks\Api;
 
 use CodeGreenCreative\Freshworks\Client;
-use CodeGreenCreative\Freshworks\Traits\HasFilters;
 use CodeGreenCreative\Freshworks\Traits\CanBeForgotten;
 use CodeGreenCreative\Freshworks\Traits\CanBulkDestroy;
 use CodeGreenCreative\Freshworks\Traits\CanCloneItself;
+use CodeGreenCreative\Freshworks\Traits\CanPaginate;
+use CodeGreenCreative\Freshworks\Traits\HasFilters;
 use CodeGreenCreative\Freshworks\Traits\PerformsCrudOperations;
 
 class Deals extends Client
 {
     use PerformsCrudOperations;
     use CanCloneItself;
     use CanBulkDestroy;
+    use CanPaginate;
     use HasFilters;
     use HasFields;
     use CanBeForgotten;
diff --git a/src/Api/Phone.php b/src/Api/Phone.php
@@ -2,7 +2,6 @@
 
 namespace CodeGreenCreative\Freshworks\Api;
 
-use Psr\Http\Message\ResponseInterface;
 use CodeGreenCreative\Freshworks\Client;
 
 class Phone extends Client
@@ -14,8 +13,8 @@ class Phone extends Client
      * @param  array  $query [description]
      * @return [type]        [description]
      */
-    public function log(array $parameters = []): ResponseInterface
+    public function log(array $parameters = []): \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('GET', '{$this->resource}', ['body' => json_encode($parameters)]);
+        return $this->request('POST', $this->resource, ['body' => json_encode($parameters)]);
     }
 }
diff --git a/src/Api/SalesActivities.php b/src/Api/SalesActivities.php
@@ -2,18 +2,14 @@
 
 namespace CodeGreenCreative\Freshworks\Api;
 
-use Psr\Http\Message\ResponseInterface;
 use CodeGreenCreative\Freshworks\Client;
+use CodeGreenCreative\Freshworks\Traits\CanPaginate;
 use CodeGreenCreative\Freshworks\Traits\PerformsCrudOperations;
 
 class SalesActivities extends Client
 {
     use PerformsCrudOperations;
+    use CanPaginate;
 
     private $resource = 'sales_activities';
-
-    public function all(array $query = []): ResponseInterface
-    {
-        return $this->client->request('GET', '{$this->resource}', ['query' => $query]);
-    }
 }
diff --git a/src/Api/Search.php b/src/Api/Search.php
@@ -2,7 +2,6 @@
 
 namespace CodeGreenCreative\Freshworks\Api;
 
-use Psr\Http\Message\ResponseInterface;
 use CodeGreenCreative\Freshworks\Client;
 
 class Search extends Client
@@ -14,8 +13,8 @@ class Search extends Client
      * @param  array  $query [description]
      * @return [type]        [description]
      */
-    public function lookup(array $query = []): ResponseInterface
+    public function lookup(array $query = []): \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('GET', '{$this->resource}', ['query' => $query]);
+        return $this->request('GET', $this->resource, ['query' => $query]);
     }
 }
diff --git a/src/Api/Tasks.php b/src/Api/Tasks.php
@@ -2,18 +2,14 @@
 
 namespace CodeGreenCreative\Freshworks\Api;
 
-use Psr\Http\Message\ResponseInterface;
 use CodeGreenCreative\Freshworks\Client;
+use CodeGreenCreative\Freshworks\Traits\CanPaginate;
 use CodeGreenCreative\Freshworks\Traits\PerformsCrudOperations;
 
 class Tasks extends Client
 {
     use PerformsCrudOperations;
+    use CanPaginate;
 
     private $resource = 'tasks';
-
-    public function all(array $query = []): ResponseInterface
-    {
-        return $this->client->request('GET', '{$this->resource}', ['query' => $query]);
-    }
 }
diff --git a/src/Client.php b/src/Client.php
@@ -2,22 +2,60 @@
 
 namespace CodeGreenCreative\Freshworks;
 
-class Client
+use Psr\Http\Message\ResponseInterface;
+
+class Client extends \GuzzleHttp\Client
 {
-    protected $client;
+    private $response;
 
     /**
-     * [__construct description]
+     * Set up Guzzle client
      */
     public function __construct()
     {
-        $this->client = new \GuzzleHttp\Client([
-            'base_uri' => sprintf('https://%s.myfreshworks.com/api/', config('freshworks.domain')),
+        parent::__construct([
+            'base_uri' => sprintf('https://%s.myfreshworks.com/crm/sales/api/', config('freshworks.domain')),
             'headers' => [
                 'Authorization' => "Token token=" . config('freshworks.api_key'),
                 'Accept' => 'application/json',
                 'Content-Type' => 'application/json',
             ],
         ]);
     }
+
+    /**
+     * Go perform the request
+     * @param  string $method
+     * @param  string $uri
+     * @param  array  $options
+     * @return \CodeGreenCreative\Freshworks\Client
+     */
+    public function go(string $method, $uri = '', array $options = []): Self
+    {
+        try {
+            $this->response = parent::request($method, $uri, $options);
+        } catch (\Exception $e) {
+            throw new Exceptions\FreshworksException($e->getResponse()->getBody()->getContents(), 1);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Return the JSON response as an object
+     * @return Object
+     */
+    public function toObject(): Object
+    {
+        return json_decode($this->response->getBody());
+    }
+
+    /**
+     * Return the JSON response as an array
+     * @return Array
+     */
+    public function toArray(): Array
+    {
+        return json_decode($this->response->getBody(), true);
+    }
 }
diff --git a/src/Freshworks.php b/src/Freshworks.php
@@ -2,7 +2,6 @@
 
 namespace CodeGreenCreative\Freshworks;
 
-use CodeGreenCreative\Freshworks\Exceptions\FreshworksException;
 use Illuminate\Support\Str;
 
 class Freshworks
@@ -21,7 +20,7 @@ public function __call(string $name, array $arguments = [])
                 return new $name;
             }
         } catch (\Exception $e) {
-            throw new FreshworksException($e->getMessage(), 1);
+            throw new Exceptions\FreshworksException($e->getMessage(), 1);
         }
     }
 }
diff --git a/src/FreshworksFacade.php b/src/FreshworksFacade.php
@@ -6,7 +6,7 @@
 
 class FreshworksFacade extends Facade
 {
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): String
     {
         return 'freshworks';
     }
diff --git a/src/FreshworksServiceProvider.php b/src/FreshworksServiceProvider.php
@@ -15,7 +15,7 @@ class FreshworksServiceProvider extends \Illuminate\Support\ServiceProvider
      *
      * @return void
      */
-    public function boot()
+    public function boot(): Void
     {
         $this->publishes([
             __DIR__.'/../config/freshworks.php' => config_path('freshworks.php'),
@@ -27,7 +27,7 @@ public function boot()
      *
      * @return void
      */
-    public function register()
+    public function register(): Void
     {
         $this->app->bind('freshworks', function($app) {
             return new Freshworks;
diff --git a/src/Traits/CanBeForgotten.php b/src/Traits/CanBeForgotten.php
@@ -2,12 +2,10 @@
 
 namespace CodeGreenCreative\Freshworks\Traits;
 
-use Psr\Http\Message\ResponseInterface;
-
 trait CanBeForgotten
 {
-    public function forget(int $id): ResponseInterface
+    public function forget(int $id): \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('DELETE', '{$this->resource}/{$id}/forget');
+        return $this->go('DELETE', "{$this->resource}/{$id}/forget");
     }
 }
diff --git a/src/Traits/CanBulkDestroy.php b/src/Traits/CanBulkDestroy.php
@@ -2,12 +2,10 @@
 
 namespace CodeGreenCreative\Freshworks\Traits;
 
-use Psr\Http\Message\ResponseInterface;
-
 trait CanBulkDestroy
 {
-    public function bulkDelete(array $ids, array $payload): ResponseInterface
+    public function bulkDelete(array $ids, array $payload): \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('DELETE', '{$this->resource}/bulk_destroy', ['body' => json_encode($payload)]);
+        return $this->go('DELETE', "{$this->resource}/bulk_destroy", ['body' => json_encode($payload)]);
     }
 }
diff --git a/src/Traits/CanCloneItself.php b/src/Traits/CanCloneItself.php
@@ -2,12 +2,10 @@
 
 namespace CodeGreenCreative\Freshworks\Traits;
 
-use Psr\Http\Message\ResponseInterface;
-
 trait CanCloneItself
 {
-    public function clone(int $id): ResponseInterface
+    public function clone(int $id): \CodeGreenCreative\Freshworks\Client
     {
-        return $this->client->request('POST', '{$this->resource}/{$id}/clone');
+        return $this->go('POST', "{$this->resource}/{$id}/clone");
     }
 }
diff --git a/src/Traits/CanPaginate.php b/src/Traits/CanPaginate.php
diff --git a/src/Traits/HasFields.php b/src/Traits/HasFields.php
diff --git a/src/Traits/HasFilters.php b/src/Traits/HasFilters.php
diff --git a/src/Traits/PerformsCrudOperations.php b/src/Traits/PerformsCrudOperations.php

Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ class Configuration extends Client`
`13`	`13`	`* @param array $arguments [description]`
`14`	`14`	`* @return [type] [description]`
`15`	`15`	`*/`
`16`		`- public function __call(string $name, array $arguments = [])`
	`16`	`+ public function __call(string $name, array $arguments = []) \CodeGreenCreative\Freshworks\Client`
`17`	`17`	`{`
`18`		`- return $this->client->request('GET', 'selector/' . Str::snake($name));`
	`18`	`+ return $this->request('GET', 'selector/' . Str::snake($name));`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace CodeGreenCreative\Freshworks\Api;`
`4`	`4`
`5`		`-use Psr\Http\Message\ResponseInterface;`
`6`	`5`	`use CodeGreenCreative\Freshworks\Client;`
`7`	`6`
`8`	`7`	`class Phone extends Client`
`@@ -14,8 +13,8 @@ class Phone extends Client`
`14`	`13`	`* @param array $query [description]`
`15`	`14`	`* @return [type] [description]`
`16`	`15`	`*/`
`17`		`- public function log(array $parameters = []): ResponseInterface`
	`16`	`+ public function log(array $parameters = []): \CodeGreenCreative\Freshworks\Client`
`18`	`17`	`{`
`19`		`- return $this->client->request('GET', '{$this->resource}', ['body' => json_encode($parameters)]);`
	`18`	`+ return $this->request('POST', $this->resource, ['body' => json_encode($parameters)]);`
`20`	`19`	`}`
`21`	`20`	`}`