Add PartualUser method fetch_shield_mode_status

Add PartualUser method fetch_shield_mode_status

Author: chillymosh

docs/changelog.rst

@@ -12,6 +12,7 @@ Master
         - Added :attr:`~twitchio.Game.igdb_id` to :class:`~twitchio.Game`
         - Added ``igdb_ids`` argument to :func:`~twitchio.Client.fetch_games`
         - Added ``tags`` attribute to :class:`~twitchio.Stream`, :class:`~twitchio.ChannelInfo` and :class:`~twitchio.SearchUser`
+        - Added :func:`~twitchio.PartialUser.fetch_shield_mode_status`
 
     - Bug fixes
         - Fix :func:`~twitchio.PartialUser.fetch_bits_leaderboard` not handling ``started_at`` and :class:`~twitchio.BitsLeaderboard` not correctly parsing

twitchio/http.py

@@ -1108,3 +1108,9 @@ async def get_follow_count(
             full_body=True,
             paginate=False,
         )
+
+    async def get_shield_mode_status(self, token: str, broadcaster_id: str, moderator_id: str):
+        q = [("broadcaster_id", broadcaster_id), ("moderator_id", moderator_id)]
+        return await self.request(
+            Route("GET", "moderation/shield_mode", query=q, token=token), paginate=False, full_body=False
+        )

twitchio/models.py

@@ -1790,3 +1790,37 @@ def __init__(self, http: "TwitchHTTP", data: dict):
 
     def __repr__(self):
         return f"<Timeout broadcaster={self.broadcaster} user={self.user} created_at={self.created_at} end_time={self.end_time}>"
+
+
+class ShieldStatus:
+    """
+    Represents a Shield Mode activation status.
+
+    Attributes
+    -----------
+    moderator: :class:`~twitchio.PartialUser`
+        The moderator that last activated Shield Mode.
+    display_name: :class:`str`
+        The moderator's display name. Is an empty string if Shield Mode hasn't been previously activated.
+    last_activated_at: :class:`datetime.datetime`
+        The UTC datetime of when Shield Mode was last activated.
+        Is an empty string if Shield Mode hasn't been previously activated.
+    is_active: :class:`bool`
+        A Boolean value that determines whether Shield Mode is active.
+        Is true if the broadcaster activated Shield Mode; otherwise, false.
+    """
+
+    __slots__ = ("moderator", "display_name", "last_activated_at", "is_active")
+
+    def __init__(self, http: "TwitchHTTP", data: dict):
+        self.moderator: Optional[PartialUser] = (
+            PartialUser(http, data["moderator_id"], data["moderator_login"]) if data["moderator_id"] else None
+        )
+        self.display_name: Optional[str] = data.get("moderator_name")
+        self.is_active: bool = data["is_active"]
+        self.last_activated_at: Optional[datetime.datetime] = (
+            parse_timestamp(data["last_activated_at"]) if data["last_activated_at"] else None
+        )
+
+    def __repr__(self):
+        return f"<ShieldStatus moderator={self.moderator} is_active={self.is_active} last_activated_at={self.last_activated_at}>"

twitchio/user.py

@@ -1502,6 +1502,30 @@ async def send_whisper(self, token: str, user_id: int, message: str):
 
         await self._http.post_whisper(token=token, from_user_id=str(self.id), to_user_id=str(user_id), message=message)
 
+    async def fetch_shield_mode_status(self, token: str, moderator_id: int):
+        """|coro|
+
+        Fetches the user's Shield Mode activation status.
+
+        Parameters
+        -----------
+        token: :class:`str`
+            An oauth user token with the ``moderator:read:shield_mode`` or ``moderator:manage:shield_mode`` scope.
+        moderator_id: :class:`int`
+            The ID of the broadcaster or a user that is one of the broadcaster's moderators. This ID must match the user ID in the access token.
+
+        Returns
+        --------
+        :class:`twitchio.ShieldStatus`
+        """
+        from .models import ShieldStatus
+
+        data = await self._http.get_shield_mode_status(
+            broadcaster_id=str(self.id), moderator_id=str(moderator_id), token=token
+        )
+
+        return ShieldStatus(self._http, data[0])
+
 
 class BitLeaderboardUser(PartialUser):