ruwuma/crates/ruma-client-api/src/r0/push/get_pushrule_actions.rs
2021-10-06 10:48:08 +02:00

53 lines
1.4 KiB
Rust

//! [GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions](https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-pushrules-scope-kind-ruleid-actions)
use ruma_api::ruma_api;
use ruma_common::push::Action;
use super::RuleKind;
ruma_api! {
metadata: {
description: "This endpoint get the actions for the specified push rule.",
method: GET,
name: "get_pushrule_actions",
path: "/_matrix/client/r0/pushrules/:scope/:kind/:rule_id/actions",
rate_limited: false,
authentication: AccessToken,
}
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,
}
response: {
/// The actions to perform for this rule.
pub actions: Vec<Action>,
}
error: crate::Error
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given scope, kind and rule ID.
pub fn new(scope: &'a str, kind: RuleKind, rule_id: &'a str) -> Self {
Self { scope, kind, rule_id }
}
}
impl Response {
/// Creates a new `Response` with the given actions.
pub fn new(actions: Vec<Action>) -> Self {
Self { actions }
}
}