Add new endpoints

Adding a lot of new endpoints

Author: chillymosh

docs/changelog.rst

@@ -4,7 +4,20 @@ Master
 ======
 - TwitchIO
     - Additions
-        - Added :func:`twitchio.PartialUser.create_custom_reward` to allow custom reward creations
+        - Added following new PartialUser methods:
+            - :func:`twitchio.PartialUser.create_custom_reward`
+            - :func:`twitchio.PartialUser.chat_announcement`
+            - :func:`twitchio.PartialUser.delete_chat_messages`
+            - :func:`twitchio.PartialUser.fetch_channel_vips`
+            - :func:`twitchio.PartialUser.add_channel_vip`
+            - :func:`twitchio.PartialUser.remove_channel_vip`
+            - :func:`twitchio.PartialUser.add_channel_moderator`
+            - :func:`twitchio.PartialUser.remove_channel_moderator`
+            - :func:`twitchio.PartialUser.start_raid`
+            - :func:`twitchio.PartialUser.cancel_raid`
+        - Added following new Client methods:
+            - :func:`~twitchio.Client.fetch_chatters_colors`
+            - :func:`~twitchio.Client.update_chatter_color`
         - Add ``duration`` and ``vod_offset`` attributes to :class:`~twitchio.Clip`
         - Added repr for :class:`~twitchio.CustomReward`
     - Bug fixes

twitchio/client.py

@@ -718,6 +718,48 @@ async def delete_videos(self, token: str, ids: List[int]) -> List[int]:
 
         return resp
 
+    async def fetch_chatters_colors(self, user_ids: List[int],  token: Optional[str] = None):
+        """|coro|
+
+        Fetches the color of a chatter.
+
+        Parameters
+        -----------
+        user_ids: List[:class:`int`]
+            List of user ids to fetch the colors for
+        token: Optional[:class:`str`]
+            An oauth token with the channel:read:redirect scope
+
+        Returns
+        --------
+            List[:class:`twitchio.ChatterColor`]
+        """
+        data = await self._http.get_user_chat_color(user_ids, token)
+        return [models.ChatterColor(self._http, x) for x in data]
+
+    async def update_chatter_color(self, token: str, user_id: int, color: str):
+        """|coro|
+
+        Updates the color of the specified user in the specified channel/broadcaster's chat.
+
+        Parameters
+        -----------
+        token: :class:`str`
+            An oauth token with the user:manage:chat_color scope.
+        user_id: :class:`int`
+            The ID of the user whose color is being updated, this must match the user ID in the token.
+        color: :class:`str`
+            Turbo and Prime users may specify a named color or a Hex color code like #9146FF.
+            Please see the Twitch documentation for more information.
+
+        Returns
+        --------
+            None
+        """
+        await self._http.put_user_chat_color(
+            token=token, user_id=str(user_id), color=color
+        )
+
     async def get_webhook_subscriptions(self):
         """|coro|
 

twitchio/http.py

@@ -927,7 +927,7 @@ async def get_goals(self, broadcaster_id: str, token: str):
         return await self.request(Route("GET", "goals", query=[("broadcaster_id", broadcaster_id)], token=token))
 
     async def get_chat_settings(
-        self, broadcaster_id: str, moderator_id: Optional[str] = None, token: Optional[str] = None
+        self, broadcaster_id: str, token: Optional[str] = None, moderator_id: Optional[str] = None
     ):
         q = [("broadcaster_id", broadcaster_id)]
         if moderator_id and token:
@@ -936,9 +936,9 @@ async def get_chat_settings(
 
     async def patch_chat_settings(
         self,
+        token: str,
         broadcaster_id: str,
         moderator_id: str,
-        token: str,
         emote_mode: Optional[bool] = None,
         follower_mode: Optional[bool] = None,
         follower_mode_duration: Optional[int] = None,
@@ -969,3 +969,69 @@ async def patch_chat_settings(
         }
         data = {k: v for k, v in data.items() if v is not None}
         return await self.request(Route("PATCH", "chat/settings", query=q, body=data, token=token))
+
+    async def post_chat_announcement(
+        self, token: str, broadcaster_id: str, moderator_id: str, message: str, color: Optional[str] = "primary"
+    ):
+        q = [("broadcaster_id", broadcaster_id), ("moderator_id", moderator_id)]
+        body = {"message": message, "color": color}
+        return await self.request(Route("POST", "chat/announcements", query=q, body=body, token=token))
+
+    async def delete_chat_messages(
+        self, token: str, broadcaster_id: str, moderator_id: str, message_id: Optional[str] = None
+    ):
+        q = [("broadcaster_id", broadcaster_id), ("moderator_id", moderator_id)]
+        if message_id:
+            q.append(("message_id", message_id))
+        return await self.request(Route("DELETE", "moderation/chat", query=q, token=token))
+
+    async def put_user_chat_color(self, token: str, user_id: str, color: str):
+        q = [("user_id", user_id), ("color", color)]
+        return await self.request(Route("PUT", "chat/color", query=q, token=token))
+
+    async def get_user_chat_color(self, user_ids: List[int], token: Optional[str] = None):
+        if len(user_ids) > 100:
+            raise ValueError("You can only get up to 100 user chat colors at once")
+        q = [("user_id", str(user_id)) for user_id in user_ids]
+        return await self.request(Route("GET", "chat/color", query=q, token=token))
+
+    async def post_channel_moderator(self, token: str, broadcaster_id: str, user_id: str):
+        q = [("broadcaster_id", broadcaster_id), ("user_id", user_id)]
+        return await self.request(Route("POST", "moderation/moderators", query=q, token=token))
+
+    async def delete_channel_moderator(self, token: str, broadcaster_id: str, user_id: str):
+        q = [("broadcaster_id", broadcaster_id), ("user_id", user_id)]
+        return await self.request(Route("DELETE", "moderation/moderators", query=q, token=token))
+
+    async def get_channel_vips(
+        self, token: str, broadcaster_id: str, first: int = 20, user_ids: Optional[List[str]] = None
+    ):
+        q = [("broadcaster_id", broadcaster_id), ("first", first)]
+        if first > 100:
+            raise ValueError("You can only get up to 100 VIPs at once")
+        if user_ids and len(user_ids) <= 100:
+            q.extend(("user_id", user_id) for user_id in user_ids)
+        else:
+            raise ValueError("You can can only specify up to 100 VIPs")
+        return await self.request(Route("GET", "channels/vips", query=q, token=token))
+
+    async def post_channel_vip(self, token: str, broadcaster_id: str, user_id: str):
+        q = [("broadcaster_id", broadcaster_id), ("user_id", user_id)]
+        return await self.request(Route("POST", "channels/vips", query=q, token=token))
+
+    async def delete_channel_vip(self, token: str, broadcaster_id: str, user_id: str):
+        q = [("broadcaster_id", broadcaster_id), ("user_id", user_id)]
+        return await self.request(Route("DELETE", "channels/vips", query=q, token=token))
+
+    async def post_whisper(self, token: str, from_user_id: str, to_user_id: str, message: str):
+        q = [("from_user_id", from_user_id), ("to_user_id", to_user_id)]
+        body = {"message": message}
+        return await self.request(Route("POST", "whispers", query=q, body=body, token=token))
+
+    async def post_raid(self, token: str, from_broadcaster_id: str, to_broadcaster_id: str):
+        q = [("from_broadcaster_id", from_broadcaster_id), ("to_broadcaster_id", to_broadcaster_id)]
+        return await self.request(Route("POST", "raids", query=q, token=token))
+
+    async def delete_raid(self, token: str, broadcaster_id: str):
+        q = [("broadcaster_id", broadcaster_id)]
+        return await self.request(Route("DELETE", "raids", query=q, token=token))

twitchio/models.py

@@ -70,6 +70,8 @@
     "PollChoice",
     "Goal",
     "ChatSettings",
+    "Raid",
+    "ChatterColor"
 )
 
 
@@ -1559,3 +1561,47 @@ def __init__(self, http: "TwitchHTTP", data: dict):
 
     def __repr__(self):
         return f"<ChatSettings broadcaster={self.broadcaster} emote_mode={self.emote_mode} follower_mode={self.follower_mode} slow_mode={self.slow_mode} subscriber_mode={self.subscriber_mode} unique_chat_mode={self.unique_chat_mode}>"
+
+
+class ChatterColor:
+    """
+    Represents chatters current name color.
+
+    Attributes
+    -----------
+    user: :class:`~twitchio.PartialUser`
+        PartialUser of the chatter.
+    color: :class:`str`
+        The color of the chatter's name.
+    """
+
+    __slots__ = ("user", "color")
+
+    def __init__(self, http: "TwitchHTTP", data: dict):
+        self.user = PartialUser(http, data["user_id"], data["user_login"])
+        self.color: str = data["color"]
+
+    def __repr__(self):
+        return f"<ChatterColor user={self.user} color={self.color}>"
+
+
+class Raid:
+    """
+    Represents a raid for a broadcaster / channel
+
+    Attributes
+    -----------
+    created_at: :class:`datetime.datetime`
+        Date and time of when the raid started.
+    is_mature: :class:`bool`
+        Indicates whether the stream being raided is marked as mature.
+    """
+
+    __slots__ = ("created_at", "is_mature")
+
+    def __init__(self, data: dict):
+        self.created_at: datetime.datetime = parse_timestamp(data["created_at"])
+        self.is_mature: bool = data["is_mature"]
+
+    def __repr__(self):
+        return f"<Raid created_at={self.created_at} is_mature={self.is_mature}>"