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
//! Gets information about one or more specified Twitch users.
//! [`get-users`](https://dev.twitch.tv/docs/api/reference#get-users)
//!
//! ## Request: [GetUsersRequest]
//!
//! To use this endpoint, construct a [`GetUsersRequest`] with the [`GetUsersRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::users::get_users;
//! let request = get_users::GetUsersRequest::builder()
//! .id(vec!["1234".into()])
//! .login(vec!["justintvfan".into()])
//! .build();
//! ```
//!
//! ## Response: [User]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, users::get_users};
//! # 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_users::GetUsersRequest::builder()
//! .id(vec!["1234".into()])
//! .login(vec!["justintvfan".into()])
//! .build();
//! let response: Vec<get_users::User> = 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 [`GetUsersRequest::parse_response(None, &request.get_uri(), response)`](GetUsersRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Users](super::get_users)
///
/// [`get-users`](https://dev.twitch.tv/docs/api/reference#get-users)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetUsersRequest {
/// User ID. Multiple user IDs can be specified. Limit: 100.
#[builder(default)]
pub id: Vec<types::UserId>,
/// User login name. Multiple login names can be specified. Limit: 100.
#[builder(default)]
pub login: Vec<types::UserName>,
}
/// Return Values for [Get Users](super::get_users)
///
/// [`get-users`](https://dev.twitch.tv/docs/api/reference#get-users)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct User {
/// User’s broadcaster type: "partner", "affiliate", or "".
pub broadcaster_type: Option<types::BroadcasterType>,
/// Date when the user was created.
pub created_at: types::Timestamp,
/// User’s channel description.
pub description: Option<String>,
/// User’s display name.
pub display_name: types::DisplayName,
/// User’s email address. Returned if the request includes the [`user:read:email` scope](twitch_oauth2::Scope::UserReadEmail).
pub email: Option<String>,
/// User’s ID.
pub id: types::UserId,
/// User’s login name.
pub login: types::UserName,
/// URL of the user’s offline image.
pub offline_image_url: Option<String>,
/// URL of the user’s profile image.
pub profile_image_url: Option<String>,
/// User’s type: "staff", "admin", "global_mod", or "".
#[serde(rename = "type")]
pub type_: Option<types::UserType>,
/// Total number of views of the user’s channel.
pub view_count: usize,
}
impl Request for GetUsersRequest {
type Response = Vec<User>;
#[cfg(feature = "twitch_oauth2")]
const OPT_SCOPE: &'static [twitch_oauth2::Scope] = &[twitch_oauth2::Scope::UserReadEmail];
const PATH: &'static str = "users";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] = &[];
}
impl RequestGet for GetUsersRequest {}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetUsersRequest::builder()
.id(vec!["44322889".into()])
.build();
// From twitch docs
// FIXME: This is not valid anymore. Twitch....
let data = br#"
{
"data": [
{
"id": "141981764",
"login": "twitchdev",
"display_name": "TwitchDev",
"type": "",
"broadcaster_type": "partner",
"description": "Supporting third-party developers building Twitch integrations from chatbots to game integrations.",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/8a6381c7-d0c0-4576-b179-38bd5ce1d6af-profile_image-300x300.png",
"offline_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/3f13ab61-ec78-4fe6-8481-8682cb3b0ac2-channel_offline_image-1920x1080.png",
"view_count": 5980557,
"email": "not-real@email.com",
"created_at": "2016-12-14T20:32:28.894263Z"
}
]
}
"#
.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/users?id=44322889"
);
dbg!(GetUsersRequest::parse_response(Some(req), &uri, http_response).unwrap());
}