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

//! Starts a commercial on a specified channel.
//! [`start-commercial`](https://dev.twitch.tv/docs/api/reference#start-commercial)
//!
//! # Accessing the endpoint
//!
//! ## Request: [StartCommercialRequest]
//!
//! To use this endpoint, construct a [`StartCommercialRequest`] with the [`StartCommercialRequest::new()`] method.
//!
//! ```rust, no_run
//! use twitch_api2::helix::channels::start_commercial;
//! let request = start_commercial::StartCommercialRequest::new();
//! ```
//!
//! ## Body: [StartCommercialBody]
//!
//! We also need to provide a body to the request specifying length of commercial and where to start it.
//!
//! ```
//! # use twitch_api2::helix::channels::start_commercial;
//! let body = start_commercial::StartCommercialBody::builder()
//!     .broadcaster_id("1234".to_string())
//!     .length(twitch_api2::types::CommercialLength::Length90)
//!     .build();
//! ```
//!
//! ## Response: [StartCommercialRequest]
//!
//! Send the request to receive the response with [`HelixClient::req_post()`](helix::HelixClient::req_post).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, channels::start_commercial};
//! # 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 = start_commercial::StartCommercialRequest::new();
//! let body = start_commercial::StartCommercialBody::builder()
//!     .broadcaster_id("1234".to_string())
//!     .length(twitch_api2::types::CommercialLength::Length90)
//!     .build();
//! let response: Vec<start_commercial::StartCommercial> = client.req_post(request, body, &token).await?.data;
//! # Ok(())
//! # }
//! ```
//!
//! You can also get the [`http::Request`] with [`request.create_request(body, &token, &client_id)`](helix::RequestPost::create_request)
//! and parse the [`http::Response`] with [`request.parse_response(&request.get_uri()?)`](helix::RequestPost::parse_response())
use super::*;

impl StartCommercialRequest {
    /// Create a new [`StartCommercialRequest`]
    pub fn new() -> Self { StartCommercialRequest {} }
}
// Not implementing builder since it's not really needed...
/// Query Parameters for [Start Commercial](super::start_commercial)
///
/// [`start-commercial`](https://dev.twitch.tv/docs/api/reference#start-commercial)
#[derive(PartialEq, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct StartCommercialRequest {}

impl Default for StartCommercialRequest {
    fn default() -> Self { StartCommercialRequest::new() }
}

/// Body Parameters for [Start Commercial](super::start_commercial)
///
/// [`start-commercial`](https://dev.twitch.tv/docs/api/reference#start-commercial)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct StartCommercialBody {
    /// ID of the channel requesting a commercial
    pub broadcaster_id: types::UserId,
    /// Desired length of the commercial in seconds. Valid options are 30, 60, 90, 120, 150, 180.
    #[builder(setter(into))]
    pub length: types::CommercialLength,
}

/// Return Values for [Start Commercial](super::start_commercial)
///
/// [`start-commercial`](https://dev.twitch.tv/docs/api/reference#start-commercial)
#[derive(PartialEq, Deserialize, Debug, Clone)]
#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct StartCommercial {
    /// Length of the triggered commercial
    pub length: types::CommercialLength,
    /// Provides contextual information on why the request failed
    pub message: String,
    /// Seconds until the next commercial can be served on this channel
    pub retry_after: u64,
}

impl helix::Request for StartCommercialRequest {
    /// FIXME: Make non-vec
    type Response = Vec<StartCommercial>;

    const PATH: &'static str = "channels/commercial";
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: &'static [twitch_oauth2::Scope] = &[twitch_oauth2::Scope::ChannelEditCommercial];
}

impl helix::RequestPost for StartCommercialRequest {
    type Body = StartCommercialBody;
}

#[test]
fn test_request() {
    use helix::*;
    let req = StartCommercialRequest {};

    // From twitch docs
    let data = br#"
{
    "data": [{
      "length" : 60,
      "message" : "",
      "retry_after" : 480
    }]
}
"#
    .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/channels/commercial?"
    );

    dbg!(StartCommercialRequest::parse_response(Some(req), &uri, http_response).unwrap());
}