Skip to content

Commit 27623a7

Browse files
chillymoshchillymosh
committed
Add eventsub events payload for docs
1 parent da51216 commit 27623a7

File tree

2 files changed

+63
-63
lines changed

2 files changed

+63
-63
lines changed

‎twitchio/events.pyi‎

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -24,103 +24,103 @@ async def event_ready() -> None:
2424
# AutoMod
2525
async def event_automod_message_hold(payload: twitchio.AutomodMessageHold) -> None: ...
2626
async def event_automod_message_update(payload: twitchio.AutomodMessageUpdate) -> None: ...
27-
async def event_automod_settings_update() -> None: ...
28-
async def event_automod_terms_update() -> None: ...
27+
async def event_automod_settings_update(payload: twitchio.AutomodSettingsUpdate) -> None: ...
28+
async def event_automod_terms_update(payload: twitchio.AutomodTermsUpdate) -> None: ...
2929

3030
# Channel/Broadcaster
31-
async def event_channel_update() -> None: ...
32-
async def event_follow() -> None: ...
33-
async def event_ad_break() -> None: ...
34-
async def event_chat_clear() -> None: ...
35-
async def event_chat_clear_user() -> None: ...
36-
async def event_cheer() -> None: ...
37-
async def event_raid() -> None: ...
31+
async def event_channel_update(payload: twitchio.ChannelUpdate) -> None: ...
32+
async def event_follow(payload: twitchio.ChannelFollow) -> None: ...
33+
async def event_ad_break(payload: twitchio.ChannelAdBreakBegin) -> None: ...
34+
async def event_chat_clear(payload: twitchio.ChannelChatClear) -> None: ...
35+
async def event_chat_clear_user(payload: twitchio.ChannelChatClearUserMessages) -> None: ...
36+
async def event_cheer(payload: twitchio.ChannelCheer) -> None: ...
37+
async def event_raid(payload: twitchio.ChannelRaid) -> None: ...
3838

3939
# Messages/Chat
40-
async def event_message() -> None: ...
41-
async def event_message_whisper() -> None: ...
42-
async def event_message_delete() -> None: ...
43-
async def event_chat_notification() -> None: ...
44-
async def event_chat_settings_update() -> None: ...
45-
async def event_chat_user_message_hold() -> None: ...
46-
async def event_chat_user_message_update() -> None: ...
40+
async def event_message(payload: twitchio.ChatMessage) -> None: ...
41+
async def event_message_whisper(payload: twitchio.Whisper) -> None: ...
42+
async def event_message_delete(payload: twitchio.ChatMessageDelete) -> None: ...
43+
async def event_chat_notification(payload: twitchio.ChatNotification) -> None: ...
44+
async def event_chat_settings_update(payload: twitchio.ChatSettingsUpdate) -> None: ...
45+
async def event_chat_user_message_hold(payload: twitchio.ChatUserMessageHold) -> None: ...
46+
async def event_chat_user_message_update(payload: twitchio.ChatUserMessageUpdate) -> None: ...
4747

4848
# Shared Chat
49-
async def event_shared_chat_begin() -> None: ...
50-
async def event_shared_chat_update() -> None: ...
51-
async def event_shared_chat_end() -> None: ...
49+
async def event_shared_chat_begin(payload: twitchio.SharedChatSessionBegin) -> None: ...
50+
async def event_shared_chat_update(payload: twitchio.SharedChatSessionUpdate) -> None: ...
51+
async def event_shared_chat_end(payload: twitchio.SharedChatSessionEnd) -> None: ...
5252

5353
# Subscriptions
54-
async def event_subscription() -> None: ...
55-
async def event_subscription_end() -> None: ...
56-
async def event_subscription_gift() -> None: ...
57-
async def event_subscription_message() -> None: ...
54+
async def event_subscription(payload: twitchio.ChannelSubscribe) -> None: ...
55+
async def event_subscription_end(payload: twitchio.ChannelSubscriptionEnd) -> None: ...
56+
async def event_subscription_gift(payload: twitchio.ChannelSubscriptionGift) -> None: ...
57+
async def event_subscription_message(payload: twitchio.ChannelSubscriptionMessage) -> None: ...
5858

5959
# Bans
60-
async def event_ban() -> None: ...
61-
async def event_unban() -> None: ...
62-
async def event_unban_request() -> None: ...
63-
async def event_unban_request_resolve() -> None: ...
60+
async def event_ban(payload: twitchio.ChannelBan) -> None: ...
61+
async def event_unban(payload: twitchio.ChannelUnban) -> None: ...
62+
async def event_unban_request(payload: twitchio.ChannelUnbanRequest) -> None: ...
63+
async def event_unban_request_resolve(payload: twitchio.ChannelUnbanRequestResolve) -> None: ...
6464

6565
# Warnings
66-
async def event_warning_acknowledge() -> None: ...
67-
async def event_warning_send() -> None: ...
66+
async def event_warning_acknowledge(payload: twitchio.ChannelWarningAcknowledge) -> None: ...
67+
async def event_warning_send(payload: twitchio.ChannelWarningSend) -> None: ...
6868

6969
# Moderation and VIPs
70-
async def event_mod_action() -> None: ...
71-
async def event_moderator_add() -> None: ...
72-
async def event_moderator_remove() -> None: ...
73-
async def event_vip_add() -> None: ...
74-
async def event_vip_remove() -> None: ...
70+
async def event_mod_action(payload: twitchio.ChannelModerate) -> None: ...
71+
async def event_moderator_add(payload: twitchio.ChannelModeratorAdd) -> None: ...
72+
async def event_moderator_remove(payload: twitchio.ChannelModeratorRemove) -> None: ...
73+
async def event_vip_add(payload: twitchio.ChannelVIPAdd) -> None: ...
74+
async def event_vip_remove(payload: twitchio.ChannelVIPRemove) -> None: ...
7575

7676
# Redemptions and Rewards
77-
async def event_automatic_redemption_add() -> None: ...
78-
async def event_custom_reward_add() -> None: ...
79-
async def event_custom_reward_update() -> None: ...
80-
async def event_custom_reward_remove() -> None: ...
81-
async def event_custom_redemption_add() -> None: ...
82-
async def event_custom_redemption_update() -> None: ...
77+
async def event_automatic_redemption_add(payload: twitchio.ChannelPointsAutoRedeemAdd) -> None: ...
78+
async def event_custom_reward_add(payload: twitchio.ChannelPointsRewardAdd) -> None: ...
79+
async def event_custom_reward_update(payload: twitchio.ChannelPointsRewardUpdate) -> None: ...
80+
async def event_custom_reward_remove(payload: twitchio.ChannelPointsRewardRemove) -> None: ...
81+
async def event_custom_redemption_add(payload: twitchio.ChannelPointsRedemptionAdd) -> None: ...
82+
async def event_custom_redemption_update(payload: twitchio.ChannelPointsRedemptionUpdate) -> None: ...
8383

8484
# Polls
85-
async def event_poll_begin() -> None: ...
86-
async def event_poll_progress() -> None: ...
87-
async def event_poll_end() -> None: ...
85+
async def event_poll_begin(payload: twitchio.ChannelPollBegin) -> None: ...
86+
async def event_poll_progress(payload: twitchio.ChannelPollProgress) -> None: ...
87+
async def event_poll_end(payload: twitchio.ChannelPollEnd) -> None: ...
8888

8989
# Suspicious Users
90-
async def event_suspicious_user_message() -> None: ...
91-
async def event_suspicious_user_update() -> None: ...
90+
async def event_suspicious_user_message(payload: twitchio.SuspiciousUserMessage) -> None: ...
91+
async def event_suspicious_user_update(payload: twitchio.SuspiciousUserUpdate) -> None: ...
9292

9393
# Charity Campaigns
94-
async def event_charity_campaign_donate() -> None: ...
95-
async def event_charity_campaign_start() -> None: ...
96-
async def event_charity_campaign_progress() -> None: ...
97-
async def event_charity_campaign_stop() -> None: ...
94+
async def event_charity_campaign_donate(payload: twitchio.CharityCampaignDonation) -> None: ...
95+
async def event_charity_campaign_start(payload: twitchio.CharityCampaignStart) -> None: ...
96+
async def event_charity_campaign_progress(payload: twitchio.CharityCampaignProgress) -> None: ...
97+
async def event_charity_campaign_stop(payload: twitchio.CharityCampaignStop) -> None: ...
9898

9999
# Goals
100-
async def event_goal_begin() -> None: ...
101-
async def event_goal_peogress() -> None: ...
102-
async def event_goal_end() -> None: ...
100+
async def event_goal_begin(payload: twitchio.GoalBegin) -> None: ...
101+
async def event_goal_peogress(payload: twitchio.GoalProgress) -> None: ...
102+
async def event_goal_end(payload: twitchio.GoalEnd) -> None: ...
103103

104104
# Hype Train
105-
async def event_hype_train() -> None: ...
106-
async def event_hype_train_progress() -> None: ...
107-
async def event_hype_train_end() -> None: ...
105+
async def event_hype_train(payload: twitchio.HypeTrainBegin) -> None: ...
106+
async def event_hype_train_progress(payload: twitchio.HypeTrainProgress) -> None: ...
107+
async def event_hype_train_end(payload: twitchio.HypeTrainEnd) -> None: ...
108108

109109
# Shield Mode
110-
async def event_shield_mode_begin() -> None: ...
111-
async def event_shield_mode_end() -> None: ...
110+
async def event_shield_mode_begin(payload: twitchio.ShieldModeBegin) -> None: ...
111+
async def event_shield_mode_end(payload: twitchio.ShieldModeEnd) -> None: ...
112112

113113
# Shoutouts
114-
async def event_shoutout_create() -> None: ...
115-
async def event_shoutout_receive() -> None: ...
114+
async def event_shoutout_create(payload: twitchio.ShoutoutCreate) -> None: ...
115+
async def event_shoutout_receive(payload: twitchio.ShoutoutReceive) -> None: ...
116116

117117
# Streams
118118
async def event_stream_online(payload: twitchio.StreamOnline) -> None: ...
119119
async def event_stream_offline(payload: twitchio.StreamOffline) -> None: ...
120120

121121
# OAuth
122-
async def event_user_authorization_grant() -> None: ...
123-
async def event_user_authorization_revoke() -> None: ...
122+
async def event_user_authorization_grant(payload: twitchio.UserAuthorizationGrant) -> None: ...
123+
async def event_user_authorization_revoke(payload: twitchio.UserAuthorizationRevoke) -> None: ...
124124

125125
# Users
126-
async def event_user_update() -> None: ...
126+
async def event_user_update(payload: twitchio.UserUpdate) -> None: ...

‎twitchio/models/eventsub_.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4069,7 +4069,7 @@ def __repr__(self) -> str:
40694069

40704070
class CharityCampaignDonation(BaseEvent):
40714071
"""
4072-
Represents a charity campaign start event.
4072+
Represents a charity campaign donation event.
40734073
40744074
Attributes
40754075
----------

0 commit comments

Comments
 (0)