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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
//! Manage the members of a Deepgram Project.
//!
//! See the [Deepgram API Reference][api] for more info.
//!
//! [api]: https://developers.deepgram.com/api-reference/#members
use url::Url;
use crate::{send_and_translate_response, Deepgram};
use response::Message;
pub mod response;
/// Manage the members of a Deepgram Project.
///
/// Constructed using [`Deepgram::members`].
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#members
#[derive(Debug, Clone)]
pub struct Members<'a>(&'a Deepgram);
impl Deepgram {
/// Construct a new [`Members`] from a [`Deepgram`].
pub fn members(&self) -> Members<'_> {
self.into()
}
}
impl<'a> From<&'a Deepgram> for Members<'a> {
/// Construct a new [`Members`] from a [`Deepgram`].
fn from(deepgram: &'a Deepgram) -> Self {
Self(deepgram)
}
}
impl Members<'_> {
/// Get all members of the specified project.
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#members-get-members
///
/// # Examples
///
/// ```no_run
/// # use std::env;
/// #
/// # use deepgram::{Deepgram, DeepgramError};
/// #
/// # #[tokio::main]
/// # async fn main() -> Result<(), DeepgramError> {
/// # let deepgram_api_key =
/// # env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
/// #
/// # let project_id =
/// # env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
/// #
/// let dg_client = Deepgram::new(&deepgram_api_key)?;
///
/// let members = dg_client
/// .members()
/// .list_members(&project_id)
/// .await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn list_members(&self, project_id: &str) -> crate::Result<response::Members> {
let url = self.members_url(project_id)?;
send_and_translate_response(self.0.client.get(url)).await
}
/// Remove the specified member from the specified project.
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#members-delete
///
/// # Examples
///
/// ```no_run
/// # use std::env;
/// #
/// # use deepgram::{Deepgram, DeepgramError};
/// #
/// # #[tokio::main]
/// # async fn main() -> Result<(), DeepgramError> {
/// # let deepgram_api_key =
/// # env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
/// #
/// # let project_id =
/// # env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
/// #
/// # let member_id =
/// # env::var("DEEPGRAM_MEMBER_ID").expect("DEEPGRAM_MEMBER_ID environmental variable");
/// #
/// let dg_client = Deepgram::new(&deepgram_api_key)?;
///
/// dg_client
/// .members()
/// .remove_member(&project_id, &member_id)
/// .await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn remove_member(&self, project_id: &str, member_id: &str) -> crate::Result<Message> {
let url = self.member_url(project_id, member_id)?;
send_and_translate_response(self.0.client.delete(url)).await
}
fn members_url(&self, project_id: &str) -> crate::Result<Url> {
self.0.api_url(&format!("v1/projects/{project_id}/members"))
}
fn member_url(&self, project_id: &str, member_id: &str) -> crate::Result<Url> {
self.0
.api_url(&format!("v1/projects/{project_id}/members/{member_id}"))
}
}
#[cfg(test)]
mod tests {
use crate::Deepgram;
#[test]
fn urls_default_base() {
let dg = Deepgram::new("token").unwrap();
assert_eq!(
dg.members().members_url("proj").unwrap().as_str(),
"https://api.deepgram.com/v1/projects/proj/members"
);
assert_eq!(
dg.members().member_url("proj", "mem").unwrap().as_str(),
"https://api.deepgram.com/v1/projects/proj/members/mem"
);
}
#[test]
fn urls_custom_base() {
let dg = Deepgram::with_base_url("http://deepgram.internal").unwrap();
assert_eq!(
dg.members().members_url("proj").unwrap().as_str(),
"http://deepgram.internal/v1/projects/proj/members"
);
assert_eq!(
dg.members().member_url("proj", "mem").unwrap().as_str(),
"http://deepgram.internal/v1/projects/proj/members/mem"
);
}
}