Skip to content

Commit f5eb5ac

Browse files
committed
Add additional info to AutoRedeem Docs
1 parent 43474b6 commit f5eb5ac

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

twitchio/models/eventsub_.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3253,6 +3253,7 @@ class AutoRedeemReward:
32533253
Attributes
32543254
----------
32553255
type: typing.Literal["single_message_bypass_sub_mode", "send_highlighted_message", "random_sub_emote_unlock", "chosen_sub_emote_unlock", "chosen_modified_sub_emote_unlock", "message_effect", "gigantify_an_emote", "celebration"]
3256+
The type of the reward. V2 does not cover Power-ups e.g. `gigantify_an_emote`, `celebration`, and `message_effect`.
32563257
channel_points: int
32573258
Number of channel points used. This is also covers `cost` when using V1.
32583259
emote: UnlockedEmote | None
@@ -3284,6 +3285,9 @@ class ChannelPointsAutoRedeemAdd(BaseEvent):
32843285
"""
32853286
Represents an automatic redemption of a channel points reward.
32863287
3288+
.. note::
3289+
This is a combination of V1 and V2.
3290+
32873291
Attributes
32883292
----------
32893293
broadcaster: PartialUser
@@ -3298,10 +3302,15 @@ class ChannelPointsAutoRedeemAdd(BaseEvent):
32983302
The datetime object of when the reward was redeemed.
32993303
reward: AutoRedeemReward
33003304
The details of the reward auto redeemed.
3305+
3306+
V2 does not cover Power-ups e.g. `gigantify_an_emote`, `celebration`, and `message_effect`.
3307+
Please see ChannelBitsUseSubscription for those specific types if using V2.
33013308
emotes: list[ChannelPointsEmote]
33023309
A list of ChannelPointsEmote objects that appear in the text.
3303-
If using V1, this is populated by Twitch.
3304-
If using V2, the emotes can be found in the fragments, but we calculate the index ourselves for this property.
3310+
3311+
- If using V1, this is populated by Twitch.
3312+
- If using V2, the emotes can be found in the fragments, but we calculate the index ourselves for this property.
3313+
33053314
user_input: str | None
33063315
The text input by the user if the reward requires input. This is `None` when using V2. `text` is the preferred attribute to use.
33073316
fragments: list[ChatMessageFragment]

0 commit comments

Comments
 (0)