feat(user-management): add delete user

Author: DanielleHuisman

src/user_management/operations/delete_user.rs

@@ -0,0 +1,113 @@
+use async_trait::async_trait;
+use serde::Serialize;
+use thiserror::Error;
+
+use crate::user_management::{UserId, UserManagement};
+use crate::{ResponseExt, WorkOsError, WorkOsResult};
+
+/// The parameters for [`DeleteUser`].
+#[derive(Debug, Serialize)]
+pub struct DeleteUserParams<'a> {
+    /// The unique ID of the user.
+    pub user_id: &'a UserId,
+}
+
+/// An error returned from [`DeleteUser`].
+#[derive(Debug, Error)]
+pub enum DeleteUserError {}
+
+impl From<DeleteUserError> for WorkOsError<DeleteUserError> {
+    fn from(err: DeleteUserError) -> Self {
+        Self::Operation(err)
+    }
+}
+
+/// [WorkOS Docs: Delete a user](https://workos.com/docs/reference/user-management/user/delete)
+#[async_trait]
+pub trait DeleteUser {
+    /// Permanently deletes a user in the current environment. It cannot be undone.
+    ///
+    /// [WorkOS Docs: Delete a user](https://workos.com/docs/reference/user-management/user/delete)
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use workos_sdk::WorkOsResult;
+    /// # use workos_sdk::user_management::*;
+    /// use workos_sdk::{ApiKey, WorkOs};
+    ///
+    /// # async fn run() -> WorkOsResult<(), DeleteUserError> {
+    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
+    ///
+    /// workos
+    ///     .user_management()
+    ///     .delete_user(&DeleteUserParams {
+    ///         user_id: &UserId::from("user_01F3GZ5ZGZBZVQGZVHJFVXZJGZ"),
+    ///     })
+    ///     .await?;
+    /// # Ok(())
+    /// # }
+    /// ```
+    async fn delete_user(&self, params: &DeleteUserParams<'_>)
+        -> WorkOsResult<(), DeleteUserError>;
+}
+
+#[async_trait]
+impl DeleteUser for UserManagement<'_> {
+    async fn delete_user(
+        &self,
+        params: &DeleteUserParams<'_>,
+    ) -> WorkOsResult<(), DeleteUserError> {
+        let url = self
+            .workos
+            .base_url()
+            .join(&format!("/user_management/users/{id}", id = params.user_id))?;
+        self.workos
+            .client()
+            .delete(url)
+            .bearer_auth(self.workos.key())
+            .send()
+            .await?
+            .handle_unauthorized_or_generic_error()?;
+
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use tokio;
+
+    use super::*;
+    use crate::{ApiKey, WorkOs};
+    use matches::assert_matches;
+
+    #[tokio::test]
+    async fn it_calls_the_delete_user_endpoint() {
+        let mut server = mockito::Server::new_async().await;
+
+        let workos = WorkOs::builder(&ApiKey::from("sk_example_123456789"))
+            .base_url(&server.url())
+            .unwrap()
+            .build();
+
+        server
+            .mock(
+                "DELETE",
+                "/user_management/users/user_01F3GZ5ZGZBZVQGZVHJFVXZJGZ",
+            )
+            .match_header("Authorization", "Bearer sk_example_123456789")
+            .with_status(202)
+            .create_async()
+            .await;
+
+        let result = workos
+            .user_management()
+            .delete_user(&DeleteUserParams {
+                user_id: &UserId::from("user_01F3GZ5ZGZBZVQGZVHJFVXZJGZ"),
+            })
+            .await;
+
+        assert_matches!(result, Ok(()));
+    }
+}

src/user_management/operations/enroll_auth_factor.rs

@@ -11,8 +11,8 @@ use crate::{ResponseExt, WorkOsError, WorkOsResult};
 #[derive(Debug, Serialize)]
 pub struct EnrollAuthFactorParams<'a> {
     /// The unique ID of the user to enroll the auth factor.
-    #[serde(skip)]
-    pub id: &'a UserId,
+    #[serde(skip_serializing)]
+    pub user_id: &'a UserId,
 
     /// The type of the factor to enroll.
     #[serde(flatten)]
@@ -119,7 +119,7 @@ pub trait EnrollAuthFactor {
     /// let response = workos
     ///     .user_management()
     ///     .enroll_auth_factor(&EnrollAuthFactorParams {
-    ///         id: &UserId::from("user_01FVYZ5QM8N98T9ME5BCB2BBMJ"),
+    ///         user_id: &UserId::from("user_01FVYZ5QM8N98T9ME5BCB2BBMJ"),
     ///         r#type: &EnrollAuthFactorType::Totp {
     ///             issuer: Some("Foo Corp"),
     ///             user: Some("alan.turing@example.com"),
@@ -144,7 +144,7 @@ impl EnrollAuthFactor for UserManagement<'_> {
     ) -> WorkOsResult<EnrollAuthFactorResponse, EnrollAuthFactorError> {
         let url = self.workos.base_url().join(&format!(
             "/user_management/users/{}/auth_factors",
-            params.id
+            params.user_id
         ))?;
 
         let response = self
@@ -222,7 +222,7 @@ mod test {
         let response = workos
             .user_management()
             .enroll_auth_factor(&EnrollAuthFactorParams {
-                id: &UserId::from("user_01FVYZ5QM8N98T9ME5BCB2BBMJ"),
+                user_id: &UserId::from("user_01FVYZ5QM8N98T9ME5BCB2BBMJ"),
                 r#type: &EnrollAuthFactorType::Totp {
                     issuer: Some("Foo Corp"),
                     user: Some("alan.turing@example.com"),

src/user_management/operations/update_user.rs

@@ -98,7 +98,7 @@ impl UpdateUser for UserManagement<'_> {
         let url = self
             .workos
             .base_url()
-            .join(&format!("/user_management/{id}", id = params.user_id))?;
+            .join(&format!("/user_management/users/{id}", id = params.user_id))?;
         let user = self
             .workos
             .client()
@@ -137,7 +137,10 @@ mod test {
             .build();
 
         server
-            .mock("PUT", "/user_management/user_01E4ZCR3C56J083X43JQXF3JK5")
+            .mock(
+                "PUT",
+                "/user_management/users/user_01E4ZCR3C56J083X43JQXF3JK5",
+            )
             .match_header("Authorization", "Bearer sk_example_123456789")
             .with_status(200)
             .with_body(