web-arena-indigo 0.2.0

Unofficial async client for the WebARENA Indigo VPS API (NTTPC): instances, SSH keys, firewalls, snapshots, DNS
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

//! SSH key APIs.

use crate::http::HttpClient;
use crate::{WebArenaIndigoApi, WebArenaIndigoApiError};
use serde::{Deserialize, Serialize};
use serde_json::json;

pub struct SshApi<'a> {
    indigo: &'a WebArenaIndigoApi,
}

impl<'a> SshApi<'a> {
    pub(crate) fn new(api: &'a WebArenaIndigoApi) -> Self {
        SshApi { indigo: api }
    }

    /// `GET /webarenaIndigo/v1/vm/sshkey`
    pub async fn ssh_key_list(&self) -> Result<SshKeyListResponse, WebArenaIndigoApiError> {
        HttpClient::get(
            self.indigo.throttle(),
            self.indigo.access_token(),
            &self.indigo.endpoint("/webarenaIndigo/v1/vm/sshkey"),
        )
        .await
    }

    /// `GET /webarenaIndigo/v1/vm/sshkey/active/status`
    pub async fn active_ssh_key_list(
        &self,
    ) -> Result<ActiveSshKeyListResponse, WebArenaIndigoApiError> {
        HttpClient::get(
            self.indigo.throttle(),
            self.indigo.access_token(),
            &self
                .indigo
                .endpoint("/webarenaIndigo/v1/vm/sshkey/active/status"),
        )
        .await
    }

    /// `POST /webarenaIndigo/v1/vm/sshkey`
    pub async fn create_ssh_key(
        &self,
        name: &str,
        public_key: &str,
    ) -> Result<CreateSshKeyResponse, WebArenaIndigoApiError> {
        HttpClient::post(
            self.indigo.throttle(),
            self.indigo.access_token(),
            &self.indigo.endpoint("/webarenaIndigo/v1/vm/sshkey"),
            &json!({
                "sshName": name,
                "sshKey": public_key,
            }),
        )
        .await
    }

    /// `GET /webarenaIndigo/v1/vm/sshkey/{id}`
    pub async fn retrieve_ssh_key(
        &self,
        ssh_key_id: u32,
    ) -> Result<RetrieveSshKeyResponse, WebArenaIndigoApiError> {
        HttpClient::get(
            self.indigo.throttle(),
            self.indigo.access_token(),
            &self
                .indigo
                .endpoint(&format!("/webarenaIndigo/v1/vm/sshkey/{}", ssh_key_id)),
        )
        .await
    }

    /// `PUT /webarenaIndigo/v1/vm/sshkey/{id}`
    pub async fn update_ssh_key(
        &self,
        ssh_key_id: u32,
        request: UpdateSshKeyRequest,
    ) -> Result<UpdateSshKeyResponse, WebArenaIndigoApiError> {
        HttpClient::put(
            self.indigo.throttle(),
            self.indigo.access_token(),
            &self
                .indigo
                .endpoint(&format!("/webarenaIndigo/v1/vm/sshkey/{}", ssh_key_id)),
            &request,
        )
        .await
    }

    /// `DELETE /webarenaIndigo/v1/vm/sshkey/{id}`
    pub async fn destroy_ssh_key(
        &self,
        ssh_key_id: u32,
    ) -> Result<DestroySshKeyResponse, WebArenaIndigoApiError> {
        HttpClient::delete(
            self.indigo.throttle(),
            self.indigo.access_token(),
            &self
                .indigo
                .endpoint(&format!("/webarenaIndigo/v1/vm/sshkey/{}", ssh_key_id)),
        )
        .await
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SshKeyListResponse {
    pub success: bool,
    pub total: u32,
    #[serde(rename = "sshkeys")]
    pub ssh_keys: Vec<SshKey>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SshKey {
    pub id: u32,
    pub service_id: String,
    pub user_id: u32,
    pub name: String,
    #[serde(rename = "sshkey")]
    pub ssh_key: String,
    pub status: String,
    pub created_at: String,
    pub updated_at: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActiveSshKeyListResponse {
    pub success: bool,
    pub total: u32,
    #[serde(rename = "sshkeys")]
    pub ssh_keys: Vec<SshKey>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateSshKeyResponse {
    pub success: bool,
    pub message: String,
    #[serde(rename = "sshKey")]
    pub ssh_key: SshKey,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RetrieveSshKeyResponse {
    pub success: bool,
    #[serde(rename = "sshKey")]
    pub ssh_key: Vec<SshKey>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UpdateSshKeyResponse {
    pub success: bool,
    pub message: String,
}

#[derive(Debug, Clone, Serialize)]
pub struct UpdateSshKeyRequest {
    #[serde(rename = "sshName")]
    pub ssh_name: String,
    #[serde(rename = "sshKey")]
    pub ssh_key: String,
    #[serde(rename = "sshKeyStatus")]
    pub ssh_key_status: SshKeyStatus,
}

#[derive(Debug, Clone, Copy, Default, Serialize)]
pub enum SshKeyStatus {
    #[default]
    #[serde(rename = "ACTIVE")]
    Active,
    #[serde(rename = "DEACTIVE")]
    Deactive,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DestroySshKeyResponse {
    pub success: bool,
    pub message: String,
}