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.subscription.message")]
//! A user sends a resubscription chat message in a specific channel

use super::*;
/// [`channel.subscription.message`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelsubscriptionmessage): a subscription to the specified channel expires.
#[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 ChannelSubscriptionMessageV1 {
    /// The broadcaster user ID for the channel you want to get resubscription chat message notifications for.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub broadcaster_user_id: types::UserId,
}

impl ChannelSubscriptionMessageV1 {
    /// The broadcaster user ID for the channel you want to get resubscription chat message notifications for.
    pub fn broadcaster_user_id(broadcaster_user_id: impl Into<types::UserId>) -> Self {
        Self {
            broadcaster_user_id: broadcaster_user_id.into(),
        }
    }
}

impl EventSubscription for ChannelSubscriptionMessageV1 {
    type Payload = ChannelSubscriptionMessageV1Payload;

    const EVENT_TYPE: EventType = EventType::ChannelSubscriptionMessage;
    #[cfg(feature = "twitch_oauth2")]
    const SCOPE: twitch_oauth2::Validator =
        twitch_oauth2::validator![twitch_oauth2::Scope::ChannelReadSubscriptions];
    const VERSION: &'static str = "1";
}

/// [`channel.subscription.message`](ChannelSubscriptionMessageV1) response payload.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChannelSubscriptionMessageV1Payload {
    /// The broadcaster user ID.
    pub broadcaster_user_id: types::UserId,
    /// The broadcaster login.
    pub broadcaster_user_login: types::UserName,
    /// The broadcaster display name.
    pub broadcaster_user_name: types::DisplayName,
    // FIXME: Twitch says this is `cumulative_total`, see https://github.com/twitchdev/issues/issues/415
    /// The total number of months the user has been subscribed to the channel.
    pub cumulative_months: i64,
    /// The month duration of the subscription.
    pub duration_months: i64,
    /// An object that contains the resubscription message and emote information needed to recreate the message.
    pub message: SubscriptionMessage,
    /// The number of consecutive months the user’s current subscription has been active. This value is null if the user has opted out of sharing this information.
    pub streak_months: Option<i64>,
    /// The tier of the user’s subscription.
    pub tier: types::SubscriptionTier,
    /// The user ID of the user who sent a resubscription chat message.
    pub user_id: types::UserId,
    /// The user login of the user who sent a resubscription chat message.
    pub user_login: types::UserName,
    /// The user display name of the user who a resubscription chat message.
    pub user_name: types::DisplayName,
}

/// A message attached to a [`ChannelSubscriptionMessageV1Payload`]
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct SubscriptionMessage {
    /// The text of the resubscription chat message.
    pub text: String,
    /// An array that includes the emote ID and start and end positions for where the emote appears in the text.
    #[serde(deserialize_with = "crate::deserialize_default_from_null")]
    pub emotes: Vec<types::EmoteOccurrence>,
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn parse_payload() {
        let payload = r##"
        {
            "subscription": {
                "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
                "type": "channel.subscription.message",
                "version": "1",
                "status": "enabled",
                "cost": 0,
                "condition": {
                    "broadcaster_user_id": "1337"
                },
                "transport": {
                    "method": "webhook",
                    "callback": "https://example.com/webhooks/callback"
                },
                "created_at": "2019-11-16T10:11:12.123Z"
            },
            "event": {
                "user_id": "1234",
                "user_login": "cool_user",
                "user_name": "Cool_User",
                "broadcaster_user_id": "1337",
                "broadcaster_user_login": "cooler_user",
                "broadcaster_user_name": "Cooler_User",
                "tier": "1000",
                "message": {
                    "text": "Love the stream! FevziGG",
                    "emotes": [
                        {
                            "begin": 23,
                            "end": 30,
                            "id": "302976485"
                        }
                        ]
                    },
                    "cumulative_months": 15,
                    "streak_months": 1,
                    "duration_months": 6
                }
            }
            "##;

        let val = dbg!(crate::eventsub::Event::parse(payload).unwrap());
        crate::tests::roundtrip(&val)
    }
    #[test]
    fn parse_emotes_null() {
        let message = r#"
            {
                "text": "",
                "emotes": null
            }"#;
        crate::parse_json::<SubscriptionMessage>(message, true).unwrap();
    }
}