unifly-api 0.9.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

// ── Event and alarm domain types ──

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use super::common::DataSource;
use super::entity_id::{EntityId, MacAddress};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
pub enum EventCategory {
    Device,
    Client,
    Network,
    System,
    Admin,
    Firewall,
    Vpn,
    Unknown,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
#[non_exhaustive]
pub enum EventSeverity {
    Info,
    Warning,
    Error,
    Critical,
}

/// Unified event from WebSocket or Session API event log.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Event {
    pub id: Option<EntityId>,
    pub timestamp: DateTime<Utc>,
    pub category: EventCategory,
    pub severity: EventSeverity,
    pub event_type: String,
    pub message: String,

    // Related entities
    pub device_mac: Option<MacAddress>,
    pub client_mac: Option<MacAddress>,
    pub site_id: Option<EntityId>,

    // Raw data for consumers that need it
    pub raw_key: Option<String>,

    #[serde(skip)]
    #[allow(dead_code)]
    pub(crate) source: DataSource,
}

/// Alarm (a persistent event requiring acknowledgment).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Alarm {
    pub id: EntityId,
    pub timestamp: DateTime<Utc>,
    pub category: EventCategory,
    pub severity: EventSeverity,
    pub message: String,
    pub archived: bool,

    pub device_mac: Option<MacAddress>,
    pub site_id: Option<EntityId>,
}