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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

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

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {}

pub type r#ReturnsNamefields = Vec<String>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsProfilefieldsItem {
    /// Profile field id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// Profile field shortname
    #[serde(rename = "shortname")]
    pub r#shortname: Option<String>,
    /// Profield field name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// Profield field datatype
    #[serde(rename = "datatype")]
    pub r#datatype: Option<String>,
    /// Profield field 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>,
    /// Profield field category id
    #[serde(rename = "categoryid")]
    pub r#categoryid: Option<i64>,
    /// Profield field category name
    #[serde(rename = "categoryname")]
    pub r#categoryname: Option<String>,
    /// Profield field sort order
    #[serde(rename = "sortorder")]
    pub r#sortorder: Option<i64>,
    /// Profield field required
    #[serde(rename = "required")]
    pub r#required: Option<i64>,
    /// Profield field locked
    #[serde(rename = "locked")]
    pub r#locked: Option<i64>,
    /// Profield field visible
    #[serde(rename = "visible")]
    pub r#visible: Option<i64>,
    /// Profield field unique
    #[serde(rename = "forceunique")]
    pub r#forceunique: Option<i64>,
    /// Profield field in signup form
    #[serde(rename = "signup")]
    pub r#signup: Option<i64>,
    /// Profield field default data
    #[serde(rename = "defaultdata")]
    pub r#defaultdata: Option<String>,
    /// defaultdata format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN
    #[serde(rename = "defaultdataformat")]
    pub r#defaultdataformat: Option<i64>,
    /// Profield field settings
    #[serde(rename = "param1")]
    pub r#param1: Option<String>,
    /// Profield field settings
    #[serde(rename = "param2")]
    pub r#param2: Option<String>,
    /// Profield field settings
    #[serde(rename = "param3")]
    pub r#param3: Option<String>,
    /// Profield field settings
    #[serde(rename = "param4")]
    pub r#param4: Option<String>,
    /// Profield field settings
    #[serde(rename = "param5")]
    pub r#param5: Option<String>,
}

/// Required profile fields
pub type r#ReturnsProfilefields = Vec<ReturnsProfilefieldsItem>;

/// 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 = "namefields")]
    pub r#namefields: Option<r#ReturnsNamefields>,
    /// Password policy
    #[serde(rename = "passwordpolicy")]
    pub r#passwordpolicy: Option<String>,
    /// Site policy
    #[serde(rename = "sitepolicy")]
    pub r#sitepolicy: Option<String>,
    /// Site policy handler
    #[serde(rename = "sitepolicyhandler")]
    pub r#sitepolicyhandler: Option<String>,
    /// Default city
    #[serde(rename = "defaultcity")]
    pub r#defaultcity: Option<String>,
    /// Default country
    #[serde(rename = "country")]
    pub r#country: Option<String>,
    /// Required profile fields
    #[serde(rename = "profilefields")]
    pub r#profilefields: Option<r#ReturnsProfilefields>,
    /// Recaptcha public key
    #[serde(rename = "recaptchapublickey")]
    pub r#recaptchapublickey: Option<String>,
    /// Recaptcha challenge hash
    #[serde(rename = "recaptchachallengehash")]
    pub r#recaptchachallengehash: Option<String>,
    /// Recaptcha challenge noscript image
    #[serde(rename = "recaptchachallengeimage")]
    pub r#recaptchachallengeimage: Option<String>,
    /// Recaptcha challenge js url
    #[serde(rename = "recaptchachallengejs")]
    pub r#recaptchachallengejs: Option<String>,
    /// 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("auth_email_get_signup_settings", 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("auth_email_get_signup_settings", params).await
}