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
//! Gets a list of chat badges that can be used in chat for any channel.
//! [`get-global-chat-badges`](https://dev.twitch.tv/docs/api/reference#get-global-chat-badges)
//!
//! # Accessing the endpoint
//!
//! ## Request: [GetGlobalChatBadgesRequest]
//!
//! To use this endpoint, construct a [`GetGlobalChatBadgesRequest`] with the [`GetGlobalChatBadgesRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::chat::get_global_chat_badges;
//! let request = get_global_chat_badges::GetGlobalChatBadgesRequest::new();
//! ```
//!
//! ## Response: [BadgeSet]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, chat::get_global_chat_badges};
//! # 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_global_chat_badges::GetGlobalChatBadgesRequest::new();
//! let response: Vec<helix::chat::BadgeSet> = 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 [`GetGlobalChatBadgesRequest::parse_response(None, &request.get_uri(), response)`](GetGlobalChatBadgesRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Global Chat Badges](super::get_global_chat_badges)
///
/// [`get-global-chat-badges`](https://dev.twitch.tv/docs/api/reference#get-global-chat-badges)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug, Default)]
#[non_exhaustive]
pub struct GetGlobalChatBadgesRequest {}
impl GetGlobalChatBadgesRequest {
/// Make a new [`Self`]
pub fn new() -> Self { Self::default() }
}
/// Return Values for [Get Global Chat Badges](super::get_global_chat_badges)
///
/// [`get-global-chat-badges`](https://dev.twitch.tv/docs/api/reference#get-global-chat-badges)
pub type GetGlobalChatBadgesResponse = BadgeSet;
impl Request for GetGlobalChatBadgesRequest {
type Response = Vec<GetGlobalChatBadgesResponse>;
const PATH: &'static str = "chat/badges/global";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] = &[];
}
impl RequestGet for GetGlobalChatBadgesRequest {}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetGlobalChatBadgesRequest::new();
// From twitch docs
// FIXME: Example has ...
let data = br#"
{
"data": [
{
"set_id": "vip",
"versions": [
{
"id": "1",
"image_url_1x": "https://static-cdn.jtvnw.net/badges/v1/b817aba4-fad8-49e2-b88a-7cc744dfa6ec/1",
"image_url_2x": "https://static-cdn.jtvnw.net/badges/v1/b817aba4-fad8-49e2-b88a-7cc744dfa6ec/2",
"image_url_4x": "https://static-cdn.jtvnw.net/badges/v1/b817aba4-fad8-49e2-b88a-7cc744dfa6ec/3"
}
]
}
]
}
"#
.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/chat/badges/global?"
);
dbg!(GetGlobalChatBadgesRequest::parse_response(Some(req), &uri, http_response).unwrap());
}