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

#![doc(alias = "channel.ad_break.begin")]
//! a user runs a midroll commercial break, either manually or automatically via ads manager.

use super::*;
/// [`channel.ad_break.begin`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelad_breakbegin): a user runs a midroll commercial break, either manually or automatically via ads manager.
#[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 ChannelAdBreakBeginV1 {
    /// The ID of the broadcaster that you want to get Channel Ad Break begin notifications for.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub broadcaster_user_id: types::UserId,
}

impl ChannelAdBreakBeginV1 {
    /// The ID of the broadcaster that you want to get Channel Ad Break begin 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 ChannelAdBreakBeginV1 {
    type Payload = ChannelAdBreakBeginV1Payload;

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

/// [`channel.ad_break.begin`](ChannelAdBreakBeginV1) response payload.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChannelAdBreakBeginV1Payload {
    /// Length in seconds of the mid-roll ad break requested
    pub duration_seconds: i32,
    #[serde(alias = "timestamp")]
    /// The UTC timestamp of when the ad break began, in RFC3339 format. Note that there is potential delay between this event, when the streamer requested the ad break, and when the viewers will see ads.
    pub started_at: types::Timestamp,
    /// Indicates if the ad was automatically scheduled via Ads Manager
    pub is_automatic: bool,
    /// The broadcaster’s user ID for the channel the ad was run on.
    pub broadcaster_user_id: types::UserId,
    /// The broadcaster’s user login for the channel the ad was run on.
    pub broadcaster_user_login: types::UserName,
    /// The broadcaster’s user display name for the channel the ad was run on.
    pub broadcaster_user_name: types::DisplayName,
    /// The ID of the user that requested the ad. For automatic ads, this will be the ID of the broadcaster.
    pub requester_user_id: types::UserId,
    /// The login of the user that requested the ad.
    pub requester_user_login: types::UserName,
    /// The display name of the user that requested the ad.
    pub requester_user_name: types::DisplayName,
}

#[cfg(test)]
#[test]
fn parse_payload() {
    // FIXME: twitch docs has trailing commas
    // FIXME: it uses string for the integer and bool, https://github.com/twitchdev/issues/issues/857#issuecomment-1793796590
    let payload = r##"
    {
        "subscription": {
            "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
            "type": "channel.ad_break.begin",
            "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.634234626Z"
        },
        "event": {
            "duration_seconds": 60,
            "started_at": "2019-11-16T10:11:12.634234626Z",
            "is_automatic": false,
            "broadcaster_user_id": "1337",
            "broadcaster_user_login": "cool_user",
            "broadcaster_user_name": "Cool_User",
            "requester_user_id": "1337",
            "requester_user_login": "cool_user",
            "requester_user_name": "Cool_User"
        }
    }
    "##;

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