romm-api 1.0.0

HTTP client and domain logic for the RomM API
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

//! Device management endpoints (`/api/devices`).

use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::Endpoint;

/// Sync mode expected by RomM device endpoints.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum SyncMode {
    Api,
    FileTransfer,
    PushPull,
}

/// Response from `POST /api/devices`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeviceCreateResponse {
    pub device_id: String,
    pub name: Option<String>,
    pub created_at: String,
}

/// Response shape for `GET /api/devices*`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeviceSchema {
    pub id: String,
    pub user_id: u64,
    pub name: Option<String>,
    pub platform: Option<String>,
    pub client: Option<String>,
    pub client_version: Option<String>,
    pub ip_address: Option<String>,
    pub mac_address: Option<String>,
    pub hostname: Option<String>,
    pub sync_mode: SyncMode,
    pub sync_enabled: bool,
    pub sync_config: Option<Value>,
    pub last_seen: Option<String>,
    pub created_at: String,
    pub updated_at: String,
}

/// `POST /api/devices`.
#[derive(Debug, Clone)]
pub struct RegisterDevice {
    pub body: Value,
}

impl Endpoint for RegisterDevice {
    type Output = DeviceCreateResponse;

    fn method(&self) -> &'static str {
        "POST"
    }

    fn path(&self) -> String {
        "/api/devices".into()
    }

    fn body(&self) -> Option<Value> {
        Some(self.body.clone())
    }
}

/// `GET /api/devices`.
#[derive(Debug, Clone, Default)]
pub struct ListDevices;

impl Endpoint for ListDevices {
    type Output = Vec<DeviceSchema>;

    fn method(&self) -> &'static str {
        "GET"
    }

    fn path(&self) -> String {
        "/api/devices".into()
    }
}

/// `GET /api/devices/{device_id}`.
#[derive(Debug, Clone)]
pub struct GetDevice {
    pub device_id: String,
}

impl Endpoint for GetDevice {
    type Output = DeviceSchema;

    fn method(&self) -> &'static str {
        "GET"
    }

    fn path(&self) -> String {
        format!("/api/devices/{}", self.device_id)
    }
}

/// `PUT /api/devices/{device_id}`.
#[derive(Debug, Clone)]
pub struct UpdateDevice {
    pub device_id: String,
    pub body: Value,
}

impl Endpoint for UpdateDevice {
    type Output = DeviceSchema;

    fn method(&self) -> &'static str {
        "PUT"
    }

    fn path(&self) -> String {
        format!("/api/devices/{}", self.device_id)
    }

    fn body(&self) -> Option<Value> {
        Some(self.body.clone())
    }
}

/// `DELETE /api/devices/{device_id}`.
#[derive(Debug, Clone)]
pub struct DeleteDevice {
    pub device_id: String,
}

impl Endpoint for DeleteDevice {
    type Output = Value;

    fn method(&self) -> &'static str {
        "DELETE"
    }

    fn path(&self) -> String {
        format!("/api/devices/{}", self.device_id)
    }
}