logo
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

//! `PUT /_matrix/client/*/pushrules/{scope}/{kind}/{ruleId}/enabled`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3pushrulesscopekindruleidenabled

    use ruma_common::api::ruma_api;

    use crate::push::RuleKind;

    ruma_api! {
        metadata: {
            description: "This endpoint allows clients to enable or disable the specified push rule.",
            method: PUT,
            name: "set_pushrule_enabled",
            r0_path: "/_matrix/client/r0/pushrules/:scope/:kind/:rule_id/enabled",
            stable_path: "/_matrix/client/v3/pushrules/:scope/:kind/:rule_id/enabled",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The scope to fetch a rule from. 'global' to specify global rules.
            #[ruma_api(path)]
            pub scope: &'a str,

            /// The kind of rule
            #[ruma_api(path)]
            pub kind: RuleKind,

            /// The identifier for the rule.
            #[ruma_api(path)]
            pub rule_id: &'a str,

            /// Whether the push rule is enabled or not.
            pub enabled: bool,
        }

        #[derive(Default)]
        response: {}

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given scope, rule kind, rule ID and enabled flag.
        pub fn new(scope: &'a str, kind: RuleKind, rule_id: &'a str, enabled: bool) -> Self {
            Self { scope, kind, rule_id, enabled }
        }

        /// Creates a new `Request` to enable the given rule.
        pub fn enable(scope: &'a str, kind: RuleKind, rule_id: &'a str) -> Self {
            Self::new(scope, kind, rule_id, true)
        }

        /// Creates a new `Request` to disable the given rule.
        pub fn disable(scope: &'a str, kind: RuleKind, rule_id: &'a str) -> Self {
            Self::new(scope, kind, rule_id, false)
        }
    }

    impl Response {
        /// Creates an empty `Response`.
        pub fn new() -> Self {
            Self {}
        }
    }
}