librus-rs 2.0.1

Rust client for Librus Synergia - the Polish school diary system
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

//! Current user data types.

use serde::Deserialize;

/// User account information.
#[derive(Debug, Deserialize)]
pub struct Account {
    /// Account ID.
    #[serde(rename = "Id")]
    pub id: u32,
    /// Associated user ID.
    #[serde(rename = "UserId")]
    pub user_id: u32,
    /// First name.
    #[serde(rename = "FirstName")]
    pub first_name: String,
    /// Last name.
    #[serde(rename = "LastName")]
    pub last_name: String,
    /// Email address.
    #[serde(rename = "Email")]
    pub email: String,
    /// User group ID.
    #[serde(rename = "GroupId")]
    pub group_id: u32,
    /// Whether the account is active.
    #[serde(rename = "IsActive")]
    pub is_active: bool,
    /// Login username.
    #[serde(rename = "Login")]
    pub login: String,
    /// Whether this is a premium account.
    #[serde(rename = "IsPremium")]
    pub is_premium: bool,
    /// Whether this is a premium demo account.
    #[serde(rename = "IsPremiumDemo")]
    pub is_premium_demo: bool,
    /// Premium expiration date timestamp.
    #[serde(rename = "ExpiredPremiumDate")]
    pub expired_premium_date: Option<u64>,
    /// List of premium add-ons.
    #[serde(rename = "PremiumAddons")]
    pub premium_addons: Vec<String>,
}

/// Basic user profile.
#[derive(Debug, Deserialize)]
pub struct User {
    /// First name.
    #[serde(rename = "FirstName")]
    pub first_name: String,
    /// Last name.
    #[serde(rename = "LastName")]
    pub last_name: String,
}

/// Class reference.
#[derive(Debug, Deserialize)]
pub struct Class {
    /// Class ID.
    #[serde(rename = "Id")]
    pub id: u32,
    /// API URL for the class.
    #[serde(rename = "Url")]
    pub url: String,
}

#[derive(Debug, Deserialize)]
pub struct Resource {
    #[serde(rename = "Url")]
    pub url: String,
}

#[derive(Debug, Deserialize)]
pub struct Resources {
    #[serde(rename = "..")]
    pub url: Resource,
}

/// Current user information combining account, profile, and class.
#[derive(Debug, Deserialize)]
pub struct Me {
    /// Account details.
    #[serde(rename = "Account")]
    pub account: Account,
    /// Session refresh interval.
    #[serde(rename = "Refresh")]
    pub refresh: u32,
    /// User profile.
    #[serde(rename = "User")]
    pub user: User,
    /// Class the user belongs to.
    #[serde(rename = "Class")]
    pub class: Class,
}

/// Response containing current user information.
#[derive(Debug, Deserialize)]
pub struct ResponseMe {
    /// Current user data.
    #[serde(rename = "Me")]
    pub me: Me,
    /// Related API resources.
    #[serde(rename = "Resources")]
    pub resources: Resources,
    /// API URL for this response.
    #[serde(rename = "Url")]
    pub url: String,
}