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

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

use crate::error::OpenAIError;

/// Represents an individual Admin API key in an org.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct AdminApiKey {
    /// The object type, which is always `organization.admin_api_key`.
    pub object: String,
    /// The identifier, which can be referenced in API endpoints.
    pub id: String,
    /// The name of the API key.
    pub name: String,
    /// The redacted value of the API key.
    pub redacted_value: String,
    /// The value of the API key. Only shown on create.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
    /// The Unix timestamp (in seconds) of when the API key was created.
    pub created_at: u64,
    /// The Unix timestamp (in seconds) of when the API key was last used.
    pub last_used_at: Option<u64>,
    /// The owner of the API key.
    pub owner: AdminApiKeyOwner,
}

/// Represents the owner of an admin API key.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct AdminApiKeyOwner {
    pub kind: String,

    pub object: String,
    /// The identifier, which can be referenced in API endpoints.
    pub id: String,
    /// The name of the owner.
    pub name: String,
    /// The Unix timestamp (in seconds) of when the owner was created.
    pub created_at: u64,

    pub role: String,
}

/// Represents the response object for listing admin API keys.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct ApiKeyList {
    /// The object type, which is always `list`.
    pub object: String,
    /// The list of admin API keys.
    pub data: Vec<AdminApiKey>,
    /// Indicates if there are more admin API keys available.
    pub has_more: bool,
    /// The ID of the first admin API key in the list.
    pub first_id: Option<String>,
    /// The ID of the last admin API key in the list.
    pub last_id: Option<String>,
}

/// Represents the request object for creating an admin API key.
#[derive(Debug, Serialize, Deserialize, Builder, Clone, PartialEq)]
#[builder(name = "CreateAdminApiKeyRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct CreateAdminApiKeyRequest {
    /// The name of the API key being created.
    pub name: String,
}

/// Represents the response object for deleting an admin API key.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub struct AdminApiKeyDeleteResponse {
    /// The object type, which is always `organization.admin_api_key.deleted`.
    pub object: String,
    /// The ID of the deleted API key.
    pub id: String,
    /// Indicates if the API key was successfully deleted.
    pub deleted: bool,
}