twitch_highway 0.3.2

Twitch API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

mod builder;
mod response;
mod types;

pub use builder::GetHypeTrainEventsBuilder;
pub use response::{HypeTrainResponse, HypeTrainStatusResponse};
pub use types::{
    AllTimeHigh, Current, HypeTrain, HypeTrainContribution, HypeTrainEvent, HypeTrainStatus,
    HypeTrainType, SharedAllTimeHigh, SharedTrainParticipant,
};

use crate::types::{
    constants::{HYPE_TRAIN, STATUS},
    BroadcasterId,
};
use crate::{request::TwitchAPIRequest, TwitchAPI};

pub trait HypeTrainAPI {
    #[deprecated(
        since = "0.2.1",
        note = "Use get_hype_train_status instead. Removed by Twitch on Dec 4, 2025"
    )]
    /// Gets information about the broadcaster’s current or most recent Hype Train event
    ///
    /// # **DEPRECATED**
    ///
    /// Scheduled for removal on **December 4, 2025**.
    ///
    /// Use [`get_hype_train_status`](HypeTrainAPI::get_hype_train_status) instead.
    ///
    /// See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299)
    ///
    /// # Arguments
    ///
    /// * `broadcaster_id` - The ID of the broadcaster that’s running the Hype Train.
    ///
    /// # Returns
    ///
    /// Returns a [`GetHypeTrainEventsBuilder`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     hype_train::HypeTrainAPI,
    ///     types::BroadcasterId,
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .get_hype_train_events(&BroadcasterId::from("1234"))
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// `channel:read:hype_train`
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-hype-train-events>
    fn get_hype_train_events<'a>(
        &'a self,
        broadcaster_id: &'a BroadcasterId,
    ) -> GetHypeTrainEventsBuilder<'a>;

    /// Get the status of a Hype Train for the specified broadcaster
    ///
    /// # Arguments
    ///
    /// * `broadcaster_id` - The User ID of the channel broadcaster.
    ///
    /// # Returns
    ///
    /// Returns a [`HypeTrainStatusResponse`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     hype_train::HypeTrainAPI,
    ///     types::BroadcasterId,
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .get_hype_train_status(&BroadcasterId::from("1234"))
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// `channel:read:hype_train`
    ///
    /// API Reference
    ///
    // <https://dev.twitch.tv/docs/api/reference/#get-hype-train-status>
    fn get_hype_train_status(
        &self,
        broadcaster_id: &BroadcasterId,
    ) -> TwitchAPIRequest<HypeTrainStatusResponse>;
}

impl HypeTrainAPI for TwitchAPI {
    fn get_hype_train_events<'a>(
        &'a self,
        broadcaster_id: &'a BroadcasterId,
    ) -> GetHypeTrainEventsBuilder<'a> {
        GetHypeTrainEventsBuilder::new(self, broadcaster_id)
    }
    simple_endpoint!(
        fn get_hype_train_status(
            broadcaster_id: &BroadcasterId
        ) -> HypeTrainStatusResponse;
            endpoint: GetHypeTrainStatus,
            method: GET,
            path: [HYPE_TRAIN, STATUS],
    );
}