feat(helix): add Get Channel iCalendar

src/helix/client/client_ext.rs

@@ -998,6 +998,24 @@
         make_stream(req, token, self, |broadcasts| broadcasts.segments.into())
     }
 
+    /// Gets the broadcaster’s streaming schedule as an [iCalendar](https://datatracker.ietf.org/doc/html/rfc5545).
+    pub async fn get_channel_icalendar<'b, T>(
+        &'client self,
+        broadcaster_id: impl types::IntoCow<'b, types::UserIdRef> + Send + 'b,
+        token: &T,
+    ) -> Result<String, ClientError<C>>
+    where
+        T: TwitchToken + Send + Sync + ?Sized,
+    {
+        Ok(self
+            .req_get(
+                helix::schedule::GetChannelICalendar::broadcaster_id(broadcaster_id),
+                token,
+            )
+            .await?
+            .data)
+    }
+
     /// Get all global emotes
     pub async fn get_global_emotes<T>(
         &'client self,

src/helix/endpoints/schedule/get_channel_icalendar.rs

@@ -0,0 +1,134 @@
+//! Gets the broadcaster’s streaming schedule as an [iCalendar](https://datatracker.ietf.org/doc/html/rfc5545).
+//! [`get-channel-icalendar`](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar)
+//!
+//! ## Notes
+//!
+//! See also [`get_channel_schedule`](helix::HelixClient::get_channel_schedule)
+//!
+//! ## Request: [GetChannelICalendar]
+//!
+//! To use this endpoint, construct a [`GetChannelICalendar`] with the [`GetChannelICalendar::broadcaster_id()`] method.
+//!
+//! ```rust
+//! use twitch_api::helix::schedule::get_channel_icalendar;
+//! let request =
+//!     get_channel_icalendar::GetChannelICalendar::broadcaster_id("1234");
+//! ```
+//!
+//! ## Response: [String]
+//!
+//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
+//!
+//! ```rust, no_run
+//! use twitch_api::helix::{self, schedule::get_channel_icalendar};
+//! # 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 = get_channel_icalendar::GetChannelICalendar::broadcaster_id("1234");
+//! let response: String = client.req_get(request, &token).await?.data;
+//! # Ok(())
+//! # }
+//! ```
+//!
+//! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestGet::create_request)
+//! and parse the [`http::Response`] with [`GetChannelICalendar::parse_response(None, &request.get_uri(), response)`](GetChannelICalendar::parse_response)
+
+use super::*;
+use helix::RequestGet;
+
+/// Query Parameters for [Get Channel iCalendar](super::get_channel_icalendar)
+///
+/// [`get-channel-icalendar`](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar)
+#[derive(PartialEq, Eq, Deserialize, Serialize, Clone, Debug)]
+#[cfg_attr(feature = "typed-builder", derive(typed_builder::TypedBuilder))]
+#[must_use]
+#[non_exhaustive]
+pub struct GetChannelICalendar<'a> {
+    /// The ID of the broadcaster that owns the streaming schedule you want to get.
+    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
+    #[cfg_attr(feature = "deser_borrow", serde(borrow = "'a"))]
+    pub broadcaster_id: Cow<'a, types::UserIdRef>,
+}
+
+impl<'a> GetChannelICalendar<'a> {
+    /// Get a broadcasters schedule as an iCalendar
+    pub fn broadcaster_id(broadcaster_id: impl types::IntoCow<'a, types::UserIdRef> + 'a) -> Self {
+        Self {
+            broadcaster_id: broadcaster_id.into_cow(),
+        }
+    }
+}
+
+/// Return Values for [Get Channel iCalendar](super::get_channel_icalendar)
+///
+/// [`get-channel-icalendar`](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar)
+pub type GetChannelICalendarResponse = ScheduledBroadcasts;
+
+impl Request for GetChannelICalendar<'_> {
+    type Response = String;
+
+    const PATH: &'static str = "schedule/icalendar";
+    #[cfg(feature = "twitch_oauth2")]
+    const SCOPE: twitch_oauth2::Validator = twitch_oauth2::validator![];
+}
+
+impl RequestGet for GetChannelICalendar<'_> {
+    fn parse_inner_response(
+        request: Option<Self>,
+        _uri: &http::Uri,
+        response: &str,
+        _status: http::StatusCode,
+    ) -> Result<helix::Response<Self, <Self as Request>::Response>, helix::HelixRequestGetError>
+    where
+        Self: Sized,
+    {
+        Ok(helix::Response::new(
+            response.to_owned(),
+            None,
+            request,
+            None,
+            None,
+        ))
+    }
+}
+
+#[cfg(test)]
+#[test]
+fn test_request() {
+    use helix::*;
+    let req = GetChannelICalendar::broadcaster_id("141981764");
+
+    let data = br#"BEGIN:VCALENDAR
+PRODID:-//twitch.tv//StreamSchedule//1.0
+VERSION:2.0
+CALSCALE:GREGORIAN
+REFRESH-INTERVAL;VALUE=DURATION:PT1H
+NAME:TwitchDev
+BEGIN:VEVENT
+UID:e4acc724-371f-402c-81ca-23ada79759d4
+DTSTAMP:20210323T040131Z
+DTSTART;TZID=/America/New_York:20210701T140000
+DTEND;TZID=/America/New_York:20210701T150000
+SUMMARY:TwitchDev Monthly Update // July 1, 2021
+DESCRIPTION:Science & Technology.
+CATEGORIES:Science & Technology
+END:VEVENT
+END:VCALENDAR%"#
+        .to_vec();
+
+    let http_response = http::Response::builder().body(data.clone()).unwrap();
+
+    let uri = req.get_uri().unwrap();
+    assert_eq!(
+        uri.to_string(),
+        "https://api.twitch.tv/helix/schedule/icalendar?broadcaster_id=141981764"
+    );
+
+    let res = GetChannelICalendar::parse_response(Some(req), &uri, http_response)
+        .unwrap()
+        .data;
+    assert_eq!(res.as_bytes(), data);
+}

src/helix/endpoints/schedule/mod.rs

@@ -4,12 +4,12 @@
 //!
 //! <!-- generate with "cargo xtask overview" (with a nightly toolchain) -->
 //! <!-- BEGIN-OVERVIEW -->
-//! <details open><summary style="cursor: pointer">Schedule 🟡 5/6</summary>
+//! <details open><summary style="cursor: pointer">Schedule 🟢 6/6</summary>
 //!
 //! | Endpoint | Helper | Module |
 //! |---|---|---|
 //! | [Get Channel Stream Schedule](https://dev.twitch.tv/docs/api/reference#get-channel-stream-schedule) | - | [`get_channel_stream_schedule`] |
-//! | [Get Channel iCalendar](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar) | - | - |
+//! | [Get Channel iCalendar](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar) | [`HelixClient::get_channel_icalendar`](crate::helix::HelixClient::get_channel_icalendar) | [`get_channel_icalendar`] |
 //! | [Update Channel Stream Schedule](https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule) | - | [`update_channel_stream_schedule`] |
 //! | [Create Channel Stream Schedule Segment](https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment) | - | [`create_channel_stream_schedule_segment`] |
 //! | [Update Channel Stream Schedule Segment](https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment) | - | [`update_channel_stream_schedule_segment`] |
@@ -27,6 +27,7 @@ use std::borrow::Cow;
 
 pub mod create_channel_stream_schedule_segment;
 pub mod delete_channel_stream_schedule_segment;
+pub mod get_channel_icalendar;
 pub mod get_channel_stream_schedule;
 pub mod update_channel_stream_schedule;
 pub mod update_channel_stream_schedule_segment;
@@ -40,6 +41,8 @@ pub use delete_channel_stream_schedule_segment::{
     DeleteChannelStreamScheduleSegment, DeleteChannelStreamScheduleSegmentRequest,
 };
 #[doc(inline)]
+pub use get_channel_icalendar::GetChannelICalendar;
+#[doc(inline)]
 pub use get_channel_stream_schedule::GetChannelStreamScheduleRequest;
 #[doc(inline)]
 pub use update_channel_stream_schedule::{

src/helix/mod.rs

@@ -290,12 +290,12 @@
 //!
 //! </details>
 //!
-//! <details><summary style="cursor: pointer">Schedule 🟡 5/6</summary>
+//! <details><summary style="cursor: pointer">Schedule 🟢 6/6</summary>
 //!
 //! | Endpoint | Helper | Module |
 //! |---|---|---|
 //! | [Get Channel Stream Schedule](https://dev.twitch.tv/docs/api/reference#get-channel-stream-schedule) | - | [`schedule::get_channel_stream_schedule`] |
-//! | [Get Channel iCalendar](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar) | - | - |
+//! | [Get Channel iCalendar](https://dev.twitch.tv/docs/api/reference#get-channel-icalendar) | [`HelixClient::get_channel_icalendar`] | [`schedule::get_channel_icalendar`] |
 //! | [Update Channel Stream Schedule](https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule) | - | [`schedule::update_channel_stream_schedule`] |
 //! | [Create Channel Stream Schedule Segment](https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment) | - | [`schedule::create_channel_stream_schedule_segment`] |
 //! | [Update Channel Stream Schedule Segment](https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment) | - | [`schedule::update_channel_stream_schedule_segment`] |