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

#![doc(alias = "channel.shield_mode.end")]
//! A channel deactivates Shield Mode

use super::*;
/// [`channel.shield_mode.end`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshield_modeend): an user responds to a prediction on the specified channel
#[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 ChannelShieldModeEndV1 {
    /// The ID of the broadcaster that you want to receive notifications about when they deactivate  Shield Mode.
    pub broadcaster_user_id: types::UserId,
    /// The ID of the broadcaster or one of the broadcaster’s moderators.
    pub moderator_user_id: types::UserId,
}

impl ChannelShieldModeEndV1 {
    /// Get shield mode end events for this channel as 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 ChannelShieldModeEndV1 {
    type Payload = ChannelShieldModeEndV1Payload;

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

/// [`channel.shield_mode.end`](ChannelShieldModeEndV1) response payload.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChannelShieldModeEndV1Payload {
    /// An ID that identifies the broadcaster whose Shield Mode status was updated.
    pub broadcaster_user_id: types::UserId,
    /// The broadcaster’s login name.
    pub broadcaster_user_login: types::UserName,
    /// The broadcaster’s display name.
    pub broadcaster_user_name: types::DisplayName,
    /// An ID that identifies the moderator that updated the Shield Mode’s status. If the broadcaster updated the status, this ID will be the same as broadcaster_user_id.
    pub moderator_user_id: types::UserId,
    /// The moderator’s login name.
    pub moderator_user_login: types::UserName,
    /// The moderator’s display name.
    pub moderator_user_name: types::DisplayName,
    /// The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode.
    pub ended_at: types::Timestamp,
}

#[cfg(test)]
#[test]
fn parse_payload() {
    let payload = r##"
    {
        "subscription": {
          "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
          "type": "channel.shield_mode.end",
          "version": "1",
          "status": "enabled",
          "cost": 0,
          "condition": {
            "broadcaster_user_id": "12345",
            "moderator_user_id": "98765"
          },
          "transport": {
            "method": "webhook",
            "callback": "https://example.com/webhooks/callback"
          },
          "created_at": "2022-07-25T10:11:12.1236739Z"
        },
        "event": {
          "broadcaster_user_id": "12345",
          "broadcaster_user_name": "SimplySimple",
          "broadcaster_user_login": "simplysimple",
          "moderator_user_id": "98765",
          "moderator_user_name": "ParticularlyParticular123",
          "moderator_user_login": "particularlyparticular123",
          "ended_at": "2022-07-27T01:30:23.17106713Z"
        }
      }
    "##;

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