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
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use crate::v1::endpoints::administration::Administration;
use crate::v1::error::APIError;
use crate::v1::helpers::format_response;
use crate::v1::resources::administration::project_user::CreateProjectUserParameters;
use crate::v1::resources::administration::project_user::ModifyProjectUserParameters;
use crate::v1::resources::administration::project_user::ProjectUser;
use crate::v1::resources::shared::DeletedObject;
use crate::v1::resources::shared::ListResponse;
use crate::v1::resources::shared::SimpleListParameters;

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

impl Administration<'_> {
    /// Manage users within a project, including adding, updating roles, and removing users.
    pub fn project_users(&self) -> ProjectUsers<'_> {
        ProjectUsers {
            administration: self,
        }
    }
}

impl ProjectUsers<'_> {
    /// Returns a list of users in the project.
    pub async fn list(
        &self,
        project_id: &str,
        query: Option<SimpleListParameters>,
    ) -> Result<ListResponse<ProjectUser>, APIError> {
        let response = self
            .administration
            .client
            .get_with_query(
                &format!("/organization/projects/{project_id}/users"),
                &query,
            )
            .await?;

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

        Ok(response)
    }

    /// Retrieves a user in the project.
    pub async fn retrieve(&self, project_id: &str, user_id: &str) -> Result<ProjectUser, APIError> {
        let response = self
            .administration
            .client
            .get(&format!(
                "/organization/projects/{project_id}/users/{user_id}"
            ))
            .await?;

        let response: ProjectUser = format_response(response)?;

        Ok(response)
    }

    /// Adds a user to the project.
    pub async fn create(
        &self,
        project_id: &str,
        parameters: CreateProjectUserParameters,
    ) -> Result<ProjectUser, APIError> {
        let response = self
            .administration
            .client
            .post(
                &format!("/organization/projects/{project_id}/users"),
                &parameters,
                None,
            )
            .await?;

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

        Ok(response)
    }

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

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

        Ok(response)
    }

    /// Deletes a user from the project.
    pub async fn delete(&self, project_id: &str, user_id: &str) -> Result<DeletedObject, APIError> {
        let response = self
            .administration
            .client
            .delete(&format!(
                "/organization/projects/{project_id}/users/{user_id}"
            ))
            .await?;

        let response: DeletedObject = format_response(response)?;

        Ok(response)
    }
}