feat: added new topic "Channel Shared Chat Session Begin"

Author: Teekeks

twitchAPI/eventsub/__init__.py

@@ -323,4 +323,9 @@
      - Function: :const:`~twitchAPI.eventsub.base.EventSubBase.listen_channel_chat_user_message_update()` |br|
        Payload: :const:`~twitchAPI.object.eventsub.ChannelChatUserMessageUpdateEvent`
      - A user is notified if their message’s automod status is updated.
+   * - **Channel Shared Chat Session Begin**
+     - Function: :const:`~twitchAPI.eventsub.base.EventSubBase.listen_channel_shared_chat_begin()` |br|
+       Payload: :const:`~twitchAPI.object.eventsub.ChannelSharedChatBeginEvent`
+     - A notification when a channel becomes active in an active shared chat session.
+
 """

twitchAPI/eventsub/base.py

@@ -28,7 +28,8 @@
                                        ChannelVIPRemoveEvent, ChannelUnbanRequestCreateEvent, ChannelUnbanRequestResolveEvent,
                                        ChannelSuspiciousUserMessageEvent, ChannelSuspiciousUserUpdateEvent, ChannelModerateEvent,
                                        ChannelWarningAcknowledgeEvent, ChannelWarningSendEvent, AutomodMessageHoldEvent, AutomodMessageUpdateEvent,
-                                       AutomodSettingsUpdateEvent, AutomodTermsUpdateEvent, ChannelChatUserMessageHoldEvent, ChannelChatUserMessageUpdateEvent)
+                                       AutomodSettingsUpdateEvent, AutomodTermsUpdateEvent, ChannelChatUserMessageHoldEvent, ChannelChatUserMessageUpdateEvent,
+                                       ChannelSharedChatBeginEvent)
 from twitchAPI.helper import remove_none_values
 from twitchAPI.type import TwitchAPIException
 import asyncio
@@ -1894,3 +1895,25 @@ async def listen_channel_chat_user_message_update(self,
             'user_id': user_id
         }
         return await self._subscribe('channel.chat.user_message_update', '1', param, callback, ChannelChatUserMessageUpdateEvent)
+
+    async def listen_channel_shared_chat_begin(self,
+                                               broadcaster_user_id: str,
+                                               callback: Callable[[ChannelSharedChatBeginEvent], Awaitable[None]]) -> str:
+        """A notification when a channel becomes active in an active shared chat session.
+
+        For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshared_chatbegin
+
+        :param broadcaster_user_id: The User ID of the channel to receive shared chat session begin events for.
+        :param callback: function for callback
+        :raises ~twitchAPI.type.EventSubSubscriptionConflict: if a conflict was found with this subscription
+            (e.g. already subscribed to this exact topic)
+        :raises ~twitchAPI.type.EventSubSubscriptionTimeout: if :const:`~twitchAPI.eventsub.webhook.EventSubWebhook.wait_for_subscription_confirm`
+            is true and the subscription was not fully confirmed in time
+        :raises ~twitchAPI.type.EventSubSubscriptionError: if the subscription failed (see error message for details)
+        :raises ~twitchAPI.type.TwitchBackendException: if the subscription failed due to a twitch backend error
+        :returns: The id of the topic subscription
+        """
+        param = {
+            'broadcaster_user_id': broadcaster_user_id,
+        }
+        return await self._subscribe('channel.shared_chat.begin', '1', param, callback, ChannelSharedChatBeginEvent)

twitchAPI/object/eventsub.py

@@ -23,7 +23,7 @@
            'ChannelVIPAddEvent', 'ChannelVIPRemoveEvent', 'ChannelUnbanRequestCreateEvent', 'ChannelUnbanRequestResolveEvent',
            'ChannelSuspiciousUserMessageEvent', 'ChannelSuspiciousUserUpdateEvent', 'ChannelModerateEvent', 'ChannelWarningAcknowledgeEvent',
            'ChannelWarningSendEvent', 'AutomodMessageHoldEvent', 'AutomodMessageUpdateEvent', 'AutomodSettingsUpdateEvent',
-           'AutomodTermsUpdateEvent', 'ChannelChatUserMessageHoldEvent', 'ChannelChatUserMessageUpdateEvent',
+           'AutomodTermsUpdateEvent', 'ChannelChatUserMessageHoldEvent', 'ChannelChatUserMessageUpdateEvent', 'ChannelSharedChatBeginEvent',
            'Subscription', 'ChannelPollBeginData', 'PollChoice', 'BitsVoting', 'ChannelPointsVoting', 'ChannelUpdateData', 'ChannelFollowData',
            'ChannelSubscribeData', 'ChannelSubscriptionEndData', 'ChannelSubscriptionGiftData', 'ChannelSubscriptionMessageData',
            'SubscriptionMessage', 'Emote', 'ChannelCheerData', 'ChannelRaidData', 'ChannelBanData', 'ChannelUnbanData', 'ChannelModeratorAddData',
@@ -47,7 +47,8 @@
            'ModerateMetadataUnvip', 'ModerateMetadataUntimeout', 'ModerateMetadataUnraid', 'ModerateMetadataUnban', 'ModerateMetadataUnbanRequest',
            'ModerateMetadataAutomodTerms', 'ModerateMetadataBan', 'ModerateMetadataMod', 'ModerateMetadataVip', 'ModerateMetadataRaid',
            'ModerateMetadataFollowers', 'ChannelModerateData', 'ChannelWarningAcknowledgeData', 'ChannelWarningSendData', 'AutomodMessageHoldData',
-           'AutomodMessageUpdateData', 'AutomodSettingsUpdateData', 'AutomodTermsUpdateData', 'ChannelChatUserMessageHoldData', 'ChannelChatUserMessageUpdateData']
+           'AutomodMessageUpdateData', 'AutomodSettingsUpdateData', 'AutomodTermsUpdateData', 'ChannelChatUserMessageHoldData', 'ChannelChatUserMessageUpdateData',
+           'SharedChatParticipant', 'ChannelSharedChatBeginData']
 
 
 # Event Data
@@ -2228,6 +2229,33 @@ class ChannelChatUserMessageUpdateData(TwitchObject):
     """The body of the message."""
 
 
+class SharedChatParticipant(TwitchObject):
+    broadcaster_user_id: str
+    """The User ID of the participant channel."""
+    broadcaster_user_name: str
+    """The display name of the participant channel."""
+    broadcaster_user_login: str
+    """The user login of the participant channel."""
+
+
+class ChannelSharedChatBeginData(TwitchObject):
+    session_id: str
+    """The unique identifier for the shared chat session."""
+    broadcaster_user_id: str
+    """The User ID of the channel in the subscription condition which is now active in the shared chat session."""
+    broadcaster_user_name: str
+    """The display name of the channel in the subscription condition which is now active in the shared chat session."""
+    broadcaster_user_login: str
+    """The user login of the channel in the subscription condition which is now active in the shared chat session."""
+    host_broadcaster_user_id: str
+    """The User ID of the host channel."""
+    host_broadcaster_user_name: str
+    """The display name of the host channel."""
+    host_broadcaster_user_login: str
+    """The user login of the host channel."""
+    participants: List[SharedChatParticipant]
+    """The list of participants in the session."""
+
 # Events
 
 class ChannelPollBeginEvent(TwitchObject):
@@ -2544,3 +2572,8 @@ class ChannelChatUserMessageUpdateEvent(TwitchObject):
     subscription: Subscription
     event: ChannelChatUserMessageUpdateData
 
+
+class ChannelSharedChatBeginEvent(TwitchObject):
+    subscription: Subscription
+    event: ChannelSharedChatBeginData
+