deepgram 0.9.2

Community Rust SDK for Deepgram's automated speech recognition APIs.
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Manage the permissions of a Deepgram Project.
//!
//! See the [Deepgram API Reference][api] for more info.
//!
//! [api]: https://developers.deepgram.com/api-reference/#scopes

use serde::Serialize;

use crate::{send_and_translate_response, Deepgram};

use response::Message;

pub mod response;

/// Manage the permissions of a Deepgram Project.
///
/// Constructed using [`Deepgram::scopes`].
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/api-reference/#scopes
#[derive(Debug, Clone)]
pub struct Scopes<'a>(&'a Deepgram);

impl Deepgram {
    /// Construct a new [`Scopes`] from a [`Deepgram`].
    pub fn scopes(&self) -> Scopes<'_> {
        self.into()
    }
}

impl<'a> From<&'a Deepgram> for Scopes<'a> {
    /// Construct a new [`Scopes`] from a [`Deepgram`].
    fn from(deepgram: &'a Deepgram) -> Self {
        Self(deepgram)
    }
}

impl Scopes<'_> {
    /// Get the specified project scopes assigned to the specified member.
    ///
    /// See the [Deepgram API Reference][api] for more info.
    ///
    /// [api]: https://developers.deepgram.com/api-reference/#scopes-get
    ///
    /// # 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)?;
    ///
    /// let scopes = dg_client
    ///     .scopes()
    ///     .get_scope(&project_id, &member_id)
    ///     .await?;
    /// #
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get_scope(
        &self,
        project_id: &str,
        member_id: &str,
    ) -> crate::Result<response::Scopes> {
        let url = format!(
            "https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes "
        );

        send_and_translate_response(self.0.client.get(url)).await
    }

    /// Update the specified project scopes assigned to the specified member.
    ///
    /// See the [Deepgram API Reference][api] for more info.
    ///
    /// [api]: https://developers.deepgram.com/api-reference/#scopes-update
    ///
    /// # 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
    ///     .scopes()
    ///     .update_scope(&project_id, &member_id, "member")
    ///     .await?;
    /// #
    /// # Ok(())
    /// # }
    /// ```
    pub async fn update_scope(
        &self,
        project_id: &str,
        member_id: &str,
        scope: &str,
    ) -> crate::Result<Message> {
        #[derive(Serialize)]
        struct Scope<'a> {
            scope: &'a str,
        }

        let url =
            format!("https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes");
        let request = self.0.client.put(url).json(&Scope { scope });

        send_and_translate_response(request).await
    }
}