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
139
140
141
142
143
144
145
146
147
148
149
150
151

use async_trait::async_trait;
use serde::Serialize;
use thiserror::Error;

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

/// The parameters for [`UpdateOrganizationMembership`].
#[derive(Debug, Serialize)]
pub struct UpdateOrganizationMembershipParams<'a> {
    /// The unique ID of the organization membership.
    #[serde(skip_serializing)]
    pub organization_membership_id: &'a OrganizationMembershipId,

    /// The unique role identifier.
    pub role_slug: &'a RoleSlug,
}

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

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

/// [WorkOS Docs: Update an organization membership](https://workos.com/docs/reference/user-management/organization-membership/update)
#[async_trait]
pub trait UpdateOrganizationMembership {
    /// Update the details of an existing organization membership.
    ///
    /// [WorkOS Docs: Update an organization membership](https://workos.com/docs/reference/user-management/organization-membership/update)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::roles::RoleSlug;
    /// # use workos::user_management::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), UpdateOrganizationMembershipError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let organization_membership = workos
    ///     .user_management()
    ///     .update_organization_membership(&UpdateOrganizationMembershipParams {
    ///         organization_membership_id: &OrganizationMembershipId::from("om_01E4ZCR3C56J083X43JQXF3JK5"),
    ///         role_slug: &RoleSlug::from("admin"),
    ///     })
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn update_organization_membership(
        &self,
        params: &UpdateOrganizationMembershipParams<'_>,
    ) -> WorkOsResult<OrganizationMembership, UpdateOrganizationMembershipError>;
}

#[async_trait]
impl UpdateOrganizationMembership for UserManagement<'_> {
    async fn update_organization_membership(
        &self,
        params: &UpdateOrganizationMembershipParams<'_>,
    ) -> WorkOsResult<OrganizationMembership, UpdateOrganizationMembershipError> {
        let url = self.workos.base_url().join(&format!(
            "/user_management/organization_memberships/{id}",
            id = params.organization_membership_id
        ))?;
        let organization_membership = self
            .workos
            .client()
            .put(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_update_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(
                "PUT",
                "/user_management/organization_memberships/om_01E4ZCR3C56J083X43JQXF3JK5",
            )
            .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": "admin"
                    },
                    "status": "active",
                    "created_at": "2021-06-25T19:07:33.155Z",
                    "updated_at": "2021-06-27T19:07:33.278Z"
                })
                .to_string(),
            )
            .create_async()
            .await;

        let organization_membership = workos
            .user_management()
            .update_organization_membership(&UpdateOrganizationMembershipParams {
                organization_membership_id: &OrganizationMembershipId::from(
                    "om_01E4ZCR3C56J083X43JQXF3JK5",
                ),
                role_slug: &RoleSlug::from("admin"),
            })
            .await
            .unwrap();

        assert_eq!(
            organization_membership.id,
            OrganizationMembershipId::from("om_01E4ZCR3C56J083X43JQXF3JK5")
        )
    }
}