ruma_client_api/push/
get_pushrules_global_scope.rs

1//! `GET /_matrix/client/*/pushrules/global/`
2//!
3//! Retrieve all push rulesets in the global scope for this user.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3pushrulesglobal
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        push::Ruleset,
14    };
15
16    const METADATA: Metadata = metadata! {
17        method: GET,
18        rate_limited: false,
19        authentication: AccessToken,
20        history: {
21            1.0 => "/_matrix/client/r0/pushrules/global/",
22            1.1 => "/_matrix/client/v3/pushrules/global/",
23        }
24    };
25
26    /// Request type for the `get_pushrules_global_scope` endpoint.
27    #[request(error = crate::Error)]
28    #[derive(Default)]
29    pub struct Request {}
30
31    /// Response type for the `get_pushrules_global_scope` endpoint.
32    #[response(error = crate::Error)]
33    pub struct Response {
34        /// The global ruleset.
35        #[ruma_api(body)]
36        pub global: Ruleset,
37    }
38
39    impl Request {
40        /// Creates an empty `Request`.
41        pub fn new() -> Self {
42            Self {}
43        }
44    }
45
46    impl Response {
47        /// Creates a new `Response` with the given global ruleset.
48        pub fn new(global: Ruleset) -> Self {
49            Self { global }
50        }
51    }
52}