Added docs to verify_otp

supabase-community · Oct 21, 2024 · c791910 · c791910
1 parent c99d1df
commit c791910
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git 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<Session, Error> {
         let mut headers = HeaderMap::new();
         headers.insert("apikey", HeaderValue::from_str(&self.api_key)?);

diff --git a/src/models.rs b/src/models.rs
@@ -210,14 +210,15 @@ pub struct OTPResponse {
     pub message_id: Option<String>,
 }
 
-#[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,