ruwuma/ruma-client-api/src/r0/push/set_pushrule.rs
2020-06-30 13:06:37 +02:00

55 lines
1.9 KiB
Rust

//! [PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}](https://matrix.org/docs/spec/client_server/r0.6.0#put-matrix-client-r0-pushrules-scope-kind-ruleid)
use ruma_api::ruma_api;
use super::{Action, PushCondition, RuleKind};
ruma_api! {
metadata: {
description: "This endpoint allows the creation, modification and deletion of pushers for this user ID.",
method: PUT,
name: "set_pushrule",
path: "/_matrix/client/r0/pushrules/:scope/:kind/:rule_id",
rate_limited: true,
requires_authentication: true,
}
request: {
/// The scope to set the rule in. 'global' to specify global rules.
#[ruma_api(path)]
pub scope: String,
/// The kind of rule
#[ruma_api(path)]
pub kind: RuleKind,
/// The identifier for the rule.
#[ruma_api(path)]
pub rule_id: String,
/// Use 'before' with a rule_id as its value to make the new rule the next-most important rule with respect to the given user defined rule.
#[ruma_api(query)]
pub before: Option<String>,
/// This makes the new rule the next-less important rule relative to the given user defined rule.
#[ruma_api(query)]
pub after: Option<String>,
/// The actions to perform when this rule is matched.
pub actions: Vec<Action>,
/// The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches.
/// Only applicable to underride and override rules, empty Vec otherwise.
#[serde(default)]
pub conditions: Vec<PushCondition>,
/// The glob-style pattern to match against. Only applicable to content rules.
#[serde(skip_serializing_if = "Option::is_none")]
pub pattern: Option<String>,
}
response: {}
error: crate::Error
}