ruma_client_api/account/
deactivate.rs

Help
1//! `POST /_matrix/client/*/account/deactivate`
2//!
3//! Deactivate the current user's account.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3accountdeactivate
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13    };
14
15    use crate::{
16        account::ThirdPartyIdRemovalStatus,
17        uiaa::{AuthData, UiaaResponse},
18    };
19
20    const METADATA: Metadata = metadata! {
21        method: POST,
22        rate_limited: true,
23        authentication: AccessTokenOptional,
24        history: {
25            1.0 => "/_matrix/client/r0/account/deactivate",
26            1.1 => "/_matrix/client/v3/account/deactivate",
27        }
28    };
29
30    /// Request type for the `deactivate` endpoint.
31    #[request(error = UiaaResponse)]
32    #[derive(Default)]
33    pub struct Request {
34        /// Additional authentication information for the user-interactive authentication API.
35        #[serde(skip_serializing_if = "Option::is_none")]
36        pub auth: Option<AuthData>,
37
38        /// Identity server from which to unbind the user's third party
39        /// identifier.
40        #[serde(skip_serializing_if = "Option::is_none")]
41        pub id_server: Option<String>,
42
43        /// Whether the user would like their content to be erased as much as possible from the
44        /// server.
45        ///
46        /// Defaults to `false`.
47        #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
48        pub erase: bool,
49    }
50
51    /// Response type for the `deactivate` endpoint.
52    #[response(error = UiaaResponse)]
53    pub struct Response {
54        /// Result of unbind operation.
55        pub id_server_unbind_result: ThirdPartyIdRemovalStatus,
56    }
57
58    impl Request {
59        /// Creates an empty `Request`.
60        pub fn new() -> Self {
61            Default::default()
62        }
63    }
64
65    impl Response {
66        /// Creates a new `Response` with the given unbind result.
67        pub fn new(id_server_unbind_result: ThirdPartyIdRemovalStatus) -> Self {
68            Self { id_server_unbind_result }
69        }
70    }
71}
ruma_client_api/account/deactivate.rs

ruma_client_api/account/
deactivate.rs
