openai_dive 1.4.3

OpenAI Dive is an unofficial async Rust library that allows you to interact with the OpenAI 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
99
100
101
102
103

use crate::v1::endpoints::administration::Administration;
use crate::v1::error::APIError;
use crate::v1::helpers::format_response;
use crate::v1::resources::administration::project::CreateProjectParameters;
use crate::v1::resources::administration::project::ModifyProjectParameters;
use crate::v1::resources::administration::project::Project;
use crate::v1::resources::shared::ListResponse;
use crate::v1::resources::shared::SimpleListParameters;

pub struct Projects<'a> {
    pub administration: &'a Administration<'a>,
}

impl Administration<'_> {
    /// Manage the projects within an organization includes creation, updating, and archiving of projects.
    pub fn projects(&self) -> Projects<'_> {
        Projects {
            administration: self,
        }
    }
}

impl Projects<'_> {
    /// Lists all of the projects in the organization.
    pub async fn list(
        &self,
        query: Option<SimpleListParameters>,
    ) -> Result<ListResponse<Project>, APIError> {
        let response = self
            .administration
            .client
            .get_with_query("/organization/projects", &query)
            .await?;

        let response: ListResponse<Project> = format_response(response)?;

        Ok(response)
    }

    /// Retrieves a project by their identifier.
    pub async fn retrieve(&self, project_id: &str) -> Result<Project, APIError> {
        let response = self
            .administration
            .client
            .get(&format!("/organization/projects/{project_id}"))
            .await?;

        let response: Project = format_response(response)?;

        Ok(response)
    }

    /// Create a new project in the organization.
    pub async fn create(&self, parameters: CreateProjectParameters) -> Result<Project, APIError> {
        let response = self
            .administration
            .client
            .post("/organization/projects", &parameters, None)
            .await?;

        let response: Project = format_response(response.data)?;

        Ok(response)
    }

    /// Modifies a project in the organization.
    pub async fn modify(
        &self,
        project_id: &str,
        parameters: ModifyProjectParameters,
    ) -> Result<Project, APIError> {
        let response = self
            .administration
            .client
            .post(
                &format!("/organization/projects/{project_id}"),
                &parameters,
                None,
            )
            .await?;

        let response: Project = format_response(response.data)?;

        Ok(response)
    }

    /// Archives a project in the organization.
    pub async fn archive(&self, project_id: &str) -> Result<Project, APIError> {
        let response = self
            .administration
            .client
            .post(
                &format!("/organization/projects/{project_id}/archive"),
                &(),
                None,
            )
            .await?;

        let response: Project = format_response(response.data)?;

        Ok(response)
    }
}