🔀 Merge pull request #281 from trag1c/main

✨ Added Webhook related endpoints

Author: zunda-arrow

pincer/__init__.py

@@ -24,7 +24,11 @@
     DispatchError, DisallowedIntentsError, InvalidTokenError, HeartbeatError,
     UnavailableGuildError, HTTPError, NotModifiedError, BadRequestError,
     UnauthorizedError, ForbiddenError, NotFoundError, MethodNotAllowedError,
+<<<<<<< HEAD
+    RateLimitError, GatewayError, ServerError, EmbedOverflow
+=======
     RateLimitError, GatewayError, ServerError, ImageEncodingError
+>>>>>>> upstream/main
 )
 from .objects import Intents
 
@@ -63,15 +67,15 @@ def __repr__(self) -> str:
     "CogAlreadyExists", "CogError", "CogNotFound", "CommandAlreadyRegistered",
     "CommandCooldownError", "CommandDescriptionTooLong", "CommandError",
     "CommandIsNotCoroutine", "CommandReturnIsEmpty", "DisallowedIntentsError",
-    "DispatchError", "EmbedFieldError", "ForbiddenError", "GatewayConfig",
-    "GatewayError", "HTTPError", "HeartbeatError", "ImageEncodingError",
-    "Intents", "InvalidArgumentAnnotation", "InvalidCommandGuild",
-    "InvalidCommandName", "InvalidEventName", "InvalidPayload",
-    "InvalidTokenError", "InvalidUrlError", "MethodNotAllowedError",
-    "NoCogManagerReturnFound", "NoExportMethod", "NoValidSetupMethod",
-    "NotFoundError", "NotModifiedError", "PincerError", "RateLimitError",
-    "ServerError", "TaskAlreadyRunning", "TaskCancelError", "TaskError",
-    "TaskInvalidDelay", "TaskIsNotCoroutine", "TooManyArguments",
+    "DispatchError", "EmbedFieldError", "EmbedOverflow", "ForbiddenError",
+    "GatewayConfig", "GatewayError", "HTTPError", "HeartbeatError",
+    "ImageEncodingError", "Intents", "InvalidArgumentAnnotation",
+    "InvalidCommandGuild", "InvalidCommandName", "InvalidEventName",
+    "InvalidPayload", "InvalidTokenError", "InvalidUrlError",
+    "MethodNotAllowedError", "NoCogManagerReturnFound", "NoExportMethod",
+    "NoValidSetupMethod", "NotFoundError", "NotModifiedError", "PincerError",
+    "RateLimitError", "ServerError", "TaskAlreadyRunning", "TaskCancelError",
+    "TaskError", "TaskInvalidDelay", "TaskIsNotCoroutine", "TooManyArguments",
     "TooManySetupArguments", "UnauthorizedError", "UnavailableGuildError",
     "UnhandledException", "__author__", "__email__", "__package__",
     "__title__", "__version__", "command", "event_middleware"

pincer/client.py

@@ -37,6 +37,7 @@
     from .utils.snowflake import Snowflake
     from .core.dispatch import GatewayDispatch
     from .objects.app.throttling import ThrottleInterface
+    from .objects.guild import Webhook
 
 _log = logging.getLogger(__package__)
 
@@ -833,5 +834,27 @@ async def get_channel(self, _id: int) -> Channel:
         """
         return await Channel.from_id(self, _id)
 
+    async def get_webhook(
+        self,
+        id: Snowflake,
+        token: Optional[str] = None
+    ) -> Webhook:
+        """|coro|
+        Fetch a Webhook from its identifier.
+
+        Parameters
+        ----------
+        id: :class:`int`
+            The id of the webhook which should be
+            fetched from the Discord gateway.
+        token: Optional[:class:`str`]
+            The webhook token.
+
+        Returns
+        -------
+        :class:`~pincer.objects.guild.webhook.Webhook`
+            A Webhook object.
+        """
+        return await Webhook.from_id(self, id, token)
 
 Bot = Client

pincer/exceptions.py

@@ -189,6 +189,10 @@ def from_desc(cls, _type: str, max_size: int, cur_size: int):
         )
 
 
+class EmbedOverflow(PincerError):
+    """Exception that is raised when too many embeds are passed in."""
+
+
 class TaskError(PincerError):
     """Base class for exceptions that are related to tasks.
 

pincer/objects/guild/channel.py

@@ -16,11 +16,12 @@
 from ...utils.types import MISSING
 
 if TYPE_CHECKING:
-    from typing import Dict, List, Optional, Union
+    from typing import AsyncGenerator, Dict, List, Optional, Union
 
     from .member import GuildMember
     from .overwrite import Overwrite
     from .thread import ThreadMetadata
+    from .webhook import Webhook
     from ..message.message import Message
     from ..message.embed import Embed
     from ..user.user import User
@@ -215,15 +216,21 @@ async def from_id(cls, client: Client, channel_id: int) -> Channel:
 
     @overload
     async def edit(
-            self, *, name: str = None,
-            type: ChannelType = None,
-            position: int = None, topic: str = None, nsfw: bool = None,
-            rate_limit_per_user: int = None, bitrate: int = None,
-            user_limit: int = None,
-            permissions_overwrites: List[Overwrite] = None,
-            parent_id: Snowflake = None, rtc_region: str = None,
-            video_quality_mod: int = None,
-            default_auto_archive_duration: int = None
+        self,
+        *,
+        name: str = None,
+        type: ChannelType = None,
+        position: int = None,
+        topic: str = None,
+        nsfw: bool = None,
+        rate_limit_per_user: int = None,
+        bitrate: int = None,
+        user_limit: int = None,
+        permissions_overwrites: List[Overwrite] = None,
+        parent_id: Snowflake = None,
+        rtc_region: str = None,
+        video_quality_mod: int = None,
+        default_auto_archive_duration: int = None
     ) -> Channel:
         ...
 
@@ -344,6 +351,24 @@ async def send(self, message: Union[Embed, Message, str]) -> UserMessage:
         self.__post_sent(msg)
         return msg
 
+    async def get_webhooks(self) -> AsyncGenerator[Webhook, None]:
+        """|coro|
+        Get all webhooks in the channel.
+        Requires the ``MANAGE_WEBHOOKS`` permission.
+
+        Yields
+        -------
+        AsyncGenerator[:class:`~.pincer.objects.guild.webhook.Webhook`, None]
+        """
+        data = await self._http.get(f"channels/{self.id}/webhooks")
+        for webhook_data in data:
+            yield Webhook.from_dict(
+                construct_client_dict(
+                    self._client,
+                    webhook_data
+                )
+            )
+
     def __str__(self):
         """return the discord tag when object gets used as a string."""
         return self.name or str(self.id)

pincer/objects/guild/guild.py

@@ -29,6 +29,7 @@
     from .template import GuildTemplate
     from .welcome_screen import WelcomeScreen, WelcomeScreenChannel
     from .widget import GuildWidget
+    from .webhook import Webhook
     from ..user.user import User
     from ..user.integration import Integration
     from ..voice.region import VoiceRegion
@@ -1537,6 +1538,21 @@ async def delete_template(
             construct_client_dict(self._client, data)
         )
 
+    async def get_webhooks(self) -> AsyncGenerator[Webhook, None]:
+        """|coro|
+        Returns an async generator of the guild webhooks.
+
+        Yields
+        -------
+        AsyncGenerator[:class:`~pincer.objects.guild.webhook.Webhook`, None]
+            The guild webhook object.
+        """
+        data = await self._http.get(f"guilds/{self.id}/webhooks")
+        for webhook_data in data:
+            yield Webhook.from_dict(
+                construct_client_dict(self._client, webhook_data)
+            )
+
     @classmethod
     def from_dict(cls, data) -> Guild:
         """