feat: Add the voice state event (#1147)

* feat: add voice state event

* refactor: you did not see that

* refactor: do things that were requested

* Update interactions/api/models/member.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/member.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/guild.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/gateway/client.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/gateway/client.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/gateway/client.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/gw.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/gw.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/gw.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/gw.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/gw.py

* Update interactions/api/models/gw.py

* Update interactions/api/models/member.py

* Update interactions/api/models/channel.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/guild.py

Co-authored-by: Damego <[email protected]>

* Update interactions/api/models/guild.py

Co-authored-by: Damego <[email protected]>

Co-authored-by: Damego <[email protected]>

Author: EepyElvyra

interactions/api/gateway/client.py

@@ -33,7 +33,7 @@
 from ..http.client import HTTPClient
 from ..models.flags import Intents
 from ..models.guild import Guild
-from ..models.gw import GuildMember, GuildRole
+from ..models.gw import GuildMember, GuildRole, VoiceState
 from ..models.member import Member
 from ..models.message import Message
 from ..models.misc import Snowflake
@@ -463,7 +463,8 @@ def _dispatch_event(self, event: str, data: dict) -> None:
                 log.warning(
                     "Context is being created for the interaction, but no type is specified. Skipping..."
                 )
-        elif event not in {"TYPING_START", "VOICE_STATE_UPDATE", "VOICE_SERVER_UPDATE"}:
+
+        elif event not in {"TYPING_START", "VOICE_SERVER_UPDATE"}:
             name: str = event.lower()
             try:
                 data["_client"] = self._http
@@ -542,6 +543,10 @@ def _dispatch_event(self, event: str, data: dict) -> None:
                         old_obj = obj
 
                     _cache.add(old_obj, id)
+
+                    if event == "VOICE_STATE_UPDATE" and not obj.channel_id:  # user left
+                        del _cache[obj.user_id]
+
                     self._dispatch.dispatch(
                         f"on_{name}", before, old_obj
                     )  # give previously stored and new one
@@ -601,6 +606,8 @@ def __get_object_id(
         """
         if isinstance(obj, (Member, GuildMember)):
             id = (Snowflake(data["guild_id"]), obj.id)
+        if isinstance(obj, VoiceState):
+            id = obj.user_id
         else:
             id = getattr(obj, "id", None)
         if id is not None:

interactions/api/models/channel.py

@@ -27,6 +27,7 @@
     from ...client.models.component import ActionRow, Button, SelectMenu
     from ..http.client import HTTPClient
     from .guild import Invite, InviteTargetType
+    from .gw import VoiceState
     from .member import Member
     from .message import Attachment, Embed, Message, Sticker
 
@@ -500,6 +501,29 @@ def mention(self) -> str:
         """
         return f"<#{self.id}>"
 
+    @property
+    def voice_states(self) -> List["VoiceState"]:
+        """
+        Returns all voice states this channel has. Only applicable for voice channels.
+
+        :rtype: List[VoiceState]
+        """
+        if self.type != ChannelType.GUILD_VOICE:
+            raise LibraryException(
+                code=14, message="Cannot only get voice states from a voice channel!"
+            )
+
+        if not self._client:
+            raise LibraryException(code=13)
+
+        from .gw import VoiceState
+
+        states: List[VoiceState] = []
+
+        data = self._client.cache[VoiceState].values.values()
+        states.extend(state for state in data if state.channel_id == self.id)
+        return states
+
     def history(
         self,
         start_at: Optional[Union[int, str, Snowflake, "Message"]] = MISSING,

interactions/api/models/guild.py

@@ -38,7 +38,7 @@
 
 if TYPE_CHECKING:
     from ..http.client import HTTPClient
-    from .gw import AutoModerationRule
+    from .gw import AutoModerationRule, VoiceState
     from .message import Message
 
 __all__ = (
@@ -540,6 +540,40 @@ async def ban(
             if int(member.id) == _member_id:
                 return self.members.remove(member)
 
+    @property
+    def voice_states(self) -> List["VoiceState"]:
+        """
+        Gets all voice states of the guild.
+
+        :rtype: List[VoiceState]
+        """
+
+        if not self._client:
+            raise LibraryException(code=13)
+
+        from .gw import VoiceState
+
+        states: List[VoiceState] = []
+
+        data = self._client.cache[VoiceState].values.values()
+        states.extend(state for state in data if state.guild_id == self.id)
+        return states
+
+    @property
+    def mapped_voice_states(self) -> Dict[int, List["VoiceState"]]:
+        """
+        Returns all the voice states mapped after their channel id.
+
+        :rtype: Dict[int, List[VoiceState]]
+        """
+        states = self.voice_states
+        _states: Dict[int, List[VoiceState]] = {int(state.channel_id): [] for state in states}
+
+        for state in states:
+            _states[int(state.channel_id)].append(state)
+
+        return _states
+
     async def remove_ban(
         self,
         user_id: Union[int, Snowflake],  # only support ID since there's no member on the guild

interactions/api/models/gw.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, List, Optional
+from typing import Any, List, Optional, Union
 
 from ...utils.attrs_utils import (
     ClientSerializerMixin,
@@ -10,7 +10,7 @@
 )
 from .channel import Channel, ThreadMember
 from .emoji import Emoji
-from .guild import EventMetadata
+from .guild import EventMetadata, Guild
 from .member import Member
 from .message import Sticker
 from .misc import (
@@ -50,6 +50,7 @@
     "GuildJoinRequest",
     "GuildEmojis",
     "GuildRole",
+    "VoiceState",
 )
 
 
@@ -572,3 +573,107 @@ class Webhooks(DictSerializerMixin):
 
     channel_id: Snowflake = field(converter=Snowflake)
     guild_id: Snowflake = field(converter=Snowflake)
+
+
+@define()
+class VoiceState(ClientSerializerMixin):
+    """
+    A class object representing the gateway event ``VOICE_STATE_UPDATE``.
+    This class creates an object every time the event ``VOICE_STATE_UPDATE`` is received from the discord API.
+    It contains information about the user's update voice information. Additionally, the last voice state is cached,
+    allowing you to see, what attributes of the user's voice information change.
+
+    :ivar Member member: The member whose VoiceState was updated
+    :ivar Snowflake user_id: The id of the user whose VoiceState was updated. This is technically the same as the "member id", but it is called `user_id` because of API terminology.
+    :ivar bool suppress: Whether the user is muted by the current user(-> bot)
+    :ivar int session_id: The id of the session
+    :ivar bool self_video: Whether the user's camera is enabled.
+    :ivar bool self_mute: Whether the user is muted by themselves
+    :ivar bool self_deaf: Whether the user is deafened by themselves
+    :ivar bool self_stream: Whether the user is streaming in the current channel
+    :ivar datetime request_to_speak_timestamp: Only for stage-channels; when the user requested permissions to speak in the stage channel
+    :ivar bool mute: Whether the user's microphone is muted by the server
+    :ivar Snowflake guild_id: The id of the guild in what the update took action
+    :ivar bool deaf: Whether the user is deafened by the guild
+    :ivar Snowflake channel_id: The id of the channel the update took action
+    """
+
+    channel_id: Optional[Snowflake] = field(converter=Snowflake, default=None)
+    guild_id: Optional[Snowflake] = field(converter=Snowflake, default=None)
+    user_id: Optional[Snowflake] = field(converter=Snowflake, default=None)
+    member: Optional[Member] = field(converter=Member, default=None, add_client=True)
+    request_to_speak_timestamp: Optional[datetime] = field(
+        converter=datetime.fromisoformat, default=None
+    )
+    suppress: bool = field()
+    session_id: int = field()
+    self_video: bool = field()
+    self_mute: bool = field()
+    self_deaf: bool = field()
+    self_stream: Optional[bool] = field(default=None)
+    mute: bool = field()
+    deaf: bool = field()
+
+    def __attrs_post_init__(self):
+        if self.member:
+            self.member._extras["guild_id"] = self.guild_id
+
+    @property
+    def joined(self) -> bool:
+        """
+        Whether the user joined the channel.
+
+        :rtype: bool
+        """
+        return self.channel_id is not None
+
+    async def mute_member(self, reason: Optional[str] = None) -> Member:
+        """
+        Mutes the current member.
+
+        :param Optional[str] reason: The reason of the muting, optional
+        :return: The modified member object
+        :rtype: Member
+        """
+        return await self.member.modify(guild_id=int(self.guild_id), mute=True, reason=reason)
+
+    async def deafen_member(self, reason: Optional[str] = None) -> Member:
+        """
+        Deafens the current member.
+
+        :param Optional[str] reason: The reason of the deafening, optional
+        :return: The modified member object
+        :rtype: Member
+        """
+        return await self.member.modify(guild_id=int(self.guild_id), deaf=True, reason=reason)
+
+    async def move_member(
+        self, channel_id: Union[int, str, Snowflake], *, reason: Optional[str] = None
+    ) -> Member:
+        """
+        Moves the member to another channel.
+
+        :param Union[int, str, Snowflake] channel_id: The ID of the channel to move the user to
+        :param Optional[str] reason: The reason of the move
+        :return: The modified member object
+        :rtype: Member
+        """
+        return await self.member.modify(
+            guild_id=int(self.guild_id), channel_id=channel_id, reason=reason
+        )
+
+    async def get_channel(self) -> Channel:
+        """
+        Gets the channel in what the update took place.
+
+        :rtype: Channel
+        """
+        return Channel(**await self._client.get_channel(int(self.channel_id)), _client=self._client)
+
+    async def get_guild(self) -> "Guild":
+        """
+        Gets the guild in what the update took place.
+
+        :rtype: Guild
+        """
+        return Guild(**await self._client.get_guild(int(self.guild_id)), _client=self._client)

interactions/api/models/member.py

@@ -14,6 +14,7 @@
 if TYPE_CHECKING:
     from ...client.models.component import ActionRow, Button, SelectMenu
     from .guild import Guild
+    from .gw import VoiceState
     from .message import Attachment, Embed, Message
 
 __all__ = ("Member",)
@@ -75,6 +76,20 @@ def __getattr__(self, name):
         except AttributeError as e:
             raise AttributeError(f"Neither `User` nor `Member` have attribute {name}") from e
 
+    @property
+    def voice_state(self) -> Optional["VoiceState"]:
+        """
+        Returns the current voice state of the member, if any.
+
+        :rtype: VoiceState
+        """
+        if not self._client:
+            raise LibraryException(code=13)
+
+        from .gw import VoiceState
+
+        return self._client.cache[VoiceState].get(self.id)
+
     @property
     def guild_id(self) -> Optional[Union[Snowflake, LibraryException]]:
         """