twitch_highway 0.4.1

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

mod builder;
mod response;
mod types;

pub use builder::GetCharityCampaignDonationBuilder;
pub use response::{CharityCampaignDonationResponse, CharityCampaignResponse};
pub use types::{CharityCampaign, CharityCampaignDonation};

use crate::{
    request::TwitchAPIRequest,
    types::{constants::CHARITY, BroadcasterId},
    TwitchAPI,
};

pub trait CharityAPI {
    /// Gets information about the charity campaign that a broadcaster is running
    ///
    /// # Arguments
    ///
    /// * `broadcaster_id` -
    ///
    /// # Returns
    ///
    /// Returns a [`CharityCampaignResponse`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     charity::CharityAPI,
    ///     types::BroadcasterId
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .get_charity_campaign(&BroadcasterId::from("1234"))
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// `channel:read:charity`
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-charity-campaign>
    fn get_charity_campaign(
        &self,
        broadcaster_id: &BroadcasterId,
    ) -> TwitchAPIRequest<CharityCampaignResponse>;

    /// Gets the list of donations that users have made to the broadcaster’s active charity campaign
    ///
    /// # Arguments
    ///
    /// * `broadcaster_id` -
    ///
    /// # Returns
    ///
    /// Returns a [`GetCharityCampaignDonationBuilder`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     charity::CharityAPI,
    ///     types::BroadcasterId
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .get_charity_campaign_donations(&BroadcasterId::from("1234"))
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// `channel:read:charity`
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-charity-campaign-donations>
    fn get_charity_campaign_donations<'a>(
        &'a self,
        broadcaster_id: &'a BroadcasterId,
    ) -> GetCharityCampaignDonationBuilder<'a>;
}

impl CharityAPI for TwitchAPI {
    simple_endpoint!(
        fn get_charity_campaign(
            broadcaster_id: &BroadcasterId,
        ) -> CharityCampaignResponse;
            endpoint: GetCharityCampaign,
            method: GET,
            path: [CHARITY, "campaigns"],
    );
    fn get_charity_campaign_donations<'a>(
        &'a self,
        broadcaster_id: &'a BroadcasterId,
    ) -> GetCharityCampaignDonationBuilder<'a> {
        GetCharityCampaignDonationBuilder::new(self, broadcaster_id)
    }
}