ruma_client_api/account/
bind_3pid.rs

Help
1//! `POST /_matrix/client/*/account/3pid/bind`
2//!
3//! Bind a 3PID to a user's account on an identity server
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3account3pidbind
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedClientSecret, OwnedSessionId,
13    };
14
15    use crate::account::IdentityServerInfo;
16
17    const METADATA: Metadata = metadata! {
18        method: POST,
19        rate_limited: true,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/account/3pid/bind",
23            1.1 => "/_matrix/client/v3/account/3pid/bind",
24        }
25    };
26
27    /// Request type for the `bind_3pid` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// Client-generated secret string used to protect this session.
31        pub client_secret: OwnedClientSecret,
32
33        /// The ID server to send the onward request to as a hostname with an
34        /// appended colon and port number if the port is not the default.
35        #[serde(flatten)]
36        pub identity_server_info: IdentityServerInfo,
37
38        /// The session identifier given by the identity server.
39        pub sid: OwnedSessionId,
40    }
41
42    /// Response type for the `bind_3pid` endpoint.
43    #[response(error = crate::Error)]
44    #[derive(Default)]
45    pub struct Response {}
46
47    impl Request {
48        /// Creates a new `Request` with the given client secret, identity server information and
49        /// session identifier.
50        pub fn new(
51            client_secret: OwnedClientSecret,
52            identity_server_info: IdentityServerInfo,
53            sid: OwnedSessionId,
54        ) -> Self {
55            Self { client_secret, identity_server_info, sid }
56        }
57    }
58
59    impl Response {
60        /// Creates an empty `Response`.
61        pub fn new() -> Self {
62            Self {}
63        }
64    }
65}
ruma_client_api/account/bind_3pid.rs

ruma_client_api/account/
bind_3pid.rs
