uptrakit-web-api-types 0.0.1

Shared HTTP request/response types for the Uptrakit web API
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

use serde::{Deserialize, Serialize};
use uptrakit_shared_types::{DeviceAuthStatus, SecretString};

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeviceAuthStartRequest {
    pub client_name: Option<String>,
}

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeviceAuthStartResponse {
    pub device_code: String,
    pub user_code: String,
    pub verification_url: String,
    pub expires_in: u64,
    pub interval: u64,
}

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeviceAuthPollRequest {
    pub device_code: String,
}

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeviceAuthPollResponse {
    pub status: DeviceAuthStatus,
    pub token: Option<SecretString>,
    pub token_name: Option<String>,
}

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeviceAuthApproveRequest {
    pub user_code: String,
}

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct DeviceAuthApproveResponse {
    pub message: String,
}

// ---------------------------------------------------------------------------
// SSE event payloads for the device auth stream
// ---------------------------------------------------------------------------

/// SSE `authorized` event payload: the device flow was approved and a token
/// is available.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct DeviceAuthAuthorizedSse {
    /// The API token for the authorized device.
    pub token: SecretString,
    /// Human-readable name of the token (matches the client name or default).
    pub token_name: String,
}

/// SSE `expired` event payload: the device flow expired before approval.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct DeviceAuthExpiredSse {
    /// Human-readable explanation of the expiry.
    pub message: String,
}