twitch_highway 0.3.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

mod builder;
mod response;
mod types;

pub use builder::{GetExtensionBuilder, GetGameAnalyticsBuilder};
pub use response::{ExtensionAnalyticsResponse, GameAnalyticsResponse};
pub use types::{AnalyticsType, ExtensionAnalytic, GameAnalytic};

use crate::TwitchAPI;

pub trait AnalyticsAPI {
    /// Gets an analytics report for one or more extensions
    ///
    /// # Returns
    ///
    /// Returns a [`GetExtensionBuilder`]
    ///
    /// # Example
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     analytics::{AnalyticsAPI, AnalyticsType},
    ///     types::ExtensionId,
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let extension_id = ExtensionId::from("72189");
    /// let response = api
    ///     .get_extension_analytics()
    ///     .extension_id(&extension_id)
    ///     .kind(AnalyticsType::OverviewV2)
    ///     .started_at(&"2018-01-01T00:00:00Z".parse().unwrap())
    ///     .ended_at(&"2018-03-01T00:00:00Z".parse().unwrap())
    ///     .first(50)
    ///     .after("eyJiI...")
    ///     .json()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-extension-analytics>
    fn get_extension_analytics<'a>(&'a self) -> GetExtensionBuilder<'a>;

    /// Gets an analytics report for one or more games
    ///
    /// # Returns
    ///
    /// Returns a [`GetGameAnalyticsBuilder`]
    ///
    /// # Example
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     analytics::{AnalyticsAPI, AnalyticsType},
    ///     types::GameId,
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let game_id = GameId::from("72189");
    /// let response = api
    ///     .get_game_analytics()
    ///     .game_id(&game_id)
    ///     .kind(AnalyticsType::OverviewV2)
    ///     .started_at(&"2018-01-01T00:00:00Z".parse().unwrap())
    ///     .ended_at(&"2018-03-01T00:00:00Z".parse().unwrap())
    ///     .first(50)
    ///     .after("eyJiI...")
    ///     .json()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-game-analytics>
    fn get_game_analytics<'a>(&'a self) -> GetGameAnalyticsBuilder<'a>;
}

impl AnalyticsAPI for TwitchAPI {
    fn get_extension_analytics<'a>(&'a self) -> GetExtensionBuilder<'a> {
        GetExtensionBuilder::new(self)
    }
    fn get_game_analytics<'a>(&'a self) -> GetGameAnalyticsBuilder<'a> {
        GetGameAnalyticsBuilder::new(self)
    }
}