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
//! `POST /_matrix/identity/*/validate/msisdn/submitToken`
//!
//! Validate the ownership of a phone number.
pub mod v2 {
//! `/v2/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.2/identity-service-api/#post_matrixidentityv2validatemsisdnsubmittoken
use ruma_common::{api::ruma_api, ClientSecret, SessionId};
ruma_api! {
metadata: {
description: "Validate ownership of an phone number.",
method: POST,
name: "validate_msisdn",
stable_path: "/_matrix/identity/v2/validate/msisdn/submitToken",
authentication: AccessToken,
rate_limited: false,
added: 1.0,
}
request: {
/// The session ID, generated by the `requestToken` call.
pub sid: &'a SessionId,
/// The client secret that was supplied to the `requestToken` call.
pub client_secret: &'a ClientSecret,
/// The token generated by the `requestToken` call and sent to the user.
pub token: &'a str,
}
response: {
/// Whether the validation was successful or not.
pub success: bool,
}
}
impl<'a> Request<'a> {
/// Create a new `Request` with the given session ID, client secret and token.
pub fn new(sid: &'a SessionId, client_secret: &'a ClientSecret, token: &'a str) -> Self {
Self { sid, client_secret, token }
}
}
impl Response {
/// Create a new `Response` with the success status.
pub fn new(success: bool) -> Self {
Self { success }
}
}
}