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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
//! `POST /_matrix/client/*/account/3pid/msisdn/requestToken`
//!
//! Request a 3PID management token with a phone number.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.4/client-server-api/#post_matrixclientv3account3pidmsisdnrequesttoken
use js_int::UInt;
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedClientSecret, OwnedSessionId,
};
use crate::account::IdentityServerInfo;
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: false,
authentication: None,
history: {
1.0 => "/_matrix/client/r0/account/3pid/msisdn/requestToken",
1.1 => "/_matrix/client/v3/account/3pid/msisdn/requestToken",
}
};
/// Request type for the `request_3pid_management_token_via_msisdn` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// Client-generated secret string used to protect this session.
pub client_secret: OwnedClientSecret,
/// Two-letter ISO 3166 country code for the phone number.
pub country: String,
/// Phone number to validate.
pub phone_number: String,
/// Used to distinguish protocol level retries from requests to re-send the SMS.
pub send_attempt: UInt,
/// Return URL for identity server to redirect the client back to.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<String>,
/// Optional identity server hostname and access token.
///
/// Deprecated since r0.6.0.
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub identity_server_info: Option<IdentityServerInfo>,
}
/// Response type for the `request_3pid_management_token_via_msisdn` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// The session identifier given by the identity server.
pub sid: OwnedSessionId,
/// URL to submit validation token to.
///
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will
/// result in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",
serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
)]
pub submit_url: Option<String>,
}
impl Request {
/// Creates a new `Request` with the given client secret, country code, phone number and
/// send-attempt counter.
pub fn new(
client_secret: OwnedClientSecret,
country: String,
phone_number: String,
send_attempt: UInt,
) -> Self {
Self {
client_secret,
country,
phone_number,
send_attempt,
next_link: None,
identity_server_info: None,
}
}
}
impl Response {
/// Creates a new `Response` with the given session identifier.
pub fn new(sid: OwnedSessionId) -> Self {
Self { sid, submit_url: None }
}
}
}