openapp-sdk-core 0.1.60

Core of the OpenApp SDK: HTTP transport, auth, retries, telemetry, and per-resource sub-clients reused by every language SDK.
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

//! `API Keys` resource group.

use std::sync::Arc;

use reqwest::Method;

use super::types;
use crate::{
    error::SdkError,
    transport::{RequestSpec, Transport},
};

#[derive(Debug, Clone)]
pub struct ApiKeysClient {
    transport: Arc<Transport>,
}

impl ApiKeysClient {
    pub(crate) fn new(transport: Arc<Transport>) -> Self {
        Self { transport }
    }

    /// `GET /api-keys` — list API keys for the authenticated user's org.
    pub async fn list(&self) -> Result<Vec<types::ApiKeyListItem>, SdkError> {
        self.transport
            .request_json::<(), Vec<types::ApiKeyListItem>>(RequestSpec {
                method: Method::GET,
                path: "/api-keys",
                ..Default::default()
            })
            .await
    }

    /// `POST /api-keys` — mint a new API key.
    pub async fn create(
        &self,
        body: &types::CreateApiKeyRequest,
    ) -> Result<types::CreateApiKeyResponse, SdkError> {
        self.transport
            .request_json::<types::CreateApiKeyRequest, types::CreateApiKeyResponse>(RequestSpec {
                method: Method::POST,
                path: "/api-keys",
                body: Some(body),
                ..Default::default()
            })
            .await
    }

    /// `PATCH /api-keys/{id}` — rename or adjust scopes.
    pub async fn update(
        &self,
        id: &str,
        body: &types::UpdateApiKeyRequest,
    ) -> Result<(), SdkError> {
        let path = format!("/api-keys/{id}");
        self.transport
            .request_json::<types::UpdateApiKeyRequest, ()>(RequestSpec {
                method: Method::PATCH,
                path: &path,
                body: Some(body),
                ..Default::default()
            })
            .await
    }

    /// `DELETE /api-keys/{id}` — soft-revoke the key.
    pub async fn revoke(&self, id: &str) -> Result<(), SdkError> {
        let path = format!("/api-keys/{id}");
        self.transport
            .request_json::<(), ()>(RequestSpec {
                method: Method::DELETE,
                path: &path,
                ..Default::default()
            })
            .await
    }

    /// `POST /api-keys/{id}/restore` — un-revoke a previously revoked key.
    pub async fn restore(&self, id: &str) -> Result<(), SdkError> {
        let path = format!("/api-keys/{id}/restore");
        self.transport
            .request_json::<(), ()>(RequestSpec {
                method: Method::POST,
                path: &path,
                ..Default::default()
            })
            .await
    }

    /// `DELETE /api-keys/{id}/purge` — hard-delete a revoked key.
    pub async fn purge(&self, id: &str) -> Result<(), SdkError> {
        let path = format!("/api-keys/{id}/purge");
        self.transport
            .request_json::<(), ()>(RequestSpec {
                method: Method::DELETE,
                path: &path,
                ..Default::default()
            })
            .await
    }
}