async-openai 0.34.0

Rust library for OpenAI
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

use crate::{
    config::Config,
    error::OpenAIError,
    types::admin::api_keys::{
        AdminApiKey, AdminApiKeyDeleteResponse, ApiKeyList, CreateAdminApiKeyRequest,
    },
    Client, RequestOptions,
};

/// Admin API keys enable Organization Owners to programmatically manage various aspects of their
/// organization, including users, projects, and API keys. These keys provide administrative capabilities,
/// allowing you to automate organization management tasks.
pub struct AdminAPIKeys<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> AdminAPIKeys<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

    /// List all organization and project API keys.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<ApiKeyList, OpenAIError> {
        self.client
            .get("/organization/admin_api_keys", &self.request_options)
            .await
    }

    /// Create an organization admin API key.
    pub async fn create(
        &self,
        request: CreateAdminApiKeyRequest,
    ) -> Result<AdminApiKey, OpenAIError> {
        self.client
            .post(
                "/organization/admin_api_keys",
                request,
                &self.request_options,
            )
            .await
    }

    /// Retrieve a single organization API key.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, key_id: &str) -> Result<AdminApiKey, OpenAIError> {
        self.client
            .get(
                format!("/organization/admin_api_keys/{key_id}").as_str(),
                &self.request_options,
            )
            .await
    }

    /// Delete an organization admin API key.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn delete(&self, key_id: &str) -> Result<AdminApiKeyDeleteResponse, OpenAIError> {
        self.client
            .delete(
                format!("/organization/admin_api_keys/{key_id}").as_str(),
                &self.request_options,
            )
            .await
    }
}