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
//! `PUT /_matrix/client/*/pushrules/{scope}/{kind}/{ruleId}/enabled`
//!
//! This endpoint allows clients to enable or disable the specified push rule.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.4/client-server-api/#put_matrixclientv3pushrulesscopekindruleidenabled
use ruma_common::{
api::{request, response, Metadata},
metadata,
};
use crate::push::{RuleKind, RuleScope};
const METADATA: Metadata = metadata! {
method: PUT,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/pushrules/:scope/:kind/:rule_id/enabled",
1.1 => "/_matrix/client/v3/pushrules/:scope/:kind/:rule_id/enabled",
}
};
/// Request type for the `set_pushrule_enabled` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The scope to fetch a rule from.
#[ruma_api(path)]
pub scope: RuleScope,
/// The kind of rule
#[ruma_api(path)]
pub kind: RuleKind,
/// The identifier for the rule.
#[ruma_api(path)]
pub rule_id: String,
/// Whether the push rule is enabled or not.
pub enabled: bool,
}
/// Response type for the `set_pushrule_enabled` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given scope, rule kind, rule ID and enabled flag.
pub fn new(scope: RuleScope, kind: RuleKind, rule_id: String, enabled: bool) -> Self {
Self { scope, kind, rule_id, enabled }
}
/// Creates a new `Request` to enable the given rule.
pub fn enable(scope: RuleScope, kind: RuleKind, rule_id: String) -> Self {
Self::new(scope, kind, rule_id, true)
}
/// Creates a new `Request` to disable the given rule.
pub fn disable(scope: RuleScope, kind: RuleKind, rule_id: String) -> Self {
Self::new(scope, kind, rule_id, false)
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
}