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
//! Get all of a broadcaster’s subscriptions.
//! [`get-broadcaster-subscriptions`](https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions)
//!
//! # Accessing the endpoint
//!
//! ## Request: [GetBroadcasterSubscriptionsRequest]
//!
//! To use this endpoint, construct a [`GetBroadcasterSubscriptionsRequest`] with the [`GetBroadcasterSubscriptionsRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::subscriptions::get_broadcaster_subscriptions;
//! let request = get_broadcaster_subscriptions::GetBroadcasterSubscriptionsRequest::builder()
//! .broadcaster_id("1234")
//! .build();
//! ```
//!
//! ## Response: [BroadcasterSubscription]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, subscriptions::get_broadcaster_subscriptions};
//! # 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_broadcaster_subscriptions::GetBroadcasterSubscriptionsRequest::builder()
//! .broadcaster_id("1234")
//! .build();
//! let response: Vec<get_broadcaster_subscriptions::BroadcasterSubscription> = 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 [`GetBroadcasterSubscriptionsRequest::parse_response(None, &request.get_uri(), response)`](GetBroadcasterSubscriptionsRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Broadcaster Subscriptions](super::get_broadcaster_subscriptions)
///
/// [`get-broadcaster-subscriptions`](https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetBroadcasterSubscriptionsRequest {
/// User ID of the broadcaster. Must match the User ID in the Bearer token.
#[builder(setter(into))]
pub broadcaster_id: types::UserId,
/// Unique identifier of account to get subscription status of. Accepts up to 100 values.
#[builder(default)]
pub user_id: Vec<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 after: Option<helix::Cursor>,
/// Number of values to be returned per page. Limit: 100. Default: 20.
#[builder(setter(into), default)]
pub first: Option<String>,
}
/// Return Values for [Get Broadcaster Subscriptions](super::get_broadcaster_subscriptions)
///
/// [`get-broadcaster-subscriptions`](https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct BroadcasterSubscription {
/// User ID of the broadcaster.
pub broadcaster_id: types::UserId,
/// Login of the broadcaster.
pub broadcaster_login: types::UserName,
/// Display name of the broadcaster.
pub broadcaster_name: types::DisplayName,
/// User ID of the broadcaster.
#[serde(
default,
deserialize_with = "helix::deserialize_none_from_empty_string"
)]
pub gifter_id: Option<types::UserId>,
/// Login of the gifter.
#[serde(
default,
deserialize_with = "helix::deserialize_none_from_empty_string"
)]
pub gifter_login: Option<types::UserName>,
/// Display name of the gifter.
#[serde(
default,
deserialize_with = "helix::deserialize_none_from_empty_string"
)]
pub gifter_name: Option<types::DisplayName>,
/// Determines if the subscription is a gift subscription.
pub is_gift: bool,
/// Type of subscription (Tier 1, Tier 2, Tier 3). 1000 = Tier 1, 2000 = Tier 2, 3000 = Tier 3 subscriptions.
pub tier: types::SubscriptionTier,
/// Name of the subscription.
pub plan_name: String,
/// ID of the subscribed user.
pub user_id: types::UserId,
/// Login of the subscribed user.
pub user_login: types::UserName,
/// Display name of the subscribed user.
pub user_name: types::DisplayName,
}
impl Request for GetBroadcasterSubscriptionsRequest {
type Response = Vec<BroadcasterSubscription>;
const PATH: &'static str = "subscriptions";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] =
&[twitch_oauth2::Scope::ChannelReadSubscriptions];
}
impl RequestGet for GetBroadcasterSubscriptionsRequest {}
impl helix::Paginated for GetBroadcasterSubscriptionsRequest {
fn set_pagination(&mut self, cursor: Option<helix::Cursor>) { self.after = cursor }
}
impl helix::Response<GetBroadcasterSubscriptionsRequest, Vec<BroadcasterSubscription>> {
/// The current number of subscriber points earned by this broadcaster.
pub fn points(&self) -> Result<i64, BroadcasterSubscriptionPointsError> {
let points = self.get_other("points")?;
if let Some(points) = points {
Ok(points)
} else {
Err(BroadcasterSubscriptionPointsError::PointsNotFound)
}
}
}
/// Errors when retrieving `points` in [Get Broadcaster Subscriptions](self)
#[derive(Debug, thiserror::Error)]
pub enum BroadcasterSubscriptionPointsError {
/// Deserialization error
#[error(transparent)]
DeserError(#[from] serde_json::Error),
/// `points` not found in the response
#[error("`points` not found in the response")]
PointsNotFound,
}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetBroadcasterSubscriptionsRequest::builder()
.broadcaster_id("123".to_string())
.build();
// From twitch docs. Example has ...
let data = br#"
{
"data": [
{
"broadcaster_id": "141981764",
"broadcaster_login": "twitchdev",
"broadcaster_name": "TwitchDev",
"gifter_id": "12826",
"gifter_login": "twitch",
"gifter_name": "Twitch",
"is_gift": true,
"tier": "1000",
"plan_name": "Channel Subscription (twitchdev)",
"user_id": "527115020",
"user_name": "twitchgaming",
"user_login": "twitchgaming"
}
],
"pagination": {
"cursor": "xxxx"
},
"total": 13,
"points": 13
}
"#
.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/subscriptions?broadcaster_id=123"
);
let resp =
dbg!(
GetBroadcasterSubscriptionsRequest::parse_response(Some(req), &uri, http_response)
.unwrap()
);
assert_eq!(resp.total, Some(13));
assert_eq!(resp.points().unwrap(), 13);
}