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 196 197 198 199 200 201
//! Gets information on follow relationships between two Twitch users.
//! [`get-users-follows`](https://dev.twitch.tv/docs/api/reference#get-users-follows)
//!
//! ## Request: [GetUsersFollowsRequest]
//!
//! To use this endpoint, construct a [`GetUsersFollowsRequest`] with the [`GetUsersFollowsRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::users::get_users_follows;
//! let request = get_users_follows::GetUsersFollowsRequest::builder()
//! .to_id(Some("1234".into()))
//! .build();
//! ```
//!
//! ## Response: [UsersFollows]
//!
//! 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_follows};
//! # 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_follows::GetUsersFollowsRequest::builder()
//! .to_id(Some("1234".into()))
//! .build();
//! let response: Vec<get_users_follows::FollowRelationship> = client.req_get(request, &token).await?.data.follow_relationships;
//! # 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 [`GetUsersFollowsRequest::parse_response(None, &request.get_uri(), response)`](GetUsersFollowsRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Users Follows](super::get_users_follows)
///
/// [`get-users-follows`](https://dev.twitch.tv/docs/api/reference#get-users-follows)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetUsersFollowsRequest {
/// 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 after: Option<helix::Cursor>,
/// Maximum number of objects to return. Maximum: 100. Default: 20.
#[builder(default, setter(into))]
pub first: Option<usize>,
/// User ID. The request returns information about users who are being followed by the from_id user.
#[builder(default, setter(into))]
pub from_id: Option<types::UserId>,
/// User ID. The request returns information about users who are following the to_id user.
#[builder(default, setter(into))]
pub to_id: Option<types::UserId>,
}
/// Return Values for [Get Users Follows](super::get_users_follows)
///
/// [`get-users-follows`](https://dev.twitch.tv/docs/api/reference#get-users-follows)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct UsersFollows {
/// Total number of items returned in all pages.
///
/// * If only `from_id` was in the request, this is the total number of followed users.
/// * If only `to_id` was in the request, this is the total number of followers.
/// * If both `from_id` and `to_id` were in the request, this is 1 (if the "from" user follows the "to" user) or 0.
pub total: i64,
/// The follow relationships returned by this endpoint on this page. See [Response::get_next](helix::Response::get_next) for getting more pages
pub follow_relationships: Vec<FollowRelationship>,
}
/// Describes a follow relationship
///
/// Used in [UsersFollows]
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct FollowRelationship {
///Date and time when the from_id user followed the to_id user.
pub followed_at: types::Timestamp,
///ID of the user following the to_id user.
pub from_id: types::UserId,
///Display name corresponding to from_id.
pub from_name: types::DisplayName,
/// Login of the user following the to_id user.
pub from_login: types::UserName,
///ID of the user being followed by the from_id user.
pub to_id: types::UserId,
///Display name corresponding to to_id.
pub to_name: types::DisplayName,
///Login of the user being followed by the from_id user.
pub to_login: types::UserName,
}
impl Request for GetUsersFollowsRequest {
type Response = UsersFollows;
#[cfg(feature = "twitch_oauth2")]
const OPT_SCOPE: &'static [twitch_oauth2::Scope] = &[];
const PATH: &'static str = "users/follows";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] = &[];
}
impl RequestGet for GetUsersFollowsRequest {
fn parse_inner_response(
request: Option<Self>,
uri: &http::Uri,
response: &str,
status: http::StatusCode,
) -> Result<helix::Response<Self, Self::Response>, helix::HelixRequestGetError>
where
Self: Sized,
{
#[derive(PartialEq, Deserialize, Debug, Clone)]
struct InnerResponse {
data: Vec<FollowRelationship>,
total: i64,
#[serde(default)]
pagination: helix::Pagination,
}
let response: InnerResponse = helix::parse_json(response, true).map_err(|e| {
helix::HelixRequestGetError::DeserializeError(
response.to_string(),
e,
uri.clone(),
status,
)
})?;
Ok(helix::Response {
data: UsersFollows {
total: response.total,
follow_relationships: response.data,
},
pagination: response.pagination.cursor,
request,
total: Some(response.total),
other: None,
})
}
}
impl helix::Paginated for GetUsersFollowsRequest {
fn set_pagination(&mut self, cursor: Option<helix::Cursor>) { self.after = cursor }
}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetUsersFollowsRequest::builder()
.to_id(Some("23161357".into()))
.build();
// From twitch docs
let data = br#"
{
"total": 12345,
"data":
[
{
"from_id": "171003792",
"from_login": "iiisutha067iii",
"from_name": "IIIsutha067III",
"to_id": "23161357",
"to_name": "LIRIK",
"to_login": "lirik",
"followed_at": "2017-08-22T22:55:24Z"
},
{
"from_id": "113627897",
"from_login": "birdman616",
"from_name": "Birdman616",
"to_id": "23161357",
"to_name": "LIRIK",
"to_login": "lirik",
"followed_at": "2017-08-22T22:55:04Z"
}
],
"pagination":{
"cursor": "eyJiIjpudWxsLCJhIjoiMTUwMzQ0MTc3NjQyNDQyMjAwMCJ9"
}
}
"#
.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/follows?to_id=23161357"
);
dbg!(GetUsersFollowsRequest::parse_response(Some(req), &uri, http_response).unwrap());
}