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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
#![allow(deprecated_in_future, deprecated)]
//! Gets the information of the most recent Hype Train of the given channel ID.
//! [`get-hype-train-events`](https://dev.twitch.tv/docs/api/reference#get-hype-train-events)
//!
//! # Accessing the endpoint
//!
//! ## Request: [GetHypeTrainEventsRequest]
//!
//! To use this endpoint, construct a [`GetHypeTrainEventsRequest`] with the [`GetHypeTrainEventsRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::hypetrain::get_hypetrain_events;
//! let request = get_hypetrain_events::GetHypeTrainEventsRequest::builder()
//! .broadcaster_id("4321".to_string())
//! .build();
//! ```
//!
//! ## Response: [HypeTrainEvent](types::TwitchCategory)
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, hypetrain::get_hypetrain_events};
//! # use twitch_api2::client;
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
//! # let client: helix::HelixClient<'static, client::DummyHttpClient> = helix::HelixClient::default();
//! # let token = twitch_oauth2::AccessToken::new("validtoken".to_string());
//! # let token = twitch_oauth2::UserToken::from_existing(&client, token, None, None).await?;
//! let request = get_hypetrain_events::GetHypeTrainEventsRequest::builder()
//! .broadcaster_id("4321".to_string())
//! .build();
//! let response: Vec<get_hypetrain_events::HypeTrainEvent> = client.req_get(request, &token).await?.data;
//! # Ok(())
//! # }
//! ```
//!
//! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestGet::create_request)
//! and parse the [`http::Response`] with [`GetHypeTrainEventsRequest::parse_response(None, &request.get_uri(), response)`](GetHypeTrainEventsRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Hype Train Events](super::get_hypetrain_events)
///
/// [`get-hype-train-events`](https://dev.twitch.tv/docs/api/reference#get-hype-train-events)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetHypeTrainEventsRequest {
/// Must match the User ID in the Bearer token.
#[builder(setter(into))]
pub broadcaster_id: types::UserId,
/// Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
#[builder(default)]
pub cursor: Option<helix::Cursor>,
/// Maximum number of objects to return. Maximum: 100. Default: 20.
#[builder(default, setter(into))]
pub first: Option<usize>,
/// Retreive a single event by event ID
#[deprecated(
since = "0.6.0",
note = "this does nothing, see https://discuss.dev.twitch.tv/t/get-hype-train-events-api-endpoint-id-query-parameter-deprecation/37613"
)]
#[builder(default, setter(into))]
pub id: Option<String>,
}
/// Return Values for [Get Hype Train Events](super::get_hypetrain_events)
///
/// [`get-hype-train-events`](https://dev.twitch.tv/docs/api/reference#get-hype-train-events)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct HypeTrainEvent {
/// Event ID
pub id: String,
/// Displays hypetrain.{event_name}, currently only hypetrain.progression
pub event_type: HypeTrainEventType,
/// RFC3339 formatted timestamp for events.
pub event_timestamp: types::Timestamp,
/// Returns the version of the endpoint.
pub version: String,
/// Returns `broadcaster_id`, `broadcaster_name`, `user_id`, `user_name`, and `expires_at`.
pub event_data: HypeTrainEventData,
}
/// Type of Hype Train event
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[non_exhaustive]
pub enum HypeTrainEventType {
/// Progression
#[serde(rename = "hypetrain.progression")]
Progression,
}
/// Event data for
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct HypeTrainEventData {
/// The requested broadcaster ID.
pub broadcaster_id: types::UserId,
/// The time at which the hype train expires. The expiration is extended when the hype train reaches a new level.
pub expires_at: types::Timestamp,
/// RFC3339 formatted timestamp of when another hype train can be started again
pub cooldown_end_time: types::Timestamp,
/// The number of points required to reach the next level.
pub goal: i64,
/// The most recent contribution.
pub last_contribution: Contribution,
/// Current level of hype train event.
pub level: i64,
/// The timestamp at which the hype train started.
pub started_at: types::Timestamp,
// FIXME: Contains a maximum of two user objects
/// The contributors with the most points contributed.
pub top_contributions: Vec<Contribution>,
/// Total points contributed to the hype train.
pub total: i64,
/// The distinct ID of this Hype Train
pub id: types::HypeTrainId,
}
impl Request for GetHypeTrainEventsRequest {
type Response = Vec<HypeTrainEvent>;
const PATH: &'static str = "hypetrain/events";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] = &[];
}
impl RequestGet for GetHypeTrainEventsRequest {}
impl helix::Paginated for GetHypeTrainEventsRequest {
fn set_pagination(&mut self, cursor: Option<helix::Cursor>) { self.cursor = cursor }
}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetHypeTrainEventsRequest::builder()
.broadcaster_id("270954519".to_string())
.build();
// From twitch docs
let data = br#"
{
"data": [
{
"id": "1b0AsbInCHZW2SQFQkCzqN07Ib2",
"event_type": "hypetrain.progression",
"event_timestamp": "2020-04-24T20:07:24Z",
"version": "1.0",
"event_data": {
"broadcaster_id": "270954519",
"cooldown_end_time": "2020-04-24T20:13:21.003802269Z",
"expires_at": "2020-04-24T20:12:21.003802269Z",
"goal": 1800,
"id": "70f0c7d8-ff60-4c50-b138-f3a352833b50",
"last_contribution": {
"total": 200,
"type": "BITS",
"user": "134247454"
},
"level": 2,
"started_at": "2020-04-24T20:05:47.30473127Z",
"top_contributions": [
{
"total": 600,
"type": "BITS",
"user": "134247450"
}
],
"total": 600
}
}
],
"pagination": {
"cursor": "eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjI3MDk1NDUxOToxNTg3NzU4ODQ0OjFiMEFzYkluQ0haVzJTUUZRa0N6cU4wN0liMiJ9fQ"
}
}
"#
.to_vec();
let http_response = http::Response::builder().body(data).unwrap();
let uri = req.get_uri().unwrap();
assert_eq!(
uri.to_string(),
"https://api.twitch.tv/helix/hypetrain/events?broadcaster_id=270954519"
);
dbg!(GetHypeTrainEventsRequest::parse_response(Some(req), &uri, http_response).unwrap());
}