outfox-openai 0.7.0

Openai for outfox
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

use derive_builder::Builder;
use serde::{Deserialize, Serialize};

use crate::error::OpenAIError;

/// Represents an individual certificate uploaded to the organization.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct Certificate {
    /// The object type. Can be `certificate`, `organization.certificate`, or
    /// `organization.project.certificate`.
    pub object: String,
    /// The identifier, which can be referenced in API endpoints.
    pub id: String,
    /// The name of the certificate.
    pub name: String,
    /// The Unix timestamp (in seconds) of when the certificate was uploaded.
    pub created_at: u64,
    /// Details about the certificate.
    pub certificate_details: CertificateDetails,
    /// Whether the certificate is currently active at the specified scope.
    /// Not returned when getting details for a specific certificate.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active: Option<bool>,
}

/// Details about a certificate.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct CertificateDetails {
    /// The Unix timestamp (in seconds) of when the certificate becomes valid.
    pub valid_at: u64,
    /// The Unix timestamp (in seconds) of when the certificate expires.
    pub expires_at: u64,
    /// The content of the certificate in PEM format.
    /// Only included when requested via the `include[]=content` query parameter.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content: Option<String>,
}

/// Response for listing certificates.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct ListCertificatesResponse {
    /// The object type, which is always `list`.
    pub object: String,
    /// The list of certificates.
    pub data: Vec<Certificate>,
    /// The ID of the first certificate in the list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub first_id: Option<String>,
    /// The ID of the last certificate in the list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub last_id: Option<String>,
    /// Indicates if there are more certificates available.
    pub has_more: bool,
}

/// Request for uploading a certificate.
#[derive(Debug, Serialize, Deserialize, Builder, Clone, PartialEq)]
#[builder(name = "UploadCertificateRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct UploadCertificateRequest {
    /// An optional name for the certificate.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The certificate content in PEM format.
    pub content: String,
}

/// Request for modifying a certificate.
#[derive(Debug, Serialize, Deserialize, Builder, Clone, PartialEq)]
#[builder(name = "ModifyCertificateRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct ModifyCertificateRequest {
    /// The updated name for the certificate.
    pub name: String,
}

/// Request for toggling (activating/deactivating) certificates.
#[derive(Debug, Serialize, Deserialize, Builder, Clone, PartialEq)]
#[builder(name = "ToggleCertificatesRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct ToggleCertificatesRequest {
    /// Array of certificate IDs to toggle (1-10 certificates).
    pub certificate_ids: Vec<String>,
}

/// Response for deleting a certificate.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct DeleteCertificateResponse {
    /// The object type, which is always `certificate.deleted`.
    pub object: String,
    /// The ID of the certificate that was deleted.
    pub id: String,
}