unifly-api 0.8.1

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

use serde::Serialize;
use uuid::Uuid;

use super::{Error, IntegrationClient, types};

impl IntegrationClient {
    // ── Devices ──────────────────────────────────────────────────────

    pub async fn list_devices(
        &self,
        site_id: &Uuid,
        offset: i64,
        limit: i32,
    ) -> Result<types::Page<types::DeviceResponse>, Error> {
        self.get_with_params(
            &format!("v1/sites/{site_id}/devices"),
            &[("offset", offset.to_string()), ("limit", limit.to_string())],
        )
        .await
    }

    pub async fn get_device(
        &self,
        site_id: &Uuid,
        device_id: &Uuid,
    ) -> Result<types::DeviceDetailsResponse, Error> {
        self.get(&format!("v1/sites/{site_id}/devices/{device_id}"))
            .await
    }

    pub async fn get_device_statistics(
        &self,
        site_id: &Uuid,
        device_id: &Uuid,
    ) -> Result<types::DeviceStatisticsResponse, Error> {
        self.get(&format!(
            "v1/sites/{site_id}/devices/{device_id}/statistics/latest"
        ))
        .await
    }

    pub async fn adopt_device(
        &self,
        site_id: &Uuid,
        mac: &str,
        ignore_device_limit: bool,
    ) -> Result<types::DeviceDetailsResponse, Error> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct Body<'a> {
            mac_address: &'a str,
            ignore_device_limit: bool,
        }

        self.post(
            &format!("v1/sites/{site_id}/devices"),
            &Body {
                mac_address: mac,
                ignore_device_limit,
            },
        )
        .await
    }

    pub async fn remove_device(&self, site_id: &Uuid, device_id: &Uuid) -> Result<(), Error> {
        self.delete(&format!("v1/sites/{site_id}/devices/{device_id}"))
            .await
    }

    pub async fn device_action(
        &self,
        site_id: &Uuid,
        device_id: &Uuid,
        action: &str,
    ) -> Result<(), Error> {
        #[derive(Serialize)]
        struct Body<'a> {
            action: &'a str,
        }

        self.post_no_response(
            &format!("v1/sites/{site_id}/devices/{device_id}/actions"),
            &Body { action },
        )
        .await
    }

    pub async fn port_action(
        &self,
        site_id: &Uuid,
        device_id: &Uuid,
        port_idx: u32,
        action: &str,
    ) -> Result<(), Error> {
        #[derive(Serialize)]
        struct Body<'a> {
            action: &'a str,
        }

        self.post_no_response(
            &format!("v1/sites/{site_id}/devices/{device_id}/interfaces/ports/{port_idx}/actions"),
            &Body { action },
        )
        .await
    }

    pub async fn list_pending_devices(
        &self,
        _site_id: &Uuid,
        offset: i64,
        limit: i32,
    ) -> Result<types::Page<types::PendingDeviceResponse>, Error> {
        self.get_with_params(
            "v1/pending-devices",
            &[("offset", offset.to_string()), ("limit", limit.to_string())],
        )
        .await
    }

    pub async fn list_device_tags(
        &self,
        site_id: &Uuid,
        offset: i64,
        limit: i32,
    ) -> Result<types::Page<types::DeviceTagResponse>, Error> {
        self.get_with_params(
            &format!("v1/sites/{site_id}/device-tags"),
            &[("offset", offset.to_string()), ("limit", limit.to_string())],
        )
        .await
    }
}