tone3000 0.1.0

Async Rust client for the TONE3000 API (v1)
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

//! OAuth token set returned by the token endpoint.

use serde::{Deserialize, Serialize};

/// Tokens returned by `POST /oauth/token` (exchange or refresh).
#[derive(Debug, Clone, Deserialize, Serialize)]
#[non_exhaustive]
pub struct Tokens {
    /// The Bearer credential for API calls. Short-lived.
    pub access_token: String,
    /// Used to mint a new access token once this one expires.
    ///
    /// TONE3000 **rotates** these: each refresh returns a new one and invalidates the
    /// old, so persist every value you receive or the session dies. Register
    /// [`ClientBuilder::on_tokens_changed`] to catch them.
    ///
    /// [`ClientBuilder::on_tokens_changed`]: crate::ClientBuilder::on_tokens_changed
    #[serde(default)]
    pub refresh_token: Option<String>,
    /// Lifetime of the access token in seconds from issue.
    ///
    /// [`ClientBuilder::expires_at`] wants an absolute unix timestamp, not this duration:
    /// add it to the current unix time and pass the sum. Without it, proactive refresh
    /// cannot know when to fire and the client only refreshes reactively on a 401.
    ///
    /// [`ClientBuilder::expires_at`]: crate::ClientBuilder::expires_at
    #[serde(default)]
    pub expires_in: Option<u64>,
}