revolt-models 0.14.0

Revolt Backend: API Models
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

auto_derived!(
    pub struct MFATicket {
        /// Unique Id
        #[serde(rename = "_id")]
        pub id: String,

        /// Account Id
        pub account_id: String,

        /// Unique Token
        pub token: String,

        /// Whether this ticket has been validated
        /// (can be used for account actions)
        pub validated: bool,

        /// Whether this ticket is authorised
        /// (can be used to log a user in)
        pub authorised: bool,

        /// TOTP code at time of ticket creation
        pub last_totp_code: Option<String>,
    }

    #[serde(untagged)]
    pub enum ResponseVerify {
        NoTicket,
        WithTicket {
            /// Authorised MFA ticket, can be used to log in
            ticket: MFATicket,
        },
    }

    /// MFA response
    #[serde(untagged)]
    pub enum MFAResponse {
        Password { password: String },
        Recovery { recovery_code: String },
        Totp { totp_code: String },
    }

    #[derive(Default)]
    pub struct MultiFactorStatus {
        #[serde(skip_serializing_if = "crate::if_false", default)]
        pub email_otp: bool,
        #[serde(skip_serializing_if = "crate::if_false", default)]
        pub trusted_handover: bool,
        #[serde(skip_serializing_if = "crate::if_false", default)]
        pub email_mfa: bool,
        #[serde(skip_serializing_if = "crate::if_false", default)]
        pub totp_mfa: bool,
        #[serde(skip_serializing_if = "crate::if_false", default)]
        pub security_key_mfa: bool,
        #[serde(skip_serializing_if = "crate::if_false", default)]
        pub recovery_active: bool,
    }

    pub enum MFAMethod {
        Password,
        Recovery,
        Totp,
    }

    /// # Totp Secret
    pub struct ResponseTotpSecret {
        pub secret: String,
    }
);