palpo-core 0.0.2

Core library used by the palpo crates.
Documentation 
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

//! `POST /_matrix/client/*/account/3pid/add`
//!
//! Add contact information to a user's account

//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3account3pidadd

use salvo::prelude::*;
use serde::{Deserialize, Serialize};
//         1.0 => "/_matrix/client/r0/account/3pid/add",
//         1.1 => "/_matrix/client/v3/account/3pid/add",
//         1.0 => "/_matrix/client/r0/account/3pid/bind",
//         1.1 => "/_matrix/client/v3/account/3pid/bind",

use crate::client::account::IdentityServerInfo;
use crate::client::account::ThirdPartyIdRemovalStatus;
use crate::client::uiaa::AuthData;
use crate::third_party::Medium;
use crate::third_party::ThirdPartyIdentifier;
use crate::{OwnedClientSecret, OwnedSessionId};

#[derive(ToSchema, Serialize, Debug)]
pub struct ThreepidsResBody {
    /// A list of third party identifiers the homeserver has associated with the user's
    /// account.
    ///
    /// If the `compat-get-3pids` feature is enabled, this field will always be serialized,
    /// even if its value is an empty list.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub three_pids: Vec<ThirdPartyIdentifier>,
}
impl ThreepidsResBody {
    pub fn new(three_pids: Vec<ThirdPartyIdentifier>) -> Self {
        Self { three_pids }
    }
}

/// Request type for the `add_3pid` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct AddThreepidReqBody {
    /// Additional information for the User-Interactive Authentication API.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub auth: Option<AuthData>,

    /// Client-generated secret string used to protect this session.
    pub client_secret: OwnedClientSecret,

    /// The session identifier given by the identity server.
    pub sid: OwnedSessionId,
}

/// Request type for the `bind_3pid` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct BindThreepidReqBody {
    /// Client-generated secret string used to protect this session.
    pub client_secret: OwnedClientSecret,

    /// 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,

    /// The session identifier given by the identity server.
    pub sid: OwnedSessionId,
}

/// Request type for the `bind_3pid` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct UnbindThreepidReqBody {
    /// Identity server to unbind from.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id_server: Option<String>,

    /// Medium of the 3PID to be removed.
    pub medium: Medium,

    /// Third-party address being removed.
    pub address: String,
}

#[derive(ToSchema, Serialize, Debug)]
pub struct UnbindThreepidResBody {
    /// Result of unbind operation.
    pub id_server_unbind_result: ThirdPartyIdRemovalStatus,
}

/// Request type for the `bind_3pid` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct DeleteThreepidReqBody {
    /// Identity server to delete from.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id_server: Option<String>,

    /// Medium of the 3PID to be removed.
    pub medium: Medium,

    /// Third-party address being removed.
    pub address: String,
}

#[derive(ToSchema, Serialize, Debug)]
pub struct DeleteThreepidResBody {
    /// Result of unbind operation.
    pub id_server_unbind_result: ThirdPartyIdRemovalStatus,
}

/// `POST /_matrix/client/*/account/3pid/email/requestToken`
///
/// Request a 3PID management token with a 3rd party email.
/// `/v3/` ([spec])
///
/// [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3account3pidemailrequesttoken
///
// const METADATA: Metadata = metadata! {
//     method: POST,
//     rate_limited: false,
//     authentication: None,
//     history: {
//         1.0 => "/_matrix/client/r0/account/3pid/email/requestToken",
//         1.1 => "/_matrix/client/v3/account/3pid/email/requestToken",
//     }
// };

/// Request type for the `request_3pid_management_token_via_email` endpoint.
#[derive(ToSchema, Deserialize, Debug)]
pub struct TokenViaEmailReqBody {
    /// Client-generated secret string used to protect this session.
    pub client_secret: OwnedClientSecret,

    /// The email address.
    pub email: String,

    /// Used to distinguish protocol level retries from requests to re-send the email.
    pub send_attempt: u64,

    /// Return URL for identity server to redirect the client back to.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub next_link: Option<String>,
}

/// Response type for the `request_3pid_management_token_via_email` endpoint.

#[derive(ToSchema, Serialize, Debug)]
pub struct TokenViaEmailResBody {
    /// The session identifier given by the identity server.
    pub sid: OwnedSessionId,

    /// URL to submit validation token to.
    ///
    /// If omitted, verification happens without client.
    #[serde(
        skip_serializing_if = "Option::is_none",
        default,
        deserialize_with = "crate::serde::empty_string_as_none"
    )]
    pub submit_url: Option<String>,
}

/// `POST /_matrix/client/*/account/3pid/msisdn/requestToken`
///
/// Request a 3PID management token with a phone number.
/// `/v3/` ([spec])
///
/// [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3account3pidmsisdnrequesttoken

// 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.
#[derive(ToSchema, Deserialize, Debug)]
pub struct TokenViaMsisdnReqBody {
    /// 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: u64,

    /// Return URL for identity server to redirect the client back to.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub next_link: Option<String>,
}

/// Response type for the `request_3pid_management_token_via_msisdn` endpoint.

#[derive(ToSchema, Serialize, Debug)]
pub struct TokenViaMsisdnResBody {
    /// The session identifier given by the identity server.
    pub sid: OwnedSessionId,

    /// URL to submit validation token to.
    ///
    /// If omitted, verification happens without client.
    #[serde(
        skip_serializing_if = "Option::is_none",
        default,
        deserialize_with = "crate::serde::empty_string_as_none"
    )]
    pub submit_url: Option<String>,
}