feat: add search_community_data

Author: New-dev0

swibots/api/chat/controllers/message_controller.py

@@ -2,7 +2,7 @@
 import os
 import json
 import logging
-from typing import TYPE_CHECKING, List, Optional, Tuple, Union
+from typing import TYPE_CHECKING, List, Optional, Tuple, Union, Literal
 from urllib.parse import urlencode
 from io import BytesIO
 from asyncio.tasks import Task
@@ -16,7 +16,7 @@
 )
 from swibots.utils import isUrl
 from swibots.api.common.models import User, EmbeddedMedia, Media
-from swibots.api.community.models import Channel, Group
+from swibots.api.community.models import Channel, Group, CommunityMember, SearchResultUser
 
 if TYPE_CHECKING:
     from swibots.api.chat import ChatClient
@@ -771,3 +771,45 @@ async def get_user(self, user_id: int | str = None, username: str = None) -> Use
         else:
             raise ValueError("Either provide 'user_id' or 'username' to get user info.")
         return self.client.build_object(User, response.data)
+
+
+    async def search_community_data(
+            self,
+            query: str,
+            community_id: str,
+            filter: Literal["MESSAGES", "MEDIA", "LINK", "GROUP", "CHANNEL", "MEMBER"] = "MESSAGES",
+            limit: int = 10,
+            page: int = 0,
+    ) -> Union[List[Message], List[Group], List[Channel], List[SearchResultUser]]:
+        """Search community data
+
+        Parameters:
+            query (``str``): The search query
+            community_id (``str``): The community id
+            filter (``str``, *optional*): The filter. Defaults to "MESSAGES".
+            limit (``int``, *optional*): The limit. Defaults to 10.
+            page (``int``, *optional*): The page. Defaults to 0.
+
+        Returns:
+            Union[List[Message], List[Group], List[Channel], List[SearchResultUser]]: The search results
+
+                    """
+        data = {
+            "searchString": query,
+            "item": filter,
+            "communityId": community_id,
+            "limit": limit,
+            "page": page,
+        }
+        response = await self.client.get(
+            "/v1/search/community-data?{}".format(urlencode(data))
+        )
+        if filter in ["MESSAGES", "MEDIA", "LINK"]:
+            return self.client.build_list(Message, response.data)
+        elif filter == "GROUP":
+            return self.client.build_list(Group, response.data)
+        elif filter == "CHANNEL":
+            return self.client.build_list(Channel, response.data)
+        elif filter == "MEMBER":
+            return self.client.build_list(SearchResultUser, response.data)
+        return response.data

swibots/api/chat/methods/get_community_media_files.py

@@ -1,7 +1,8 @@
 from typing import List
 import swibots
 from swibots.api.chat.models import Message
-
+from typing import Literal, Union
+from swibots.api.community.models import Channel, Group, SearchResultUser
 
 class GetCommunityMediaFiles:
     async def get_community_media_files(
@@ -21,3 +22,29 @@ async def get_community_media_files(
         This function does the same as :meth:`~switch.api.chat.controllers.MessageController.get_messages`.
         """
         return await self.chat_service.messages.get_community_media_files(community_id)
+
+
+    async def search_community_data(
+        self: "swibots.ApiClient",
+        query: str,
+        community_id: str,
+        filter: Literal["MESSAGES", "MEDIA", "LINK", "GROUP", "CHANNEL", "MEMBER"] = "MESSAGES",
+        limit: int = 10,
+        page: int = 0,
+    ) -> Union[List[Message], List[Group], List[Channel], List[SearchResultUser]]:
+        """Search community data
+
+        Parameters:
+            query (``str``): The search query
+            community_id (``str``): The community id
+            filter (``str``, *optional*): The filter. Defaults to "MESSAGES".
+            limit (``int``, *optional*): The limit. Defaults to 10.
+            page (``int``, *optional*): The page. Defaults to 0.
+
+        Returns:
+            Union[List[Message], List[Group], List[Channel], List[SearchResultUser]]: The search results
+
+        Raises:
+            ``~switch.error.SwitchError``: If the search results could not be retrieved
+        """
+        return await self.chat_service.messages.search_community_data(query, community_id, filter, limit, page)

swibots/api/community/models/community_member.py

@@ -80,3 +80,43 @@ def from_json(self, data: JSONDict = None) -> "CommunityMember":
             self.xp = data.get("xp")
             self.xp_spend = data.get("xp_spend")
         return self
+
+
+class SearchResultUser(SwitchObject):
+    def __init__(self, app: "swibots.App" = None, id: str = None, member_id: str = None, name: str = None, username: str = None, image_url: str = None, active: bool = None, deleted: bool = None, profile_colour: str = None, bot: bool = None):
+        super().__init__(app)
+        self.id = id
+        self.member_id = member_id
+        self.name = name
+        self.username = username
+        self.image_url = image_url
+        self.active = active
+        self.deleted = deleted
+        self.profile_colour = profile_colour
+        self.bot = bot
+
+    def to_json(self) -> JSONDict:
+        return {
+            "id": self.id,
+            "memberId": self.member_id,
+            "name": self.name,
+            "username": self.username,
+            "imageUrl": self.image_url,
+            "active": self.active,
+            "deleted": self.deleted,
+            "profileColour": self.profile_colour,
+            "bot": self.bot,
+        }
+
+    def from_json(self, data: JSONDict = None) -> "SearchResultUser":
+        if data is not None:
+            self.id = data.get("id")
+            self.member_id = data.get("memberId")
+            self.name = data.get("name")
+            self.username = data.get("username")
+            self.image_url = data.get("imageUrl")
+            self.active = data.get("active")
+            self.deleted = data.get("deleted")
+            self.profile_colour = data.get("profileColour")
+            self.bot = data.get("bot")
+        return self