Merge pull request #343 from jbot-the-dev/events

Added missing events

Author: EvieePy

docs/changelog.rst

@@ -53,8 +53,15 @@ Master
             - :func:`~twitchio.ext.eventsub.event_eventsub_notification_channel_goal_begin`
             - :func:`~twitchio.ext.eventsub.event_eventsub_notification_channel_goal_progress`
             - :func:`~twitchio.ext.eventsub.event_eventsub_notification_channel_goal_end`
+
+        - Channel subscription end
+            - :func:`~twitchio.ext.eventsub.EventSubClient.subscribe_channel_subscription_end`
+        - User authorization grant
+            - :func:`~twitchio.ext.eventsub.EventSubClient.subscribe_user_authorization_granted`
+
         - HypeTrainBeginProgressData now has the :attr:`~twitchio.ext.eventsub.HypeTrainBeginProgressData.level`
 
+
     - Bug fixes
         Correct typo in :class:`~twitchio.ext.eventsub.HypeTrainBeginProgressData` attribute :attr:`~twitchio.ext.eventsub.HypeTrainBeginProgressData.expires`
 

docs/exts/eventsub.rst

@@ -89,6 +89,10 @@ Event Reference
 ----------------
 This is a list of events dispatched by the eventsub ext.
 
+.. function:: event_eventsub_notification_user_authorization_grant(event: UserAuthorizationGrantedData)
+
+    Called when your app has had access granted on a channel.
+
 .. function:: event_eventsub_revokation(event: RevokationEvent)
 
     Called when your app has had access revoked on a channel.
@@ -108,6 +112,10 @@ This is a list of events dispatched by the eventsub ext.
 
     Called when someone subscribes to a channel that you've subscribed to.
 
+.. function:: event_eventsub_notification_subscription_end(event: ChannelSubscriptionEndData)
+
+    Called when a subscription to a channel that you've subscribed to ends.
+
 .. function:: event_eventsub_notification_subscription_gift(event: ChannelSubscriptionGiftData)
 
     Called when someone gifts a subscription to a channel that you've subscribed to.

twitchio/ext/eventsub/models.py

@@ -238,6 +238,31 @@ def __init__(self, client: EventSubClient, data: dict):
         self.is_gift: bool = data["is_gift"]
 
 
+class ChannelSubscriptionEndData(EventData):
+    """
+    A Subscription End event
+
+    Attributes
+    -----------
+    user: :class:`twitchio.PartialUser`
+        The user who subscribed
+    broadcaster: :class:`twitchio.PartialUser`
+        The channel that was subscribed to
+    tier: :class:`int`
+        The tier of the subscription
+    is_gift: :class:`bool`
+        Whether the subscription was a gift or not
+    """
+
+    __slots__ = "user", "broadcaster", "tier", "is_gift"
+
+    def __init__(self, client: EventSubClient, data: dict):
+        self.user = _transform_user(client, data, "user")
+        self.broadcaster = _transform_user(client, data, "broadcaster_user")
+        self.tier = int(data["tier"])
+        self.is_gift: bool = data["is_gift"]
+
+
 class ChannelSubscriptionGiftData(EventData):
     """
     A Subscription Gift event
@@ -1145,6 +1170,25 @@ def __init__(self, client: EventSubClient, data: dict):
         self.broadcaster = _transform_user(client, data, "broadcaster_user")
 
 
+class UserAuthorizationGrantedData(EventData):
+    """
+    An Authorization Granted event
+
+    Attributes
+    -----------
+    user: :class:`twitchio.PartialUser`
+        The user that has granted authorization for your app
+    client_id: :class:`str`
+        The client id of the app that had its authorization granted
+    """
+
+    __slots__ = "client_id", "user"
+
+    def __init__(self, client: EventSubClient, data: dict):
+        self.user = _transform_user(client, data, "user")
+        self.client_id: str = data["client_id"]
+
+
 class UserAuthorizationRevokedData(EventData):
     """
     An Authorization Revokation event
@@ -1274,6 +1318,7 @@ def __init__(self, client: EventSubClient, data: dict):
     ChannelBanData,
     ChannelUnbanData,
     ChannelSubscribeData,
+    ChannelSubscriptionEndData,
     ChannelSubscriptionGiftData,
     ChannelSubscriptionMessageData,
     ChannelCheerData,
@@ -1294,6 +1339,7 @@ def __init__(self, client: EventSubClient, data: dict):
     PredictionEndData,
     StreamOnlineData,
     StreamOfflineData,
+    UserAuthorizationGrantedData,
     UserAuthorizationRevokedData,
     UserUpdateData,
 ]
@@ -1312,6 +1358,7 @@ class _SubscriptionTypes(metaclass=_SubTypesMeta):
 
     follow = "channel.follow", 1, ChannelFollowData
     subscription = "channel.subscribe", 1, ChannelSubscribeData
+    subscription_end = "channel.subscription.end", 1, ChannelSubscriptionEndData
     subscription_gift = "channel.subscription.gift", 1, ChannelSubscriptionGiftData
     subscription_message = "channel.subscription.message", 1, ChannelSubscriptionMessageData
     cheer = "channel.cheer", 1, ChannelCheerData
@@ -1356,6 +1403,7 @@ class _SubscriptionTypes(metaclass=_SubTypesMeta):
     stream_start = "stream.online", 1, StreamOnlineData
     stream_end = "stream.offline", 1, StreamOfflineData
 
+    user_authorization_grant = "user.authorization.grant", 1, UserAuthorizationGrantedData
     user_authorization_revoke = "user.authorization.revoke", 1, UserAuthorizationRevokedData
 
     user_update = "user.update", 1, UserUpdateData

twitchio/ext/eventsub/server.py

@@ -120,6 +120,9 @@ def subscribe_channel_unbans(self, broadcaster: Union[PartialUser, str, int]):
     def subscribe_channel_subscriptions(self, broadcaster: Union[PartialUser, str, int]):
         return self._subscribe_with_broadcaster(models.SubscriptionTypes.subscription, broadcaster)
 
+    def subscribe_channel_subscription_end(self, broadcaster: Union[PartialUser, str, int]):
+        return self._subscribe_with_broadcaster(models.SubscriptionTypes.subscription_end, broadcaster)
+
     def subscribe_channel_subscription_gifts(self, broadcaster: Union[PartialUser, str, int]):
         return self._subscribe_with_broadcaster(models.SubscriptionTypes.subscription_gift, broadcaster)
 
@@ -211,6 +214,11 @@ def subscribe_channel_prediction_lock(self, broadcaster: Union[PartialUser, str,
     def subscribe_channel_prediction_end(self, broadcaster: Union[PartialUser, str, int]):
         return self._subscribe_with_broadcaster(models.SubscriptionTypes.prediction_end, broadcaster)
 
+    async def subscribe_user_authorization_granted(self):
+        return await self._http.create_subscription(
+            models.SubscriptionTypes.user_authorization_grant, {"client_id": self.client._http.client_id}
+        )
+
     async def subscribe_user_authorization_revoked(self):
         return await self._http.create_subscription(
             models.SubscriptionTypes.user_authorization_revoke, {"client_id": self.client._http.client_id}