ruma_client_api/push/
set_pushrule_actions.rs

Help
1//! `PUT /_matrix/client/*/pushrules/global/{kind}/{ruleId}/actions`
2//!
3//! This endpoint allows clients to change the actions of a push rule. This can be used to change
4//! the actions of builtin rules.
5
6pub mod v3 {
7    //! `/v3/` ([spec])
8    //!
9    //! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3pushrulesglobalkindruleidactions
10
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata,
14        push::Action,
15    };
16
17    use crate::push::RuleKind;
18
19    const METADATA: Metadata = metadata! {
20        method: PUT,
21        rate_limited: false,
22        authentication: AccessToken,
23        history: {
24            1.0 => "/_matrix/client/r0/pushrules/global/:kind/:rule_id/actions",
25            1.1 => "/_matrix/client/v3/pushrules/global/:kind/:rule_id/actions",
26        }
27    };
28
29    /// Request type for the `set_pushrule_actions` endpoint.
30    #[request(error = crate::Error)]
31    pub struct Request {
32        /// The kind of rule
33        #[ruma_api(path)]
34        pub kind: RuleKind,
35
36        /// The identifier for the rule.
37        #[ruma_api(path)]
38        pub rule_id: String,
39
40        /// The actions to perform for this rule
41        pub actions: Vec<Action>,
42    }
43
44    /// Response type for the `set_pushrule_actions` endpoint.
45    #[response(error = crate::Error)]
46    #[derive(Default)]
47    pub struct Response {}
48
49    impl Request {
50        /// Creates a new `Request` with the given rule kind, rule ID and actions.
51        pub fn new(kind: RuleKind, rule_id: String, actions: Vec<Action>) -> Self {
52            Self { kind, rule_id, actions }
53        }
54    }
55
56    impl Response {
57        /// Creates an empty `Response`.
58        pub fn new() -> Self {
59            Self {}
60        }
61    }
62}
ruma_client_api/push/set_pushrule_actions.rs

ruma_client_api/push/
set_pushrule_actions.rs
