feat: add restore_users (#134)

* feat: add restore_users

* fix: apply linter fixes

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fix: make linter happy

* fix: make linter happy 2

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: yaziine

pyproject.toml

@@ -38,6 +38,7 @@ disallow_untyped_defs = true
 disallow_untyped_calls = true
 check_untyped_defs = true
 warn_unused_configs = true
+strict_optional = false
 
 [[tool.mypy.overrides]]
 module = "stream_chat.tests.*"

stream_chat/async_chat/client.py

@@ -171,6 +171,9 @@ async def delete_users(
             "users/delete", data=dict(options, user=delete_type, user_ids=user_ids)
         )
 
+    async def restore_users(self, user_ids: Iterable[str]) -> StreamResponse:
+        return await self.post("users/restore", data={"user_ids": user_ids})
+
     async def deactivate_user(self, user_id: str, **options: Any) -> StreamResponse:
         return await self.post(f"users/{user_id}/deactivate", data=options)
 

stream_chat/base/client.py

@@ -218,6 +218,15 @@ def delete_users(
         """
         pass
 
+    @abc.abstractmethod
+    def restore_users(
+        self, user_ids: Iterable[str]
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Restores soft deleted users.
+        """
+        pass
+
     @abc.abstractmethod
     def deactivate_user(
         self, user_id: str, **options: Any
@@ -562,7 +571,7 @@ def delete_channel_type(
     @abc.abstractmethod
     def channel(
         self, channel_type: str, channel_id: str = None, data: Dict = None
-    ) -> TChannel:
+    ) -> TChannel:  # type: ignore[type-var]
         """
         Creates a channel object
 
@@ -1141,6 +1150,7 @@ def create_import_url(
         """
         pass
 
+    @abc.abstractmethod
     def create_import(
         self, path: str, mode: Literal["insert", "upsert"] = "upsert"
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
@@ -1162,6 +1172,7 @@ def create_import(
         """
         pass
 
+    @abc.abstractmethod
     def get_import(self, id: str) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         """
         Get the status of an import task.
@@ -1181,6 +1192,7 @@ def get_import(self, id: str) -> Union[StreamResponse, Awaitable[StreamResponse]
         """
         pass
 
+    @abc.abstractmethod
     def list_imports(
         self, options: Dict = None
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:

stream_chat/client.py

@@ -161,6 +161,9 @@ def delete_users(
             "users/delete", data=dict(options, user=delete_type, user_ids=user_ids)
         )
 
+    def restore_users(self, user_ids: Iterable[str]) -> StreamResponse:
+        return self.post("users/restore", data={"user_ids": user_ids})
+
     def deactivate_user(self, user_id: str, **options: Any) -> StreamResponse:
         return self.post(f"users/{user_id}/deactivate", data=options)
 

stream_chat/tests/async_chat/test_client.py

@@ -164,6 +164,15 @@ async def test_delete_users(self, client: StreamChatAsync, random_user: Dict):
 
         pytest.fail("task did not succeed")
 
+    async def test_restore_users(self, client: StreamChatAsync, random_user: Dict):
+        response = await client.delete_user(random_user["id"])
+        assert random_user["id"] == response["user"]["id"]
+
+        await client.restore_users([random_user["id"]])
+
+        response = await client.query_users({"id": random_user["id"]})
+        assert len(response["users"]) == 1
+
     async def test_deactivate_user(self, client: StreamChatAsync, random_user: Dict):
         response = await client.deactivate_user(random_user["id"])
         assert "user" in response

stream_chat/tests/test_client.py

@@ -154,6 +154,15 @@ def test_delete_users(self, client: StreamChat, random_user: Dict):
 
         pytest.fail("task did not succeed")
 
+    def test_restore_users(self, client: StreamChat, random_user: Dict):
+        response = client.delete_user(random_user["id"])
+        assert random_user["id"] == response["user"]["id"]
+
+        client.restore_users([random_user["id"]])
+
+        response = client.query_users({"id": random_user["id"]})
+        assert len(response["users"]) == 1
+
     def test_deactivate_user(self, client: StreamChat, random_user: Dict):
         response = client.deactivate_user(random_user["id"])
         assert "user" in response