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
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

use crate::{
    config::Config,
    error::OpenAIError,
    types::admin::certificates::{
        Certificate, DeleteCertificateResponse, ListCertificatesResponse, ModifyCertificateRequest,
        ToggleCertificatesRequest, UploadCertificateRequest,
    },
    Client, RequestOptions,
};

/// Certificates enable Mutual TLS (mTLS) authentication for your organization.
/// Manage certificates at the organization level.
pub struct Certificates<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

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

    // Organization-level certificate operations

    /// List all certificates for the organization.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list_organization(&self) -> Result<ListCertificatesResponse, OpenAIError> {
        self.client
            .get("/organization/certificates", &self.request_options)
            .await
    }

    /// Upload a certificate to the organization.
    /// This does not automatically activate the certificate.
    pub async fn upload_organization(
        &self,
        request: UploadCertificateRequest,
    ) -> Result<Certificate, OpenAIError> {
        self.client
            .post("/organization/certificates", request, &self.request_options)
            .await
    }

    /// Activate certificates for the organization.
    /// You can atomically and idempotently activate up to 10 certificates at a time.
    pub async fn activate_organization(
        &self,
        request: ToggleCertificatesRequest,
    ) -> Result<ListCertificatesResponse, OpenAIError> {
        self.client
            .post(
                "/organization/certificates/activate",
                request,
                &self.request_options,
            )
            .await
    }

    /// Deactivate certificates for the organization.
    /// You can atomically and idempotently deactivate up to 10 certificates at a time.
    pub async fn deactivate_organization(
        &self,
        request: ToggleCertificatesRequest,
    ) -> Result<ListCertificatesResponse, OpenAIError> {
        self.client
            .post(
                "/organization/certificates/deactivate",
                request,
                &self.request_options,
            )
            .await
    }

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

    /// Modify a certificate. Note that only the name can be modified.
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn modify(
        &self,
        certificate_id: &str,
        request: ModifyCertificateRequest,
    ) -> Result<Certificate, OpenAIError> {
        self.client
            .post(
                format!("/organization/certificates/{certificate_id}").as_str(),
                request,
                &self.request_options,
            )
            .await
    }

    /// Delete a certificate from the organization.
    /// The certificate must be inactive for the organization and all projects.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn delete(
        &self,
        certificate_id: &str,
    ) -> Result<DeleteCertificateResponse, OpenAIError> {
        self.client
            .delete(
                format!("/organization/certificates/{certificate_id}").as_str(),
                &self.request_options,
            )
            .await
    }
}