twitch_api 0.7.2

//! Sends a whisper message to the specified user.
//! [`send-whisper`](https://dev.twitch.tv/docs/api/reference#send-whisper)
//!
//! # Accessing the endpoint
//!
//! ## Request: [SendWhisperRequest]
//!
//! To use this endpoint, construct a [`SendWhisperRequest`] with the [`SendWhisperRequest::new()`] method.
//!
//! ```rust
//! use twitch_api::helix::whispers::send_whisper;
//! let request = send_whisper::SendWhisperRequest::new("456", "123");
//! ```
//!
//! ## Body: [SendWhisperBody]
//!
//! We also need to provide a body to the request containing what we want to change.
//!
//! ```
//! # use twitch_api::helix::whispers::send_whisper;
//! let body = send_whisper::SendWhisperBody::new("Hello!");
//! ```
//!
//! ## Response: [SendWhisperResponse]
//!
//!
//! Send the request to receive the response with [`HelixClient::req_post()`](helix::HelixClient::req_post).
//!
//!
//! ```rust, no_run
//! use twitch_api::helix::{self, whispers::send_whisper};
//! # use twitch_api::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 = send_whisper::SendWhisperRequest::new("456", "123");
//! let body = send_whisper::SendWhisperBody::new("Hello!");
//! let response: send_whisper::SendWhisperResponse = client.req_post(request, body, &token).await?.data;
//! # Ok(())
//! # }
//! ```
//!
//! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestPost::create_request)
//! and parse the [`http::Response`] with [`SendWhisperRequest::parse_response(None, &request.get_uri(), response)`](SendWhisperRequest::parse_response)

use super::*;
use helix::RequestPost;
/// Query Parameters for [Send Whisper](super::send_whisper)
///
/// [`send-whisper`](https://dev.twitch.tv/docs/api/reference#send-whisper)
#[derive(PartialEq, Eq, Deserialize, Serialize, Clone, Debug)]
#[cfg_attr(feature = "typed-builder", derive(typed_builder::TypedBuilder))]
#[must_use]
#[non_exhaustive]
pub struct SendWhisperRequest<'a> {
    /// The ID of the user sending the whisper. This user must have a verified phone number.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    #[cfg_attr(feature = "deser_borrow", serde(borrow = "'a"))]
    pub from_user_id: Cow<'a, types::UserIdRef>,
    /// The ID of the user to receive the whisper.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    #[cfg_attr(feature = "deser_borrow", serde(borrow = "'a"))]
    pub to_user_id: Cow<'a, types::UserIdRef>,
}

impl<'a> SendWhisperRequest<'a> {
    /// Create a new [`SendWhisperRequest`]
    pub fn new(
        from: impl types::IntoCow<'a, types::UserIdRef> + 'a,
        to: impl types::IntoCow<'a, types::UserIdRef> + 'a,
    ) -> Self {
        Self {
            from_user_id: from.into_cow(),
            to_user_id: to.into_cow(),
        }
    }
}

/// Body Parameters for [Send Whisper](super::send_whisper)
///
/// [`send-whisper`](https://dev.twitch.tv/docs/api/reference#send-whisper)
#[derive(PartialEq, Eq, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct SendWhisperBody<'a> {
    /// The whisper message to send. The message must not be empty.
    ///
    /// The maximum message lengths are:
    ///
    /// 500 characters if the user you're sending the message to hasn't whispered you before.
    /// 10,000 characters if the user you're sending the message to has whispered you before.
    ///
    /// Messages that exceed the maximum length are truncated.
    #[cfg_attr(feature = "deser_borrow", serde(borrow = "'a"))]
    pub message: Cow<'a, str>,
}

impl<'a> From<&'a str> for SendWhisperBody<'a> {
    fn from(string: &'a str) -> Self { Self::new(string) }
}

impl<'a> SendWhisperBody<'a> {
    /// Create a new message
    pub fn new(message: impl Into<Cow<'a, str>>) -> Self {
        Self {
            message: message.into(),
        }
    }
}

impl helix::private::SealedSerialize for SendWhisperBody<'_> {}

/// Return Values for [Send Whisper](super::send_whisper)
///
/// [`send-whisper`](https://dev.twitch.tv/docs/api/reference#send-whisper)
#[derive(PartialEq, Eq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub enum SendWhisperResponse {
    /// Successfully sent the whisper message or the message was silently dropped.
    Success,
}

impl Request for SendWhisperRequest<'_> {
    type Response = SendWhisperResponse;

    const PATH: &'static str = "whispers";
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: twitch_oauth2::Validator =
        twitch_oauth2::validator![twitch_oauth2::Scope::UserManageWhispers];
}

impl<'a> RequestPost for SendWhisperRequest<'a> {
    type Body = SendWhisperBody<'a>;

    fn parse_inner_response(
        request: Option<Self>,
        uri: &http::Uri,
        response_str: &str,
        status: http::StatusCode,
    ) -> Result<helix::Response<Self, Self::Response>, helix::HelixRequestPostError>
    where
        Self: Sized,
    {
        match status {
            http::StatusCode::NO_CONTENT => Ok(helix::Response::with_data(
                SendWhisperResponse::Success,
                request,
            )),
            _ => Err(helix::HelixRequestPostError::InvalidResponse {
                reason: "unexpected status",
                response: response_str.to_string(),
                status,
                uri: uri.clone(),
            }),
        }
    }
}

#[cfg(test)]
#[test]
fn test_request() {
    use helix::*;
    let req = SendWhisperRequest::new("123", "456");

    let body = SendWhisperBody::new("hello");

    assert_eq!(
        std::str::from_utf8(&body.try_to_body().unwrap()).unwrap(),
        r#"{"message":"hello"}"#
    );

    dbg!(req.create_request(body, "token", "clientid").unwrap());

    // From twitch docs
    let data = vec![];

    let http_response = http::Response::builder().status(204).body(data).unwrap();

    let uri = req.get_uri().unwrap();
    assert_eq!(
        uri.to_string(),
        "https://api.twitch.tv/helix/whispers?from_user_id=123&to_user_id=456"
    );

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