twitch_highway 0.3.2

Twitch API
Documentation 
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

mod response;
mod types;

pub use response::StartRaidResponse;
pub use types::StartRaid;

use crate::{
    request::{NoContent, TwitchAPIRequest},
    types::{
        constants::{BROADCASTER_ID, FROM_BROADCASTER_ID, RAIDS, TO_BROADCASTER_ID},
        BroadcasterId,
    },
    TwitchAPI,
};

pub trait RaidAPI {
    /// Raid another channel by sending the broadcaster’s viewers to the targeted channel
    ///
    /// # Arguments
    ///
    /// * `from_broadcaster_id` - The ID of the broadcaster that’s sending the raiding party.
    /// * `to_broadcaster_id` - The ID of the broadcaster to raid.
    ///
    /// # Returns
    ///
    /// Returns a [`StartRaidResponse`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     raid::RaidAPI,
    ///     types::BroadcasterId,
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let from_broadcaster_id = BroadcasterId::from("1234");
    /// let to_broadcaster_id = BroadcasterId::from("5678");
    /// let response = api
    ///     .start_raid(&from_broadcaster_id, &to_broadcaster_id)
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// `channel:manage:raids`
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#start-a-raid>
    fn start_raid(
        &self,
        from_broadcaster_id: &BroadcasterId,
        to_broadcaster_id: &BroadcasterId,
    ) -> TwitchAPIRequest<StartRaidResponse>;

    /// Cancel a pending raid
    ///
    /// # Arguments
    ///
    /// * `broadcaster_id` -
    ///
    /// # Returns
    ///
    /// Returns a [`NoContent`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     raid::RaidAPI,
    ///     types::BroadcasterId
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .cancel_raid(&BroadcasterId::from("1234"))
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// `channel:manage:raids`
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#cancel-a-raid>
    fn cancel_raid(&self, broadcaster_id: &BroadcasterId) -> TwitchAPIRequest<NoContent>;
}

impl RaidAPI for TwitchAPI {
    simple_endpoint!(
        fn start_raid(
            from_broadcaster_id: &BroadcasterId [key = FROM_BROADCASTER_ID],
            to_broadcaster_id: &BroadcasterId [key = TO_BROADCASTER_ID],
        ) -> StartRaidResponse;
            endpoint: Startraid,
            method: POST,
            path: [RAIDS],
    );
    simple_endpoint!(
        fn cancel_raid(
            broadcaster_id: &BroadcasterId [key = BROADCASTER_ID],
        ) -> NoContent ;
            endpoint: Cancelraid,
            method: DELETE,
            path: [RAIDS],
    );
}