unifly-api 0.8.0

Async Rust client, reactive data layer, and domain model for UniFi controller APIs
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

// Legacy API event and alarm endpoints
//
// Events (stat/event) and alarms (stat/alarm) with archive support
// via cmd/evtmgr.

use serde_json::json;
use tracing::debug;

use crate::error::Error;
use crate::legacy::client::LegacyClient;
use crate::legacy::models::{LegacyAlarm, LegacyEvent};

impl LegacyClient {
    /// List recent events.
    ///
    /// `GET /api/s/{site}/stat/event`
    ///
    /// If `count` is provided, limits the number of events returned
    /// by appending `?_limit={count}` to the request.
    pub async fn list_events(&self, count: Option<u32>) -> Result<Vec<LegacyEvent>, Error> {
        let path = match count {
            Some(n) => format!("stat/event?_limit={n}"),
            None => "stat/event".to_string(),
        };
        let url = self.site_url(&path);
        debug!(?count, "listing events");
        self.get(url).await
    }

    /// List active alarms.
    ///
    /// `GET /api/s/{site}/stat/alarm`
    pub async fn list_alarms(&self) -> Result<Vec<LegacyAlarm>, Error> {
        let url = self.site_url("stat/alarm");
        debug!("listing alarms");
        self.get(url).await
    }

    /// Archive (acknowledge) a specific alarm by its ID.
    ///
    /// `POST /api/s/{site}/cmd/evtmgr` with `{"cmd": "archive-alarm", "_id": "..."}`
    pub async fn archive_alarm(&self, id: &str) -> Result<(), Error> {
        let url = self.site_url("cmd/evtmgr");
        debug!(id, "archiving alarm");
        let _: Vec<serde_json::Value> = self
            .post(
                url,
                &json!({
                    "cmd": "archive-alarm",
                    "_id": id,
                }),
            )
            .await?;
        Ok(())
    }

    /// Archive all alarms for the active site.
    ///
    /// `POST /api/s/{site}/cmd/evtmgr` with `{"cmd": "archive-all-alarms"}`
    pub async fn archive_all_alarms(&self) -> Result<(), Error> {
        let url = self.site_url("cmd/evtmgr");
        debug!("archiving all alarms");
        let _: Vec<serde_json::Value> = self
            .post(
                url,
                &json!({
                    "cmd": "archive-all-alarms",
                }),
            )
            .await?;
        Ok(())
    }
}