Add filter for compagnies and contacts, create filter trait

src/Resources/Company.php

@@ -11,6 +11,7 @@
 use Freshdesk\Resources\Traits\AllTrait;
 use Freshdesk\Resources\Traits\CreateTrait;
 use Freshdesk\Resources\Traits\DeleteTrait;
+use Freshdesk\Resources\Traits\FilterTrait;
 use Freshdesk\Resources\Traits\UpdateTrait;
 use Freshdesk\Resources\Traits\ViewTrait;
 
@@ -24,7 +25,7 @@
 class Company extends AbstractResource
 {
 
-    use AllTrait, CreateTrait, ViewTrait, UpdateTrait, DeleteTrait;
+    use AllTrait, CreateTrait, ViewTrait, UpdateTrait, DeleteTrait, FilterTrait;
 
     /**
      * The resource endpoint

src/Resources/Contact.php

@@ -11,6 +11,7 @@
 use Freshdesk\Resources\Traits\AllTrait;
 use Freshdesk\Resources\Traits\CreateTrait;
 use Freshdesk\Resources\Traits\DeleteTrait;
+use Freshdesk\Resources\Traits\FilterTrait;
 use Freshdesk\Resources\Traits\UpdateTrait;
 use Freshdesk\Resources\Traits\ViewTrait;
 
@@ -24,7 +25,7 @@
  */
 class Contact extends AbstractResource
 {
-    use AllTrait, CreateTrait, ViewTrait, UpdateTrait, DeleteTrait;
+    use AllTrait, CreateTrait, ViewTrait, UpdateTrait, DeleteTrait, FilterTrait;
 
     /**
      * The resource endpoint

src/Resources/Ticket.php

@@ -11,6 +11,7 @@
 use Freshdesk\Resources\Traits\AllTrait;
 use Freshdesk\Resources\Traits\CreateTrait;
 use Freshdesk\Resources\Traits\DeleteTrait;
+use Freshdesk\Resources\Traits\FilterTrait;
 use Freshdesk\Resources\Traits\UpdateTrait;
 use Freshdesk\Resources\Traits\ViewTrait;
 
@@ -24,7 +25,7 @@
 class Ticket extends AbstractResource
 {
 
-    use AllTrait, CreateTrait, ViewTrait, UpdateTrait, DeleteTrait;
+    use AllTrait, CreateTrait, ViewTrait, UpdateTrait, DeleteTrait, FilterTrait;
 
     /**
      * The resource endpoint
@@ -35,7 +36,7 @@ class Ticket extends AbstractResource
 
     /**
      * Restore a ticket
-     * 
+     *
      * Restores a previously deleted ticket
      *
      * @api
@@ -130,32 +131,4 @@ public function timeEntries($id, array $query = null)
 
         return $this->api()->request('GET', $this->endpoint($end), null, $query);
     }
-
-    /**
-     * Filters by ticket fields
-     *
-     * Make sure to pass a valid $filtersQuery string example: "type:question"
-     *
-     * @api
-     * @param string $filtersQuery
-     * @return array|null
-     * @throws \Freshdesk\Exceptions\AccessDeniedException
-     * @throws \Freshdesk\Exceptions\ApiException
-     * @throws \Freshdesk\Exceptions\AuthenticationException
-     * @throws \Freshdesk\Exceptions\ConflictingStateException
-     * @throws \Freshdesk\Exceptions\NotFoundException
-     * @throws \Freshdesk\Exceptions\RateLimitExceededException
-     * @throws \Freshdesk\Exceptions\UnsupportedContentTypeException
-     * @throws \Freshdesk\Exceptions\MethodNotAllowedException
-     * @throws \Freshdesk\Exceptions\UnsupportedAcceptHeaderException
-     * @throws \Freshdesk\Exceptions\ValidationException
-     */
-    public function search(string $filtersQuery)
-    {
-        $end = '/search'.$this->endpoint();
-        $query = [
-            'query' => '"'.$filtersQuery.'"',
-        ];
-        return $this->api()->request('GET', $end, null, $query);
-    }
 }

src/Resources/Traits/AllTrait.php

@@ -30,7 +30,7 @@ abstract protected function endpoint($end = null);
     abstract protected function api();
 
     /**
-     * Get a list of all agents.
+     * Get a list of all items of a resource.
      *
      * Use filters ($query) to view only specific resources (those which match the criteria that you choose).
      *

src/Resources/Traits/FilterTrait.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Freshdesk\Resources\Traits;
+
+/**
+ * Create Trait
+ *
+ * @package Freshdesk\Resources\Traits
+ */
+trait FilterTrait
+{
+
+    /**
+     * @param null $end string
+     * @return string
+     * @internal
+     */
+    abstract protected function endpoint($end = null);
+
+    /**
+     * @return \Freshdesk\Api
+     * @internal
+     */
+    abstract protected function api();
+
+    /**
+     * Filter a resource
+     *
+     * Filter a resource by $query
+     * Make sure to pass a valid $query string
+     *
+     * @api
+     * @param string $query
+     * @return array|null
+     * @throws \Freshdesk\Exceptions\AccessDeniedException
+     * @throws \Freshdesk\Exceptions\ApiException
+     * @throws \Freshdesk\Exceptions\AuthenticationException
+     * @throws \Freshdesk\Exceptions\ConflictingStateException
+     * @throws \Freshdesk\Exceptions\NotFoundException
+     * @throws \Freshdesk\Exceptions\RateLimitExceededException
+     * @throws \Freshdesk\Exceptions\UnsupportedContentTypeException
+     * @throws \Freshdesk\Exceptions\MethodNotAllowedException
+     * @throws \Freshdesk\Exceptions\UnsupportedAcceptHeaderException
+     * @throws \Freshdesk\Exceptions\ValidationException
+     */
+    public function filter(string $query)
+    {
+        $end = '/search'.$this->endpoint();
+        $query = [
+            'query' => '"'.$query.'"',
+        ];
+        return $this->api()->request('GET', $end, null, $query);
+    }
+}

tests/Resources/CompanyTest.php

@@ -17,7 +17,7 @@ public function setUp()
         parent::setUp();
 
         $this->class = Company::class;
-    } 
+    }
 
     public function methodsThatShouldExist()
     {
@@ -27,6 +27,7 @@ public function methodsThatShouldExist()
             ['view'],
             ['update'],
             ['delete'],
+            ['filter'],
             ['fields'],
         ];
     }

tests/Resources/ContactTest.php

@@ -27,6 +27,7 @@ public function methodsThatShouldExist()
             ['view'],
             ['update'],
             ['delete'],
+            ['filter'],
             ['fields'],
             ['makeAgent'],
         ];

tests/Resources/TicketTest.php

@@ -26,12 +26,12 @@ public function methodsThatShouldExist()
             ['view'],
             ['update'],
             ['delete'],
+            ['filter'],
             ['fields'],
             ['restore'],
             ['fields'],
             ['conversations'],
-            ['timeEntries'],
-            ['search']
+            ['timeEntries']
         ];
     }