refactor: cleanup

Author: DanielleHuisman

src/user_management/operations.rs

@@ -1,3 +1,4 @@
+mod accept_invitation;
 mod authenticate_with_code;
 mod authenticate_with_email_verification;
 mod authenticate_with_magic_auth;
@@ -9,8 +10,10 @@ mod create_password_reset;
 mod create_user;
 mod delete_user;
 mod enroll_auth_factor;
+mod find_invitation_by_token;
 mod get_authorization_url;
 mod get_email_verification;
+mod get_invitation;
 mod get_jwks;
 mod get_jwks_url;
 mod get_logout_url;
@@ -20,16 +23,14 @@ mod get_user;
 mod get_user_by_external_id;
 mod get_user_identities;
 mod list_auth_factors;
+mod list_invitations;
 mod list_users;
 mod reset_password;
-mod update_user;
-mod send_invitation;
-mod get_invitation;
-mod get_invitation_by_token;
-mod accept_invitation;
 mod revoke_invitation;
-mod list_invitations;
+mod send_invitation;
+mod update_user;
 
+pub use accept_invitation::*;
 pub use authenticate_with_code::*;
 pub use authenticate_with_email_verification::*;
 pub use authenticate_with_magic_auth::*;
@@ -41,8 +42,10 @@ pub use create_password_reset::*;
 pub use create_user::*;
 pub use delete_user::*;
 pub use enroll_auth_factor::*;
+pub use find_invitation_by_token::*;
 pub use get_authorization_url::*;
 pub use get_email_verification::*;
+pub use get_invitation::*;
 pub use get_jwks::*;
 pub use get_jwks_url::*;
 pub use get_logout_url::*;
@@ -52,12 +55,9 @@ 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_users::*;
 pub use reset_password::*;
-pub use update_user::*;
-pub use send_invitation::*;
-pub use get_invitation::*;
-pub use get_invitation_by_token::*;
-pub use accept_invitation::*;
 pub use revoke_invitation::*;
-pub use list_invitations::*;
+pub use send_invitation::*;
+pub use update_user::*;

src/user_management/operations/accept_invitation.rs

@@ -14,25 +14,21 @@ impl From<AcceptInvitationError> for WorkOsError<AcceptInvitationError> {
     }
 }
 
-/// [WorkOS Docs: Accept an invitation](https://workos.com/docs/reference/user-management/invitation/accept
+/// [WorkOS Docs: Accept an invitation](https://workos.com/docs/reference/user-management/invitation/accept)
 #[async_trait]
 pub trait AcceptInvitation {
-    /// Accepts an invitation and, if linked to an organization, activates the user’s membership in that organization.
+    /// Accepts an invitation and, if linked to an organization, activates the user's membership in that organization.
     ///
     /// [WorkOS Docs: Accept an invitation](https://workos.com/docs/reference/user-management/invitation/accept)
     ///
     /// # Examples
     ///
     /// ```
-    /// use std::collections::HashSet;
-    ///
     /// # use workos_sdk::WorkOsResult;
     /// # use workos_sdk::user_management::*;
-    /// use workos_sdk::{ApiKey, WorkOs};    ///
-    /// #
-    /// use workos_sdk::organizations::OrganizationId;
+    /// use workos_sdk::{ApiKey, WorkOs};
     ///
-    /// async fn run() -> WorkOsResult<(), AcceptInvitationError> {
+    /// # async fn run() -> WorkOsResult<(), AcceptInvitationError> {
     /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
     ///
     /// let invitation = workos
@@ -44,22 +40,20 @@ pub trait AcceptInvitation {
     /// ```
     async fn accept_invitation(
         &self,
-        id: &InvitationId,
+        invitation_id: &InvitationId,
     ) -> WorkOsResult<Invitation, AcceptInvitationError>;
 }
 
 #[async_trait]
 impl AcceptInvitation for UserManagement<'_> {
     async fn accept_invitation(
         &self,
-        id: &InvitationId,
+        invitation_id: &InvitationId,
     ) -> WorkOsResult<Invitation, AcceptInvitationError> {
-        let url = self
-            .workos
-            .base_url()
-            .join(&format!("/user_management/invitations/{id}/accept"))?;
-
-        let invitation = self
+        let url = self.workos.base_url().join(&format!(
+            "/user_management/invitations/{invitation_id}/accept"
+        ))?;
+        let user = self
             .workos
             .client()
             .post(url)
@@ -70,7 +64,7 @@ impl AcceptInvitation for UserManagement<'_> {
             .json::<Invitation>()
             .await?;
 
-        Ok(invitation)
+        Ok(user)
     }
 }
 
@@ -79,6 +73,7 @@ mod test {
     use serde_json::json;
     use tokio;
 
+    use crate::user_management::InvitationId;
     use crate::{ApiKey, WorkOs};
 
     use super::*;
@@ -93,27 +88,25 @@ mod test {
             .build();
 
         server
-            .mock(
-                "POST",
-                "/user_management/invitations/invitation_01E4ZCR3C56J083X43JQXF3JK5/accept",
-            )
+            .mock("POST", "/user_management/invitations/invitation_01E4ZCR3C56J083X43JQXF3JK5/accept")
             .match_header("Authorization", "Bearer sk_example_123456789")
             .with_status(200)
             .with_body(
                 json!({
-                  "object": "invitation",
-                  "id": "invitation_01E4ZCR3C56J083X43JQXF3JK5",
-                  "email": "marcelina.davis@example.com",
-                  "state": "pending",
-                  "accepted_at": "2021-07-01T19:07:33.155Z",
-                  "revoked_at": null,
-                  "expires_at": "2021-07-01T19:07:33.155Z",
-                  "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
-                  "accept_invitation_url": "https://your-app.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
-                  "organization_id": "org_01E4ZCR3C56J083X43JQXF3JK5",
-                  "inviter_user_id": "user_01HYGBX8ZGD19949T3BM4FW1C3",
-                  "created_at": "2021-06-25T19:07:33.155Z",
-                  "updated_at": "2021-06-25T19:07:33.155Z"
+                    "object": "invitation",
+                    "id": "invitation_01E4ZCR3C56J083X43JQXF3JK5",
+                    "email": "marcelina.davis@example.com",
+                    "state": "accepted",
+                    "accepted_at": "2021-06-27T19:07:33.155Z",
+                    "revoked_at": null,
+                    "expires_at": "2021-07-01T19:07:33.155Z",
+                    "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+                    "accept_invitation_url": "https://your-app.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
+                    "organization_id": "org_01E4ZCR3C56J083X43JQXF3JK5",
+                    "inviter_user_id": "user_01HYGBX8ZGD19949T3BM4FW1C3",
+                    "accepted_user_id": "user_01JBJDMMV04RSWPG30MQE8ADFV",
+                    "created_at": "2021-06-25T19:07:33.155Z",
+                    "updated_at": "2021-06-25T19:07:33.155Z"
                 })
                 .to_string(),
             )
@@ -126,7 +119,10 @@ mod test {
             .await
             .unwrap();
 
-        assert_eq!(invitation.email, String::from("marcelina.davis@example.com"));
+        assert_eq!(
+            invitation.id,
+            InvitationId::from("invitation_01E4ZCR3C56J083X43JQXF3JK5")
+        );
         assert!(invitation.accepted_at.is_some());
     }
 }

src/user_management/operations/create_magic_auth.rs

@@ -35,8 +35,6 @@ pub trait CreateMagicAuth {
     /// # Examples
     ///
     /// ```
-    /// use std::collections::HashSet;
-    ///
     /// # use workos_sdk::WorkOsResult;
     /// # use workos_sdk::user_management::*;
     /// use workos_sdk::{ApiKey, WorkOs};

src/user_management/operations/create_password_reset.rs

@@ -73,8 +73,6 @@ pub trait CreatePasswordReset {
     /// # Examples
     ///
     /// ```
-    /// use std::collections::HashSet;
-    ///
     /// # use workos_sdk::WorkOsResult;
     /// # use workos_sdk::user_management::*;
     /// use workos_sdk::{ApiKey, WorkOs};

src/user_management/operations/create_user.rs

@@ -51,8 +51,6 @@ pub trait CreateUser {
     /// # Examples
     ///
     /// ```
-    /// use std::collections::HashSet;
-    ///
     /// # use workos_sdk::WorkOsResult;
     /// # use workos_sdk::user_management::*;
     /// use workos_sdk::{ApiKey, WorkOs};

src/user_management/operations/enroll_auth_factor.rs

@@ -107,8 +107,6 @@ pub trait EnrollAuthFactor {
     /// # Examples
     ///
     /// ```
-    /// use std::collections::HashSet;
-    ///
     /// # use workos_sdk::WorkOsResult;
     /// # use workos_sdk::user_management::*;
     /// use workos_sdk::{ApiKey, WorkOs};

…nt/operations/get_invitation_by_token.rs …t/operations/find_invitation_by_token.rssrc/user_management/operations/get_invitation_by_token.rs renamed to src/user_management/operations/find_invitation_by_token.rs src/user_management/operations/get_invitation_by_token.rs renamed to src/user_management/operations/find_invitation_by_token.rs

@@ -4,62 +4,57 @@ use thiserror::Error;
 use crate::user_management::{Invitation, InvitationToken, UserManagement};
 use crate::{ResponseExt, WorkOsError, WorkOsResult};
 
-/// An error returned from [`GetInvitationByToken`].
+/// An error returned from [`FindInvitationByToken`].
 #[derive(Debug, Error)]
-pub enum GetInvitationByTokenError {}
+pub enum FindInvitationByTokenError {}
 
-impl From<GetInvitationByTokenError> for WorkOsError<GetInvitationByTokenError> {
-    fn from(err: GetInvitationByTokenError) -> Self {
+impl From<FindInvitationByTokenError> for WorkOsError<FindInvitationByTokenError> {
+    fn from(err: FindInvitationByTokenError) -> Self {
         Self::Operation(err)
     }
 }
 
 /// [WorkOS Docs: Find an invitation by token](https://workos.com/docs/reference/user-management/invitation/find-by-token)
 #[async_trait]
-pub trait GetInvitationByToken {
+pub trait FindInvitationByToken {
     /// Retrieve an existing invitation using the token.
     ///
     /// [WorkOS Docs: Find an invitation by token](https://workos.com/docs/reference/user-management/invitation/find-by-token)
     ///
     /// # Examples
     ///
     /// ```
-    /// use std::collections::HashSet;
-    ///
     /// # use workos_sdk::WorkOsResult;
     /// # use workos_sdk::user_management::*;
     /// use workos_sdk::{ApiKey, WorkOs};
-    /// #
-    /// use workos_sdk::organizations::OrganizationId;
     ///
-    /// async fn run() -> WorkOsResult<(), GetInvitationByTokenError> {
+    /// # async fn run() -> WorkOsResult<(), FindInvitationByTokenError> {
     /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
     ///
     /// let invitation = workos
     ///     .user_management()
-    ///     .get_invitation_by_token(&InvitationToken::from("Z1uX3RbwcIl5fIGJJJCXXisdI"))
+    ///     .find_invitation_by_token(&InvitationToken::from("Z1uX3RbwcIl5fIGJJJCXXisdI"))
     ///     .await?;
     /// # Ok(())
     /// # }
     /// ```
-    async fn get_invitation_by_token(
+    async fn find_invitation_by_token(
         &self,
         token: &InvitationToken,
-    ) -> WorkOsResult<Invitation, GetInvitationByTokenError>;
+    ) -> WorkOsResult<Invitation, FindInvitationByTokenError>;
 }
 
 #[async_trait]
-impl GetInvitationByToken for UserManagement<'_> {
-    async fn get_invitation_by_token(
+impl FindInvitationByToken for UserManagement<'_> {
+    async fn find_invitation_by_token(
         &self,
         token: &InvitationToken,
-    ) -> WorkOsResult<Invitation, GetInvitationByTokenError> {
+    ) -> WorkOsResult<Invitation, FindInvitationByTokenError> {
         let url = self
             .workos
             .base_url()
-            .join(&format!("user_management/invitations/by_token/{token}"))?;
-
-        let invitation = self
+            .join(&format!("/user_management/invitations/by_token/{token}"))?;
+        let organization = self
             .workos
             .client()
             .get(url)
@@ -70,7 +65,7 @@ impl GetInvitationByToken for UserManagement<'_> {
             .json::<Invitation>()
             .await?;
 
-        Ok(invitation)
+        Ok(organization)
     }
 }
 
@@ -79,12 +74,12 @@ mod test {
     use serde_json::json;
     use tokio;
 
-    use crate::{ApiKey, WorkOs};
-    use crate::user_management::InvitationId;
+    use crate::{ApiKey, WorkOs, user_management::InvitationId};
+
     use super::*;
 
     #[tokio::test]
-    async fn it_calls_the_get_invitation_by_token_endpoint() {
+    async fn it_calls_the_find_invitation_by_token_endpoint() {
         let mut server = mockito::Server::new_async().await;
 
         let workos = WorkOs::builder(&ApiKey::from("sk_example_123456789"))
@@ -101,19 +96,19 @@ mod test {
             .with_status(200)
             .with_body(
                 json!({
-                  "object": "invitation",
-                  "id": "invitation_01E4ZCR3C56J083X43JQXF3JK5",
-                  "email": "marcelina.davis@example.com",
-                  "state": "pending",
-                  "accepted_at": null,
-                  "revoked_at": null,
-                  "expires_at": "2021-07-01T19:07:33.155Z",
-                  "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
-                  "accept_invitation_url": "https://your-app.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
-                  "organization_id": "org_01E4ZCR3C56J083X43JQXF3JK5",
-                  "inviter_user_id": "user_01HYGBX8ZGD19949T3BM4FW1C3",
-                  "created_at": "2021-06-25T19:07:33.155Z",
-                  "updated_at": "2021-06-25T19:07:33.155Z"
+                    "object": "invitation",
+                    "id": "invitation_01E4ZCR3C56J083X43JQXF3JK5",
+                    "email": "marcelina.davis@example.com",
+                    "state": "pending",
+                    "accepted_at": null,
+                    "revoked_at": null,
+                    "expires_at": "2021-07-01T19:07:33.155Z",
+                    "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+                    "accept_invitation_url": "https://your-app.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
+                    "organization_id": "org_01E4ZCR3C56J083X43JQXF3JK5",
+                    "inviter_user_id": "user_01HYGBX8ZGD19949T3BM4FW1C3",
+                    "created_at": "2021-06-25T19:07:33.155Z",
+                    "updated_at": "2021-06-25T19:07:33.155Z"
                 })
                 .to_string(),
             )
@@ -122,10 +117,13 @@ mod test {
 
         let invitation = workos
             .user_management()
-            .get_invitation_by_token(&InvitationToken::from("Z1uX3RbwcIl5fIGJJJCXXisdI"))
+            .find_invitation_by_token(&InvitationToken::from("Z1uX3RbwcIl5fIGJJJCXXisdI"))
             .await
             .unwrap();
 
-        assert_eq!(invitation.id, InvitationId::from("invitation_01E4ZCR3C56J083X43JQXF3JK5"));
+        assert_eq!(
+            invitation.id,
+            InvitationId::from("invitation_01E4ZCR3C56J083X43JQXF3JK5")
+        )
     }
 }