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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
use anyhow::Result;

use crate::Client;

pub struct UserFactors {
    pub client: Client,
}

impl UserFactors {
    #[doc(hidden)]
    pub fn new(client: Client) -> Self {
        UserFactors { client }
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors` endpoint.
     *
     * Enumerates all the enrolled factors for the specified user
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     */
    pub async fn list_factors(&self, user_id: &str) -> Result<Vec<crate::types::UserFactor>> {
        let url = format!(
            "/api/v1/users/{}/factors",
            crate::progenitor_support::encode_path(&user_id.to_string()),
        );

        self.client.get(&url, None).await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors` endpoint.
     *
     * As opposed to `list_factors`, this function returns all the pages of the request at once.
     *
     * Enumerates all the enrolled factors for the specified user
     */
    pub async fn list_all_factors(&self, user_id: &str) -> Result<Vec<crate::types::UserFactor>> {
        let url = format!(
            "/api/v1/users/{}/factors",
            crate::progenitor_support::encode_path(&user_id.to_string()),
        );

        self.client.get_all_pages(&url, None).await
    }

    /**
     * Enroll Factor.
     *
     * This function performs a `POST` to the `/api/v1/users/{userId}/factors` endpoint.
     *
     * Enrolls a user with a supported factor.
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     * * `update_phone: bool`
     * * `template_id: &str` -- id of SMS template (only for SMS factor).
     * * `token_lifetime_seconds: i64`
     * * `activate: bool`
     */
    pub async fn enroll_factor(
        &self,
        user_id: &str,
        update_phone: bool,
        template_id: &str,
        token_lifetime_seconds: i64,
        activate: bool,
        body: &crate::types::UserFactor,
    ) -> Result<crate::types::UserFactor> {
        let mut query_args: Vec<(String, String)> = Default::default();
        if activate {
            query_args.push(("activate".to_string(), activate.to_string()));
        }
        if !template_id.is_empty() {
            query_args.push(("templateId".to_string(), template_id.to_string()));
        }
        if token_lifetime_seconds > 0 {
            query_args.push((
                "tokenLifetimeSeconds".to_string(),
                token_lifetime_seconds.to_string(),
            ));
        }
        if update_phone {
            query_args.push(("updatePhone".to_string(), update_phone.to_string()));
        }
        let query_ = serde_urlencoded::to_string(&query_args).unwrap();
        let url = format!(
            "/api/v1/users/{}/factors?{}",
            crate::progenitor_support::encode_path(&user_id.to_string()),
            query_
        );

        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors/catalog` endpoint.
     *
     * Enumerates all the supported factors that can be enrolled for the specified user
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     */
    pub async fn list_supported_factors(
        &self,
        user_id: &str,
    ) -> Result<Vec<crate::types::UserFactor>> {
        let url = format!(
            "/api/v1/users/{}/factors/catalog",
            crate::progenitor_support::encode_path(&user_id.to_string()),
        );

        self.client.get(&url, None).await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors/catalog` endpoint.
     *
     * As opposed to `list_supported_factors`, this function returns all the pages of the request at once.
     *
     * Enumerates all the supported factors that can be enrolled for the specified user
     */
    pub async fn list_all_supported_factors(
        &self,
        user_id: &str,
    ) -> Result<Vec<crate::types::UserFactor>> {
        let url = format!(
            "/api/v1/users/{}/factors/catalog",
            crate::progenitor_support::encode_path(&user_id.to_string()),
        );

        self.client.get_all_pages(&url, None).await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors/questions` endpoint.
     *
     * Enumerates all available security questions for a user's `question` factor
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     */
    pub async fn list_supported_security_questions(
        &self,
        user_id: &str,
    ) -> Result<Vec<crate::types::SecurityQuestion>> {
        let url = format!(
            "/api/v1/users/{}/factors/questions",
            crate::progenitor_support::encode_path(&user_id.to_string()),
        );

        self.client.get(&url, None).await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors/questions` endpoint.
     *
     * As opposed to `list_supported_security_questions`, this function returns all the pages of the request at once.
     *
     * Enumerates all available security questions for a user's `question` factor
     */
    pub async fn list_all_supported_security_questions(
        &self,
        user_id: &str,
    ) -> Result<Vec<crate::types::SecurityQuestion>> {
        let url = format!(
            "/api/v1/users/{}/factors/questions",
            crate::progenitor_support::encode_path(&user_id.to_string()),
        );

        self.client.get_all_pages(&url, None).await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors/{factorId}` endpoint.
     *
     * Fetches a factor for the specified user
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     * * `factor_id: &str`
     */
    pub async fn get_factor(
        &self,
        user_id: &str,
        factor_id: &str,
    ) -> Result<crate::types::UserFactor> {
        let url = format!(
            "/api/v1/users/{}/factors/{}",
            crate::progenitor_support::encode_path(&user_id.to_string()),
            crate::progenitor_support::encode_path(&factor_id.to_string()),
        );

        self.client.get(&url, None).await
    }

    /**
     * This function performs a `DELETE` to the `/api/v1/users/{userId}/factors/{factorId}` endpoint.
     *
     * Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     * * `factor_id: &str`
     */
    pub async fn delete_factor(&self, user_id: &str, factor_id: &str) -> Result<()> {
        let url = format!(
            "/api/v1/users/{}/factors/{}",
            crate::progenitor_support::encode_path(&user_id.to_string()),
            crate::progenitor_support::encode_path(&factor_id.to_string()),
        );

        self.client.delete(&url, None).await
    }

    /**
     * Activate Factor.
     *
     * This function performs a `POST` to the `/api/v1/users/{userId}/factors/{factorId}/lifecycle/activate` endpoint.
     *
     * The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     * * `factor_id: &str`
     */
    pub async fn activate_factor(
        &self,
        user_id: &str,
        factor_id: &str,
        body: &crate::types::ActivateFactorRequest,
    ) -> Result<crate::types::UserFactor> {
        let url = format!(
            "/api/v1/users/{}/factors/{}/lifecycle/activate",
            crate::progenitor_support::encode_path(&user_id.to_string()),
            crate::progenitor_support::encode_path(&factor_id.to_string()),
        );

        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }

    /**
     * This function performs a `GET` to the `/api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}` endpoint.
     *
     * Polls factors verification transaction for status.
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     * * `factor_id: &str`
     * * `transaction_id: &str`
     */
    pub async fn get_factor_transaction_status(
        &self,
        user_id: &str,
        factor_id: &str,
        transaction_id: &str,
    ) -> Result<crate::types::VerifyUserFactorResponse> {
        let url = format!(
            "/api/v1/users/{}/factors/{}/transactions/{}",
            crate::progenitor_support::encode_path(&user_id.to_string()),
            crate::progenitor_support::encode_path(&factor_id.to_string()),
            crate::progenitor_support::encode_path(&transaction_id.to_string()),
        );

        self.client.get(&url, None).await
    }

    /**
     * Verify MFA Factor.
     *
     * This function performs a `POST` to the `/api/v1/users/{userId}/factors/{factorId}/verify` endpoint.
     *
     * Verifies an OTP for a `token` or `token:hardware` factor
     *
     * **Parameters:**
     *
     * * `user_id: &str`
     * * `factor_id: &str`
     * * `template_id: &str`
     * * `token_lifetime_seconds: i64`
     * * `x_forwarded_for: &str`
     * * `user_agent: &str`
     * * `accept_language: &str`
     */
    pub async fn verify_factor(
        &self,
        user_id: &str,
        factor_id: &str,
        template_id: &str,
        token_lifetime_seconds: i64,
        body: &crate::types::VerifyFactorRequest,
    ) -> Result<crate::types::VerifyUserFactorResponse> {
        let mut query_args: Vec<(String, String)> = Default::default();
        if !template_id.is_empty() {
            query_args.push(("templateId".to_string(), template_id.to_string()));
        }
        if token_lifetime_seconds > 0 {
            query_args.push((
                "tokenLifetimeSeconds".to_string(),
                token_lifetime_seconds.to_string(),
            ));
        }
        let query_ = serde_urlencoded::to_string(&query_args).unwrap();
        let url = format!(
            "/api/v1/users/{}/factors/{}/verify?{}",
            crate::progenitor_support::encode_path(&user_id.to_string()),
            crate::progenitor_support::encode_path(&factor_id.to_string()),
            query_
        );

        self.client
            .post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
            .await
    }
}