From c791910309990a2069b97911269d287635ae3ed9 Mon Sep 17 00:00:00 2001 From: Eric Biggs Date: Mon, 21 Oct 2024 04:13:58 -0400 Subject: [PATCH] Added docs to verify_otp --- src/client.rs | 15 ++++++++++++++- src/models.rs | 5 +++-- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/src/client.rs b/src/client.rs index ad632a6..44cff45 100644 --- a/src/client.rs +++ b/src/client.rs @@ -619,7 +619,20 @@ impl AuthClient { Ok(user) } - // TODO: Add test + /// Verify the OTP sent to the user + /// # Example + /// ``` + /// let params = VerifyEmailOtpParams { + /// token: "abc123", + /// otp_type: OtpType::EmailChange, + /// options: None, + /// }; + /// + /// let session = auth_client + /// .verify_otp(params) + /// .await + /// .unwrap(); + ///``` pub async fn verify_otp(&self, params: VerifyOtpParams) -> Result { let mut headers = HeaderMap::new(); headers.insert("apikey", HeaderValue::from_str(&self.api_key)?); diff --git a/src/models.rs b/src/models.rs index a5e2810..537b82b 100644 --- a/src/models.rs +++ b/src/models.rs @@ -210,14 +210,15 @@ pub struct OTPResponse { pub message_id: Option, } -#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(untagged)] pub enum VerifyOtpParams { Mobile(VerifyMobileOtpParams), Email(VerifyEmailOtpParams), TokenHash(VerifyTokenHashParams), } -#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct VerifyMobileOtpParams { /// The user's phone number. pub phone: String,