peertube 0.2.0

Peertube API client
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

pub struct Notifications {
    config: crate::Config,
}

impl Notifications {
    pub(crate) fn new(config: &crate::Config) -> Self {
        Self {
            config: config.clone(),
        }
    }

    /**
     * List my notifications.
     */
    pub async fn all(
        &self,
        auth: &crate::data::Token,
        params: &crate::param::Notification,
    ) -> crate::Result<crate::Pager<crate::data::Notification>> {
        let request = crate::Request {
            path: "/users/me/notifications".into(),
            params: crate::Params::Query(params),
            auth: Some(auth.clone()),
        };

        crate::Api::get(&self.config, request).await
    }

    /**
     * Mark notifications as read by their id.
     */
    pub async fn read(&self, auth: &crate::data::Token, ids: &[u32]) -> crate::Result<()> {
        let params = crate::param::Notifications { ids: ids.to_vec() };

        let request = crate::Request {
            path: "/users/me/notifications/read".into(),
            params: crate::Params::Json(params),
            auth: Some(auth.clone()),
        };

        crate::Api::post::<crate::data::Empty, _>(&self.config, request)
            .await?
            .into()
    }

    /**
     * Mark all my notification as read.
     */
    pub async fn read_all(&self, auth: &crate::data::Token) -> crate::Result<()> {
        let request = crate::Request {
            path: "/users/me/notifications/read-all".into(),
            params: crate::Params::none(),
            auth: Some(auth.clone()),
        };

        crate::Api::post::<crate::data::Empty, _>(&self.config, request)
            .await?
            .into()
    }

    /**
     * Update my notification settings.
     */
    pub async fn settings(
        &self,
        auth: &crate::data::Token,
        settings: &crate::param::NotificationSettings,
    ) -> crate::Result<()> {
        let request = crate::Request {
            path: "/users/me/notification-settings".into(),
            params: crate::Params::Json(settings),
            auth: Some(auth.clone()),
        };

        crate::Api::put(&self.config, request).await
    }
}

#[cfg(test)]
mod test {
    #[tokio::test]
    async fn all() {
        let (api, token) = crate::test::api().await;

        let notifications = api
            .me
            .notifications
            .all(&token, &crate::param::Notification::default())
            .await;

        assert!(notifications.is_ok());
    }

    #[tokio::test]
    async fn read() {
        let (api, token) = crate::test::api().await;

        let status = api.me.notifications.read(&token, &[1]).await;

        assert!(status.is_ok());
    }

    #[tokio::test]
    async fn read_all() {
        let (api, token) = crate::test::api().await;

        let status = api.me.notifications.read_all(&token).await;

        assert!(status.is_ok());
    }

    #[tokio::test]
    async fn settings() {
        use crate::param::NotificationSettingsValue::*;

        let (api, token) = crate::test::api().await;
        let settings = crate::param::NotificationSettings {
            abuse_as_moderator: Both,
            auto_instance_following: Web,
            blacklist_on_my_video: Both,
            comment_mention: Web,
            my_video_import_finished: Web,
            my_video_published: Web,
            new_comment_on_my_video: Web,
            new_follow: Web,
            new_instance_follower: Web,
            new_user_registration: Web,
            new_video_from_subscription: Web,
            video_auto_blacklist_as_moderator: Both,
        };

        let status = api.me.notifications.settings(&token, &settings).await;

        assert!(status.is_ok());
    }
}