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
//! `GET /_matrix/client/*/pushrules/global/{kind}/{ruleId}`
//!
//! Retrieve a single specified push rule.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3pushrulesglobalkindruleid
use ruma_common::{
api::{auth_scheme::AccessToken, request, response},
metadata,
};
use crate::push::{PushRule, RuleKind};
metadata! {
method: GET,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/pushrules/global/{kind}/{rule_id}",
1.1 => "/_matrix/client/v3/pushrules/global/{kind}/{rule_id}",
}
}
/// Request type for the `get_pushrule` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The kind of rule.
#[ruma_api(path)]
pub kind: RuleKind,
/// The identifier for the rule.
#[ruma_api(path)]
pub rule_id: String,
}
/// Response type for the `get_pushrule` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// The specific push rule.
#[ruma_api(body)]
pub rule: PushRule,
}
impl Request {
/// Creates a new `Request` with the given rule kind and rule ID.
pub fn new(kind: RuleKind, rule_id: String) -> Self {
Self { kind, rule_id }
}
}
impl Response {
/// Creates a new `Response` with the given rule.
pub fn new(rule: PushRule) -> Self {
Self { rule }
}
}
}