[CHAT-2597] Add shadow_ban, remove_shadow_ban, update_message_partial, pin_message & unpin_message methods (#66)

Co-authored-by: ferhat elmas <elmas.ferhat@gmail.com>

Author: gumuz

lib/GetStream/StreamChat/Client.php

@@ -499,6 +499,36 @@ public function unbanUser($targetId, $options=null)
         return $this->delete("moderation/ban", $options);
     }
 
+    /**
+     * @param  string $targetId
+     * @param  array $options
+     * @return mixed
+     * @throws StreamException
+     */
+    public function shadowBan($targetId, $options=null)
+    {
+        if ($options === null) {
+            $options = [];
+        }
+        $options["shadow"] = true;
+        return $this->banUser($targetId, $options);
+    }
+
+    /**
+     * @param  string $targetId
+     * @param  array $options
+     * @return mixed
+     * @throws StreamException
+     */
+    public function removeShadowBan($targetId, $options=null)
+    {
+        if ($options === null) {
+            $options = [];
+        }
+        $options["shadow"] = true;
+        return $this->unbanUser($targetId, $options);
+    }
+
     /**
      * @param  string $messageId
      * @return mixed
@@ -624,6 +654,60 @@ public function markAllRead($userId)
         return $this->post("channels/read", $options);
     }
 
+    /**
+     * @param  string $messageId
+     * @param  string $userId
+     * @param  int $expiration
+     * @return mixed
+     * @throws StreamException
+     */
+    public function pinMessage($messageId, $userId, $expiration=null)
+    {
+        $updates = [
+            "set" => [
+                "pinned" => true,
+                "pin_expires" => $expiration,
+            ]
+        ];
+        return $this->partialUpdateMessage($messageId, $updates, $userId);
+    }
+
+    /**
+     * @param  string $messageId
+     * @param  string $userId
+     * @return mixed
+     * @throws StreamException
+     */
+    public function unPinMessage($messageId, $userId)
+    {
+        $updates = [
+            "set" => [
+                "pinned" => false,
+            ]
+        ];
+        return $this->partialUpdateMessage($messageId, $updates, $userId);
+    }
+
+    /**
+     * @param  string $messageId
+     * @param  array $updates [set => [key => value], unset => [key]]
+     * @param  string $userId
+     * @param  array $options
+     * @return mixed
+     * @throws StreamException
+     */
+    public function partialUpdateMessage($messageId, $updates, $userId=null, $options=null)
+    {
+        if ($options === null) {
+            $options = [];
+        }
+        if ($userId !== null) {
+            $options["user"] = ["id" => $userId];
+        }
+        $options = array_merge($options, $updates);
+        return $this->put("messages/" .$messageId, $options);
+    }
+
     /**
      * @param  array $message
      * @return mixed

tests/integration/IntegrationTest.php

@@ -208,6 +208,55 @@ public function testExportUser()
         $this->assertSame("Gandalf the Grey", $response["user"]["name"]);
     }
 
+    public function testShadowban()
+    {
+        $user1 = $this->getUser();
+        $user2 = $this->getUser();
+        $channel = $this->getChannel();
+
+        $response = $channel->sendMessage(["text" => "hello world"], $user1["id"]);
+        $this->assertFalse($response["message"]["shadowed"]);
+        $response = $this->client->getMessage($response["message"]["id"]);
+        $this->assertFalse($response["message"]["shadowed"]);
+
+        $this->client->shadowBan($user1["id"], ["user_id" => $user2["id"]]);
+
+        $response = $channel->sendMessage(["text" => "hello world"], $user1["id"]);
+        $this->assertFalse($response["message"]["shadowed"]);
+        $response = $this->client->getMessage($response["message"]["id"]);
+        $this->assertTrue($response["message"]["shadowed"]);
+
+        $this->client->removeShadowBan($user1["id"], ["user_id" => $user2["id"]]);
+
+        $response = $channel->sendMessage(["text" => "hello world"], $user1["id"]);
+        $this->assertFalse($response["message"]["shadowed"]);
+        $response = $this->client->getMessage($response["message"]["id"]);
+        $this->assertFalse($response["message"]["shadowed"]);
+    }
+
+    public function testPinMessage()
+    {
+        $user1 = $this->getUser();
+        $user2 = $this->getUser();
+        $channel = $this->getChannel();
+
+        $response = $channel->sendMessage(["text" => "hello world"], $user1["id"]);
+        $this->assertNull($response["message"]["pinned_at"]);
+        $this->assertNull($response["message"]["pinned_by"]);
+
+        $this->client->pinMessage($response["message"]["id"], $user2["id"]);
+
+        $response = $this->client->getMessage($response["message"]["id"]);
+        $this->assertNotNull($response["message"]["pinned_at"]);
+        $this->assertEquals($user2["id"], $response["message"]["pinned_by"]["id"]);
+
+        $this->client->unPinMessage($response["message"]["id"], $user2["id"]);
+
+        $response = $this->client->getMessage($response["message"]["id"]);
+        $this->assertNull($response["message"]["pinned_at"]);
+        $this->assertNull($response["message"]["pinned_by"]);
+    }
+
     public function testBanUser()
     {
         $user1 = $this->getUser();