Bits Use Subscription

Author: chillymosh

docs/references/eventsub_subscriptions.rst

@@ -34,6 +34,11 @@ Eventsub Subscriptions
 .. autoclass:: AutomodTermsUpdateSubscription
     :members:
 
+.. attributetable:: ChannelBitsUseSubscription
+
+.. autoclass:: ChannelBitsUseSubscription
+    :members:
+
 .. attributetable:: ChannelUpdateSubscription
 
 .. autoclass:: ChannelUpdateSubscription

twitchio/client.py

@@ -333,7 +333,7 @@ async def login(self, *, token: str | None = None, load_tokens: bool = True, sav
         if self._bot_id:
             logger.debug("Fetching Clients self user for %r", self)
             partial = PartialUser(id=self._bot_id, http=self._http)
-            self._user = partial if not self._fetch_self else await partial.user()
+            self._user = await partial.user() if self._fetch_self else partial
 
         await self.setup_hook()
 

twitchio/eventsub/enums.py

@@ -99,6 +99,7 @@ class SubscriptionType(enum.Enum):
     ChannelUpdate: Literal["channel.update"]
     ChannelFollow: Literal["channel.follow"]
     ChannelAdBreakBegin: Literal["channel.ad_break.begin"]
+    ChannelBitsUseSubscription: Literal["channel.bits.use"]
     ChannelChatClear: Literal["channel.chat.clear"]
     ChannelChatClearUserMessages: Literal["channel.chat.clear_user_messages"]
     ChannelChatMessage: Literal["channel.chat.message"]
@@ -172,6 +173,7 @@ class SubscriptionType(enum.Enum):
     AutomodMessageUpdate = "automod.message.update"
     AutomodSettingsUpdate = "automod.settings.update"
     AutomodTermsUpdate = "automod.terms.update"
+    ChannelBitsUse = "channel.bits.use"
     ChannelUpdate = "channel.update"
     ChannelFollow = "channel.follow"
     ChannelAdBreakBegin = "channel.ad_break.begin"

twitchio/eventsub/subscriptions.py

@@ -43,6 +43,7 @@
     "AutomodSettingsUpdateSubscription",
     "AutomodTermsUpdateSubscription",
     "ChannelBanSubscription",
+    "ChannelBitsUseSubscription",
     "ChannelCheerSubscription",
     "ChannelFollowSubscription",
     "ChannelModerateSubscription",
@@ -115,6 +116,7 @@
 # Short names: Only map names that require shortening...
 _SUB_MAPPING: dict[str, str] = {
     "channel.ad_break.begin": "ad_break",
+    "channel.bits.use": "bits_use",
     "channel.chat.clear_user_messages": "chat_clear_user",
     "channel.chat.message": "message",  # Sub events?
     "channel.chat.message_delete": "message_delete",
@@ -404,6 +406,51 @@ def condition(self) -> Condition:
         return {"broadcaster_user_id": self.broadcaster_user_id, "moderator_user_id": self.moderator_user_id}
 
 
+class ChannelBitsUseSubscription(SubscriptionPayload):
+    """The ``channel.bits.use`` subscription type sends a notification whenever Bits are used on a channel.
+
+    This event is designed to be an all-purpose event for when Bits are used in a channel and might be updated in the future as more Twitch features use Bits.
+
+    Currently, this event will be sent when a user:
+
+    - Cheers in a channel
+    - Uses a Power-up
+        - Will not emit when a streamer uses a Power-up for free in their own channel.
+
+    .. important::
+        Requires a user access token that includes the ``bits:read`` scope. This must be the broadcaster's token.
+
+        Bits transactions via Twitch Extensions are not included in this subscription type.
+
+    One attribute ``.condition`` can be accessed from this class, which returns a mapping of the subscription
+    parameters provided.
+
+    Parameters
+    ----------
+    broadcaster_user_id: str | PartialUser
+        The ID, or PartialUser, of the broadcaster to subscribe to.
+
+    Raises
+    ------
+    ValueError
+        The parameters "broadcaster_user_id" must be passed.
+    """
+
+    type: ClassVar[Literal["channel.bits.use"]] = "channel.bits.use"
+    version: ClassVar[Literal["1"]] = "1"
+
+    @handle_user_ids()
+    def __init__(self, **condition: Unpack[Condition]) -> None:
+        self.broadcaster_user_id: str = condition.get("broadcaster_user_id", "")
+
+        if not self.broadcaster_user_id:
+            raise ValueError('The parameter "broadcaster_user_id" must be passed.')
+
+    @property
+    def condition(self) -> Condition:
+        return {"broadcaster_user_id": self.broadcaster_user_id}
+
+
 class ChannelUpdateSubscription(SubscriptionPayload):
     """The ``channel.update`` subscription type sends notifications when a broadcaster updates the category, title, content classification labels, or broadcast language for their channel.
 

twitchio/ext/commands/core.py

@@ -168,7 +168,7 @@ def __str__(self) -> str:
 
     async def __call__(self, context: Context) -> Any:
         callback = self._callback(self._injected, context) if self._injected else self._callback(context)  # type: ignore
-        return await callback
+        return await callback  # type: ignore will fix later
 
     @property
     def component(self) -> Component_T | None:
@@ -197,7 +197,7 @@ def relative_name(self) -> str:
 
         If this command has no parent, this simply returns the name.
         """
-        return self._name if not self._parent else f"{self._parent._name} {self._name}"
+        return f"{self._parent._name} {self._name}" if self._parent else self._name
 
     @property
     def full_parent_name(self) -> str:

twitchio/types_/eventsub.py

@@ -42,6 +42,7 @@
     "BaseEmoteData",
     "ChannelAdBreakBeginEvent",
     "ChannelBanEvent",
+    "ChannelBitsUseEvent",
     "ChannelChatClearEvent",
     "ChannelChatClearUserMessagesEvent",
     "ChannelChatMessageDeleteEvent",
@@ -355,6 +356,24 @@ class ChannelAdBreakBeginEvent(BaseBroadcasterEvent):
     is_automatic: str
 
 
+class PowerUpEmote(TypedDict):
+    id: str
+    name: str
+
+
+class PowerUpData(TypedDict):
+    type: Literal["message_effect", "celebration", "gigantify_an_emote"]
+    emote: PowerUpEmote | None
+    message_effect_id: str | None
+
+
+class ChannelBitsUseEvent(BroadcasterUserEvent):
+    bits: int
+    type: Literal["cheer", "power_up"]
+    message: ChatMessageData
+    power_up: PowerUpData | None
+
+
 class ChannelChatClearEvent(BaseBroadcasterEvent): ...