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

#![doc(alias = "user.whisper.message")]
//! A user receives a whisper
use super::*;

/// [`user.whisper.message`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#userwhispermessage): a user receives a whisper.
#[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 UserWhisperMessageV1 {
    /// The user ID of the person receiving whispers.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub user_id: types::UserId,
}

impl UserWhisperMessageV1 {
    /// The user ID of the person receiving whispers.
    pub fn new(user_id: impl Into<types::UserId>) -> Self {
        Self {
            user_id: user_id.into(),
        }
    }
}

impl EventSubscription for UserWhisperMessageV1 {
    type Payload = UserWhisperMessageV1Payload;

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

/// [`user.whisper.message`](UserWhisperMessageV1) response payload.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct UserWhisperMessageV1Payload {
    /// The ID of the user sending the message.
    pub from_user_id: types::UserId,
    /// The name of the user sending the message.
    pub from_user_name: types::DisplayName,
    /// The login of the user sending the message.
    pub from_user_login: types::UserName,
    /// The ID of the user receiving the message.
    pub to_user_id: types::UserId,
    /// The name of the user receiving the message.
    pub to_user_name: types::DisplayName,
    /// The login of the user receiving the message.
    pub to_user_login: types::UserName,
    /// The whisper ID.
    pub whisper_id: types::WhisperId,
    /// Object containing whisper information.
    pub whisper: Whisper,
}

/// Object containing whisper information.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct Whisper {
    /// The body of the whisper message.
    pub text: String,
}

#[cfg(test)]
#[test]
fn parse_payload() {
    let payload = r#"
    {
        "subscription": {
            "id": "7297f7eb-3bf5-461f-8ae6-7cd7781ebce3",
            "status": "enabled",
            "type": "user.whisper.message",
            "version": "1",
            "condition": {
                "user_id": "423374343"
            },
            "transport": {
                "method": "webhook",
                "callback": "https://example.com/webhooks/callback"
            },
            "created_at": "2024-02-23T21:12:33.771005262Z",
            "cost": 0
        },
        "event": {
            "from_user_id": "423374343",
            "from_user_login": "glowillig",
            "from_user_name": "glowillig",
            "to_user_id": "424596340",
            "to_user_login": "quotrok",
            "to_user_name": "quotrok",
            "whisper_id": "some-whisper-id",
            "whisper": {
                "text": "a secret"
            }
        }
    }
    "#;

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