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

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

/// Check only for updates in these areas
pub type r#ParamsFilter = Vec<String>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// Course id to check
    #[serde(rename = "courseid")]
    pub r#courseid: Option<i64>,
    /// Check updates since this time stamp
    #[serde(rename = "since")]
    pub r#since: Option<i64>,
    /// Check only for updates in these areas
    #[serde(rename = "filter")]
    pub r#filter: Option<r#ParamsFilter>,
}

/// The ids of the items updated
pub type r#ReturnsInstancesItemUpdatesItemItemids = Vec<i64>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsInstancesItemUpdatesItem {
    /// Name of the area updated.
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// Last time was updated
    #[serde(rename = "timeupdated")]
    pub r#timeupdated: Option<i64>,
    /// The ids of the items updated
    #[serde(rename = "itemids")]
    pub r#itemids: Option<r#ReturnsInstancesItemUpdatesItemItemids>,
}

pub type r#ReturnsInstancesItemUpdates = Vec<ReturnsInstancesItemUpdatesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsInstancesItem {
    /// The context level
    #[serde(rename = "contextlevel")]
    pub r#contextlevel: Option<String>,
    /// Instance id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    #[serde(rename = "updates")]
    pub r#updates: Option<r#ReturnsInstancesItemUpdates>,
}

pub type r#ReturnsInstances = Vec<ReturnsInstancesItem>;

/// 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 = "instances")]
    pub r#instances: Option<r#ReturnsInstances>,
    /// 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("core_course_get_updates_since", 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("core_course_get_updates_since", params).await
}