Models

`AutomodHoldEventV1` ¶

Bases: NamedTuple

Represents an automod hold event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User whose message was held.
`message_id`	`str`	Unique identifier for the held message.
`message`	`EventMessage`	Content of the held message.
`category`	`str`	Automod category that triggered the hold.
`level`	`int`	Severity level of the automod detection.
`held_at`	`datetime`	Timestamp when the message was held.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`AutomodHoldEventV2` ¶

Bases: NamedTuple

Represents an automod hold event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User whose message was held.
`message_id`	`str`	Unique identifier for the held message.
`message`	`EventMessage`	Content of the held message.
`held_at`	`datetime`	Timestamp when the message was held.
`reason`	`Literal['automod', 'blocked_term']`	Reason why the message was held.
`automod`	`Optional[EventAutomod]`	Automod detection details if reason is automod.
`blocked_term`	`Optional[EventBlockedTerms]`	Blocked term details if reason is blocked_term.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`AutomodUpdateEventV1` ¶

Bases: NamedTuple

Represents an automod update event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User whose message was updated.
`moderator_user`	`UserIdentity`	Moderator who performed the update.
`message_id`	`str`	Unique identifier for the updated message.
`message`	`EventMessage`	Content of the updated message.
`category`	`str`	Automod category that was involved.
`level`	`int`	Severity level of the automod detection.
`status`	`Literal['Approved', 'Denied', 'Expired']`	Final status of the message.
`held_at`	`datetime`	Timestamp when the message was originally held.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`AutomodUpdateEventV2` ¶

Bases: NamedTuple

Represents an automod update event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User whose message was updated.
`moderator_user`	`UserIdentity`	Moderator who performed the update.
`message_id`	`str`	Unique identifier for the updated message.
`message`	`EventMessage`	Content of the updated message.
`status`	`Literal['Approved', 'Denied', 'Expired']`	Final status of the message.
`held_at`	`datetime`	Timestamp when the message was originally held.
`reason`	`Literal['automod', 'blocked_term']`	Reason why the message was originally held.
`automod`	`Optional[EventAutomod]`	Automod detection details if reason is automod.
`blocked_term`	`Optional[EventBlockedTerms]`	Blocked term details if reason is blocked_term.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`AutomodSettingsUpdateEvent` ¶

Bases: NamedTuple

Represents an automod settings update event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who updated the settings.
`bullying`	`int`	Bullying detection level setting.
`overall_level`	`Optional[int]`	Overall automod level setting.
`disability`	`int`	Disability-related content detection level.
`race_ethnicity_or_religion`	`int`	Race, ethnicity, or religion content detection level.
`misogyny`	`int`	Misogyny detection level setting.
`sexuality_sex_or_gender`	`int`	Sexuality, sex, or gender content detection level.
`aggression`	`int`	Aggression detection level setting.
`sex_based_terms`	`int`	Sex-based terms detection level setting.
`swearing`	`int`	Swearing detection level setting.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`AutomodTermsUpdateEvent` ¶

Bases: NamedTuple

Represents an automod terms update event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who updated the terms.
`action`	`Literal['add_permitted', 'remove_permitted', 'add_blocked', 'remove_blocked']`	Action performed on the terms.
`from_automod`	`bool`	Whether the update originated from automod.
`terms`	`Tuple[str, ...]`	Collection of terms that were updated.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`total_terms` `property` ¶

Return the total number of terms in the collection.

Returns:

Type	Description
`int`	The number of terms that were updated.

`ChannelBitsUseEvent` ¶

Bases: NamedTuple

Represents a channel bits use event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who used the bits.
`bits`	`int`	Number of bits used.
`type`	`Literal['cheer', 'power_up']`	Type of bits usage.
`message`	`Optional[EventMessage]`	Message associated with the bits usage
`power_up`	`Optional[EventPowerUp]`	Power-up associated with the bits usage
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelUpdateEvent` ¶

Bases: NamedTuple

Represents a channel update event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`title`	`str`	Updated stream title.
`language`	`str`	Stream language.
`category_id`	`str`	Category ID of the stream.
`category_name`	`str`	Category name of the stream.
`content_classification_labels`	`Tuple[str, ...]`	Content classification labels applied to the stream.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelFollowEvent` ¶

Bases: NamedTuple

Represents a channel follow event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who followed the channel.
`followed_at`	`datetime`	Timestamp when the follow occurred.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelAdBreakBeginEvent` ¶

Bases: NamedTuple

Represents a channel ad break begin event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`duration_seconds`	`int`	Duration of the ad break in seconds.
`started_at`	`datetime`	Timestamp when the ad break started.
`is_automatic`	`bool`	Whether the ad break was automatically triggered.
`requester_user`	`UserIdentity`	User who requested the ad break.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatClearEvent` ¶

Bases: NamedTuple

Represents a channel chat clear event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatClearUserMessagesEvent` ¶

Bases: NamedTuple

Represents a channel chat clear user messages event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`target_user`	`UserIdentity`	User whose messages were cleared.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatMessageEvent` ¶

Bases: NamedTuple

Represents a channel chat message event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`chatter`	`UserIdentity`	User who sent the message.
`message_id`	`str`	Unique identifier for the message.
`message`	`EventMessage`	Message content and metadata.
`message_type`	`Literal['text', 'channel_points_highlighted', 'channel_points_sub_only', 'user_intro', 'power_ups_message_effect', 'power_ups_gigantified_emote']`	Type of the chat message.
`badges`	`Tuple[EventChatBadge, ...]`	Chat badges associated with the user.
`cheer`	`Optional[dict[str, int]]`	Cheer information if the message contains bits.
`color`	`str`	Color of the user's name in chat.
`reply`	`Optional[EventReply]`	Reply information if this message is a reply.
`channel_points_custom_reward_id`	`Optional[str]`	Custom reward ID if message is associated with channel points.
`source_broadcaster_user`	`Optional[UserIdentity]`	Source broadcaster user for shared chat messages.
`source_message_id`	`Optional[str]`	Source message ID for shared chat messages.
`source_badges`	`Optional[Tuple[EventChatBadge, ...]]`	Source badges for shared chat messages.
`is_source_only`	`Optional[bool]`	Whether the message is source-only for shared chat.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatMessageDeleteEvent` ¶

Bases: NamedTuple

Represents a channel chat message delete event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`target_user`	`UserIdentity`	User whose message was deleted.
`message_id`	`str`	ID of the deleted message.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatNotificationEvent` ¶

Bases: NamedTuple

Represents a channel chat notification event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`chatter_user`	`Optional[UserIdentity]`	User who triggered the notification
`chatter_is_anonymous`	`bool`	Whether the chatter is anonymous.
`color`	`str`	Color of the notification.
`badges`	`Tuple[EventChatBadge, ...]`	Chat badges associated with the user.
`system_message`	`str`	System-generated message for the notification.
`message_id`	`str`	Unique identifier for the notification message.
`message`	`EventMessage`	Message content and metadata.
`notice_type`	`Literal[...]`	Type of notification event.
`sub`	`Optional[EventSub]`	Subscription information
`resub`	`Optional[EventResub]`	Resubscription information
`sub_gift`	`Optional[EventSubGift]`	Subscription gift information
`community_sub_gift`	`Optional[EventCommunitySubGift]`	Community subscription gift information
`gift_paid_upgrade`	`Optional[dict]`	Gift paid upgrade information
`prime_paid_upgrade`	`Optional[dict]`	Prime paid upgrade information
`pay_it_forward`	`Optional[dict]`	Pay it forward information
`raid`	`Optional[EventRaid]`	Raid information
`unraid`	`Optional[dict]`	Unraid information
`announcement`	`Optional[EventAnnouncement]`	Announcement information
`bits_badge_tier`	`Optional[EventBits]`	Bits badge tier information
`charity_donation`	`Optional[EventCharityDonation]`	Charity donation information
`source_broadcaster_user`	`Optional[UserIdentity]`	Source broadcaster user for shared chat notifications.
`source_message_id`	`Optional[str]`	Source message ID for shared chat notifications.
`source_badges`	`Optional[Tuple[EventChatBadge, ...]]`	Source badges for shared chat notifications.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatSettingsUpdateEvent` ¶

Bases: NamedTuple

Represents an event for updating channel chat settings.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`emote_mode`	`bool`	Whether emote-only mode is enabled.
`follower_mode`	`bool`	Whether follower-only mode is enabled.
`follower_mode_duration_minutes`	`Optional[int]`	Duration in minutes for follower-only mode
`slow_mode`	`bool`	Whether slow mode is enabled.
`slow_mode_wait_time_seconds`	`Optional[int]`	Wait time in seconds for slow mode
`subscriber_mode`	`bool`	Whether subscriber-only mode is enabled.
`unique_chat_mode`	`bool`	Whether unique chat (r9k) mode is enabled.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatUserMessageHoldEvent` ¶

Bases: NamedTuple

Represents a channel chat message hold event, where a message is held for moderation.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who sent the held message.
`message_id`	`str`	Unique identifier for the held message.
`message`	`EventMessage`	Content and metadata of the held message.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelChatUserMessageUpdateEvent` ¶

Bases: NamedTuple

Represents an update to a held channel chat message (e.g., approved or denied).

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who sent the message.
`message_id`	`str`	Unique identifier for the message.
`message`	`EventMessage`	Content and metadata of the message.
`status`	`Literal['approved', 'denied', 'expired']`	Status of the message after moderation.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSharedChatBeginEvent` ¶

Bases: NamedTuple

Represents the start of a shared chat session between channels.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information for the local channel.
`session_id`	`str`	Unique identifier for the shared chat session.
`host_broadcaster_user`	`UserIdentity`	Host broadcaster user information.
`participants`	`Tuple[EventSharedChatParticipant, ...]`	List of participants in the shared chat session.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSharedChatUpdateEvent` ¶

Bases: NamedTuple

Represents an update to a shared chat session.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information for the local channel.
`session_id`	`str`	Unique identifier for the shared chat session.
`host_broadcaster_user`	`UserIdentity`	Host broadcaster user information.
`participants`	`Tuple[EventSharedChatParticipant, ...]`	Updated list of participants in the shared chat session.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSharedChatEndEvent` ¶

Bases: NamedTuple

Represents the end of a shared chat session.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information for the local channel.
`session_id`	`str`	Unique identifier for the shared chat session.
`host_broadcaster_user`	`UserIdentity`	Host broadcaster user information.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSubscribeEvent` ¶

Bases: NamedTuple

Represents a channel subscription event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who subscribed.
`tier`	`Literal['1000', '2000', '3000']`	Subscription tier level.
`is_gift`	`bool`	Whether the subscription was a gift.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSubscriptionEndEvent` ¶

Bases: NamedTuple

Represents the end of a channel subscription.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User whose subscription ended.
`tier`	`Literal['1000', '2000', '3000']`	Subscription tier level.
`is_gift`	`bool`	Whether the subscription was a gift.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSubscriptionGiftEvent` ¶

Bases: NamedTuple

Represents a channel subscription gift event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who gifted the subscriptions.
`total`	`int`	Total number of subscriptions gifted.
`tier`	`Literal['1000', '2000', '3000']`	Subscription tier level.
`cumulative_total`	`Optional[int]`	Cumulative total of gifted subscriptions by the user
`is_anonymous`	`bool`	Whether the gift was anonymous.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSubscriptionMessageEvent` ¶

Bases: NamedTuple

Represents a channel subscription message event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who sent the subscription message.
`tier`	`Literal['1000', '2000', '3000']`	Subscription tier level.
`message`	`EventSubscriptionMessage`	Subscription message content and metadata.
`cumulative_months`	`int`	Total months the user has been subscribed.
`streak_months`	`Optional[int]`	Current subscription streak
`duration_months`	`int`	Duration of the subscription in months.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelCheerEvent` ¶

Bases: NamedTuple

Represents a channel cheer event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`Optional[UserIdentity]`	User who cheered, if not anonymous.
`is_anonymous`	`bool`	Whether the cheer is anonymous.
`message`	`str`	Message included with the cheer.
`bits`	`int`	Number of bits cheered.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelRaidEvent` ¶

Bases: NamedTuple

Represents a channel raid event.

Attributes:

Name	Type	Description
`from_broadcaster_user`	`UserIdentity`	Broadcaster user who initiated the raid.
`to_broadcaster_user`	`UserIdentity`	Broadcaster user who received the raid.
`viewers`	`int`	Number of viewers in the raid.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelBanEvent` ¶

Bases: NamedTuple

Represents a channel ban event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who was banned.
`moderator_user`	`UserIdentity`	Moderator who performed the ban.
`reason`	`str`	Reason for the ban.
`banned_at`	`datetime`	Timestamp when the user was banned.
`ends_at`	`Optional[datetime]`	Timestamp when the ban expires
`is_permanent`	`bool`	Whether the ban is permanent.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelUnbanEvent` ¶

Bases: NamedTuple

Represents a channel unban event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who was unbanned.
`moderator_user`	`UserIdentity`	Moderator who performed the unban.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelUnbanRequestCreateEvent` ¶

Bases: NamedTuple

Represents the creation of a channel unban request.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who submitted the unban request.
`id`	`str`	Unique identifier for the unban request.
`text`	`str`	Text submitted with the unban request.
`created_at`	`datetime`	Timestamp when the unban request was created.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelUnbanRequestResolveEvent` ¶

Bases: NamedTuple

Represents the resolution of a channel unban request.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who submitted the unban request.
`moderator_user`	`UserIdentity`	Moderator who resolved the request.
`id`	`str`	Unique identifier for the unban request.
`resolution_text`	`str`	Text provided with the resolution.
`status`	`Literal['approved', 'denied']`	Resolution status of the unban request.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelModerateEventV1` ¶

Bases: NamedTuple

Represents a channel moderation event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who performed the action.
`source_broadcaster_user`	`UserIdentity`	Source broadcaster for shared chat actions.
`action`	`Literal['ban', 'timeout', 'unban', 'untimeout', 'clear', 'emoteonly', 'emoteonlyoff',`	`'followers', 'followersoff', 'uniquechat', 'uniquechatoff', 'slow', 'slowoff', 'subscribers', 'subscribersoff', 'unraid', 'delete', 'unvip', 'vip', 'raid', 'add_blocked_term', 'add_permitted_term', 'remove_blocked_term', 'remove_permitted_term', 'mod', 'unmod', 'approve_unban_request', 'deny_unban_request', 'shared_chat_ban', 'shared_chat_timeout', 'shared_chat_untimeout', 'shared_chat_unban', 'shared_chat_delete']` The moderation action performed.
`followers`	`Optional[EventModerationFollowers]`	Follower mode settings
`slow`	`Optional[EventModerationSlow]`	Slow mode settings
`vip`	`Optional[UserIdentity]`	User added as VIP
`unvip`	`Optional[UserIdentity]`	User removed as VIP
`mod`	`Optional[UserIdentity]`	User added as moderator
`unmod`	`Optional[UserIdentity]`	User removed as moderator
`ban`	`Optional[EventModerationBan]`	Ban information
`unban`	`Optional[UserIdentity]`	Unbanned user information
`timeout`	`Optional[EventModerationTimeout]`	Timeout information
`untimeout`	`Optional[UserIdentity]`	Untimed-out user information
`raid`	`Optional[EventRaid]`	Raid information
`unraid`	`Optional[UserIdentity]`	Unraid information
`delete`	`Optional[EventModerationDelete]`	Message deletion information
`automod_terms`	`Optional[EventModerationAutomodTerms]`	Automod terms update information
`unban_request`	`Optional[EventModerationUnbanRequest]`	Unban request resolution information
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelModerateEventV2` ¶

Bases: NamedTuple

Represents a channel moderation event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who performed the action.
`source_broadcaster_user`	`UserIdentity`	Source broadcaster for shared chat actions.
`action`	`Literal['ban', 'timeout', 'unban', 'untimeout', 'clear', 'emoteonly', 'emoteonlyoff',`	`'followers', 'followersoff', 'uniquechat', 'uniquechatoff', 'slow', 'slowoff', 'subscribers', 'subscribersoff', 'unraid', 'delete', 'unvip', 'vip', 'raid', 'add_blocked_term', 'add_permitted_term', 'remove_blocked_term', 'remove_permitted_term', 'mod', 'unmod', 'approve_unban_request', 'deny_unban_request', 'warn', 'shared_chat_ban', 'shared_chat_timeout', 'shared_chat_untimeout', 'shared_chat_unban', 'shared_chat_delete']` The moderation action performed.
`followers`	`Optional[EventModerationFollowers]`	Follower mode settings
`slow`	`Optional[EventModerationSlow]`	Slow mode settings
`vip`	`Optional[UserIdentity]`	User added as VIP
`unvip`	`Optional[UserIdentity]`	User removed as VIP
`mod`	`Optional[UserIdentity]`	User added as moderator
`unmod`	`Optional[UserIdentity]`	User removed as moderator
`ban`	`Optional[EventModerationBan]`	Ban information
`unban`	`Optional[UserIdentity]`	Unbanned user information
`timeout`	`Optional[EventModerationTimeout]`	Timeout information
`untimeout`	`Optional[UserIdentity]`	Untimed-out user information
`raid`	`Optional[EventRaid]`	Raid information
`unraid`	`Optional[UserIdentity]`	Unraid information
`delete`	`Optional[EventModerationDelete]`	Message deletion information
`automod_terms`	`Optional[EventModerationAutomodTerms]`	Automod terms update information
`unban_request`	`Optional[EventModerationUnbanRequest]`	Unban request resolution information
`warn`	`Optional[EventModerationWarn]`	Warning information
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelModeratorAddEvent` ¶

Bases: NamedTuple

Represents the addition of a channel moderator.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who was added as a moderator.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelModeratorRemoveEvent` ¶

Bases: NamedTuple

Represents the removal of a channel moderator.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who was removed as a moderator.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsAutomaticRewardRedemptionAddEventV1` ¶

Bases: NamedTuple

Represents the redemption of an automatic channel points reward.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who redeemed the reward.
`id`	`str`	Unique identifier for the redemption.
`reward`	`EventChannelPointsAutomaticReward`	Details of the redeemed automatic reward.
`message`	`EventSubscriptionMessage`	Message associated with the redemption.
`user_input`	`str`	User-provided input for the redemption
`redeemed_at`	`datetime`	Timestamp when the reward was redeemed.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsAutomaticRewardRedemptionAddEventV2` ¶

Bases: NamedTuple

Represents the redemption of an automatic channel points reward.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who redeemed the reward.
`id`	`str`	Unique identifier for the redemption.
`reward`	`EventChannelPointsAutomaticRewardV2`	Details of the redeemed automatic reward.
`message`	`EventMessage`	Message associated with the redemption.
`redeemed_at`	`datetime`	Timestamp when the reward was redeemed.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsCustomRewardAddEvent` ¶

Bases: NamedTuple

Represents the creation of a custom channel points reward.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the reward.
`is_enabled`	`bool`	Whether the reward is enabled.
`is_paused`	`bool`	Whether the reward is paused.
`is_in_stock`	`bool`	Whether the reward is in stock.
`title`	`str`	Title of the reward.
`cost`	`int`	Cost of the reward in channel points.
`prompt`	`str`	Prompt or description of the reward.
`is_user_input_required`	`bool`	Whether user input is required for redemption.
`should_redemptions_skip_request_queue`	`bool`	Whether redemptions skip the request queue.
`cooldown_expires_at`	`Optional[datetime]`	Timestamp when the cooldown expires
`redemptions_redeemed_current_stream`	`Optional[int]`	Number of redemptions in the current stream
`max_per_stream`	`EventMaxPerStream`	Maximum redemptions per stream settings.
`max_per_user_per_stream`	`EventMaxPerUserPerStream`	Maximum redemptions per user per stream settings.
`global_cooldown`	`EventGlobalCooldown`	Global cooldown settings for the reward.
`background_color`	`str`	Background color of the reward.
`image`	`EventImage`	Custom image for the reward.
`default_image`	`EventImage`	Default image for the reward.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsCustomRewardUpdateEvent` ¶

Bases: NamedTuple

Represents an update to a custom channel points reward.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the reward.
`is_enabled`	`bool`	Whether the reward is enabled.
`is_paused`	`bool`	Whether the reward is paused.
`is_in_stock`	`bool`	Whether the reward is in stock.
`title`	`str`	Title of the reward.
`cost`	`int`	Cost of the reward in channel points.
`prompt`	`str`	Prompt or description of the reward.
`is_user_input_required`	`bool`	Whether user input is required for redemption.
`should_redemptions_skip_request_queue`	`bool`	Whether redemptions skip the request queue.
`cooldown_expires_at`	`Optional[datetime]`	Timestamp when the cooldown expires
`redemptions_redeemed_current_stream`	`Optional[int]`	Number of redemptions in the current stream
`max_per_stream`	`EventMaxPerStream`	Maximum redemptions per stream settings.
`max_per_user_per_stream`	`EventMaxPerUserPerStream`	Maximum redemptions per user per stream settings.
`global_cooldown`	`EventGlobalCooldown`	Global cooldown settings for the reward.
`background_color`	`str`	Background color of the reward.
`image`	`EventImage`	Custom image for the reward.
`default_image`	`EventImage`	Default image for the reward.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsCustomRewardRemoveEvent` ¶

Bases: NamedTuple

Represents the removal of a custom channel points reward.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the reward.
`is_enabled`	`bool`	Whether the reward was enabled before removal.
`is_paused`	`bool`	Whether the reward was paused before removal.
`is_in_stock`	`bool`	Whether the reward was in stock before removal.
`title`	`str`	Title of the reward.
`cost`	`int`	Cost of the reward in channel points.
`prompt`	`str`	Prompt or description of the reward.
`is_user_input_required`	`bool`	Whether user input was required for redemption.
`should_redemptions_skip_request_queue`	`bool`	Whether redemptions skipped the request queue.
`cooldown_expires_at`	`Optional[datetime]`	Timestamp when the cooldown would have expired
`redemptions_redeemed_current_stream`	`Optional[int]`	Number of redemptions in the current stream before removal
`max_per_stream`	`EventMaxPerStream`	Maximum redemptions per stream settings.
`max_per_user_per_stream`	`EventMaxPerUserPerStream`	Maximum redemptions per user per stream settings.
`global_cooldown`	`EventGlobalCooldown`	Global cooldown settings for the reward.
`background_color`	`str`	Background color of the reward.
`image`	`EventImage`	Custom image for the reward.
`default_image`	`EventImage`	Default image for the reward.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsCustomRewardRedemptionAddEvent` ¶

Bases: NamedTuple

Represents the redemption of a custom channel points reward.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who redeemed the reward.
`id`	`str`	Unique identifier for the redemption.
`user_input`	`str`	User-provided input for the redemption
`status`	`Literal['unfulfilled', 'fulfilled', 'canceled']`	Status of the redemption.
`reward`	`EventCustomReward`	Details of the redeemed custom reward.
`redeemed_at`	`datetime`	Timestamp when the reward was redeemed.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPointsCustomRewardRedemptionUpdateEvent` ¶

Bases: NamedTuple

Represents an update to a custom channel points reward redemption.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who redeemed the reward.
`id`	`str`	Unique identifier for the redemption.
`user_input`	`str`	User-provided input for the redemption
`status`	`Literal['unfulfilled', 'fulfilled', 'canceled']`	Updated status of the redemption.
`reward`	`EventCustomReward`	Details of the redeemed custom reward.
`redeemed_at`	`datetime`	Timestamp when the reward was redeemed.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPollBeginEvent` ¶

Bases: NamedTuple

Represents the start of a channel poll.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the poll.
`title`	`str`	Title of the poll.
`choices`	`Tuple[EventPollChoice, ...]`	Possible poll choices.
`bits_voting`	`EventPollVotingSettings`	Settings for voting with bits.
`channel_points_voting`	`EventPollVotingSettings`	Settings for voting with channel points.
`started_at`	`datetime`	Timestamp when the poll started.
`ends_at`	`datetime`	Timestamp when the poll ends.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPollProgressEvent` ¶

Bases: NamedTuple

Represents progress updates for a channel poll.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the poll.
`title`	`str`	Title of the poll.
`choices`	`Tuple[EventPollChoice, ...]`	Possible poll choices with updated vote counts.
`bits_voting`	`EventPollVotingSettings`	Settings for voting with bits.
`channel_points_voting`	`EventPollVotingSettings`	Settings for voting with channel points.
`started_at`	`datetime`	Timestamp when the poll started.
`ends_at`	`datetime`	Timestamp when the poll ends.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPollEndEvent` ¶

Bases: NamedTuple

Represents the end of a channel poll.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the poll.
`title`	`str`	Title of the poll.
`choices`	`Tuple[EventPollChoice, ...]`	Final poll choices with vote counts.
`bits_voting`	`EventPollVotingSettings`	Settings for voting with bits.
`channel_points_voting`	`EventPollVotingSettings`	Settings for voting with channel points.
`status`	`Literal['completed', 'archived', 'terminated']`	Final status of the poll.
`started_at`	`datetime`	Timestamp when the poll started.
`ended_at`	`datetime`	Timestamp when the poll ended.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPredictionBeginEvent` ¶

Bases: NamedTuple

Represents the start of a channel prediction event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the prediction.
`title`	`str`	Title of the prediction.
`outcomes`	`Tuple[EventPredictionOutcome, ...]`	Possible prediction outcomes.
`started_at`	`datetime`	Timestamp when the prediction started.
`locks_at`	`datetime`	Timestamp when the prediction locks.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPredictionProgressEvent` ¶

Bases: NamedTuple

Represents progress updates for a channel prediction event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the prediction.
`title`	`str`	Title of the prediction.
`outcomes`	`Tuple[EventPredictionOutcome, ...]`	Possible prediction outcomes with updated vote counts.
`started_at`	`datetime`	Timestamp when the prediction started.
`locks_at`	`datetime`	Timestamp when the prediction locks.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPredictionLockEvent` ¶

Bases: NamedTuple

Represents a channel prediction lock event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the prediction.
`title`	`str`	Title of the prediction.
`outcomes`	`Tuple[EventPredictionOutcome, ...]`	Possible prediction outcomes with final vote counts.
`started_at`	`datetime`	Timestamp when the prediction started.
`locked_at`	`datetime`	Timestamp when the prediction was locked.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelPredictionEndEvent` ¶

Bases: NamedTuple

Represents the end of a channel prediction event.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the prediction.
`title`	`str`	Title of the prediction.
`winning_outcome_id`	`str`	Identifier of the winning outcome.
`outcomes`	`Tuple[EventPredictionOutcome, ...]`	Final prediction outcomes.
`status`	`Literal['resolved', 'canceled']`	Status of the prediction (resolved or canceled).
`started_at`	`datetime`	Timestamp when the prediction started.
`ended_at`	`datetime`	Timestamp when the prediction ended.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSuspiciousUserMessageEvent` ¶

Bases: NamedTuple

Represents a message sent by a suspicious user in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	Suspicious user who sent the message.
`low_trust_status`	`str`	The low trust status of the user.
`shared_ban_channel_ids`	`Tuple[str, ...]`	IDs of channels that share a ban with this user.
`types`	`Tuple[str, ...]`	Types of suspicious behavior associated with the user.
`ban_evasion_evaluation`	`str`	Evaluation of the user's potential ban evasion.
`message`	`EventMessage`	Content and metadata of the suspicious message.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelSuspiciousUserUpdateEvent` ¶

Bases: NamedTuple

Represents an update to a user's suspicious status in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who updated the status.
`user`	`UserIdentity`	User whose suspicious status was updated.
`low_trust_status`	`str`	The updated low trust status of the user.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelVipAddEvent` ¶

Bases: NamedTuple

Represents the addition of a VIP to a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who was added as a VIP.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelVipRemoveEvent` ¶

Bases: NamedTuple

Represents the removal of a VIP from a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who was removed as a VIP.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelWarningAcknowledgeEvent` ¶

Bases: NamedTuple

Represents the acknowledgment of a warning in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who acknowledged the warning.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelWarningSendEvent` ¶

Bases: NamedTuple

Represents the sending of a warning to a user in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who received the warning.
`moderator_user`	`UserIdentity`	Moderator who sent the warning.
`reason`	`Optional[str]`	Reason for the warning, if provided.
`chat_rules_cited`	`Optional[Tuple[str, ...]]`	Chat rules cited in the warning
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelCharityCampaignDonationEvent` ¶

Bases: NamedTuple

Represents a charity donation event in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who made the donation.
`id`	`str`	Unique identifier for the donation.
`campaign_id`	`str`	Identifier for the charity campaign.
`charity_name`	`str`	Name of the charity.
`charity_description`	`str`	Description of the charity.
`charity_logo`	`str`	URL of the charity's logo.
`charity_website`	`str`	URL of the charity's website.
`amount`	`EventCharityDonationAmount`	Donation amount details.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelCharityCampaignStartEvent` ¶

Bases: NamedTuple

Represents the start of a charity campaign in a channel.

Attributes:

Name	Type	Description
`id`	`str`	Unique identifier for the charity campaign.
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`charity_name`	`str`	Name of the charity.
`charity_description`	`str`	Description of the charity.
`charity_logo`	`str`	URL of the charity's logo.
`charity_website`	`str`	URL of the charity's website.
`current_amount`	`EventCharityDonationAmount`	Current total amount raised.
`target_amount`	`EventCharityDonationAmount`	Target amount for the campaign.
`started_at`	`datetime`	Timestamp when the campaign started.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelCharityCampaignProgressEvent` ¶

Bases: NamedTuple

Represents progress updates for a charity campaign in a channel.

Attributes:

Name	Type	Description
`id`	`str`	Unique identifier for the charity campaign.
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`charity_name`	`str`	Name of the charity.
`charity_description`	`str`	Description of the charity.
`charity_logo`	`str`	URL of the charity's logo.
`charity_website`	`str`	URL of the charity's website.
`current_amount`	`EventCharityDonationAmount`	Current total amount raised.
`target_amount`	`EventCharityDonationAmount`	Target amount for the campaign.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelCharityCampaignStopEvent` ¶

Bases: NamedTuple

Represents the end of a charity campaign in a channel.

Attributes:

Name	Type	Description
`id`	`str`	Unique identifier for the charity campaign.
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`charity_name`	`str`	Name of the charity.
`charity_description`	`str`	Description of the charity.
`charity_logo`	`str`	URL of the charity's logo.
`charity_website`	`str`	URL of the charity's website.
`current_amount`	`EventCharityDonationAmount`	Final total amount raised.
`target_amount`	`EventCharityDonationAmount`	Target amount for the campaign.
`stopped_at`	`datetime`	Timestamp when the campaign stopped.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`DropEntitlementGrantEvent` ¶

Bases: NamedTuple

Represents a drop entitlement grant event.

Attributes:

Name	Type	Description
`id`	`str`	Unique identifier for the entitlement grant.
`data`	`EventDropEntitlementGrantData`	Detailed data about the entitlement grant.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ExtensionBitsTransactionCreateEvent` ¶

Bases: NamedTuple

Represents the creation of an extension bits transaction.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`user`	`UserIdentity`	User who initiated the transaction.
`id`	`str`	Unique identifier for the transaction.
`extension_client_id`	`str`	Client ID of the extension.
`product`	`EventExtensionProduct`	Details of the product purchased.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelGoalBeginEvent` ¶

Bases: NamedTuple

Represents the start of a goal in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the goal.
`type`	`str`	Type of the goal (e.g., follower, subscription).
`description`	`str`	Description of the goal.
`current_amount`	`int`	Current progress toward the goal.
`target_amount`	`int`	Target amount for the goal.
`started_at`	`datetime`	Timestamp when the goal started.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelGoalProgressEvent` ¶

Bases: NamedTuple

Represents progress updates for a goal in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the goal.
`type`	`str`	Type of the goal (e.g., follower, subscription).
`description`	`str`	Description of the goal.
`current_amount`	`int`	Current progress toward the goal.
`target_amount`	`int`	Target amount for the goal.
`started_at`	`datetime`	Timestamp when the goal started.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelGoalEndEvent` ¶

Bases: NamedTuple

Represents the end of a goal in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the goal.
`type`	`str`	Type of the goal (e.g., follower, subscription).
`description`	`str`	Description of the goal.
`current_amount`	`int`	Final progress toward the goal.
`target_amount`	`int`	Target amount for the goal.
`started_at`	`datetime`	Timestamp when the goal started.
`is_achieved`	`bool`	Whether the goal was achieved.
`ended_at`	`datetime`	Timestamp when the goal ended.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelShieldModeBeginEvent` ¶

Bases: NamedTuple

Represents the activation of Shield Mode in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who activated Shield Mode.
`started_at`	`datetime`	Timestamp when Shield Mode was activated.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelShieldModeEndEvent` ¶

Bases: NamedTuple

Represents the deactivation of Shield Mode in a channel.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information.
`moderator_user`	`UserIdentity`	Moderator who deactivated Shield Mode.
`ended_at`	`datetime`	Timestamp when Shield Mode was deactivated.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelShoutoutCreateEvent` ¶

Bases: NamedTuple

Represents the creation of a shoutout from one broadcaster to another.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information of the channel sending the shoutout.
`moderator_user`	`UserIdentity`	Moderator who initiated the shoutout.
`to_broadcaster_user`	`UserIdentity`	Broadcaster user information of the channel receiving the shoutout.
`started_at`	`datetime`	Timestamp when the shoutout was created.
`viewer_count`	`int`	Number of viewers at the time of the shoutout.
`cooldown_ends_at`	`datetime`	Timestamp when the shoutout cooldown for the broadcaster ends.
`target_cooldown_ends_at`	`datetime`	Timestamp when the shoutout cooldown for the target broadcaster ends.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`ChannelShoutoutReceiveEvent` ¶

Bases: NamedTuple

Represents the receipt of a shoutout from another broadcaster.

Attributes:

Name	Type	Description
`broadcaster_user`	`UserIdentity`	Broadcaster user information of the channel receiving the shoutout.
`from_broadcaster_user`	`UserIdentity`	Broadcaster user information of the channel sending the shoutout.
`viewer_count`	`int`	Number of viewers at the time of the shoutout.
`started_at`	`datetime`	Timestamp when the shoutout was received.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`StreamOnlineEvent` ¶

Bases: NamedTuple

Represents a stream going online event.

Attributes:

Name	Type	Description
`broadcaster`	`UserIdentity`	Broadcaster user information.
`id`	`str`	Unique identifier for the stream.
`type`	`Literal['live', 'playlist', 'watch_party', 'premiere', 'rerun']`	Type of stream.
`started_at`	`datetime`	Timestamp when the stream started.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`StreamOfflineEvent` ¶

Bases: NamedTuple

Represents a stream going offline event.

Attributes:

Name	Type	Description
`broadcaster`	`UserIdentity`	Broadcaster user information.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`UserAuthorizationGrantEvent` ¶

Bases: NamedTuple

Represents a user granting authorization to a client.

Attributes:

Name	Type	Description
`client_id`	`str`	Identifier of the client receiving authorization.
`user`	`UserIdentity`	User who granted the authorization.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`UserAuthorizationRevokeEvent` ¶

Bases: NamedTuple

Represents a user revoking authorization from a client.

Attributes:

Name	Type	Description
`client_id`	`str`	Identifier of the client from which authorization was revoked.
`user_id`	`str`	Identifier of the user who revoked authorization.
`user_login`	`Optional[str]`	Login name of the user
`user_name`	`Optional[str]`	Display name of the user
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`UserUpdateEvent` ¶

Bases: NamedTuple

Represents an update to a user's profile information.

Attributes:

Name	Type	Description
`user`	`UserIdentity`	User whose profile was updated.
`email`	`str`	Updated email address of the user.
`email_verified`	`bool`	Whether the user's email is verified.
`description`	`str`	Updated description of the user.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

`UserWhisperMessageEvent` ¶

Bases: NamedTuple

Represents a whisper message sent from one user to another.

Attributes:

Name	Type	Description
`from_user`	`UserIdentity`	User who sent the whisper.
`to_user`	`UserIdentity`	User who received the whisper.
`whisper_id`	`str`	Unique identifier for the whisper message.
`whisper`	`EventWhisperData`	Content of the whisper message.
`raw`	`MappingProxyType[str, Any]`	A shallow-frozen dictionary representing the original payload.

Models

AutomodHoldEventV1 ¶

AutomodHoldEventV2 ¶

AutomodUpdateEventV1 ¶

AutomodUpdateEventV2 ¶

AutomodSettingsUpdateEvent ¶

AutomodTermsUpdateEvent ¶

total_terms property ¶

ChannelBitsUseEvent ¶

ChannelUpdateEvent ¶

ChannelFollowEvent ¶

ChannelAdBreakBeginEvent ¶

ChannelChatClearEvent ¶

ChannelChatClearUserMessagesEvent ¶

ChannelChatMessageEvent ¶

ChannelChatMessageDeleteEvent ¶

ChannelChatNotificationEvent ¶

ChannelChatSettingsUpdateEvent ¶

ChannelChatUserMessageHoldEvent ¶

ChannelChatUserMessageUpdateEvent ¶

ChannelSharedChatBeginEvent ¶

ChannelSharedChatUpdateEvent ¶

ChannelSharedChatEndEvent ¶

ChannelSubscribeEvent ¶

ChannelSubscriptionEndEvent ¶

ChannelSubscriptionGiftEvent ¶

ChannelSubscriptionMessageEvent ¶

ChannelCheerEvent ¶

ChannelRaidEvent ¶

ChannelBanEvent ¶

ChannelUnbanEvent ¶

ChannelUnbanRequestCreateEvent ¶

ChannelUnbanRequestResolveEvent ¶

ChannelModerateEventV1 ¶

ChannelModerateEventV2 ¶

ChannelModeratorAddEvent ¶

ChannelModeratorRemoveEvent ¶

ChannelPointsAutomaticRewardRedemptionAddEventV1 ¶

ChannelPointsAutomaticRewardRedemptionAddEventV2 ¶

ChannelPointsCustomRewardAddEvent ¶

ChannelPointsCustomRewardUpdateEvent ¶

ChannelPointsCustomRewardRemoveEvent ¶

ChannelPointsCustomRewardRedemptionAddEvent ¶

ChannelPointsCustomRewardRedemptionUpdateEvent ¶

ChannelPollBeginEvent ¶

ChannelPollProgressEvent ¶

ChannelPollEndEvent ¶

ChannelPredictionBeginEvent ¶

ChannelPredictionProgressEvent ¶

ChannelPredictionLockEvent ¶

ChannelPredictionEndEvent ¶

ChannelSuspiciousUserMessageEvent ¶

ChannelSuspiciousUserUpdateEvent ¶

ChannelVipAddEvent ¶

ChannelVipRemoveEvent ¶

ChannelWarningAcknowledgeEvent ¶

ChannelWarningSendEvent ¶

ChannelCharityCampaignDonationEvent ¶

ChannelCharityCampaignStartEvent ¶

ChannelCharityCampaignProgressEvent ¶

ChannelCharityCampaignStopEvent ¶

DropEntitlementGrantEvent ¶

ExtensionBitsTransactionCreateEvent ¶

ChannelGoalBeginEvent ¶

ChannelGoalProgressEvent ¶

ChannelGoalEndEvent ¶

ChannelShieldModeBeginEvent ¶

ChannelShieldModeEndEvent ¶

ChannelShoutoutCreateEvent ¶

ChannelShoutoutReceiveEvent ¶

StreamOnlineEvent ¶

StreamOfflineEvent ¶

UserAuthorizationGrantEvent ¶

UserAuthorizationRevokeEvent ¶

UserUpdateEvent ¶

UserWhisperMessageEvent ¶

`AutomodHoldEventV1` ¶

`AutomodHoldEventV2` ¶

`AutomodUpdateEventV1` ¶

`AutomodUpdateEventV2` ¶

`AutomodSettingsUpdateEvent` ¶

`AutomodTermsUpdateEvent` ¶

`total_terms` `property` ¶

`ChannelBitsUseEvent` ¶

`ChannelUpdateEvent` ¶

`ChannelFollowEvent` ¶

`ChannelAdBreakBeginEvent` ¶

`ChannelChatClearEvent` ¶

`ChannelChatClearUserMessagesEvent` ¶

`ChannelChatMessageEvent` ¶

`ChannelChatMessageDeleteEvent` ¶

`ChannelChatNotificationEvent` ¶

`ChannelChatSettingsUpdateEvent` ¶

`ChannelChatUserMessageHoldEvent` ¶

`ChannelChatUserMessageUpdateEvent` ¶

`ChannelSharedChatBeginEvent` ¶

`ChannelSharedChatUpdateEvent` ¶

`ChannelSharedChatEndEvent` ¶

`ChannelSubscribeEvent` ¶

`ChannelSubscriptionEndEvent` ¶

`ChannelSubscriptionGiftEvent` ¶

`ChannelSubscriptionMessageEvent` ¶

`ChannelCheerEvent` ¶

`ChannelRaidEvent` ¶

`ChannelBanEvent` ¶

`ChannelUnbanEvent` ¶

`ChannelUnbanRequestCreateEvent` ¶

`ChannelUnbanRequestResolveEvent` ¶

`ChannelModerateEventV1` ¶

`ChannelModerateEventV2` ¶

`ChannelModeratorAddEvent` ¶

`ChannelModeratorRemoveEvent` ¶

`ChannelPointsAutomaticRewardRedemptionAddEventV1` ¶

`ChannelPointsAutomaticRewardRedemptionAddEventV2` ¶

`ChannelPointsCustomRewardAddEvent` ¶

`ChannelPointsCustomRewardUpdateEvent` ¶

`ChannelPointsCustomRewardRemoveEvent` ¶

`ChannelPointsCustomRewardRedemptionAddEvent` ¶

`ChannelPointsCustomRewardRedemptionUpdateEvent` ¶

`ChannelPollBeginEvent` ¶

`ChannelPollProgressEvent` ¶

`ChannelPollEndEvent` ¶

`ChannelPredictionBeginEvent` ¶

`ChannelPredictionProgressEvent` ¶

`ChannelPredictionLockEvent` ¶

`ChannelPredictionEndEvent` ¶

`ChannelSuspiciousUserMessageEvent` ¶

`ChannelSuspiciousUserUpdateEvent` ¶

`ChannelVipAddEvent` ¶

`ChannelVipRemoveEvent` ¶

`ChannelWarningAcknowledgeEvent` ¶

`ChannelWarningSendEvent` ¶

`ChannelCharityCampaignDonationEvent` ¶

`ChannelCharityCampaignStartEvent` ¶

`ChannelCharityCampaignProgressEvent` ¶

`ChannelCharityCampaignStopEvent` ¶

`DropEntitlementGrantEvent` ¶

`ExtensionBitsTransactionCreateEvent` ¶

`ChannelGoalBeginEvent` ¶

`ChannelGoalProgressEvent` ¶

`ChannelGoalEndEvent` ¶

`ChannelShieldModeBeginEvent` ¶

`ChannelShieldModeEndEvent` ¶

`ChannelShoutoutCreateEvent` ¶

`ChannelShoutoutReceiveEvent` ¶

`StreamOnlineEvent` ¶

`StreamOfflineEvent` ¶

`UserAuthorizationGrantEvent` ¶

`UserAuthorizationRevokeEvent` ¶

`UserUpdateEvent` ¶

`UserWhisperMessageEvent` ¶