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

mod request;
mod response;
mod types;

pub use request::CclLocale;
pub use response::CclsResponse;
pub use types::Ccl;

use crate::{
    request::TwitchAPIRequest,
    types::constants::{CONTENT_CLASSIFICATION_LABELS, LOCALE},
    TwitchAPI,
};

pub trait CclsAPI {
    /// Gets information about Twitch content classification labels
    ///
    /// # Arguments
    ///
    /// * `locale` - Optional locale for the Content Classification Labels.
    ///
    /// # Returns
    ///
    /// Returns a [`CclsResponse`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::ccls::{CclLocale, CclsAPI};
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .get_content_classification_labels(Some(CclLocale::deDE))
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-content-classification-labels>
    fn get_content_classification_labels(
        &self,
        locale: Option<CclLocale>,
    ) -> TwitchAPIRequest<CclsResponse>;
}

impl CclsAPI for TwitchAPI {
    simple_endpoint!(
    fn get_content_classification_labels(
        locale: Option<CclLocale> [opt, key = LOCALE, convert = as_ref],
    ) -> CclsResponse;
        endpoint: GetContentClassificationLabels,
        method: GET,
        path: [CONTENT_CLASSIFICATION_LABELS],
    );
}