ruma_client_api/backup/
update_backup_version.rs

1//! `PUT /_matrix/client/*/room_keys/version/{version}`
2//!
3//! Update information about an existing backup.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3room_keysversionversion
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14    };
15
16    use crate::backup::BackupAlgorithm;
17
18    const METADATA: Metadata = metadata! {
19        method: PUT,
20        rate_limited: true,
21        authentication: AccessToken,
22        history: {
23            unstable => "/_matrix/client/unstable/room_keys/version/:version",
24            1.1 => "/_matrix/client/v3/room_keys/version/:version",
25        }
26    };
27
28    /// Request type for the `update_backup_version` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// The backup version.
32        #[ruma_api(path)]
33        pub version: String,
34
35        /// The algorithm used for storing backups.
36        #[ruma_api(body)]
37        pub algorithm: Raw<BackupAlgorithm>,
38    }
39
40    /// Response type for the `update_backup_version` endpoint.
41    #[response(error = crate::Error)]
42    #[derive(Default)]
43    pub struct Response {}
44
45    impl Request {
46        /// Creates a new `Request` with the given backup version and algorithm.
47        pub fn new(version: String, algorithm: Raw<BackupAlgorithm>) -> Self {
48            Self { version, algorithm }
49        }
50    }
51
52    impl Response {
53        /// Creates an empty `Response`.
54        pub fn new() -> Self {
55            Self {}
56        }
57    }
58}