ruma_client_api/account/
request_password_change_token_via_msisdn.rs

Help
1//! `POST /_matrix/client/*/account/password/msisdn/requestToken`
2//!
3//! Request that a password change token is sent to the given phone number.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3accountpasswordmsisdnrequesttoken
9
10    use js_int::UInt;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata, OwnedClientSecret, OwnedSessionId,
14    };
15
16    const METADATA: Metadata = metadata! {
17        method: POST,
18        rate_limited: false,
19        authentication: None,
20        history: {
21            1.0 => "/_matrix/client/r0/account/password/msisdn/requestToken",
22            1.1 => "/_matrix/client/v3/account/password/msisdn/requestToken",
23        }
24    };
25
26    /// Request type for the `request_password_change_token_via_msisdn` endpoint.
27    #[request(error = crate::Error)]
28    pub struct Request {
29        /// Client-generated secret string used to protect this session.
30        pub client_secret: OwnedClientSecret,
31
32        /// Two-letter ISO 3166 country code for the phone number.
33        pub country: String,
34
35        /// Phone number to validate.
36        pub phone_number: String,
37
38        /// Used to distinguish protocol level retries from requests to re-send the SMS.
39        pub send_attempt: UInt,
40
41        /// Return URL for identity server to redirect the client back to.
42        #[serde(skip_serializing_if = "Option::is_none")]
43        pub next_link: Option<String>,
44    }
45
46    /// Response type for the `request_password_change_token_via_msisdn` endpoint.
47    #[response(error = crate::Error)]
48    pub struct Response {
49        /// The session identifier given by the identity server.
50        pub sid: OwnedSessionId,
51
52        /// URL to submit validation token to.
53        ///
54        /// If omitted, verification happens without client.
55        ///
56        /// If you activate the `compat-empty-string-null` feature, this field being an empty
57        /// string in JSON will result in `None` here during deserialization.
58        #[serde(skip_serializing_if = "Option::is_none")]
59        #[cfg_attr(
60            feature = "compat-empty-string-null",
61            serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
62        )]
63        pub submit_url: Option<String>,
64    }
65
66    impl Request {
67        /// Creates a new `Request` with the given client secret, country code, phone number and
68        /// send-attempt counter.
69        pub fn new(
70            client_secret: OwnedClientSecret,
71            country: String,
72            phone_number: String,
73            send_attempt: UInt,
74        ) -> Self {
75            Self { client_secret, country, phone_number, send_attempt, next_link: None }
76        }
77    }
78
79    impl Response {
80        /// Creates a new `Response` with the given session identifier.
81        pub fn new(sid: OwnedSessionId) -> Self {
82            Self { sid, submit_url: None }
83        }
84    }
85}
ruma_client_api/account/request_password_change_token_via_msisdn.rs

ruma_client_api/account/
request_password_change_token_via_msisdn.rs
