ruwuma/crates/ruma-client-api/src/push/set_pushrule_actions.rs
Kévin Commaille 1aa2eadd70 client-api: Remove RuleScope
The `global` scope is hardcoded due to a clarification in the spec.
2024-10-19 14:58:59 -04:00

63 lines
1.7 KiB
Rust

//! `PUT /_matrix/client/*/pushrules/global/{kind}/{ruleId}/actions`
//!
//! This endpoint allows clients to change the actions of a push rule. This can be used to change
//! the actions of builtin rules.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3pushrulesglobalkindruleidactions
use ruma_common::{
api::{request, response, Metadata},
metadata,
push::Action,
};
use crate::push::RuleKind;
const METADATA: Metadata = metadata! {
method: PUT,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/pushrules/global/:kind/:rule_id/actions",
1.1 => "/_matrix/client/v3/pushrules/global/:kind/:rule_id/actions",
}
};
/// Request type for the `set_pushrule_actions` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The kind of rule
#[ruma_api(path)]
pub kind: RuleKind,
/// The identifier for the rule.
#[ruma_api(path)]
pub rule_id: String,
/// The actions to perform for this rule
pub actions: Vec<Action>,
}
/// Response type for the `set_pushrule_actions` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given rule kind, rule ID and actions.
pub fn new(kind: RuleKind, rule_id: String, actions: Vec<Action>) -> Self {
Self { kind, rule_id, actions }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
}