Add filtering by batchUid for getTasks

Author: Strift

src/Contracts/TasksQuery.php

@@ -22,6 +22,12 @@ class TasksQuery
      */
     private ?array $canceledBy = null;
 
+
+    /**
+     * @var int|null
+     */
+    private ?int $batchUid = null;
+
     /**
      * @return $this
      */
@@ -54,6 +60,16 @@ public function setLimit(int $limit): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function setBatchUid(int $batchUid): self
+    {
+        $this->batchUid = $batchUid;
+
+        return $this;
+    }
+
     public function toArray(): array
     {
         return array_filter(
@@ -63,8 +79,12 @@ public function toArray(): array
                     'from' => $this->from,
                     'limit' => $this->limit,
                     'canceledBy' => $this->formatArray($this->canceledBy),
+                    'batchUid' => $this->batchUid,
                 ]
-            ), static function ($item) { return null !== $item; }
+            ),
+            static function ($item) {
+                return null !== $item;
+            }
         );
     }
 }

tests/Endpoints/TasksTest.php

@@ -126,6 +126,20 @@ public function testGetAllTasksByIndexWithFilter(): void
         self::assertGreaterThan(0, $response->getTotal());
     }
 
+    public function getAllTasksByBatchFilter(): void
+    {
+        [$promise, $response] = $this->seedIndex();
+
+        self::assertIsArray($promise);
+        $task = $this->client->getTask($promise['taskUid']);
+
+        $response = $this->client->getTasks((new TasksQuery())
+                ->setBatchUid($task['uid'])
+        );
+
+        self::assertIsArray($response->getResults());
+    }
+
     public function testCancelTasksWithFilter(): void
     {
         $date = new \DateTime('yesterday');
@@ -135,7 +149,7 @@ public function testCancelTasksWithFilter(): void
         self::assertSame('taskCancelation', $promise['type']);
         $response = $this->client->waitForTask($promise['taskUid']);
 
-        self::assertSame('?'.$query, $response['details']['originalFilter']);
+        self::assertSame('?' . $query, $response['details']['originalFilter']);
         self::assertSame('taskCancelation', $response['type']);
         self::assertSame('succeeded', $response['status']);
     }