moodle_api 0.1.0

Moodle Webservice Client in Rust.
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use serde::{self, Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// The data to create the purpose, encoded as a json array
    #[serde(rename = "jsonformdata")]
    pub r#jsonformdata: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsPurposeFormattedlawfulbasesItem {
    /// name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// description
    #[serde(rename = "description")]
    pub r#description: Option<String>,
}

/// formattedlawfulbases
pub type r#ReturnsPurposeFormattedlawfulbases = Vec<ReturnsPurposeFormattedlawfulbasesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsPurposeFormattedsensitivedatareasonsItem {
    /// name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// description
    #[serde(rename = "description")]
    pub r#description: Option<String>,
}

/// formattedsensitivedatareasons
pub type r#ReturnsPurposeFormattedsensitivedatareasons =
    Vec<ReturnsPurposeFormattedsensitivedatareasonsItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsPurpose {
    /// The purpose name.
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// The purpose description.
    #[serde(rename = "description")]
    pub r#description: Option<String>,
    /// description format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN
    #[serde(rename = "descriptionformat")]
    pub r#descriptionformat: Option<i64>,
    /// Comma-separated IDs matching records in tool_dataprivacy_lawfulbasis.
    #[serde(rename = "lawfulbases")]
    pub r#lawfulbases: Option<String>,
    /// Comma-separated IDs matching records in tool_dataprivacy_sensitive
    #[serde(rename = "sensitivedatareasons")]
    pub r#sensitivedatareasons: Option<String>,
    /// Retention period. ISO_8601 durations format (as in DateInterval format).
    #[serde(rename = "retentionperiod")]
    pub r#retentionperiod: Option<String>,
    /// Data retention with higher precedent over user's request to be forgotten.
    #[serde(rename = "protected")]
    pub r#protected: Option<i64>,
    /// id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// timecreated
    #[serde(rename = "timecreated")]
    pub r#timecreated: Option<i64>,
    /// timemodified
    #[serde(rename = "timemodified")]
    pub r#timemodified: Option<i64>,
    /// usermodified
    #[serde(rename = "usermodified")]
    pub r#usermodified: Option<i64>,
    /// formattedretentionperiod
    #[serde(rename = "formattedretentionperiod")]
    pub r#formattedretentionperiod: Option<String>,
    /// formattedlawfulbases
    #[serde(rename = "formattedlawfulbases")]
    pub r#formattedlawfulbases: Option<r#ReturnsPurposeFormattedlawfulbases>,
    /// formattedsensitivedatareasons
    #[serde(rename = "formattedsensitivedatareasons")]
    pub r#formattedsensitivedatareasons: Option<r#ReturnsPurposeFormattedsensitivedatareasons>,
    /// roleoverrides
    #[serde(rename = "roleoverrides")]
    pub r#roleoverrides: Option<String>,
}

/// warning
#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsWarningsItem {
    /// item
    #[serde(rename = "item")]
    pub r#item: Option<String>,
    /// item id
    #[serde(rename = "itemid")]
    pub r#itemid: Option<i64>,
    /// the warning code can be used by the client app to implement specific behaviour
    #[serde(rename = "warningcode")]
    pub r#warningcode: Option<String>,
    /// untranslated english message to explain the warning
    #[serde(rename = "message")]
    pub r#message: Option<String>,
}

/// list of warnings
pub type r#ReturnsWarnings = Vec<ReturnsWarningsItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Returns {
    #[serde(rename = "purpose")]
    pub r#purpose: Option<ReturnsPurpose>,
    /// Were there validation errors
    #[serde(rename = "validationerrors")]
    pub r#validationerrors: Option<bool>,
    /// list of warnings
    #[serde(rename = "warnings")]
    pub r#warnings: Option<r#ReturnsWarnings>,
}

pub async fn call<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<Returns> {
    let json = client
        .post("tool_dataprivacy_create_purpose_form", params)
        .await?;

    serde_json::from_value(json).map_err(|e| e.into())
}

pub async fn call_raw<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<serde_json::Value> {
    client
        .post("tool_dataprivacy_create_purpose_form", params)
        .await
}