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

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

use crate::organization_domains::{OrganizationDomain, OrganizationDomainId, OrganizationDomains};
use crate::{ResponseExt, WorkOsError, WorkOsResult};

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

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

/// [WorkOS Docs: Get an Organization Domain](https://workos.com/docs/reference/domain-verification/get)
#[async_trait]
pub trait GetOrganizationDomain {
    /// Get the details of an existing organization domain.
    ///
    /// [WorkOS Docs: Get an Organization Domain](https://workos.com/docs/reference/domain-verification/get)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::organization_domains::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), GetOrganizationDomainError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let organization_domain = workos
    ///     .organization_domains()
    ///     .get_organization_domain(&OrganizationDomainId::from("org_domain_01HEJXJSTVEDT7T58BM70FMFET"))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn get_organization_domain(
        &self,
        id: &OrganizationDomainId,
    ) -> WorkOsResult<OrganizationDomain, GetOrganizationDomainError>;
}

#[async_trait]
impl GetOrganizationDomain for OrganizationDomains<'_> {
    async fn get_organization_domain(
        &self,
        id: &OrganizationDomainId,
    ) -> WorkOsResult<OrganizationDomain, GetOrganizationDomainError> {
        let url = self
            .workos
            .base_url()
            .join(&format!("/organization_domains/{id}"))?;

        let organization_domain = self
            .workos
            .client()
            .get(url)
            .bearer_auth(self.workos.key())
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<OrganizationDomain>()
            .await?;

        Ok(organization_domain)
    }
}

#[cfg(test)]
mod test {
    use serde_json::json;
    use tokio;

    use crate::{ApiKey, WorkOs};

    use super::*;

    #[tokio::test]
    async fn it_calls_the_get_organization_domain_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(
                "GET",
                "/organization_domains/org_domain_01HEJXJSTVEDT7T58BM70FMFET",
            )
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(200)
            .with_body(
                json!({
                    "object": "organization_domain",
                    "id": "org_domain_01HEJXJSTVEDT7T58BM70FMFET",
                    "organization_id": "org_01EHT88Z8J8795GZNQ4ZP1J81T",
                    "domain": "foo-corp.com",
                    "state": "pending",
                    "verification_strategy": "dns",
                    "verification_token": "aW5HQ8Sgps1y3LQyrShsFRo3F",
                    "created_at": "2021-06-25T19:07:33.155Z",
                    "updated_at": "2021-06-25T19:07:33.155Z"
                })
                .to_string(),
            )
            .create_async()
            .await;

        let organization_domain = workos
            .organization_domains()
            .get_organization_domain(&OrganizationDomainId::from(
                "org_domain_01HEJXJSTVEDT7T58BM70FMFET",
            ))
            .await
            .unwrap();

        assert_eq!(
            organization_domain.id,
            OrganizationDomainId::from("org_domain_01HEJXJSTVEDT7T58BM70FMFET")
        )
    }
}