rocksky 0.3.0

Async Rust SDK for the Rocksky XRPC 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
141

//! `app.rocksky.apikey.*` — API key management for the authenticated user.

use serde::Serialize;
use serde_json::Value;

use crate::client::Client;
use crate::error::Result;
use crate::models::{ApiKey, ApikeysEnvelope};

#[derive(Debug)]
pub struct ApikeyApi<'a> {
    client: &'a Client,
}

impl<'a> ApikeyApi<'a> {
    pub(crate) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// List the authenticated user's API keys.
    pub fn list(&self) -> ListApikeys<'_> {
        ListApikeys {
            client: self.client,
            params: Page {
                limit: None,
                offset: None,
            },
        }
    }

    /// Create a new API key.
    pub async fn create(
        &self,
        name: impl Into<String>,
        description: Option<String>,
    ) -> Result<ApiKey> {
        #[derive(Serialize)]
        struct B {
            name: String,
            #[serde(skip_serializing_if = "Option::is_none")]
            description: Option<String>,
        }
        self.client
            .procedure_as(
                "app.rocksky.apikey.createApikey",
                None::<&()>,
                Some(&B {
                    name: name.into(),
                    description,
                }),
                true,
            )
            .await
    }

    /// Update an API key.
    pub async fn update(
        &self,
        api_key_id: impl Into<String>,
        name: impl Into<String>,
        description: Option<String>,
    ) -> Result<ApiKey> {
        #[derive(Serialize)]
        struct B {
            id: String,
            name: String,
            #[serde(skip_serializing_if = "Option::is_none")]
            description: Option<String>,
        }
        self.client
            .procedure_as(
                "app.rocksky.apikey.updateApikey",
                None::<&()>,
                Some(&B {
                    id: api_key_id.into(),
                    name: name.into(),
                    description,
                }),
                true,
            )
            .await
    }

    /// Remove an API key by id.
    pub async fn remove(&self, api_key_id: impl Into<String>) -> Result<ApiKey> {
        #[derive(Serialize)]
        struct P {
            id: String,
        }
        self.client
            .procedure_as(
                "app.rocksky.apikey.removeApikey",
                Some(&P {
                    id: api_key_id.into(),
                }),
                None::<&()>,
                true,
            )
            .await
    }
}

#[derive(Debug, Serialize)]
struct Page {
    #[serde(skip_serializing_if = "Option::is_none")]
    limit: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    offset: Option<u32>,
}

#[derive(Debug)]
pub struct ListApikeys<'a> {
    client: &'a Client,
    params: Page,
}

impl<'a> ListApikeys<'a> {
    pub fn limit(mut self, limit: u32) -> Self {
        self.params.limit = Some(limit);
        self
    }
    pub fn offset(mut self, offset: u32) -> Self {
        self.params.offset = Some(offset);
        self
    }
    pub async fn send(self) -> Result<Vec<ApiKey>> {
        let value: Value = self
            .client
            .query_as("app.rocksky.apikey.getApikeys", &self.params, true)
            .await?;
        // The endpoint may return a bare array or an envelope; tolerate either.
        if let Value::Array(items) = &value {
            return Ok(items
                .iter()
                .filter_map(|v| serde_json::from_value(v.clone()).ok())
                .collect());
        }
        let env: ApikeysEnvelope = serde_json::from_value(value).unwrap_or_default();
        Ok(env.api_keys)
    }
}