added pagination to users, databases and block children

Author: mechelon

src/Endpoints/Block.php

@@ -21,13 +21,12 @@ public function __construct(Notion $notion, string $blockId){
      * url: https://api.notion.com/{version}/blocks/{block_id}/children
      * notion-api-docs: https://developers.notion.com/reference/get-block-children
      *
-     * @param string $blockId
      * @return BlockCollection
      */
     public function children(): BlockCollection
     {
         $response = $this->get(
-            $this->url(Endpoint::BLOCKS . "/" . $this->blockId . "/children")
+            $this->url(Endpoint::BLOCKS . "/" . $this->blockId . "/children" . "?{$this->buildPaginationQuery()}")
         );
 
         if (!$response->ok())

src/Endpoints/Database.php

@@ -8,6 +8,7 @@
 use FiveamCode\LaravelNotionApi\Query\Sorting;
 use FiveamCode\LaravelNotionApi\Query\StartCursor;
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
+use Symfony\Component\VarDumper\Cloner\Data;
 
 class Database extends Endpoint
 {
@@ -16,9 +17,6 @@ class Database extends Endpoint
     private Collection $filter;
     private Collection $sorts;
 
-    private ?StartCursor $startCursor = null;
-    private ?int $pageSize = null;
-
 
     public function __construct(string $databaseId, Notion $notion)
     {
@@ -56,8 +54,6 @@ public function query(): array
         if($this->pageSize !== null)
             $postData["page_size"] = $this->pageSize;
 
-
-
         $response = $this->post(
             $this->url(Endpoint::DATABASES . "/{$this->databaseId}/query"),
             $postData
@@ -80,20 +76,4 @@ public function sortBy(Collection $sortings)
 
         return $this;
     }
-
-    public function limit(int $limit)
-    {
-        $this->pageSize = min($limit, 100);
-
-        return $this;
-    }
-
-    public function offset(StartCursor $startCursor)
-    {
-        // toDo
-        throw WrapperException::instance("Not implemented yet.");
-
-        $this->startCursor = $startCursor;
-        return $this;
-    }
 }

src/Endpoints/Databases.php

@@ -6,6 +6,7 @@
 use FiveamCode\LaravelNotionApi\Entities\DatabaseCollection;
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
 use FiveamCode\LaravelNotionApi\Notion;
+use FiveamCode\LaravelNotionApi\Query\StartCursor;
 
 class Databases extends Endpoint implements EndpointInterface
 {
@@ -20,7 +21,7 @@ class Databases extends Endpoint implements EndpointInterface
      */
     public function all(): DatabaseCollection
     {
-        $resultData = $this->getJson($this->url(Endpoint::DATABASES));
+        $resultData = $this->getJson($this->url(Endpoint::DATABASES) . "?{$this->buildPaginationQuery()}");
         return new DatabaseCollection($resultData);
     }
 
@@ -30,7 +31,8 @@ public function all(): DatabaseCollection
      * notion-api-docs: https://developers.notion.com/reference/get-database
      *
      * @param string $databaseId
-     * @return array
+     * @return Database
+     * @throws WrapperException
      */
     public function find(string $databaseId): Database
     {

src/Endpoints/Endpoint.php

@@ -2,6 +2,7 @@
 
 namespace FiveamCode\LaravelNotionApi\Endpoints;
 
+use FiveamCode\LaravelNotionApi\Query\StartCursor;
 use Illuminate\Support\Collection;
 use FiveamCode\LaravelNotionApi\Notion;
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
@@ -18,6 +19,10 @@ class Endpoint
     public Notion $notion;
     private Collection $validVersions;
 
+
+    protected ?StartCursor $startCursor = null;
+    protected  ?int $pageSize = null;
+
     public function __construct(Notion $notion)
     {
         $this->validVersions = collect(["v1"]);
@@ -74,4 +79,34 @@ protected function post(string $url, array $body)
         return $this->notion->getConnection()->post($url, $body);
     }
 
+
+    protected function buildPaginationQuery(): string
+    {
+        $paginationQuery = "";
+
+        if ($this->pageSize !== null)
+            $paginationQuery = "page_size={$this->pageSize}&";
+
+        if ($this->startCursor !== null)
+            $paginationQuery .= "start_cursor={$this->startCursor}";
+
+        return $paginationQuery;
+    }
+
+    public function limit(int $limit): Endpoint
+    {
+        $this->pageSize = min($limit, 100);
+
+        return $this;
+    }
+
+    public function offset(StartCursor $startCursor): Endpoint
+    {
+        // toDo
+        throw WrapperException::instance("Not implemented yet.");
+
+        $this->startCursor = $startCursor;
+        return $this;
+    }
+
 }

src/Endpoints/Users.php

@@ -5,6 +5,7 @@
 use FiveamCode\LaravelNotionApi\Entities\User;
 use FiveamCode\LaravelNotionApi\Exceptions\WrapperException;
 use FiveamCode\LaravelNotionApi\Notion;
+use FiveamCode\LaravelNotionApi\Query\StartCursor;
 
 class Users extends Endpoint implements EndpointInterface
 {
@@ -18,8 +19,7 @@ class Users extends Endpoint implements EndpointInterface
      */
     public function all(): array
     {
-        // toDo: Limit & offset, rename to get() like in eloquent?
-        return $this->getJson($this->url(Endpoint::USERS));
+        return $this->getJson($this->url(Endpoint::USERS . "?{$this->buildPaginationQuery()}"));
     }
 
     /**
@@ -38,15 +38,4 @@ public function find(string $userId): User
         return new User($jsonArray);
     }
 
-    public function limit()
-    {
-        //toDo
-        throw new WrapperException("not implemented yet");
-    }
-
-    public function offset()
-    {
-        //toDo
-        throw new WrapperException("not implemented yet");
-    }
 }

src/Notion.php

@@ -117,7 +117,7 @@ public function pages(): Pages
     }
 
     /**
-     * @return Blocks
+     * @return Block
      */
     public function block(string $blockId): Block
     {