workos 0.8.1

Rust SDK for interacting with the WorkOS API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use async_trait::async_trait;
use thiserror::Error;

use crate::user_management::{OrganizationMembership, OrganizationMembershipId, UserManagement};
use crate::{ResponseExt, WorkOsError, WorkOsResult};

/// An error returned from [`DeactivateOrganizationMembership`].
#[derive(Debug, Error)]
pub enum DeactivateOrganizationMembershipError {}

impl From<DeactivateOrganizationMembershipError>
    for WorkOsError<DeactivateOrganizationMembershipError>
{
    fn from(err: DeactivateOrganizationMembershipError) -> Self {
        Self::Operation(err)
    }
}

/// [WorkOS Docs: Deactivate an organization membership](https://workos.com/docs/reference/user-management/organization-membership/deactivate)
#[async_trait]
pub trait DeactivateOrganizationMembership {
    /// Deactivates an `active` organization membership.
    ///
    /// [WorkOS Docs: Deactivate an organization membership](https://workos.com/docs/reference/user-management/organization-membership/deactivate)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::user_management::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), DeactivateOrganizationMembershipError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let organization_membership = workos
    ///     .user_management()
    ///     .deactivate_organization_membership(&OrganizationMembershipId::from(
    ///         "om_01E4ZCR3C56J083X43JQXF3JK5"
    ///     ))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn deactivate_organization_membership(
        &self,
        organization_membership_id: &OrganizationMembershipId,
    ) -> WorkOsResult<OrganizationMembership, DeactivateOrganizationMembershipError>;
}

#[async_trait]
impl DeactivateOrganizationMembership for UserManagement<'_> {
    async fn deactivate_organization_membership(
        &self,
        organization_membership_id: &OrganizationMembershipId,
    ) -> WorkOsResult<OrganizationMembership, DeactivateOrganizationMembershipError> {
        let url = self.workos.base_url().join(&format!(
            "/user_management/organization_memberships/{organization_membership_id}/deactivate",
        ))?;

        let organization_membership = self
            .workos
            .client()
            .post(url)
            .bearer_auth(self.workos.key())
            .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, OrganizationMembershipStatus};
    use crate::{ApiKey, KnownOrUnknown, WorkOs};

    use super::*;

    #[tokio::test]
    async fn deactivate_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_memberships/om_01E4ZCR3C56J083X43JQXF3JK5/deactivate",
            )
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(200)
            .with_body(
                json!({
                    "object": "organization_membership",
                    "id": "om_01E4ZCR3C56J083X43JQXF3JK5",
                    "user_id": "user_01E4ZCR3C5A4QZ2Z2JQXGKZJ9E",
                    "organization_id": "org_01E4ZCR3C56J083X43JQXF3JK5",
                    "role": {
                        "slug": "member"
                    },
                    "status": "inactive",
                    "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()
            .deactivate_organization_membership(&OrganizationMembershipId::from(
                "om_01E4ZCR3C56J083X43JQXF3JK5",
            ))
            .await
            .unwrap();

        assert_eq!(
            organization_membership.id,
            OrganizationMembershipId::from("om_01E4ZCR3C56J083X43JQXF3JK5")
        );
        assert_eq!(
            organization_membership.status,
            KnownOrUnknown::Known(OrganizationMembershipStatus::Inactive)
        );
    }
}