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

//! Token-based authentication for Deepgram.
//!
//! See the [Deepgram API Reference][api] for more info.
//!
//! [api]: https://developers.deepgram.com/reference/auth/tokens/grant

use crate::{
    auth::{
        options::{Options, SerializableOptions},
        response::GrantResponse,
    },
    send_and_translate_response, Deepgram,
};

pub mod options;
pub mod response;

/// Token-based authentication for Deepgram.
///
/// Constructed using [`Deepgram::auth`].
///
/// See the [Deepgram API Reference][api] for more info.
///
/// [api]: https://developers.deepgram.com/reference/auth/tokens/grant
#[derive(Debug, Clone)]
pub struct Auth<'a>(&'a Deepgram);

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

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

impl Auth<'_> {
    /// Generate a temporary JSON Web Token (JWT) with a configurable TTL.
    ///
    /// The token will have usage::write permission for core voice APIs.
    /// Requires an API key with Member or higher authorization.
    /// Tokens created with this endpoint will not work with the Manage APIs.
    ///
    /// See the [Deepgram API Reference][api] for more info.
    ///
    /// [api]: https://developers.deepgram.com/reference/auth/tokens/grant
    ///
    /// # Examples
    ///
    /// Generate a token with default 30-second TTL:
    ///
    /// ```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 dg_client = Deepgram::new(&deepgram_api_key)?;
    ///
    /// let token = dg_client
    ///     .auth()
    ///     .grant(None)
    ///     .await?;
    ///
    /// println!("Token: {}", token.access_token);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// Generate a token with custom TTL:
    ///
    /// ```no_run
    /// # use std::env;
    /// #
    /// # use deepgram::{auth::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 dg_client = Deepgram::new(&deepgram_api_key)?;
    ///
    /// let options = Options::builder()
    ///     .ttl_seconds(300.0)  // 5 minutes
    ///     .build();
    ///
    /// let token = dg_client
    ///     .auth()
    ///     .grant(Some(&options))
    ///     .await?;
    ///
    /// println!("Token: {}", token.access_token);
    /// println!("Expires in: {} seconds", token.expires_in.unwrap_or(0.0));
    /// # Ok(())
    /// # }
    /// ```
    pub async fn grant(&self, options: Option<&Options>) -> crate::Result<GrantResponse> {
        let url = "https://api.deepgram.com/v1/auth/grant";

        let request = if let Some(opts) = options {
            self.0
                .client
                .post(url)
                .json(&SerializableOptions::from(opts))
        } else {
            // Send empty JSON object when no options provided
            self.0.client.post(url).json(&serde_json::json!({}))
        };

        send_and_translate_response(request).await
    }
}