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

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

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

/// The parameters for [`CreateOrganizationDomain`].
#[derive(Debug, Serialize)]
pub struct CreateOrganizationDomainParams<'a> {
    /// ID of the parent Organization.
    pub organization_id: &'a OrganizationId,

    /// Domain for the organization domain.
    pub domain: &'a str,
}

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

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

/// [WorkOS Docs: Create an Organization Domain](https://workos.com/docs/reference/domain-verification/create)
#[async_trait]
pub trait CreateOrganizationDomain {
    /// Creates a new Organization Domain.
    ///
    /// [WorkOS Docs: Create an Organization Domain](https://workos.com/docs/reference/domain-verification/create)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::organization_domains::*;
    /// use workos::organizations::OrganizationId;
    /// use workos::{ApiKey, Metadata, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), CreateOrganizationDomainError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let organization_domain = workos
    ///     .organization_domains()
    ///     .create_organization_domain(&CreateOrganizationDomainParams {
    ///         organization_id: &OrganizationId::from("org_01EHT88Z8J8795GZNQ4ZP1J81T"),
    ///         domain: "foo-corp.com",
    ///     })
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn create_organization_domain(
        &self,
        params: &CreateOrganizationDomainParams<'_>,
    ) -> WorkOsResult<OrganizationDomain, CreateOrganizationDomainError>;
}

#[async_trait]
impl CreateOrganizationDomain for OrganizationDomains<'_> {
    async fn create_organization_domain(
        &self,
        params: &CreateOrganizationDomainParams<'_>,
    ) -> WorkOsResult<OrganizationDomain, CreateOrganizationDomainError> {
        let url = self.workos.base_url().join("/organization_domains")?;

        let organization = self
            .workos
            .client()
            .post(url)
            .bearer_auth(self.workos.key())
            .json(&params)
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<OrganizationDomain>()
            .await?;

        Ok(organization)
    }
}

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

    use crate::organization_domains::OrganizationDomainId;
    use crate::organizations::OrganizationId;
    use crate::{ApiKey, WorkOs};

    use super::*;

    #[tokio::test]
    async fn it_calls_the_create_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("POST", "/organization_domains")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(201)
            .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()
            .create_organization_domain(&CreateOrganizationDomainParams {
                organization_id: &OrganizationId::from("org_01EHT88Z8J8795GZNQ4ZP1J81T"),
                domain: "foo-corp.com",
            })
            .await
            .unwrap();

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