allow for message in bits used event to be None (#528)

* allow for message in bits used event to be None

* text is None if message is None

Author: jrutschke

docs/getting-started/changelog.rst

@@ -27,6 +27,7 @@ Changelog
     - Bug fixes
         - Fix :func:`~twitchio.utils.setup_logging` breaking coloured formatting on `CRITICAL` logging level
         - Fix :class:`~models.eventsub_.ChannelPointsAutoRedeemAdd` now accounts for attribute message in payload to be None
+        - Fix :class:`~models.eventsub_.ChannelBitsUse` now accounts for attribute message in payload to be None
 
 
 3.1.0

twitchio/models/eventsub_.py

@@ -874,12 +874,12 @@ class ChannelBitsUse(_ResponderEvent):
         The redeeming user.
     bits: int
         The number of Bits used.
-    type: typing.Literal["cheer", "power_up"]
+    type: typing.Literal["cheer", "power_up", "combo"]
         What the Bits were used for.
     text: str | None
         The chat message in plain text. Is `None` if no chat message was used.
     fragments: list[ChatMessageFragment]
-        The ordered list of chat message fragments. Is `None` if no chat message was used.
+        The ordered list of chat message fragments. This is only populated for Bits uses that contain a message.
     power_up: PowerUp | None
         Data about Power-up. Is `None` if a Power-up is not used.
     """
@@ -894,13 +894,13 @@ def __init__(self, payload: ChannelBitsUseEvent, *, http: HTTPClient) -> None:
         )
         self.user = PartialUser(payload["user_id"], payload["user_login"], payload["user_name"], http=http)
         self.bits: int = int(payload["bits"])
-        self.type: Literal["cheer", "power_up"] = payload["type"]
-        self.text: str | None = payload.get("message").get("text")
+        self.type: Literal["cheer", "power_up", "combo"] = payload["type"]
+        message = payload.get("message") or {}
+        self.text: str | None = message.get("text")
         power_up = payload.get("power_up")
         self.power_up: PowerUp | None = PowerUp(power_up) if power_up is not None else None
-        self.fragments: list[ChatMessageFragment] = [
-            ChatMessageFragment(fragment, http=http) for fragment in payload["message"]["fragments"]
-        ]
+        fragments = message.get("fragments", [])
+        self.fragments: list[ChatMessageFragment] = [ChatMessageFragment(f, http=http) for f in fragments]
 
     def __repr__(self) -> str:
         return f"<ChannelBitsUse broadcaster={self.broadcaster} user={self.user} bits={self.bits} type={self.type}>"

twitchio/types_/eventsub.py

@@ -376,8 +376,8 @@ class PowerUpData(TypedDict):
 
 class ChannelBitsUseEvent(BroadcasterUserEvent):
     bits: int
-    type: Literal["cheer", "power_up"]
-    message: ChatMessageData
+    type: Literal["cheer", "power_up", "combo"]
+    message: ChatMessageData | None
     power_up: PowerUpData | None