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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
//! Manage the keys for a Deepgram Project.
//!
//! See the [Deepgram API Reference][api] for more info.
//!
//! [api]: https://developers.deepgram.com/api-reference/#keys
use crate::{
manage::keys::{
options::{Options, SerializableOptions},
response::{MemberAndApiKey, MembersAndApiKeys, NewApiKey},
},
send_and_translate_response, Deepgram,
};
use response::Message;
pub mod options;
pub mod response;
/// Manage the keys for a Deepgram Project.
///
/// Constructed using [`Deepgram::keys`].
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#keys
#[derive(Debug, Clone)]
pub struct Keys<'a>(&'a Deepgram);
impl Deepgram {
/// Construct a new [`Keys`] from a [`Deepgram`].
pub fn keys(&self) -> Keys<'_> {
self.into()
}
}
impl<'a> From<&'a Deepgram> for Keys<'a> {
/// Construct a new [`Keys`] from a [`Deepgram`].
fn from(deepgram: &'a Deepgram) -> Self {
Self(deepgram)
}
}
impl Keys<'_> {
/// Get keys for the specified project.
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#keys-get-keys
///
/// # Examples
///
/// ```no_run
/// # use std::env;
/// #
/// # use deepgram::{manage::keys::options::Options, 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 keys = dg_client
/// .keys()
/// .list(&project_id)
/// .await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn list(&self, project_id: &str) -> crate::Result<MembersAndApiKeys> {
let url = format!("https://api.deepgram.com/v1/projects/{project_id}/keys");
send_and_translate_response(self.0.client.get(url)).await
}
/// Get details of the specified key.
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#keys-get-key
///
/// # Examples
///
/// ```no_run
/// # use std::env;
/// #
/// # use deepgram::{manage::keys::options::Options, 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 key_id = env::var("DEEPGRAM_KEY_ID").expect("DEEPGRAM_KEY_ID environmental variable");
/// #
/// let dg_client = Deepgram::new(&deepgram_api_key)?;
///
/// let key = dg_client
/// .keys()
/// .get(&project_id, &key_id)
/// .await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn get(&self, project_id: &str, key_id: &str) -> crate::Result<MemberAndApiKey> {
let url = format!("https://api.deepgram.com/v1/projects/{project_id}/keys/{key_id}",);
send_and_translate_response(self.0.client.get(url)).await
}
/// Create a new key in the specified project.
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#keys-create
///
/// # Examples
///
/// ```no_run
/// # use std::env;
/// #
/// # use deepgram::{manage::keys::options::Options, 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 key_id = env::var("DEEPGRAM_KEY_ID").expect("DEEPGRAM_KEY_ID environmental variable");
/// #
/// let dg_client = Deepgram::new(&deepgram_api_key)?;
///
/// let options = Options::builder("New Key", ["member"]).build();
/// let new_key = dg_client
/// .keys()
/// .create(&project_id, &options)
/// .await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn create(&self, project_id: &str, options: &Options) -> crate::Result<NewApiKey> {
let url = format!("https://api.deepgram.com/v1/projects/{project_id}/keys");
let request = self
.0
.client
.post(url)
.json(&SerializableOptions::from(options));
send_and_translate_response(request).await
}
/// Delete the specified key in the specified project.
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#keys-delete
///
/// # Examples
///
/// ```no_run
/// # use std::env;
/// #
/// # use deepgram::{manage::keys::options::Options, 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 key_id = env::var("DEEPGRAM_KEY_ID").expect("DEEPGRAM_KEY_ID environmental variable");
/// #
/// let dg_client = Deepgram::new(&deepgram_api_key)?;
///
/// dg_client
/// .keys()
/// .delete(&project_id, &key_id)
/// .await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn delete(&self, project_id: &str, key_id: &str) -> crate::Result<Message> {
let url = format!("https://api.deepgram.com/v1/projects/{project_id}/keys/{key_id}",);
send_and_translate_response(self.0.client.delete(url)).await
}
}