ruma_client_api/account/
bind_3pid.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
//! `POST /_matrix/client/*/account/3pid/bind`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3account3pidbind

    use ruma_common::{api::ruma_api, ClientSecret, SessionId};

    use crate::account::{IdentityServerInfo, IncomingIdentityServerInfo};

    ruma_api! {
        metadata: {
            description: "Bind a 3PID to a user's account on an identity server",
            method: POST,
            name: "bind_3pid",
            r0_path: "/_matrix/client/r0/account/3pid/bind",
            stable_path: "/_matrix/client/v3/account/3pid/bind",
            rate_limited: true,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// Client-generated secret string used to protect this session.
            pub client_secret: &'a ClientSecret,

            /// The ID server to send the onward request to as a hostname with an
            /// appended colon and port number if the port is not the default.
            #[serde(flatten)]
            pub identity_server_info: IdentityServerInfo<'a>,

            /// The session identifier given by the identity server.
            pub sid: &'a SessionId,
        }

        #[derive(Default)]
        response: {}

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given client secret, identity server information and
        /// session identifier.
        pub fn new(
            client_secret: &'a ClientSecret,
            identity_server_info: IdentityServerInfo<'a>,
            sid: &'a SessionId,
        ) -> Self {
            Self { client_secret, identity_server_info, sid }
        }
    }

    impl Response {
        /// Creates an empty `Response`.
        pub fn new() -> Self {
            Self {}
        }
    }
}