canvas-lms-api 0.4.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
75
76
77

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

#[derive(Debug, Clone, Deserialize, Serialize, canvas_lms_api_derive::CanvasResource)]
pub struct AppointmentGroup {
    pub id: u64,
    pub title: Option<String>,
    pub context_codes: Option<Vec<String>>,
    pub sub_context_codes: Option<Vec<String>>,
    pub workflow_state: Option<String>,
    pub location_name: Option<String>,
    pub location_address: Option<String>,
    pub description: Option<String>,
    pub participant_type: Option<String>,
    pub participant_visibility: Option<String>,
    pub participant_limit: Option<u64>,
    pub appointments_count: Option<u64>,
    pub new_appointments: Option<Vec<serde_json::Value>>,
    pub max_appointments_per_participant: Option<u64>,
    pub min_appointments_per_participant: Option<u64>,
    pub appointments: Option<Vec<serde_json::Value>>,
    pub created_at: Option<String>,
    pub updated_at: Option<String>,
    #[serde(skip)]
    pub(crate) requester: Option<Arc<Requester>>,
}

#[derive(Debug, Clone, Default, Serialize)]
pub struct AppointmentGroupParams {
    pub context_codes: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_address: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub publish: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub participant_type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_appointments_per_participant: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_appointments_per_participant: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub participant_visibility: Option<String>,
}

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

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

    /// Update this appointment group.
    ///
    /// `PUT /api/v1/appointment_groups/:id`
    pub async fn edit(&self, params: AppointmentGroupParams) -> Result<AppointmentGroup> {
        let body = serde_json::to_value(&params).unwrap_or_default();
        let flat = crate::params::wrap_params("appointment_group", &body);
        let mut a: AppointmentGroup = self.req().put(&self.endpoint(), &flat).await?;
        a.requester = self.requester.clone();
        Ok(a)
    }
}