71 lines
2.1 KiB
Rust
71 lines
2.1 KiB
Rust
//! `PUT /_matrix/client/*/pushrules/{scope}/{kind}/{ruleId}/enabled`
|
|
|
|
pub mod v3 {
|
|
//! `/v3/` ([spec])
|
|
//!
|
|
//! [spec]: https://spec.matrix.org/v1.4/client-server-api/#put_matrixclientv3pushrulesscopekindruleidenabled
|
|
|
|
use ruma_common::api::ruma_api;
|
|
|
|
use crate::push::{RuleKind, RuleScope};
|
|
|
|
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.
|
|
#[ruma_api(path)]
|
|
pub scope: RuleScope,
|
|
|
|
/// 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: RuleScope, 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: RuleScope, 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: RuleScope, 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 {}
|
|
}
|
|
}
|
|
}
|