canvas-lms-api 0.6.0

Rust client for the Instructure Canvas LMS REST API
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

use crate::error::Result;
use crate::http::Requester;
use crate::pagination::PageStream;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct EPortfolioPage {
    pub id: u64,
    pub eportfolio_id: Option<u64>,
    pub position: Option<u64>,
    pub name: Option<String>,
    pub content: Option<String>,
    pub created_at: Option<String>,
    pub updated_at: Option<String>,
}

#[derive(Debug, Clone, Deserialize, Serialize, canvas_lms_api_derive::CanvasResource)]
pub struct EPortfolio {
    pub id: u64,
    pub user_id: Option<u64>,
    pub name: Option<String>,
    pub public: Option<bool>,
    pub created_at: Option<String>,
    pub updated_at: Option<String>,
    pub deleted_at: Option<String>,
    pub spam_status: Option<String>,
    #[serde(skip)]
    pub(crate) requester: Option<Arc<Requester>>,
}

impl EPortfolio {
    fn endpoint(&self) -> String {
        format!("eportfolios/{}", self.id)
    }

    /// Delete this ePortfolio.
    ///
    /// `DELETE /api/v1/eportfolios/:id`
    pub async fn delete(&self) -> Result<EPortfolio> {
        let mut p: EPortfolio = self.req().delete(&self.endpoint(), &[]).await?;
        p.requester = self.requester.clone();
        Ok(p)
    }

    /// List pages in this ePortfolio.
    ///
    /// `GET /api/v1/eportfolios/:eportfolio_id/pages`
    pub fn get_pages(&self) -> PageStream<EPortfolioPage> {
        let endpoint = format!("{}/pages", self.endpoint());
        PageStream::new(self.req().clone(), &endpoint, vec![])
    }

    /// Update the spam_status of this ePortfolio (admin only).
    ///
    /// `PUT /api/v1/eportfolios/:eportfolio_id/moderate`
    pub async fn moderate(&self, spam_status: &str) -> Result<EPortfolio> {
        let params = vec![("spam_status".into(), spam_status.to_string())];
        let endpoint = format!("{}/moderate", self.endpoint());
        let mut p: EPortfolio = self.req().put(&endpoint, &params).await?;
        p.requester = self.requester.clone();
        Ok(p)
    }

    /// Restore a deleted ePortfolio (admin only).
    ///
    /// `PUT /api/v1/eportfolios/:eportfolio_id/restore`
    pub async fn restore(&self) -> Result<EPortfolio> {
        let endpoint = format!("{}/restore", self.endpoint());
        let mut p: EPortfolio = self.req().put(&endpoint, &[]).await?;
        p.requester = self.requester.clone();
        Ok(p)
    }
}