unkey 0.6.0

An asynchronous Rust SDK for the Unkey 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

use crate::fetch;
use crate::models::DeleteApiRequest;
use crate::models::GetApiRequest;
use crate::models::GetApiResponse;
use crate::models::ListKeysRequest;
use crate::models::ListKeysResponse;
use crate::parse_empty_response;
use crate::parse_response;
use crate::routes;
use crate::services::HttpService;

#[allow(unused_imports)]
use crate::models::HttpError;

/// The service that handles api related requests.
#[derive(Debug, Clone, Eq, PartialEq)]
pub(crate) struct ApiService;

impl ApiService {
    /// Retrieves a paginated list of keys for an api.
    ///
    /// # Arguments
    /// - `http`: The http service to use for the request.
    /// - `req`: The request to send.
    ///
    /// # Returns
    /// A [`Result`] containing the response, or an error.
    ///
    /// # Errors
    /// The [`HttpError`], if one occurred.
    pub async fn list_keys(
        &self,
        http: &HttpService,
        req: ListKeysRequest,
    ) -> Result<ListKeysResponse, HttpError> {
        let mut route = routes::LIST_KEYS.compile();
        route
            .query_insert("apiId", &req.api_id)
            .query_insert("limit", &req.limit.unwrap_or(100).to_string());

        if let Some(revalidate) = &req.revalidate_cache {
            route.query_insert("revalidateKeysCache", &revalidate.to_string());
        }

        if let Some(owner) = &req.owner_id {
            route.query_insert("ownerId", owner);
        }

        if let Some(cursor) = &req.cursor {
            route.query_insert("cursor", cursor);
        }

        parse_response(fetch!(http, route).await).await
    }

    /// Retrieves api information.
    ///
    /// # Arguments
    /// - `http`: The http service to use for the request.
    /// - `req`: The request to send.
    ///
    /// # Returns
    /// A [`Result`] containing the response, or an error.
    ///
    /// # Errors
    /// The [`HttpError`], if one occurred.
    pub async fn get_api(
        &self,
        http: &HttpService,
        req: GetApiRequest,
    ) -> Result<GetApiResponse, HttpError> {
        let mut route = routes::GET_API.compile();
        route.query_insert("apiId", &req.api_id);

        parse_response(fetch!(http, route).await).await
    }

    /// Permanently delete an API and revoke all keys associated with it.
    ///
    /// # Arguments
    /// - `http`: The http service to use for the request.
    /// - `req`: The request to send.
    ///
    /// # Returns
    /// A [`Result`] containing the response, or an error.
    ///
    /// # Errors
    /// The [`HttpError`], if one occurred.
    pub async fn delete_api(
        &self,
        http: &HttpService,
        req: DeleteApiRequest,
    ) -> Result<(), HttpError> {
        let route = routes::DELETE_API.compile();

        parse_empty_response(fetch!(http, route, req).await).await
    }
}