Implement Polls

changes/1922.feature.md

@@ -0,0 +1 @@
+Add support for built-in polls

hikari/__init__.py

@@ -85,6 +85,7 @@
 from hikari.events.member_events import *
 from hikari.events.message_events import *
 from hikari.events.monetization_events import *
+from hikari.events.poll_events import *
 from hikari.events.reaction_events import *
 from hikari.events.role_events import *
 from hikari.events.scheduled_events import *
@@ -115,6 +116,7 @@
 from hikari.messages import *
 from hikari.monetization import *
 from hikari.permissions import *
+from hikari.polls import *
 from hikari.presences import *
 from hikari.scheduled_events import *
 from hikari.sessions import *

hikari/__init__.pyi

@@ -60,6 +60,7 @@ from hikari.events.lifetime_events import *
 from hikari.events.member_events import *
 from hikari.events.message_events import *
 from hikari.events.monetization_events import *
+from hikari.events.poll_events import *
 from hikari.events.reaction_events import *
 from hikari.events.role_events import *
 from hikari.events.scheduled_events import *
@@ -90,6 +91,7 @@ from hikari.locales import *
 from hikari.messages import *
 from hikari.monetization import *
 from hikari.permissions import *
+from hikari.polls import *
 from hikari.presences import *
 from hikari.scheduled_events import *
 from hikari.sessions import *

hikari/api/entity_factory.py

@@ -42,6 +42,7 @@
     from hikari import invites as invite_models
     from hikari import messages as message_models
     from hikari import monetization as entitlement_models
+    from hikari import polls as poll_models
     from hikari import presences as presence_models
     from hikari import scheduled_events as scheduled_events_models
     from hikari import sessions as gateway_models
@@ -1994,3 +1995,37 @@ def deserialize_stage_instance(self, payload: data_binding.JSONObject) -> stage_
         hikari.stage_intances.StageInstance
             The deserialized stage instance object
         """
+
+    ###############
+    # POLL MODELS #
+    ###############
+
+    @abc.abstractmethod
+    def deserialize_poll(self, payload: data_binding.JSONObject) -> poll_models.Poll:
+        """Parse a raw payload from Discord into a poll object.
+
+        Parameters
+        ----------
+        payload
+            The JSON payload to deserialize.
+
+        Returns
+        -------
+        hikari.polls.Poll
+            The deserialized poll object.
+        """
+
+    @abc.abstractmethod
+    def serialize_poll(self, poll: poll_models.PollBuilder) -> data_binding.JSONObject:
+        """Serialize a poll object to a json serializable dict.
+
+        Parameters
+        ----------
+        poll
+            The poll object to serialize.
+
+        Returns
+        -------
+        hikari.internal.data_binding.JSONObject
+            The serialized representation of the poll.
+        """

hikari/api/event_factory.py

@@ -48,6 +48,7 @@
     from hikari.events import member_events
     from hikari.events import message_events
     from hikari.events import monetization_events
+    from hikari.events import poll_events
     from hikari.events import reaction_events
     from hikari.events import role_events
     from hikari.events import scheduled_events
@@ -1469,3 +1470,45 @@ def deserialize_stage_instance_delete_event(
         hikari.events.stage_events.StageInstanceDeleteEvent
             The parsed stage instance delete event object.
         """
+
+    ################
+    #  POLL EVENTS #
+    ################
+
+    @abc.abstractmethod
+    def deserialize_poll_vote_create_event(
+        self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
+    ) -> poll_events.PollVoteCreateEvent:
+        """Parse a raw payload from Discord into a poll vote create event object.
+
+        Parameters
+        ----------
+        shard
+            The shard that emitted this event.
+        payload
+            The dict payload to parse.
+
+        Returns
+        -------
+        hikari.events.poll_events.PollVoteCreateEvent
+            The parsed poll vote create event object.
+        """
+
+    @abc.abstractmethod
+    def deserialize_poll_vote_delete_event(
+        self, shard: gateway_shard.GatewayShard, payload: data_binding.JSONObject
+    ) -> poll_events.PollVoteDeleteEvent:
+        """Parse a raw payload from Discord into a poll vote delete event object.
+
+        Parameters
+        ----------
+        shard
+            The shard that emitted this event.
+        payload
+            The dict payload to parse.
+
+        Returns
+        -------
+        hikari.events.poll_events.PollVoteDeleteEvent
+            The parsed poll vote delete event object.
+        """

hikari/api/rest.py

@@ -49,6 +49,7 @@
     from hikari import messages as messages_
     from hikari import monetization
     from hikari import permissions as permissions_
+    from hikari import polls
     from hikari import sessions
     from hikari import snowflakes
     from hikari import stage_instances
@@ -1043,6 +1044,7 @@ async def create_message(
         components: undefined.UndefinedOr[typing.Sequence[special_endpoints.ComponentBuilder]] = undefined.UNDEFINED,
         embed: undefined.UndefinedOr[embeds_.Embed] = undefined.UNDEFINED,
         embeds: undefined.UndefinedOr[typing.Sequence[embeds_.Embed]] = undefined.UNDEFINED,
+        poll: undefined.UndefinedOr[polls.PollBuilder] = undefined.UNDEFINED,
         sticker: undefined.UndefinedOr[snowflakes.SnowflakeishOr[stickers_.PartialSticker]] = undefined.UNDEFINED,
         stickers: undefined.UndefinedOr[
             snowflakes.SnowflakeishSequence[stickers_.PartialSticker]
@@ -1120,6 +1122,8 @@ async def create_message(
             If provided, the message embed.
         embeds
             If provided, the message embeds.
+        poll
+            If provided, the poll to create.
         sticker
             If provided, the object or ID of a sticker to send on the message.
 
@@ -8654,3 +8658,80 @@ async def delete_stage_instance(self, channel: snowflakes.SnowflakeishOr[channel
         hikari.errors.InternalServerError
             If an internal error occurs on Discord while handling the request.
         """
+
+    @abc.abstractmethod
+    async def fetch_poll_voters(
+        self,
+        channel: snowflakes.SnowflakeishOr[channels_.TextableChannel],
+        message: snowflakes.SnowflakeishOr[messages_.PartialMessage],
+        answer_id: int,
+        /,
+        *,
+        after: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED,
+        limit: undefined.UndefinedOr[int] = undefined.UNDEFINED,
+    ) -> typing.Sequence[users.User]:
+        """Fetch users that voted for a specific answer.
+
+        Parameters
+        ----------
+        channel
+            The channel the poll is in.
+        message
+            The message the poll is in.
+        answer_id
+            The answers id.
+        after
+            The votes to collect, after this user voted.
+        limit
+            The amount of votes to collect. Maximum 100, default 25
+
+        Returns
+        -------
+        typing.Sequence[users.User]
+            An sequence of Users.
+
+        Raises
+        ------
+        hikari.errors.BadRequestError
+            If any of the fields that are passed have an invalid value.
+        hikari.errors.UnauthorizedError
+            If you are unauthorized to make the request (invalid/missing token).
+        hikari.errors.NotFoundError
+            If the entitlement was not found.
+        hikari.errors.RateLimitTooLongError
+            Raised in the event that a rate limit occurs that is
+            longer than `max_rate_limit` when making a request.
+        hikari.errors.InternalServerError
+            If an internal error occurs on Discord while handling the request.
+        """
+
+    @abc.abstractmethod
+    async def end_poll(
+        self,
+        channel: snowflakes.SnowflakeishOr[channels_.TextableChannel],
+        message: snowflakes.SnowflakeishOr[messages_.PartialMessage],
+        /,
+    ) -> None:
+        """End a poll.
+
+        Parameters
+        ----------
+        channel
+            The channel the poll is in.
+        message
+            The message the poll is in.
+
+        Raises
+        ------
+        hikari.errors.BadRequestError
+            If any of the fields that are passed have an invalid value.
+        hikari.errors.UnauthorizedError
+            If you are unauthorized to make the request (invalid/missing token).
+        hikari.errors.NotFoundError
+            If the entitlement was not found.
+        hikari.errors.RateLimitTooLongError
+            Raised in the event that a rate limit occurs that is
+            longer than `max_rate_limit` when making a request.
+        hikari.errors.InternalServerError
+            If an internal error occurs on Discord while handling the request.
+        """