appwrite 0.10.0

Appwrite SDK for Rust
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
//! Health service for Appwrite SDK

use crate::client::Client;

use reqwest::Method;
use serde_json::json;
use std::collections::HashMap;

/// The Health service allows you to both validate and monitor your Appwrite
/// server's health.
#[derive(Debug, Clone)]
pub struct Health {
    client: Client,
}

impl Health {
    pub fn new(client: &Client) -> Self {
        Self { client: client.clone() }
    }

    pub fn client(&self) -> &Client {
        &self.client
    }

    /// Check the Appwrite HTTP server is up and responsive.
    pub async fn get(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatus> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite Antivirus server is up and connection is successful.
    pub async fn get_antivirus(
        &self,
    ) -> crate::error::Result<crate::models::HealthAntivirus> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/anti-virus".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the database that backs the audit and activity store. When the
    /// connection is reachable the endpoint returns a passing status with its
    /// response time.
    pub async fn get_audits_db(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatusList> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/audits-db".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite in-memory cache servers are up and connection is
    /// successful.
    pub async fn get_cache(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatusList> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/cache".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the SSL certificate for a domain
    pub async fn get_certificate(
        &self,
        domain: Option<&str>,
    ) -> crate::error::Result<crate::models::HealthCertificate> {
        let mut params = HashMap::new();
        if let Some(value) = domain {
            params.insert("domain".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/certificate".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get console pausing health status. Monitors projects approaching the pause
    /// threshold to detect potential issues with console access tracking.
    pub async fn get_console_pausing(
        &self,
        threshold: Option<i64>,
        inactivity_days: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthStatus> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        if let Some(value) = inactivity_days {
            params.insert("inactivityDays".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/console-pausing".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite database servers are up and connection is successful.
    pub async fn get_db(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatusList> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/db".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite pub-sub servers are up and connection is successful.
    pub async fn get_pub_sub(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatusList> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/pubsub".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of audit logs that are waiting to be processed in the
    /// Appwrite internal queue server.
    pub async fn get_queue_audits(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/audits".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of builds that are waiting to be processed in the Appwrite
    /// internal queue server.
    pub async fn get_queue_builds(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/builds".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of certificates that are waiting to be issued against
    /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
    /// server.
    pub async fn get_queue_certificates(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/certificates".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of database changes that are waiting to be processed in the
    /// Appwrite internal queue server.
    pub async fn get_queue_databases(
        &self,
        name: Option<&str>,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = name {
            params.insert("name".to_string(), json!(value));
        }
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/databases".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of background destructive changes that are waiting to be
    /// processed in the Appwrite internal queue server.
    pub async fn get_queue_deletes(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/deletes".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Returns the amount of failed jobs in a given queue.
    pub async fn get_failed_jobs(
        &self,
        name: crate::enums::HealthQueueName,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/failed/{name}".to_string().replace("{name}", &name.to_string());

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of function executions that are waiting to be processed in
    /// the Appwrite internal queue server.
    pub async fn get_queue_functions(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/functions".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of logs that are waiting to be processed in the Appwrite
    /// internal queue server.
    pub async fn get_queue_logs(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/logs".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of mails that are waiting to be processed in the Appwrite
    /// internal queue server.
    pub async fn get_queue_mails(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/mails".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of messages that are waiting to be processed in the Appwrite
    /// internal queue server.
    pub async fn get_queue_messaging(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/messaging".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of migrations that are waiting to be processed in the
    /// Appwrite internal queue server.
    pub async fn get_queue_migrations(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/migrations".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of jobs in the notifications queue.
    pub async fn get_queue_notifications(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/notifications".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of metrics that are waiting to be processed in the Appwrite
    /// stats resources queue.
    pub async fn get_queue_stats_resources(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/stats-resources".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of metrics that are waiting to be processed in the Appwrite
    /// internal queue server.
    pub async fn get_queue_usage(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/stats-usage".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Get the number of webhooks that are waiting to be processed in the Appwrite
    /// internal queue server.
    pub async fn get_queue_webhooks(
        &self,
        threshold: Option<i64>,
    ) -> crate::error::Result<crate::models::HealthQueue> {
        let mut params = HashMap::new();
        if let Some(value) = threshold {
            params.insert("threshold".to_string(), json!(value));
        }
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/queue/webhooks".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite storage device is up and connection is successful.
    pub async fn get_storage(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatus> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/storage".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite local storage device is up and connection is successful.
    pub async fn get_storage_local(
        &self,
    ) -> crate::error::Result<crate::models::HealthStatus> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/storage/local".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

    /// Check the Appwrite server time is synced with Google remote NTP server. We
    /// use this technology to smoothly handle leap seconds with no disruptive
    /// events. The [Network Time
    /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is
    /// used by hundreds of millions of computers and devices to synchronize their
    /// clocks over the Internet. If your computer sets its own clock, it likely
    /// uses NTP.
    pub async fn get_time(
        &self,
    ) -> crate::error::Result<crate::models::HealthTime> {
        let params = HashMap::new();
        let mut api_headers = HashMap::new();
        api_headers.insert("accept".to_string(), "application/json".to_string());

        let path = "/health/time".to_string();

        self.client.call(Method::GET, &path, Some(api_headers), Some(params)).await
    }

}

impl crate::services::Service for Health {
    fn client(&self) -> &Client {
        &self.client
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_health_creation() {
        let client = Client::new();
        let service = Health::new(&client);
        assert!(service.client().endpoint().contains("cloud.appwrite.io/v1"));
    }
}