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
120
121
122
123
124
125
126

//! Gets a specified user’s block list. The list is sorted by when the block occurred in descending order (i.e. most recent block first).
//! [`get-user-block-list`](https://dev.twitch.tv/docs/api/reference#get-user-block-list)
//!
//! ## Request: [GetUserBlockListRequest]
//!
//! To use this endpoint, construct a [`GetUserBlockListRequest`] with the [`GetUserBlockListRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::users::get_user_block_list;
//! let request = get_user_block_list::GetUserBlockListRequest::builder()
//!     .broadcaster_id("1234".to_string())
//!     .build();
//! ```
//!
//! ## Response: [UserBlock]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, users::get_user_block_list};
//! # use twitch_api2::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_user_block_list::GetUserBlockListRequest::builder()
//!     .broadcaster_id("1234".to_string())
//!     .build();
//! let response: Vec<get_user_block_list::UserBlock> = 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 [`GetUserBlockListRequest::parse_response(None, &request.get_uri(), response)`](GetUserBlockListRequest::parse_response)

use super::*;
use helix::RequestGet;

/// Query Parameters for [Get Users Block List](super::get_user_block_list)
///
/// [`get-user-block-list`](https://dev.twitch.tv/docs/api/reference#get-user-block-list)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetUserBlockListRequest {
    /// Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
    #[builder(default)]
    pub after: Option<helix::Cursor>,
    /// Maximum number of objects to return. Maximum: 100. Default: 20.
    #[builder(default, setter(into))]
    pub first: Option<usize>,
    ///  User ID for a Twitch user.
    #[builder(setter(into))]
    pub broadcaster_id: types::UserId,
}

/// Return Values for [Get Users Block List](super::get_user_block_list)
///
/// [`get-user-block-list`](https://dev.twitch.tv/docs/api/reference#get-user-block-list)
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct UserBlock {
    /// User ID of the blocked user.
    pub user_id: types::UserId,
    /// Login of the blocked user.
    pub user_login: types::UserName,
    /// Display name of the blocked user.
    pub display_name: types::DisplayName,
}

impl Request for GetUserBlockListRequest {
    type Response = Vec<UserBlock>;

    #[cfg(feature = "twitch_oauth2")]
    const OPT_SCOPE: &'static [twitch_oauth2::Scope] =
        &[twitch_oauth2::Scope::UserReadBlockedUsers];
    const PATH: &'static str = "users/blocks";
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: &'static [twitch_oauth2::Scope] = &[];
}

impl RequestGet for GetUserBlockListRequest {}

impl helix::Paginated for GetUserBlockListRequest {
    fn set_pagination(&mut self, cursor: Option<helix::Cursor>) { self.after = cursor }
}

#[cfg(test)]
#[test]
fn test_request() {
    use helix::*;
    let req = GetUserBlockListRequest::builder()
        .broadcaster_id("23161357")
        .build();

    // From twitch docs // FIXME: twitch docs say id, not user_id
    let data = br#"
{
    "data": [
        {
        "user_id": "135093069",
        "user_login": "bluelava",
        "display_name": "BlueLava"
        },
        {
        "user_id": "27419011",
        "user_login": "travistyoj",
        "display_name": "TravistyOJ"
        }
    ]
    }
"#
    .to_vec();

    let http_response = http::Response::builder().body(data).unwrap();

    let uri = req.get_uri().unwrap();
    assert_eq!(
        uri.to_string(),
        "https://api.twitch.tv/helix/users/blocks?broadcaster_id=23161357"
    );

    dbg!(GetUserBlockListRequest::parse_response(Some(req), &uri, http_response).unwrap());
}