Merge branch 'main' of https://github.com/PythonistaGuild/TwitchIO

Author: EvieePy

twitchio/eventsub/subscriptions.py

@@ -2692,7 +2692,7 @@ class HypeTrainBeginSubscription(SubscriptionPayload):
     """
 
     type: ClassVar[Literal["channel.hype_train.begin"]] = "channel.hype_train.begin"
-    version: ClassVar[Literal["1"]] = "1"
+    version: ClassVar[Literal["2"]] = "2"
 
     @handle_user_ids()
     def __init__(self, **condition: Unpack[Condition]) -> None:
@@ -2734,7 +2734,7 @@ class HypeTrainProgressSubscription(SubscriptionPayload):
     """
 
     type: ClassVar[Literal["channel.hype_train.progress"]] = "channel.hype_train.progress"
-    version: ClassVar[Literal["1"]] = "1"
+    version: ClassVar[Literal["2"]] = "2"
 
     @handle_user_ids()
     def __init__(self, **condition: Unpack[Condition]) -> None:
@@ -2773,7 +2773,7 @@ class HypeTrainEndSubscription(SubscriptionPayload):
     """
 
     type: ClassVar[Literal["channel.hype_train.end"]] = "channel.hype_train.end"
-    version: ClassVar[Literal["1"]] = "1"
+    version: ClassVar[Literal["2"]] = "2"
 
     @handle_user_ids()
     def __init__(self, **condition: Unpack[Condition]) -> None:

twitchio/models/eventsub_.py

@@ -4818,11 +4818,19 @@ def __repr__(self) -> str:
 
 
 class BaseHypeTrain(BaseEvent):
-    __slots__ = ("broadcaster", "golden_kappa", "id", "level", "started_at", "top_contributions", "total")
+    __slots__ = (
+        "broadcaster",
+        "id",
+        "level",
+        "shared_train",
+        "shared_train_participants",
+        "started_at",
+        "top_contributions",
+        "total",
+        "type",
+    )
 
-    def __init__(
-        self, payload: HypeTrainBeginEvent | HypeTrainProgressEvent | HypeTrainEndEvent, *, http: HTTPClient
-    ) -> None:
+    def __init__(self, payload: BaseHypeTrainEvent, *, http: HTTPClient) -> None:
         self.broadcaster: PartialUser = PartialUser(
             payload["broadcaster_user_id"], payload["broadcaster_user_login"], payload["broadcaster_user_name"], http=http
         )
@@ -4833,7 +4841,12 @@ def __init__(
             HypeTrainContribution(c, http=http) for c in payload["top_contributions"]
         ]
         self.started_at: datetime.datetime = parse_timestamp(payload["started_at"])
-        self.golden_kappa: bool = bool(payload["is_golden_kappa_train"])
+        self.shared_train_participants: list[PartialUser] = [
+            PartialUser(u["broadcaster_user_id"], u["broadcaster_user_login"], u["broadcaster_user_name"], http=http)
+            for u in payload["shared_train_participants"]
+        ]
+        self.shared_train: bool = bool(payload["is_shared_train"])
+        self.type: Literal["treasure", "golden_kappa", "regular"] = payload["type"]
 
     def __repr__(self) -> str:
         return f"<BaseHypeTrain id={self.id} broadcaster={self.broadcaster} started_at={self.started_at}>"
@@ -4859,34 +4872,49 @@ class HypeTrainBegin(BaseHypeTrain):
         The number of points required to reach the next level.
     top_contributions: list[HypeTrainContribution]
         The contributors with the most points contributed.
-    last_contribution: HypeTrainContribution
-        The most recent contribution.
+    all_time_high_level: int
+        The all-time high level this type of Hype Train has reached for this broadcaster.
+    all_time_high_total: int
+        The all-time high total this type of Hype Train has reached for this broadcaster.
+    shared_train: bool
+        Indicates if the Hype Train is shared.
+        When True, `shared_train_participants` will contain the list of broadcasters the train is shared with.
+    shared_train_participants: list[PartialUser]
+        List of broadcasters in the shared Hype Train.
+    type: typing.Literal["treasure", "golden_kappa", "regular"]
+        The type of the Hype Train. Possible values are:
+
+        - treasure
+        - golden_kappa
+        - regular
+
     started_at: datetime.datetime
         The datetime of when the hype train started.
     expires_at: datetime.datetime
         The datetime when the hype train expires. The expiration is extended when the hype train reaches a new level.
-    golden_kappa: bool
-        Indicates if the hype train is a Golden Kappa Train.
+
     """
 
     subscription_type = "channel.hype_train.begin"
 
     __slots__ = (
+        "all_time_high_level",
+        "all_time_high_total",
         "expires_at",
         "goal",
-        "last_contribution",
         "progress",
     )
 
     def __init__(self, payload: HypeTrainBeginEvent, *, http: HTTPClient) -> None:
         super().__init__(payload, http=http)
         self.progress: int = int(payload["progress"])
         self.goal: int = int(payload["goal"])
-        self.last_contribution: HypeTrainContribution = HypeTrainContribution(payload["last_contribution"], http=http)
         self.expires_at: datetime.datetime = parse_timestamp(payload["expires_at"])
+        self.all_time_high_level: int = int(payload["all_time_high_level"])
+        self.all_time_high_total: int = int(payload["all_time_high_total"])
 
     def __repr__(self) -> str:
-        return f"<HypeTrainBegin id={self.id} broadcaster={self.broadcaster} goal={self.goal} started_at={self.started_at}>"
+        return f"<HypeTrainBegin id={self.id} broadcaster={self.broadcaster} goal={self.goal} started_at={self.started_at} type={self.type}>"
 
 
 class HypeTrainProgress(BaseHypeTrain):
@@ -4909,34 +4937,40 @@ class HypeTrainProgress(BaseHypeTrain):
         The number of points required to reach the next level.
     top_contributions: list[HypeTrainContribution]
         The contributors with the most points contributed.
-    last_contribution: HypeTrainContribution
-        The most recent contribution.
     started_at: datetime.datetime
         The datetime of when the hype train started.
     expires_at: datetime.datetime
         The datetime when the hype train expires. The expiration is extended when the hype train reaches a new level.
-    golden_kappa: bool
-        Indicates if the hype train is a Golden Kappa Train.
+    shared_train: bool
+        Indicates if the Hype Train is shared.
+        When True, `shared_train_participants` will contain the list of broadcasters the train is shared with.
+    shared_train_participants: list[PartialUser]
+        List of broadcasters in the shared Hype Train.
+    type: typing.Literal["treasure", "golden_kappa", "regular"]
+        The type of the Hype Train. Possible values are:
+
+        - treasure
+        - golden_kappa
+        - regular
+
     """
 
     subscription_type = "channel.hype_train.progress"
 
     __slots__ = (
         "expires_at",
         "goal",
-        "last_contribution",
         "progress",
     )
 
     def __init__(self, payload: HypeTrainProgressEvent, *, http: HTTPClient) -> None:
         super().__init__(payload, http=http)
         self.progress: int = int(payload["progress"])
         self.goal: int = int(payload["goal"])
-        self.last_contribution: HypeTrainContribution = HypeTrainContribution(payload["last_contribution"], http=http)
         self.expires_at: datetime.datetime = parse_timestamp(payload["expires_at"])
 
     def __repr__(self) -> str:
-        return f"<HypeTrainProgress id={self.id} broadcaster={self.broadcaster} goal={self.goal} progress={self.progress}>"
+        return f"<HypeTrainProgress id={self.id} broadcaster={self.broadcaster} goal={self.goal} progress={self.progress} type={self.type}>"
 
 
 class HypeTrainEnd(BaseHypeTrain):
@@ -4961,8 +4995,18 @@ class HypeTrainEnd(BaseHypeTrain):
         The datetime of when the hype train ended.
     cooldown_until: datetime.datetime
         The datetime when the hype train cooldown ends so that the next hype train can start.
-    golden_kappa: bool
-        Indicates if the hype train is a Golden Kappa Train.
+    shared_train: bool
+        Indicates if the Hype Train is shared.
+        When True, `shared_train_participants` will contain the list of broadcasters the train is shared with.
+    shared_train_participants: list[PartialUser]
+        List of broadcasters in the shared Hype Train.
+    type: typing.Literal["treasure", "golden_kappa", "regular"]
+        The type of the Hype Train. Possible values are:
+
+        - treasure
+        - golden_kappa
+        - regular
+
     """
 
     subscription_type = "channel.hype_train.end"
@@ -4978,7 +5022,7 @@ def __init__(self, payload: HypeTrainEndEvent, *, http: HTTPClient) -> None:
         self.cooldown_until: datetime.datetime = parse_timestamp(payload["cooldown_ends_at"])
 
     def __repr__(self) -> str:
-        return f"<HypeTrainEnd id={self.id} broadcaster={self.broadcaster} total={self.total} ended_at={self.ended_at}>"
+        return f"<HypeTrainEnd id={self.id} broadcaster={self.broadcaster} total={self.total} ended_at={self.ended_at} type={self.type}>"
 
 
 class ShieldModeBegin(BaseEvent):

twitchio/types_/eventsub.py

@@ -41,6 +41,7 @@
     "AutomodTermsUpdateEvent",
     "BaseChannelPointsRewardData",
     "BaseEmoteData",
+    "BaseHypeTrainEvent",
     "ChannelAdBreakBeginEvent",
     "ChannelBanEvent",
     "ChannelBitsUseEvent",
@@ -1228,41 +1229,40 @@ class HypeTrainContributionData(TypedDict):
     total: int
 
 
-class HypeTrainBeginEvent(BaseBroadcasterEvent):
+class HypeTrainSharedParticipants(TypedDict):
+    broadcaster_user_id: str
+    broadcaster_user_login: str
+    broadcaster_user_name: str
+
+
+class BaseHypeTrainEvent(BaseBroadcasterEvent):
     id: str
     total: int
-    progress: int
-    goal: int
-    top_contributions: list[HypeTrainContributionData]
-    last_contribution: HypeTrainContributionData
     level: int
     started_at: str
+    top_contributions: list[HypeTrainContributionData]
+    shared_train_participants: list[HypeTrainSharedParticipants]
+    type: Literal["treasure", "golden_kappa", "regular"]
+    is_shared_train: bool
+
+
+class HypeTrainBeginEvent(BaseHypeTrainEvent):
+    progress: int
+    goal: int
+    all_time_high_level: int
+    all_time_high_total: int
     expires_at: str
-    is_golden_kappa_train: bool
 
 
-class HypeTrainProgressEvent(BaseBroadcasterEvent):
-    id: str
-    total: int
+class HypeTrainProgressEvent(BaseHypeTrainEvent):
     progress: int
     goal: int
-    top_contributions: list[HypeTrainContributionData]
-    last_contribution: HypeTrainContributionData
-    level: int
-    started_at: str
     expires_at: str
-    is_golden_kappa_train: bool
 
 
-class HypeTrainEndEvent(BaseBroadcasterEvent):
-    id: str
-    level: int
-    total: int
-    top_contributions: list[HypeTrainContributionData]
-    started_at: str
+class HypeTrainEndEvent(BaseHypeTrainEvent):
     ended_at: str
     cooldown_ends_at: str
-    is_golden_kappa_train: bool
 
 
 class ShieldModeBeginEvent(BroadcasterModeratorEvent):