Merge branch 'main' of https://github.com/PythonistaGuild/TwitchIO

PythonistaGuild · Feb 19, 2025 · 9e3f8d7 · 9e3f8d7
2 parents d576505 + 89d50c8
commit 9e3f8d7
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/docs/references/events.rst b/docs/references/events.rst
@@ -327,7 +327,7 @@ Client Events
 
   :param UserTokenPayload payload: The payload containing token information.
 
-.. py:function:: event_subscription_revoked(payload: twitchio.models.eventsub_.SubscriptionRevoked) -> None
+.. py:function:: event_subscription_revoked(payload: ~models.eventsub_.SubscriptionRevoked) -> None
   :async:
 
   Event dispatched when Twitch revokes a subscription. This can occur on websockets and webhooks.

diff --git a/docs/references/eventsub_models.rst b/docs/references/eventsub_models.rst
@@ -506,6 +506,11 @@ Eventsub
 .. autoclass:: twitchio.StreamOffline()
     :members:
 
+.. attributetable:: twitchio.SubscriptionRevoked
+
+.. autoclass:: twitchio.SubscriptionRevoked()
+    :members:
+
 .. attributetable:: twitchio.UserAuthorizationGrant
 
 .. autoclass:: twitchio.UserAuthorizationGrant()

diff --git a/twitchio/models/eventsub_.py b/twitchio/models/eventsub_.py
@@ -5004,6 +5004,31 @@ def __repr__(self) -> str:
 
 
 class SubscriptionRevoked:
+    """Represents a revoked eventsub subscription by Twitch.
+
+    Attributes
+    ----------
+    id: str
+        The ID of the subscription that has been revoked.
+    raw: RevocationSubscription
+        The raw payload of the revoked subscription as a TypedDict.
+    status: RevocationReason
+        The status provides the reason as to why the subscription was revoked by Twitch.
+    type: str
+        The type of subscription that was revoked e.g. `channel.follow`.
+    version: str
+        The version of the subscription e.g. `1` or `2`.
+    cost: int
+        The cost of the subscription.
+    transport_method: TransportMethod
+        The transport method of the subscription.
+    transport_data: RevocationTransport
+        The data pertaining to the transport of the subscription.
+        This will contain `session_id` or `callback` url depending on the transport method.
+    created_at: datetime.datetime
+        The datetime that the subscription was created.
+    """
+
     __slots__ = (
         "cost",
         "created_at",