add view support for some api & update check point about nylas changelog

lanlin · Sep 30, 2020 · 6004fde · 6004fde
1 parent cf1f508
commit 6004fde
Show file tree

Hide file tree

Showing 12 changed files with 93 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 PHP bindings for the Nylas REST API (V2.1). https://docs.nylas.com/reference</br>
 I'll try to keep up with [NyLas Changelog](https://changelog.nylas.com) in future updates.
 
-Last check at the point: [Service Accounts Now Supported for EWS Mail](https://changelog.nylas.com/#entry-166883)
+Last check at the point: [Scheduler Updates](https://changelog.nylas.com/#entry-167291)
 
 **What's new?**</br>
 

diff --git a/src/Calendars/Calendar.php b/src/Calendars/Calendar.php
@@ -13,7 +13,7 @@
  * ----------------------------------------------------------------------------------
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Calendar
 {
@@ -50,7 +50,7 @@ public function getCalendarsList(array $params = []): array
         $accessToken = $this->options->getAccessToken();
 
         $rule = V::keySet(
-            V::keyOptional('view', V::in(['count', 'ids'])),
+            V::keyOptional('view', V::in(['ids', 'count'])),
             V::keyOptional('limit', V::intType()->min(1)),
             V::keyOptional('offset', V::intType()->min(0))
         );

diff --git a/src/Contacts/Contact.php b/src/Contacts/Contact.php
@@ -16,7 +16,7 @@
  * @see https://docs.nylas.com/reference#contact-limitations
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Contact
 {
@@ -296,6 +296,7 @@ private function pictureRules(): V
     private function getBaseRules(): V
     {
         return V::keySet(
+            V::keyOptional('view', V::in(['ids', 'count'])),
             V::keyOptional('limit', V::intType()->min(1)),
             V::keyOptional('offset', V::intType()->min(0)),
             V::keyOptional('email', V::email()),

diff --git a/src/Deltas/Delta.php b/src/Deltas/Delta.php
@@ -12,7 +12,7 @@
  * ----------------------------------------------------------------------------------
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Delta
 {
@@ -153,7 +153,7 @@ private function getBaseRules(): array
         [
             V::key('cursor', V::stringType()->notEmpty()),
 
-            V::keyOptional('view', V::stringType()->notEmpty()),
+            V::keyOptional('view', V::equals('expanded')),
             V::keyOptional('exclude_types', V::in($types)),
             V::keyOptional('include_types', V::in($types)),
         ];

diff --git a/src/Drafts/Draft.php b/src/Drafts/Draft.php
@@ -15,7 +15,7 @@
  * @info include inline image <img src="cid:file_id">
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Draft
 {
@@ -43,29 +43,29 @@ public function __construct(Options $options)
     /**
      * get drafts list
      *
-     * @param mixed $anyEmail string|string[]
+     * @param mixed  $anyEmail string|string[]
+     * @param string $view     ids|count
      *
      * @return array
      */
-    public function getDraftsList($anyEmail = null): array
+    public function getDraftsList($anyEmail = null, ?string $view = null): array
     {
-        $params =['access_token' => $this->options->getAccessToken()];
-
-        if (!empty($anyEmail))
-        {
-            $params['any_email'] = Helper::fooToArray($anyEmail);
-        }
+        $params = [
+            'view'         => $view,
+            'any_email'    => Helper::fooToArray($anyEmail),
+            'access_token' => $this->options->getAccessToken(),
+        ];
 
         $rule = V::keySet(
             V::key('access_token', V::stringType()->notEmpty()),
+            V::keyOptional('view', V::in(['ids', 'count'])),
             V::keyOptional('any_email', V::simpleArray(V::email()))
         );
 
         V::doValidate($rule, $params);
 
-        $emails = \implode(',', ($params['any_email'] ?? []));
+        $query  = $this->getListQuery($params);
         $header = ['Authorization' => $params['access_token']];
-        $query  = empty($emails) ? [] : ['any_email' => $emails];
 
         return $this->options
             ->getSync()
@@ -269,6 +269,33 @@ private function getUpdateRules(): array
 
     // ------------------------------------------------------------------------------
 
+    /**
+     * get list query conditions
+     *
+     * @param array $params
+     *
+     * @return array
+     */
+    private function getListQuery(array $params): array
+    {
+        $query  = [];
+        $emails = \implode(',', $params['any_email']);
+
+        if (!empty($params['view']))
+        {
+            $query['view'] = $params['view'];
+        }
+
+        if (!empty($emails))
+        {
+            $query['any_email'] = $emails;
+        }
+
+        return $query;
+    }
+
+    // ------------------------------------------------------------------------------
+
     /**
      * draft base validate rules
      *

diff --git a/src/Events/Event.php b/src/Events/Event.php
@@ -15,7 +15,7 @@
  * @see https://docs.nylas.com/reference#event-limitations
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Event
 {
@@ -51,6 +51,7 @@ public function getEventsList(array $params = []): array
     {
         $rules = $this->getBaseRules();
 
+        $rules[]     = V::keyOptional('view', V::in(['ids', 'count']));
         $accessToken = $this->options->getAccessToken();
 
         V::doValidate(V::keySet(...$rules), $params);

diff --git a/src/Files/File.php b/src/Files/File.php
@@ -14,7 +14,7 @@
  * ----------------------------------------------------------------------------------
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class File
 {
@@ -51,7 +51,7 @@ public function getFilesList(array $params = []): array
         $accessToken = $this->options->getAccessToken();
 
         $rule = V::keySet(
-            V::keyOptional('view', V::in(['count', 'ids'])),
+            V::keyOptional('view', V::in(['ids', 'count'])),
             V::keyOptional('filename', V::stringType()->notEmpty()),
             V::keyOptional('message_id', V::stringType()->notEmpty()),
             V::keyOptional('content_type', V::stringType()->notEmpty())

diff --git a/src/Folders/Folder.php b/src/Folders/Folder.php
@@ -13,7 +13,7 @@
  * ----------------------------------------------------------------------------------
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Folder
 {
@@ -41,22 +41,32 @@ public function __construct(Options $options)
     /**
      * get folders list
      *
+     * @param string $view ids|count
+     *
      * @return array
      */
-    public function getFoldersList(): array
+    public function getFoldersList(?string $view = null): array
     {
         Helper::checkProviderUnit($this->options, false);
 
-        $rule = V::stringType()->notEmpty();
+        $params = [
+            'view'         => $view,
+            'access_token' => $this->options->getAccessToken(),
+        ];
 
-        $accessToken = $this->options->getAccessToken();
+        $rule = V::keySet(
+            V::key('access_token', V::stringType()->notEmpty()),
+            V::keyOptional('view', V::in(['ids', 'count'])),
+        );
 
-        V::doValidate($rule, $accessToken);
+        V::doValidate($rule, $params);
 
-        $header = ['Authorization' => $accessToken];
+        $header = ['Authorization' => $params['access_token']];
+        $query  = empty($params['view']) ? [] : ['view' => $params['view']];
 
         return $this->options
             ->getSync()
+            ->setQuery($query)
             ->setHeaderParams($header)
             ->get(API::LIST['folders']);
     }

diff --git a/src/Labels/Label.php b/src/Labels/Label.php
@@ -13,7 +13,7 @@
  * ----------------------------------------------------------------------------------
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Label
 {
@@ -41,22 +41,32 @@ public function __construct(Options $options)
     /**
      * get labels list
      *
+     * @param string $view ids|count
+     *
      * @return array
      */
-    public function getLabelsList(): array
+    public function getLabelsList(?string $view = null): array
     {
         Helper::checkProviderUnit($this->options, true);
 
-        $accessToken = $this->options->getAccessToken();
+        $params = [
+            'view'         => $view,
+            'access_token' => $this->options->getAccessToken(),
+        ];
 
-        $rule = V::stringType()->notEmpty();
+        $rule = V::keySet(
+            V::key('access_token', V::stringType()->notEmpty()),
+            V::keyOptional('view', V::in(['ids', 'count'])),
+        );
 
-        V::doValidate($rule, $accessToken);
+        V::doValidate($rule, $params);
 
-        $header = ['Authorization' => $accessToken];
+        $header = ['Authorization' => $params['access_token']];
+        $query  = empty($params['view']) ? [] : ['view' => $params['view']];
 
         return $this->options
             ->getSync()
+            ->setQuery($query)
             ->setHeaderParams($header)
             ->get(API::LIST['labels']);
     }

diff --git a/src/Messages/Message.php b/src/Messages/Message.php
@@ -16,7 +16,7 @@
  * @info include inline image <img src="cid:file_id">
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class Message
 {
@@ -149,10 +149,11 @@ public function updateMessage(array $params): array
      * get message info
      *
      * @param mixed $messageId string|string[]
+     * @param bool  $expanded  true|false
      *
      * @return array
      */
-    public function getMessage($messageId): array
+    public function getMessage($messageId, bool $expanded = false): array
     {
         $messageId   = Helper::fooToArray($messageId);
         $accessToken = $this->options->getAccessToken();
@@ -165,12 +166,14 @@ public function getMessage($messageId): array
         $queues = [];
         $target = API::LIST['oneMessage'];
         $header = ['Authorization' => $accessToken];
+        $query  = $expanded ? ['view' => 'expanded'] : [];
 
         foreach ($messageId as $id)
         {
             $request = $this->options
                 ->getAsync()
                 ->setPath($id)
+                ->setQuery($query)
                 ->setHeaderParams($header);
 
             $queues[] = static function () use ($request, $target)

diff --git a/src/Request/AbsBase.php b/src/Request/AbsBase.php
@@ -12,7 +12,7 @@
  * ----------------------------------------------------------------------------------
  *
  * @author lanlin
- * @change 2020/09/21
+ * @change 2020/09/30
  */
 trait AbsBase
 {
@@ -104,7 +104,10 @@ public function setQuery(array $query) : self
     {
         $query = Helper::boolToString($query);
 
-        $this->queryParams = ['query' => $query];
+        if (!empty($query))
+        {
+            $this->queryParams = ['query' => $query];
+        }
 
         return $this;
     }

diff --git a/src/Utilities/API.php b/src/Utilities/API.php
@@ -10,10 +10,10 @@
  * @see https://changelog.nylas.com/
  * @see https://docs.nylas.com/reference#api-changelog
  *
- * @version 2.1 (2020/04/27)
+ * @version 2.1 (2020/09/30)
  *
  * @author lanlin
- * @change 2020/04/26
+ * @change 2020/09/30
  */
 class API
 {