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
//! Modify channel information for users. //! [`modify-channel-information`](https://dev.twitch.tv/docs/api/reference#modify-channel-information) //! //! # Accessing the endpoint //! //! ## Request: [ModifyChannelInformationRequest] //! //! To use this endpoint, construct a [`ModifyChannelInformationRequest`] with the [`ModifyChannelInformationRequest::builder()`] method. //! //! ```rust, no_run //! use twitch_api2::helix::channels::modify_channel_information; //! let request = modify_channel_information::ModifyChannelInformationRequest::builder() //! .broadcaster_id("1234") //! .build(); //! ``` //! //! ## Body: [ModifyChannelInformationBody] //! //! We also need to provide a body to the request containing what we want to change. //! //! ``` //! # use twitch_api2::helix::channels::modify_channel_information; //! let body = modify_channel_information::ModifyChannelInformationBody::builder() //! .title("Hello World!".to_string()) //! .build(); //! ``` //! //! ## Response: [ModifyChannelInformation] //! //! //! Send the request to receive the response with [`HelixClient::req_patch()`](helix::HelixClient::req_patch). //! //! //! ```rust, no_run //! use twitch_api2::helix::{self, channels::modify_channel_information}; //! # 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 = modify_channel_information::ModifyChannelInformationRequest::builder() //! .broadcaster_id("1234") //! .build(); //! let body = modify_channel_information::ModifyChannelInformationBody::builder() //! .title("Hello World!".to_string()) //! .build(); //! let response: modify_channel_information::ModifyChannelInformation = 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 [Modify Channel Information](super::modify_channel_information) /// /// [`modify-channel-information`](https://dev.twitch.tv/docs/api/reference#modify-channel-information) #[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)] #[non_exhaustive] pub struct ModifyChannelInformationRequest { /// ID of the channel #[builder(setter(into))] pub broadcaster_id: types::UserId, } // FIXME: Twitch docs sucks... /// Body Parameters for [Modify Channel Information](super::modify_channel_information) /// /// [`modify-channel-information`](https://dev.twitch.tv/docs/api/reference#modify-channel-information) #[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)] #[non_exhaustive] pub struct ModifyChannelInformationBody { /// Current game ID being played on the channel #[builder(default, setter(into, strip_option))] pub game_id: Option<types::CategoryId>, /// Language of the channel #[builder(default, setter(into))] pub broadcaster_language: Option<String>, /// Title of the stream #[builder(default, setter(into, strip_option))] pub title: Option<String>, } /// Return Values for [Modify Channel Information](super::modify_channel_information) /// /// [`modify-channel-information`](https://dev.twitch.tv/docs/api/reference#modify-channel-information) #[derive(PartialEq, Deserialize, Debug, Clone)] #[non_exhaustive] pub enum ModifyChannelInformation { /// 204 - Channel/Stream updated successfully Success, /// 400 - Missing Query Parameter MissingQuery, /// Internal Server Error; Failed to update channel InternalServerError, } impl std::convert::TryFrom<http::StatusCode> for ModifyChannelInformation { type Error = std::borrow::Cow<'static, str>; fn try_from(s: http::StatusCode) -> Result<Self, Self::Error> { match s { http::StatusCode::NO_CONTENT => Ok(ModifyChannelInformation::Success), // FIXME: Twitch docs says 204 is success... http::StatusCode::OK => Ok(ModifyChannelInformation::Success), other => Err(other.canonical_reason().unwrap_or("").into()), } } } impl helix::Request for ModifyChannelInformationRequest { type Response = ModifyChannelInformation; const PATH: &'static str = "channels"; #[cfg(feature = "twitch_oauth2")] const SCOPE: &'static [twitch_oauth2::Scope] = &[twitch_oauth2::Scope::UserEditBroadcast]; } impl helix::RequestPatch for ModifyChannelInformationRequest { type Body = ModifyChannelInformationBody; } #[test] fn test_request() { use helix::*; let req = ModifyChannelInformationRequest::builder() .broadcaster_id(String::from("0")) .build(); // From twitch docs let data = br#""#.to_vec(); let http_response = http::Response::builder().status(200).body(data).unwrap(); let uri = req.get_uri().unwrap(); assert_eq!( uri.to_string(), "https://api.twitch.tv/helix/channels?broadcaster_id=0" ); dbg!(ModifyChannelInformationRequest::parse_response(&uri, http_response).unwrap()); }