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
//! 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, no_run
//! 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, UpdateRedemptionStatusRequest, UpdateRedemptionStatusBody, UpdateRedemptionStatusInformation};
//! # 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(twitch_oauth2::dummy_http_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?;
//! # 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 [`request.parse_response(&request.get_uri()?)`](helix::RequestPatch::parse_response())

use super::*;

/// 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(default, setter(into))]
    pub broadcaster_id: types::UserId,

    /// ID of the Custom Reward the redemptions to be updated are for.
    #[builder(default, 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(default, 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, Debug, Clone)]
#[non_exhaustive]
pub enum UpdateRedemptionStatusInformation {
    /// 200 - OK
    Success,
    /// 400 - Bad Request: Query Parameter missing or invalid
    MissingQuery,
    /// 403 - Forbidden: The Custom Reward was created by a different client_id or Channel Points are not available for the broadcaster
    Forbidden,
    /// 404 - Not Found: No Custom Reward Redemptions with the specified IDs were found with a status of UNFULFILLED.
    NotFound,
    /// Internal Server Error; Failed to update channel
    InternalServerError,
}

impl std::convert::TryFrom<http::StatusCode> for UpdateRedemptionStatusInformation {
    type Error = std::borrow::Cow<'static, str>;

    fn try_from(s: http::StatusCode) -> Result<Self, Self::Error> {
        match s {
            http::StatusCode::OK => Ok(UpdateRedemptionStatusInformation::Success),
            http::StatusCode::BAD_REQUEST => Ok(UpdateRedemptionStatusInformation::MissingQuery),
            http::StatusCode::FORBIDDEN => Ok(UpdateRedemptionStatusInformation::Forbidden),
            http::StatusCode::NOT_FOUND => Ok(UpdateRedemptionStatusInformation::NotFound),
            other => Err(other.canonical_reason().unwrap_or("").into()),
        }
    }
}

impl helix::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 helix::RequestPatch for UpdateRedemptionStatusRequest {
    type Body = UpdateRedemptionStatusBody;
}

#[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();

    // From twitch docs
    let data = br##"
 {
    "data": [
        {
            "broadcaster_name": "torpedo09",
            "broadcaster_id": "274637212",
            "id": "17fa2df1-ad76-4804-bfa5-a40ef63efe63",
            "user_id": "274637212",
            "user_name": "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(&uri, http_response).unwrap());
}