feat(user-management): add organization membership (#98)

* feat(user-management): add organization memberships

* refactor: cleanup

---------

Co-authored-by: Sam Lijin <sam@boundaryml.com>

Author: DanielleHuisman

src/user_management/operations.rs

@@ -6,8 +6,11 @@ mod authenticate_with_password;
 mod authenticate_with_refresh_token;
 mod authenticate_with_totp;
 mod create_magic_auth;
+mod create_organization_membership;
 mod create_password_reset;
 mod create_user;
+mod deactivate_organization_membership;
+mod delete_organization_membership;
 mod delete_user;
 mod enroll_auth_factor;
 mod find_invitation_by_token;
@@ -18,16 +21,20 @@ mod get_jwks;
 mod get_jwks_url;
 mod get_logout_url;
 mod get_magic_auth;
+mod get_organization_membership;
 mod get_password_reset;
 mod get_user;
 mod get_user_by_external_id;
 mod get_user_identities;
 mod list_auth_factors;
 mod list_invitations;
+mod list_organization_memberships;
 mod list_users;
+mod reactivate_organization_membership;
 mod reset_password;
 mod revoke_invitation;
 mod send_invitation;
+mod update_organization_membership;
 mod update_user;
 
 pub use accept_invitation::*;
@@ -38,8 +45,11 @@ pub use authenticate_with_password::*;
 pub use authenticate_with_refresh_token::*;
 pub use authenticate_with_totp::*;
 pub use create_magic_auth::*;
+pub use create_organization_membership::*;
 pub use create_password_reset::*;
 pub use create_user::*;
+pub use deactivate_organization_membership::*;
+pub use delete_organization_membership::*;
 pub use delete_user::*;
 pub use enroll_auth_factor::*;
 pub use find_invitation_by_token::*;
@@ -50,14 +60,18 @@ pub use get_jwks::*;
 pub use get_jwks_url::*;
 pub use get_logout_url::*;
 pub use get_magic_auth::*;
+pub use get_organization_membership::*;
 pub use get_password_reset::*;
 pub use get_user::*;
 pub use get_user_by_external_id::*;
 pub use get_user_identities::*;
 pub use list_auth_factors::*;
 pub use list_invitations::*;
+pub use list_organization_memberships::*;
 pub use list_users::*;
+pub use reactivate_organization_membership::*;
 pub use reset_password::*;
 pub use revoke_invitation::*;
 pub use send_invitation::*;
+pub use update_organization_membership::*;
 pub use update_user::*;

src/user_management/operations/create_magic_auth.rs

@@ -65,7 +65,7 @@ impl CreateMagicAuth for UserManagement<'_> {
         params: &CreateMagicAuthParams<'_>,
     ) -> WorkOsResult<MagicAuth, CreateMagicAuthError> {
         let url = self.workos.base_url().join("/user_management/magic_auth")?;
-        let user = self
+        let magic_auth = self
             .workos
             .client()
             .post(url)
@@ -78,7 +78,7 @@ impl CreateMagicAuth for UserManagement<'_> {
             .json::<MagicAuth>()
             .await?;
 
-        Ok(user)
+        Ok(magic_auth)
     }
 }
 

src/user_management/operations/create_organization_membership.rs

@@ -0,0 +1,154 @@
+use async_trait::async_trait;
+use serde::Serialize;
+use thiserror::Error;
+
+use crate::organizations::OrganizationId;
+use crate::user_management::{OrganizationMembership, UserId, UserManagement};
+use crate::{ResponseExt, WorkOsError, WorkOsResult};
+
+/// The parameters for [`CreateOrganizationMembership`].
+#[derive(Debug, Serialize)]
+pub struct CreateOrganizationMembershipParams<'a> {
+    /// The ID of the user.
+    pub user_id: &'a UserId,
+
+    /// The ID of the organization which the user belongs to.
+    pub organization_id: &'a OrganizationId,
+
+    /// The unique role identifier.
+    ///
+    /// Defaults to `member`.
+    pub role_slug: Option<&'a str>,
+}
+
+/// An error returned from [`CreateOrganizationMembership`].
+#[derive(Debug, Error)]
+pub enum CreateOrganizationMembershipError {}
+
+impl From<CreateOrganizationMembershipError> for WorkOsError<CreateOrganizationMembershipError> {
+    fn from(err: CreateOrganizationMembershipError) -> Self {
+        Self::Operation(err)
+    }
+}
+
+/// [WorkOS Docs: Create an organization membership](https://workos.com/docs/reference/user-management/organization-membership/create)
+#[async_trait]
+pub trait CreateOrganizationMembership {
+    /// Creates a new `active` organization membership for the given organization and user.
+    ///
+    /// Calling this API with an organization and user that match an `inactive` organization membership will activate the membership with the specified role.
+    ///
+    /// [WorkOS Docs: Create an organization membership](https://workos.com/docs/reference/user-management/organization-membership/create)
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use workos::WorkOsResult;
+    /// # use workos::organizations::OrganizationId;
+    /// # use workos::user_management::*;
+    /// use workos::{ApiKey, WorkOs};
+    ///
+    /// # async fn run() -> WorkOsResult<(), CreateOrganizationMembershipError> {
+    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
+    ///
+    /// let organization_membership = workos
+    ///     .user_management()
+    ///     .create_organization_membership(&CreateOrganizationMembershipParams {
+    ///          user_id: &UserId::from("user_01E4ZCR3C5A4QZ2Z2JQXGKZJ9E"),
+    ///          organization_id: &OrganizationId::from("org_01E4ZCR3C56J083X43JQXF3JK5"),
+    ///          role_slug: Some("admin"),
+    ///     })
+    ///     .await?;
+    /// # Ok(())
+    /// # }
+    /// ```
+    async fn create_organization_membership(
+        &self,
+        params: &CreateOrganizationMembershipParams<'_>,
+    ) -> WorkOsResult<OrganizationMembership, CreateOrganizationMembershipError>;
+}
+
+#[async_trait]
+impl CreateOrganizationMembership for UserManagement<'_> {
+    async fn create_organization_membership(
+        &self,
+        params: &CreateOrganizationMembershipParams<'_>,
+    ) -> WorkOsResult<OrganizationMembership, CreateOrganizationMembershipError> {
+        let url = self
+            .workos
+            .base_url()
+            .join("/user_management/organization_membership")?;
+        let organization_membership = self
+            .workos
+            .client()
+            .post(url)
+            .bearer_auth(self.workos.key())
+            .json(&params)
+            .send()
+            .await?
+            .handle_unauthorized_or_generic_error()
+            .await?
+            .json::<OrganizationMembership>()
+            .await?;
+
+        Ok(organization_membership)
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use serde_json::json;
+    use tokio;
+
+    use crate::user_management::OrganizationMembershipId;
+    use crate::{ApiKey, WorkOs};
+
+    use super::*;
+
+    #[tokio::test]
+    async fn it_calls_the_create_organization_membership_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("POST", "/user_management/organization_membership")
+            .match_header("Authorization", "Bearer sk_example_123456789")
+            .with_status(201)
+            .with_body(
+                json!({
+                    "object": "organization_membership",
+                    "id": "om_01E4ZCR3C56J083X43JQXF3JK5",
+                    "user_id": "user_01E4ZCR3C5A4QZ2Z2JQXGKZJ9E",
+                    "organization_id": "org_01E4ZCR3C56J083X43JQXF3JK5",
+                    "role": {
+                        "slug": "admin"
+                    },
+                    "status": "active",
+                    "created_at": "2021-06-25T19:07:33.155Z",
+                    "updated_at": "2021-06-25T19:07:33.155Z"
+                })
+                .to_string(),
+            )
+            .create_async()
+            .await;
+
+        let organization_membership = workos
+            .user_management()
+            .create_organization_membership(&CreateOrganizationMembershipParams {
+                user_id: &UserId::from("user_01E4ZCR3C5A4QZ2Z2JQXGKZJ9E"),
+                organization_id: &OrganizationId::from("org_01E4ZCR3C56J083X43JQXF3JK5"),
+                role_slug: Some("admin"),
+            })
+            .await
+            .unwrap();
+
+        assert_eq!(
+            organization_membership.id,
+            OrganizationMembershipId::from("om_01E4ZCR3C56J083X43JQXF3JK5")
+        )
+    }
+}

src/user_management/operations/create_password_reset.rs

@@ -105,7 +105,7 @@ impl CreatePasswordReset for UserManagement<'_> {
             .workos
             .base_url()
             .join("/user_management/password_reset")?;
-        let user = self
+        let password_reset = self
             .workos
             .client()
             .post(url)
@@ -119,7 +119,7 @@ impl CreatePasswordReset for UserManagement<'_> {
             .json::<PasswordReset>()
             .await?;
 
-        Ok(user)
+        Ok(password_reset)
     }
 }