Add websocket_welcome event docs

Author: EvieePy

docs/references/events/events.rst

@@ -360,6 +360,13 @@ Client Events
 
   :param SubscriptionRevoked payload: The payload containing token information.
 
+.. py:function:: event_websocket_welcome(payload: ~models.eventsub_.WebsocketWelcome) -> None
+  :async:
+
+  Event dispatched when a websocket successfully connects to Twitch via Eventsub or Conduits.
+
+  :param WebsocketWelcome payload: The payload containing information about the connected websocket.
+
 
 Commands Events
 ###############
@@ -1384,4 +1391,9 @@ Payloads
 .. attributetable:: twitchio.TokenRefreshedPayload
 
 .. autoclass:: twitchio.TokenRefreshedPayload()
-  :members:
+  :members:
+
+.. attributetable:: twitchio.WebsocketWelcome
+
+.. autoclass:: twitchio.WebsocketWelcome()
+  :members:

twitchio/eventsub/websockets.py

@@ -450,7 +450,6 @@ async def _process_welcome(self, data: WelcomeMessage) -> None:
 
         self._listen_task.set_name(f"EventsubWebsocketListener: {self._session_id}")
 
-        # TODO: Document Event
         if self._client:
             event = WebsocketWelcome(payload["session"])
             self._client.dispatch("websocket_welcome", payload=event)

twitchio/models/eventsub_.py

@@ -5568,17 +5568,26 @@ def __repr__(self) -> str:
 
 
 class WebsocketWelcome:
-    # TODO: Docs...
+    """The model received in the :func:`~twitchio.event_websocket_welcome` event.
+
+    Attributes
+    ----------
+    id: str
+        The ID associated with the Websocket, received from Twitch in "session_welcome".
+    keepalive_timeout_seconds: int
+        The keepalive timeout as an :class:`int` sent and confirmed by Twitch.
+    connected_at: :class:`datetime.datetime`
+        A :class:`datetime.datetime` representing when this websocket officially connected.
+    """
+
     def __init__(self, data: WelcomeSession) -> None:
         self.id: str = data["id"]
-        self.status: Literal["connected"] = "connected"
         self.keepalive_timeout_seconds: int = data["keepalive_timeout_seconds"]
-        self.reconnect_url: None = None
-        self.connected_at: str = data["connected_at"]
+        self.connected_at: datetime.datetime = parse_timestamp(data["connected_at"])
 
 
 class ConduitShard:
-    """ConduitInfo model containing various information about a Shard on a :class:`~twitchio.Conduit`.
+    """ConduitShard model containing various information about a Shard on a :class:`~twitchio.Conduit`.
 
     Attributes
     ----------
@@ -5729,6 +5738,11 @@ async def update(self, shard_count: int, /) -> Conduit:
 
         Method which updates the underlying Conduit on the Twitch API with the provided ``shard_count``.
 
+        .. important::
+
+            If you are using :class:`~twitchio.AutoClient` or :class:`~twitchio.ext.commands.AutoBot` this will not
+            update the underlying websocket connections. See: :meth:`~twitchio.ConduitInfo.update_shard_count` instead.
+
         Parameters
         ----------
         shard_count: int