feat: add headings methods

Author: New-dev0

swibots/api/chat/chat_client.py

@@ -9,6 +9,7 @@
     MediaController,
     StickerController,
     OrganizationController,
+    HeadingsController,
 )
 from swibots.api.chat.events import (
     ChatEvent,
@@ -62,6 +63,7 @@ def __init__(
         self._ads: AdvertisingController = None
         self._stickers: StickerController = None
         self._organization: OrganizationController = None
+        self._headings: HeadingsController = None
         self._ws: SwitchWSAsyncClient = None
         self._started = False
 
@@ -77,6 +79,12 @@ def ads(self) -> AdvertisingController:
             self._ads = AdvertisingController(self)
         return self._ads
 
+    @property
+    def headings(self) -> HeadingsController:
+        if self._headings is None:
+            self._headings = HeadingsController(self)
+        return self._headings
+
     @property
     def organization(self) -> OrganizationController:
         if self._organization is None:
@@ -185,7 +193,7 @@ async def _parse_event(self, raw_message: WsMessage, callback) -> ChatEvent:
                 evt = self.build_object(InlineQueryEvent, json_data)
             else:
                 logging.error(f"Received unknown event type: {messagetype}")
-#                evt = self.build_object(ChatEvent, json_data)
+                #                evt = self.build_object(ChatEvent, json_data)
                 return
         except Exception as e:
             logger.exception(e)

swibots/api/chat/controllers/__init__.py

@@ -4,12 +4,14 @@
 from .sticker_controller import StickerController
 from .organization_controller import OrganizationController
 from .ads_controller import AdvertisingController
+from .heading_controller import HeadingsController
 
 __all__ = [
     "AdvertisingController",
     "MessageController",
     "ChatController",
     "MediaController",
     "StickerController",
-    "OrganizationController"
+    "OrganizationController",
+    "HeadingsController",
 ]

swibots/api/chat/controllers/heading_controller.py

@@ -0,0 +1,61 @@
+import logging
+from typing import TYPE_CHECKING, Optional, List, Literal
+from swibots.api.community.models import CommunityHeading
+from swibots.api.common.models import User
+from urllib.parse import urlencode
+
+if TYPE_CHECKING:
+    from swibots.api.community import CommunityClient
+
+log = logging.getLogger(__name__)
+
+class HeadingsController:
+    def __init__(self, client: "CommunityClient"):
+        self.client = client
+
+    async def get_headings(self, community_id: str, additional: bool = False) -> List[CommunityHeading]:
+        """
+        :param community_id: The ID of the community
+        :return: The Heading object
+        """
+        query = urlencode({"additional": additional,
+                           "communityId": community_id,
+                           })
+        response = await self.client.get(f"/headings?{query}")
+        return self.client.build_list(CommunityHeading, response.data)
+
+
+    async def create_heading(self, community_id: str, name: str,
+                             chat_id: str,
+                             heading_for: Literal["CHANNEL", "GROUP"] = "CHANNEL",
+                             heading_type: Literal['BLANK', "VALUE"] = "VALUE",
+                             ):
+        query = urlencode({
+            "communityId": community_id,
+            "heading": name,
+            "id": chat_id,
+            "headingFor": heading_for,
+            "headingType": heading_type,
+        })
+        response = await self.client.post(f"/headings?{query}")
+        return response.data
+
+    async def delete_heading(self, community_id: str, heading_name: str):
+        query = urlencode({
+            "communityId": community_id,
+            "headingName": heading_name,
+        })
+        response = await self.client.post(f"/headings/delete-headings?{query}")
+        return response.data
+
+    async def edit_heading(self, community_id: str, heading_name: str, new_heading_name: str,
+                           heading_type: Literal['BLANK', "VALUE"] = "VALUE"):
+        query = urlencode({
+            "communityId": community_id,
+            "headingName": heading_name,
+            "newHeadingName": new_heading_name,
+            "headingType": heading_type,
+        })
+        response = await self.client.post(f"/headings/edit-headings?{query}")
+        return response.data
+

swibots/api/chat/methods/heading_methods.py

@@ -0,0 +1,52 @@
+from typing import Type, TypeVar, Optional, List, Literal
+import swibots
+from swibots.api.community.models import CommunityHeading
+
+
+class HeadingMethods:
+
+    async def get_headings(self: "swibots.ApiClient", community_id: str, additional: bool = False) -> List[CommunityHeading]:
+        """
+        Get the headings of a community
+
+        :param community_id: The ID of the community
+        :param additional: Whether to get additional information about the headings
+        """
+        return await self.chat_service.headings.get_headings(community_id, additional)
+
+    async def create_heading(self: "swibots.ApiClient", community_id: str, name: str,
+                             chat_id: str,
+                             heading_for: Literal["CHANNEL", "GROUP"] = "CHANNEL",
+                             heading_type: Literal['BLANK', "VALUE"] = "VALUE",
+                             ):
+        """
+        Create a heading in a community
+
+        :param community_id: The ID of the community
+        :param name: The name of the heading
+        :param chat_id: The ID of the chat
+        :param heading_for: The type of the heading
+        :param heading_type: The type of the heading
+        """
+        return await self.chat_service.headings.create_heading(community_id, name, chat_id, heading_for, heading_type)
+
+    async def delete_heading(self, community_id: str, heading_name: str):
+        """
+        Delete a heading from a community
+
+        :param community_id: The ID of the community
+        :param heading_name: The name of the heading to delete
+        """
+        return await self.chat_service.headings.delete_heading(community_id, heading_name)
+
+    async def edit_heading(self, community_id: str, heading_name: str, new_heading_name: str,
+                           heading_type: Literal['BLANK', "VALUE"] = "VALUE"):
+        """
+        Edit a heading in a community
+
+        :param community_id: The ID of the community
+        :param heading_name: The name of the heading to edit
+        :param new_heading_name: The new name of the heading
+        :param heading_type: The type of the heading
+        """
+        return await self.chat_service.headings.edit_heading(community_id, heading_name, new_heading_name, heading_type)

swibots/api/community/models/__init__.py

@@ -1,11 +1,11 @@
 from .channel import Channel
-from .community import Community
+from .community import Community, CommunityHeading
 from .group import Group
 from .role import Role
 from .rolepermission import RolePermission
 from .rolemember import RoleMember
 from .baninfo import BanInfo
-from .community_member import CommunityMember
+from .community_member import CommunityMember, SearchResultUser
 from .restricteduser import RestrictedUser
 from .quest import Quest, QuestCategory
 from .instantmessaging import InstantMessaging
@@ -18,9 +18,11 @@
     "RolePermission",
     "RoleMember",
     "BanInfo",
+    "CommunityHeading",
     "CommunityMember",
     "RestrictedUser",
     "Quest",
     "QuestCategory",
     "InstantMessaging",
+    "SearchResultUser",
 ]

swibots/api/community/models/community.py

@@ -1,7 +1,8 @@
-from typing import Optional
+from typing import Optional, Union, List
 from swibots.utils.types import JSONDict
 from swibots.base.switch_object import SwitchObject
 from swibots.api.community.models.channel import Channel
+from swibots.api.community.models.group import Group
 import swibots
 
 
@@ -108,3 +109,24 @@ def from_json(self, data: Optional[JSONDict]) -> Optional["Community"]:
                 self.default_channel = Channel().from_json(data.get("defaultChannel"))
 
         return self
+
+
+class CommunityHeading(SwitchObject):
+    def __init__(self, app: "swibots.Client" = None,
+                 name: str = None,
+                 heading_type: str = None,
+                 public: bool = None,
+                 details: List[Union[Channel, Group]] = None):
+        super().__init__(app)
+        self.name = name
+        self.details = details
+        self.heading_type = heading_type
+        self.public = public
+
+    def from_json(self, data):
+        self.name = data.get("headingName")
+        self.details = [(Group if detail['isGroup'] else Channel)().from_json(detail) for detail in data.get("details")]
+        self.public = data.get("enabledPublic")
+        self.heading_type = data.get("headingType")
+
+        return self