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

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

#[derive(Serialize, Deserialize, Debug)]
pub struct ParamsCustomprofilefieldsItem {
    /// The type of the custom field
    #[serde(rename = "type")]
    pub r#type: Option<String>,
    /// The name of the custom field
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// Custom field value, can be an encoded json if required
    #[serde(rename = "value")]
    pub r#value: Option<String>,
}

/// User custom fields (also known as user profile fields)
pub type r#ParamsCustomprofilefields = Vec<ParamsCustomprofilefieldsItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// Username
    #[serde(rename = "username")]
    pub r#username: Option<String>,
    /// Plain text password
    #[serde(rename = "password")]
    pub r#password: Option<String>,
    /// The first name(s) of the user
    #[serde(rename = "firstname")]
    pub r#firstname: Option<String>,
    /// The family name of the user
    #[serde(rename = "lastname")]
    pub r#lastname: Option<String>,
    /// A valid and unique email address
    #[serde(rename = "email")]
    pub r#email: Option<String>,
    /// Home city of the user
    #[serde(rename = "city")]
    pub r#city: Option<String>,
    /// Home country code
    #[serde(rename = "country")]
    pub r#country: Option<String>,
    /// Recaptcha challenge hash
    #[serde(rename = "recaptchachallengehash")]
    pub r#recaptchachallengehash: Option<String>,
    /// Recaptcha response
    #[serde(rename = "recaptcharesponse")]
    pub r#recaptcharesponse: Option<String>,
    /// User custom fields (also known as user profile fields)
    #[serde(rename = "customprofilefields")]
    pub r#customprofilefields: Option<r#ParamsCustomprofilefields>,
    /// Redirect the user to this site url after confirmation.
    #[serde(rename = "redirect")]
    pub r#redirect: 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 {
    /// True if the user was created false otherwise
    #[serde(rename = "success")]
    pub r#success: 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("auth_email_signup_user", 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_signup_user", params).await
}