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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

// ── Session-only model types ──
//
// These types support Session API resources that have no Integration API
// equivalent. Consumed by CLI stats, system, admin, and DPI commands.

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

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

/// Statistical report (from Session API `stat/report/*`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StatReport {
    pub interval: String,
    pub entries: Vec<StatEntry>,
}

/// A single stats entry within a report.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StatEntry {
    pub timestamp: DateTime<Utc>,
    pub wan_tx_bytes: Option<u64>,
    pub wan_rx_bytes: Option<u64>,
    pub num_sta: Option<u32>,
    pub lan_num_sta: Option<u32>,
    pub wlan_num_sta: Option<u32>,
    pub latency: Option<f64>,
    /// Catch-all for stat-specific fields.
    pub extra: serde_json::Value,
}

/// Controller system info (from `GET /v1/info` or Session `/api/s/{site}/stat/sysinfo`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SystemInfo {
    pub controller_name: Option<String>,
    pub version: String,
    pub build: Option<String>,
    pub hostname: Option<String>,
    pub ip: Option<IpAddr>,
    pub uptime_secs: Option<u64>,
    pub update_available: Option<bool>,
}

/// Health summary for a subsystem (from Session `stat/health`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HealthSummary {
    /// Subsystem: "www", "wlan", "wan", "lan", "vpn"
    pub subsystem: String,
    /// Status: "ok", "warn", "error"
    pub status: String,
    pub num_adopted: Option<u32>,
    pub num_sta: Option<u32>,
    pub tx_bytes_r: Option<u64>,
    pub rx_bytes_r: Option<u64>,
    pub latency: Option<f64>,
    pub wan_ip: Option<String>,
    pub gateways: Option<Vec<String>>,
    pub extra: serde_json::Value,
}

/// Low-level controller system info (from Session `stat/sysinfo`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SysInfo {
    pub timezone: Option<String>,
    pub autobackup: Option<bool>,
    pub hostname: Option<String>,
    pub ip_addrs: Vec<String>,
    pub live_chat: Option<String>,
    pub data_retention_days: Option<u32>,
    pub extra: serde_json::Value,
}

/// Backup entry (from Session `cmd/backup`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Backup {
    pub filename: String,
    pub size_bytes: u64,
    pub created_at: Option<DateTime<Utc>>,
    pub version: Option<String>,
}

/// Admin user (from Session `cmd/sitemgr`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Admin {
    pub id: EntityId,
    pub name: String,
    pub email: Option<String>,
    /// Role: "admin", "readonly", "custom"
    pub role: String,
    pub is_super: bool,
    pub last_login: Option<DateTime<Utc>>,
}

/// Country entry (from Session `stat/ccode`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Country {
    pub code: String,
    pub name: String,
}

/// DPI application entry.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DpiApplication {
    pub id: u32,
    pub name: String,
    pub category_id: u32,
    pub tx_bytes: u64,
    pub rx_bytes: u64,
}

/// DPI category entry.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DpiCategory {
    pub id: u32,
    pub name: String,
    pub tx_bytes: u64,
    pub rx_bytes: u64,
    pub apps: Vec<DpiApplication>,
}

/// Interval for historical stats queries.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum StatsInterval {
    FiveMinutes,
    Hourly,
    Daily,
}

/// A single site-level stats sample (from `stat/report/hourly.site` or `daily.site`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SiteStatsSample {
    pub timestamp: DateTime<Utc>,
    pub wan_tx_bytes: Option<u64>,
    pub wan_rx_bytes: Option<u64>,
    pub num_sta: Option<u32>,
    pub lan_num_sta: Option<u32>,
    pub wlan_num_sta: Option<u32>,
    pub latency: Option<f64>,
}

/// A single device-level stats sample (from `stat/report/hourly.ap` or `hourly.gw`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeviceStatsSample {
    pub timestamp: DateTime<Utc>,
    pub mac: MacAddress,
    pub tx_bytes: Option<u64>,
    pub rx_bytes: Option<u64>,
    pub num_sta: Option<u32>,
    pub cpu: Option<f64>,
    pub mem: Option<f64>,
}