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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
//! `POST /_matrix/identity/*/validate/msisdn/requestToken`
//!
//! Create a session for validation of a phone number.
pub mod v2 {
//! `/v2/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/identity-service-api/#post_matrixidentityv2validatemsisdnrequesttoken
use js_int::UInt;
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedClientSecret, OwnedSessionId,
};
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/identity/v2/validate/msisdn/requestToken",
}
};
/// Request type for the `create_msisdn_validation_session` endpoint.
#[request]
pub struct Request {
/// A unique string generated by the client, and used to identify the validation attempt.
pub client_secret: OwnedClientSecret,
/// The two-letter uppercase ISO-3166-1 alpha-2 country code that the number in
/// `phone_number` should be parsed as if it were dialled from.
pub country: String,
/// The phone number to validate.
pub phone_number: String,
/// The server will only send an SMS if the send_attempt is a number greater than the most
/// recent one which it has seen, scoped to that `country` + `phone_number` +
/// `client_secret` triple.
pub send_attempt: UInt,
/// When the validation is completed, the identity server will redirect the user to this
/// URL.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<String>,
}
/// Response type for the `create_msisdn_validation_session` endpoint.
#[response]
pub struct Response {
/// The session ID.
///
/// Session IDs are opaque strings generated by the identity server.
pub sid: OwnedSessionId,
}
impl Request {
/// Create a new `Request` with the given client secret, country code, phone number, the
/// `send_attempt` number and the next link to go to after validation.
pub fn new(
client_secret: OwnedClientSecret,
country: String,
phone_number: String,
send_attempt: UInt,
next_link: Option<String>,
) -> Self {
Self { client_secret, country, phone_number, send_attempt, next_link }
}
}
impl Response {
/// Create a new `Response` with the given session ID.
pub fn new(sid: OwnedSessionId) -> Self {
Self { sid }
}
}
}