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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
//! Updates the status of Custom Reward Redemption objects on a channel that are in the UNFULFILLED status.
//!
//! Only redemptions for a reward created by the same client_id as attached to the access token can be updated.
//! [`update-redemption-status`](https://dev.twitch.tv/docs/api/reference#update-redemption-status)
//!
//! # Accessing the endpoint
//!
//! ## Request: [UpdateRedemptionStatusRequest]
//!
//! To use this endpoint, construct a [`UpdateRedemptionStatusRequest`] with the [`UpdateRedemptionStatusRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::points::UpdateRedemptionStatusRequest;
//! let request = UpdateRedemptionStatusRequest::builder()
//! .broadcaster_id("274637212".to_string())
//! .reward_id("92af127c-7326-4483-a52b-b0da0be61c01".to_string())
//! .id("17fa2df1-ad76-4804-bfa5-a40ef63efe63".to_string())
//! .build();
//! ```
//!
//! ## Body: [UpdateRedemptionStatusBody]
//!
//! We also need to provide a body to the request containing what we want to change.
//!
//! ```
//! use twitch_api2::helix::points::{CustomRewardRedemptionStatus, UpdateRedemptionStatusBody};
//! let body = UpdateRedemptionStatusBody::builder()
//! .status(CustomRewardRedemptionStatus::Canceled)
//! .build();
//! ```
//!
//! ## Response: [UpdateRedemptionStatusInformation]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix;
//! use twitch_api2::helix::points::{
//! CustomRewardRedemptionStatus, UpdateRedemptionStatusBody,
//! UpdateRedemptionStatusInformation, UpdateRedemptionStatusRequest,
//! };
//! # 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 = UpdateRedemptionStatusRequest::builder()
//! .broadcaster_id("274637212".to_string())
//! .reward_id("92af127c-7326-4483-a52b-b0da0be61c01".to_string())
//! .id("17fa2df1-ad76-4804-bfa5-a40ef63efe63".to_string())
//! .build();
//! let body = UpdateRedemptionStatusBody::builder()
//! .status(CustomRewardRedemptionStatus::Canceled)
//! .build();
//! let response: UpdateRedemptionStatusInformation =
//! client.req_patch(request, body, &token).await?.data;
//! # Ok(())
//! # }
//! ```
//!
//! You can also get the [`http::Request`] with [`request.create_request(body, &token, &client_id)`](helix::RequestPatch::create_request)
//! and parse the [`http::Response`] with [`UpdateRedemptionStatusRequest::parse_response(None, &request.get_uri(), response)`](UpdateRedemptionStatusRequest::parse_response)
use crate::helix::{parse_json, HelixRequestPatchError};
pub use super::CustomRewardRedemption;
use super::*;
use helix::RequestPatch;
/// Query Parameters for [Update Redemption Status](super::update_redemption_status)
///
/// [`update-redemption-status`](https://dev.twitch.tv/docs/api/reference#update-redemption-status)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct UpdateRedemptionStatusRequest {
/// Provided broadcaster_id must match the user_id in the auth token.
#[builder(setter(into))]
pub broadcaster_id: types::UserId,
/// ID of the Custom Reward the redemptions to be updated are for.
#[builder(setter(into))]
pub reward_id: types::RewardId,
/// ID of the Custom Reward Redemption to update, must match a Custom Reward Redemption on broadcaster_id’s channel
#[builder(setter(into))]
pub id: types::RedemptionId,
}
/// Body Parameters for [Update Redemption Status](super::update_redemption_status)
///
/// [`update-redemption-status`](https://dev.twitch.tv/docs/api/reference#update-redemption-status)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct UpdateRedemptionStatusBody {
/// The new status to set redemptions to. Can be either FULFILLED or CANCELED. Updating to CANCELED will refund the user their points.
#[builder(setter(into))]
pub status: CustomRewardRedemptionStatus,
}
/// FIXME: Returns an object.
/// Return Values for [Update Redemption Status](super::update_redemption_status)
///
/// [`update-redemption-status`](https://dev.twitch.tv/docs/api/reference#update-redemption-status)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[non_exhaustive]
pub enum UpdateRedemptionStatusInformation {
/// 200 - OK
Success(CustomRewardRedemption),
}
impl Request for UpdateRedemptionStatusRequest {
type Response = UpdateRedemptionStatusInformation;
const PATH: &'static str = "channel_points/custom_rewards/redemptions";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] =
&[twitch_oauth2::scopes::Scope::ChannelManageBroadcast];
}
impl RequestPatch for UpdateRedemptionStatusRequest {
type Body = UpdateRedemptionStatusBody;
fn parse_inner_response(
request: Option<Self>,
uri: &http::Uri,
response: &str,
status: http::StatusCode,
) -> Result<helix::Response<Self, Self::Response>, helix::HelixRequestPatchError>
where
Self: Sized,
{
let resp = match status {
http::StatusCode::OK => {
let resp: helix::InnerResponse<Vec<CustomRewardRedemption>> =
parse_json(response, true).map_err(|e| {
HelixRequestPatchError::DeserializeError(
response.to_string(),
e,
uri.clone(),
status,
)
})?;
UpdateRedemptionStatusInformation::Success(resp.data.into_iter().next().ok_or(
helix::HelixRequestPatchError::InvalidResponse {
reason: "expected at least one element in data",
response: response.to_string(),
status,
uri: uri.clone(),
},
)?)
}
_ => {
return Err(helix::HelixRequestPatchError::InvalidResponse {
reason: "unexpected status code",
response: response.to_string(),
status,
uri: uri.clone(),
})
}
};
Ok(helix::Response {
data: resp,
pagination: None,
request,
total: None,
other: None,
})
}
}
impl helix::private::SealedSerialize for UpdateRedemptionStatusBody {}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = UpdateRedemptionStatusRequest::builder()
.broadcaster_id("274637212".to_string())
.reward_id("92af127c-7326-4483-a52b-b0da0be61c01".to_string())
.id("17fa2df1-ad76-4804-bfa5-a40ef63efe63".to_string())
.build();
let body = UpdateRedemptionStatusBody::builder()
.status(CustomRewardRedemptionStatus::Unfulfilled)
.build();
dbg!(req.create_request(body, "abcd", "client").unwrap());
// From twitch docs
let data = br##"
{
"data": [
{
"broadcaster_name": "torpedo09",
"broadcaster_login": "torpedo09",
"broadcaster_id": "274637212",
"id": "17fa2df1-ad76-4804-bfa5-a40ef63efe63",
"user_id": "274637212",
"user_name": "torpedo09",
"user_login": "torpedo09",
"user_input": "",
"status": "CANCELED",
"redeemed_at": "2020-07-01T18:37:32Z",
"reward": {
"id": "92af127c-7326-4483-a52b-b0da0be61c01",
"title": "game analysis",
"prompt": "",
"cost": 50000
}
}
]
}
"##
.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/channel_points/custom_rewards/redemptions?broadcaster_id=274637212&reward_id=92af127c-7326-4483-a52b-b0da0be61c01&id=17fa2df1-ad76-4804-bfa5-a40ef63efe63"
);
dbg!(UpdateRedemptionStatusRequest::parse_response(Some(req), &uri, http_response).unwrap());
}