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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
use crate::{error::Result, http::Requester};
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::sync::Arc;
/// A Canvas communication channel (email, SMS, push notification, etc.).
#[derive(Debug, Clone, Deserialize, Serialize, canvas_lms_api_derive::CanvasResource)]
pub struct CommunicationChannel {
pub id: u64,
pub address: Option<String>,
#[serde(rename = "type")]
pub channel_type: Option<String>,
pub position: Option<u64>,
pub user_id: Option<u64>,
pub workflow_state: Option<String>,
pub created_at: Option<DateTime<Utc>>,
#[serde(skip)]
pub(crate) requester: Option<Arc<Requester>>,
}
impl CommunicationChannel {
fn user_id(&self) -> u64 {
self.user_id.expect("CommunicationChannel missing user_id")
}
/// Delete this communication channel.
///
/// Returns `true` if successfully deleted.
///
/// # Canvas API
/// `DELETE /api/v1/users/:user_id/communication_channels/:id`
pub async fn delete(&self) -> Result<bool> {
let result: Value = self
.req()
.delete(
&format!(
"users/{}/communication_channels/{}",
self.user_id(),
self.id
),
&[],
)
.await?;
Ok(result.get("workflow_state").and_then(|v| v.as_str()) == Some("deleted"))
}
/// Fetch the notification preference for a specific notification type.
///
/// # Canvas API
/// `GET /api/v1/users/:user_id/communication_channels/:id/notification_preferences/:notification`
pub async fn get_preference(&self, notification: &str) -> Result<Value> {
let data: Value = self
.req()
.get(
&format!(
"users/{}/communication_channels/{}/notification_preferences/{}",
self.user_id(),
self.id,
notification
),
&[],
)
.await?;
Ok(data
.get("notification_preferences")
.and_then(|a| a.get(0))
.cloned()
.unwrap_or(Value::Null))
}
/// Fetch all notification preference categories for this channel.
///
/// # Canvas API
/// `GET /api/v1/users/:user_id/communication_channels/:id/notification_preference_categories`
pub async fn get_preference_categories(&self) -> Result<Vec<String>> {
let data: Value = self
.req()
.get(
&format!(
"users/{}/communication_channels/{}/notification_preference_categories",
self.user_id(),
self.id
),
&[],
)
.await?;
let cats = data
.get("categories")
.and_then(|v| v.as_array())
.map(|arr| {
arr.iter()
.filter_map(|v| v.as_str().map(|s| s.to_string()))
.collect()
})
.unwrap_or_default();
Ok(cats)
}
/// Fetch all notification preferences for this channel.
///
/// # Canvas API
/// `GET /api/v1/users/:user_id/communication_channels/:id/notification_preferences`
pub async fn get_preferences(&self) -> Result<Vec<Value>> {
let data: Value = self
.req()
.get(
&format!(
"users/{}/communication_channels/{}/notification_preferences",
self.user_id(),
self.id
),
&[],
)
.await?;
Ok(data
.get("notification_preferences")
.and_then(|v| v.as_array())
.cloned()
.unwrap_or_default())
}
/// Update the preference for a specific notification on this channel.
///
/// `frequency` can be `"immediately"`, `"daily"`, `"weekly"`, or `"never"`.
///
/// # Canvas API
/// `PUT /api/v1/users/self/communication_channels/:id/notification_preferences/:notification`
pub async fn update_preference(&self, notification: &str, frequency: &str) -> Result<Value> {
let params = vec![(
"notification_preferences[frequency]".to_string(),
frequency.to_string(),
)];
let data: Value = self
.req()
.put(
&format!(
"users/self/communication_channels/{}/notification_preferences/{}",
self.id, notification
),
¶ms,
)
.await?;
Ok(data
.get("notification_preferences")
.and_then(|a| a.get(0))
.cloned()
.unwrap_or(Value::Null))
}
/// Update preferences for all notifications in a category on this channel.
///
/// `frequency` can be `"immediately"`, `"daily"`, `"weekly"`, or `"never"`.
///
/// # Canvas API
/// `PUT /api/v1/users/self/communication_channels/:id/notification_preference_categories/:category`
pub async fn update_preferences_by_category(
&self,
category: &str,
frequency: &str,
) -> Result<Vec<Value>> {
let params = vec![(
"notification_preferences[frequency]".to_string(),
frequency.to_string(),
)];
let data: Value = self
.req()
.put(
&format!(
"users/self/communication_channels/{}/notification_preference_categories/{}",
self.id, category
),
¶ms,
)
.await?;
Ok(data
.get("notification_preferences")
.and_then(|v| v.as_array())
.cloned()
.unwrap_or_default())
}
}