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 = "conduit.shard.disabled")]
//! A conduit shard is disabled by twitch.

use super::*;

/// [`conduit.shard.disabled`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#conduitsharddisabled)
#[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 ConduitShardDisabledV1 {
    /// Your application’s client id. The provided client_id must match the client ID in the application access token.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub client_id: String,
    /// Optional. The conduit ID to receive events for. If omitted, events for all of this client’s conduits are sent.
    #[cfg_attr(feature = "typed-builder", builder(setter(into)))]
    pub conduit_id: Option<String>,
}

impl ConduitShardDisabledV1 {
    /// Your application’s client id. The provided client_id must match the client ID in the application access token.
    pub fn client_id(client_id: impl Into<String>) -> Self {
        Self {
            client_id: client_id.into(),
            conduit_id: None,
        }
    }

    /// The conduit ID to receive events for. If omitted, events for all of this client’s conduits are sent.
    pub fn conduit_id(mut self, conduit_id: impl Into<String>) -> Self {
        self.conduit_id = Some(conduit_id.into());
        self
    }
}

impl EventSubscription for ConduitShardDisabledV1 {
    type Payload = ConduitShardDisabledV1Payload;

    const EVENT_TYPE: EventType = EventType::ConduitShardDisabled;
    #[cfg(feature = "twitch_oauth2")]
    /// App access token where the client ID matches the client ID in the condition.
    /// If conduit_id is specified, the client must be the owner of the conduit.
    const SCOPE: twitch_oauth2::Validator = twitch_oauth2::validator![];
    const VERSION: &'static str = "1";
}

/// [`conduit.shard.disabled`](ConduitShardDisabledV1) response payload.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ConduitShardDisabledV1Payload {
    /// The conduit ID.
    pub conduit_id: String,
    /// The shard ID within the conduit.
    pub shard_id: String,
    /// The status of the disabled shard.
    pub status: eventsub::ShardStatus,
    /// The transport details about the disable shard.
    pub transport: eventsub::TransportResponse,
}

#[cfg(test)]
#[test]
fn parse_payload() {
    let payload = r##"
    {
        "subscription": {
            "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
            "type": "conduit.shard.disabled",
            "version": "1",
            "status": "enabled",
            "cost": 0,
            "condition": {
                "client_id": "uo6dggojyb8d6soh92zknwmi5ej1q2"
            },
            "transport": {
                "method": "webhook",
                "callback": "https://example.com/webhooks/callback"
            },
            "created_at": "2023-04-11T10:11:12.123Z"
        },
        "event": {
            "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac",
            "shard_id": "4",
            "status": "websocket_disconnected",
            "transport": {
                "method": "websocket",
                "session_id": "ad1c9fc3-0d99-4eb7-8a04-8608e8ff9ec9",
                "connected_at": "2020-11-10T14:32:18.730260295Z",
                "disconnected_at": "2020-11-11T14:32:18.730260295Z"
            }
        }
    }
    "##;

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