twitch_api 0.7.2

Library for talking with the new Twitch API aka. "Helix", EventSub and more!
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

#![doc(alias = "channel.warning.send")]
//! a warning is sent to a user.

use super::*;
/// [`channel.warning.send`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelwarningsend): a warning is sent to a user.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "typed-builder", derive(typed_builder::TypedBuilder))]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChannelWarningSendV1 {
    /// The User ID of the broadcaster.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub broadcaster_user_id: types::UserId,
    /// The User ID of the moderator.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub moderator_user_id: types::UserId,
}

impl ChannelWarningSendV1 {
    /// Get notifications for sendd warnings in this channel as a moderator
    pub fn new(
        broadcaster_user_id: impl Into<types::UserId>,
        moderator_user_id: impl Into<types::UserId>,
    ) -> Self {
        Self {
            broadcaster_user_id: broadcaster_user_id.into(),
            moderator_user_id: moderator_user_id.into(),
        }
    }
}

impl EventSubscription for ChannelWarningSendV1 {
    type Payload = ChannelWarningSendV1Payload;

    const EVENT_TYPE: EventType = EventType::ChannelWarningSend;
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: twitch_oauth2::Validator = twitch_oauth2::validator![any(
        twitch_oauth2::Scope::ModeratorReadWarnings,
        twitch_oauth2::Scope::ModeratorManageWarnings
    )];
    const VERSION: &'static str = "1";
}

/// [`channel.warning.send`](ChannelWarningSendV1) response payload.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChannelWarningSendV1Payload {
    /// The user ID of the broadcaster.
    pub broadcaster_user_id: types::UserId,
    /// The login of the broadcaster.
    pub broadcaster_user_login: types::UserName,
    /// The user name of the broadcaster.
    pub broadcaster_user_name: types::DisplayName,

    /// The user ID of the moderator who sent the warning.
    pub moderator_user_id: types::UserId,
    /// The login of the moderator.
    pub moderator_user_login: types::UserName,
    /// The user name of the moderator.
    pub moderator_user_name: types::DisplayName,

    /// The ID of the user being warned.
    pub user_id: types::UserId,
    /// The login of the user being warned.
    pub user_login: types::UserName,
    /// The user name of the user being.
    pub user_name: types::DisplayName,

    /// The reason given for the warning.
    pub reason: Option<String>,
    /// The chat rules cited for the warning.
    pub chat_rules_cited: Option<Vec<String>>,
}

#[cfg(test)]
#[test]
fn parse_payload() {
    use crate::eventsub::{Event, Message};

    let payload = r##"
    {
        "subscription": {
            "id": "7297f7eb-3bf5-461f-8ae6-7cd7781ebce3",
            "status": "enabled",
            "type": "channel.warning.send",
            "version": "1",
            "cost": 0,
            "condition": {
                "broadcaster_user_id": "423374343",
                "moderator_user_id": "424596340"
            },
            "transport": {
                "method": "webhook",
                "callback": "https://example.com/webhooks/callback"
            },
            "created_at": "2024-02-23T21:12:33.771005262Z"
        },
        "event": {
            "broadcaster_user_id": "423374343",
            "broadcaster_user_login": "glowillig",
            "broadcaster_user_name": "glowillig",
            "moderator_user_id": "424596340",
            "moderator_user_login": "quotrok",
            "moderator_user_name": "quotrok",
            "user_id": "141981764",
            "user_login": "twitchdev",
            "user_name": "TwitchDev",
            "reason": "cut it out",
            "chat_rules_cited": null
        }
    }
    "##;

    let val = Event::parse(payload).unwrap();
    crate::tests::roundtrip(&val);

    let Event::ChannelWarningSendV1(val) = val else {
        panic!("invalid event type");
    };
    let Message::Notification(notif) = val.message else {
        panic!("invalid settings type");
    };

    assert_eq!(notif.broadcaster_user_id.as_str(), "423374343");
    assert_eq!(notif.broadcaster_user_login.as_str(), "glowillig");
    assert_eq!(notif.broadcaster_user_name.as_str(), "glowillig");
    assert_eq!(notif.moderator_user_id.as_str(), "424596340");
    assert_eq!(notif.moderator_user_login.as_str(), "quotrok");
    assert_eq!(notif.moderator_user_name.as_str(), "quotrok");
    assert_eq!(notif.user_id.as_str(), "141981764");
    assert_eq!(notif.user_login.as_str(), "twitchdev");
    assert_eq!(notif.user_name.as_str(), "TwitchDev");
    assert_eq!(notif.reason.unwrap().as_str(), "cut it out");
    assert!(notif.chat_rules_cited.is_none());
}