2022-03-09 17:46:51 +00:00

54 lines
1.4 KiB
Rust

//! `PUT /_matrix/client/*/devices/{deviceId}`
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3devicesdeviceid
use ruma_common::{api::ruma_api, DeviceId};
ruma_api! {
metadata: {
description: "Update metadata for a device.",
method: PUT,
name: "update_device",
r0_path: "/_matrix/client/r0/devices/:device_id",
stable_path: "/_matrix/client/v3/devices/:device_id",
rate_limited: false,
authentication: AccessToken,
added: 1.0,
}
request: {
/// The device to update.
#[ruma_api(path)]
pub device_id: &'a DeviceId,
/// The new display name for this device.
///
/// If this is `None`, the display name won't be changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub display_name: Option<String>,
}
#[derive(Default)]
response: {}
error: crate::Error
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given device ID.
pub fn new(device_id: &'a DeviceId) -> Self {
Self { device_id, display_name: None }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
}