twitch_highway 0.2.1

Twitch API
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

pub mod condition;
pub mod request;
pub mod response;
pub mod subscription;
pub mod subscription_types;
pub mod transport;

use condition::Condition;
use response::EventSubscriptionsResponse;

use crate::{
    eventsub::{
        request::{CreateEventSubRequest, GetEventRequest},
        response::CreateEventSubscriptionsResponse,
        transport::TransportType,
    },
    request::NoContent,
    types::{
        constants::{EVENTSUB, ID, SUBSCRIPTIONS},
        PaginationQuery, SubscriptionId,
    },
};

endpoints! {
    EventSubAPI {
        /// <https://dev.twitch.tv/docs/api/reference/#create-eventsub-subscription>
        fn create_eventsub<T: TransportType>(
            &self,
            req: CreateEventSubRequest<Condition, T>,
        ) -> CreateEventSubscriptionsResponse {
            endpoint_type: CreateEventSub,
            method: POST,
            path: [EVENTSUB, SUBSCRIPTIONS],
            headers: [json],
            body: req.into_json()
        }

        /// <https://dev.twitch.tv/docs/api/reference/#delete-eventsub-subscription>
        fn delete_eventsub(
            &self,
            subscription_id: &SubscriptionId,
        ) -> NoContent {
            endpoint_type: DeleteEventSub,
            method: DELETE,
            path: [EVENTSUB, SUBSCRIPTIONS],
            query_params: {
                query(ID, subscription_id)
            }
        }

        /// <https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions>
        fn get_eventsub(
            &self,
            opts: Option<GetEventRequest>,
            pagination: Option<PaginationQuery>,
        ) -> EventSubscriptionsResponse {
            endpoint_type: GetEventSub,
            method: GET,
            path: [EVENTSUB, SUBSCRIPTIONS],
            query_params: {
                opt_into_query(opts),
                pagination(pagination)
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use url::Url;

    use crate::{
        eventsub::{
            condition::Condition, request::CreateEventSubRequest,
            subscription_types::SubscriptionType, transport::Transport, EventSubAPI,
        },
        types::{ConduitId, SessionId, SubscriptionId, UserId},
    };

    api_test!(
        create_eventsub,
        [CreateEventSubRequest::new(
            SubscriptionType::UserUpdate,
            Condition::new().user_id(UserId::from("1234")),
            Transport::webhook(
                Url::parse("https://this-is-a-callback.com").unwrap(),
                "s3cre7".to_string()
            )
        )]
    );
    api_test!(
        delete_eventsub,
        [&SubscriptionId::from(
            "26b1c993-bfcf-44d9-b876-379dacafe75a"
        )]
    );
    api_test!(get_eventsub, [None, None]);

    api_test!(extra
        create_eventsub,
        create_eventsub2,
        [CreateEventSubRequest::new(
            SubscriptionType::UserUpdate,
            Condition::new().user_id(UserId::from("1234")),
            Transport::websocket(
                SessionId::from("AQoQexAWVYKSTIu4ec_2VAxyuhAB")
            )
        )]
    );
    api_test!(extra
        create_eventsub,
        create_eventsub3,
        [CreateEventSubRequest::new(
            SubscriptionType::UserUpdate,
            Condition::new().user_id(UserId::from("1234")),
            Transport::conduit(
                ConduitId::from("bfcfc993-26b1-b876-44d9-afe75a379dac")
            )
        )]
    );
}