feat(organization-domains): add organization domains (#166)

Author: DanielleHuisman

src/directory_sync/types/directory.rs

@@ -2,7 +2,8 @@ use derive_more::{Deref, Display, From};
 use serde::{Deserialize, Serialize};
 
 use crate::directory_sync::DirectoryType;
-use crate::organizations::{OrganizationDomainId, OrganizationId};
+use crate::organization_domains::OrganizationDomainId;
+use crate::organizations::OrganizationId;
 use crate::{KnownOrUnknown, Timestamps};
 
 /// The ID of a [`Directory`].

src/events/types/events/organization_domain_created.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::organizations::OrganizationDomain;
+use crate::organization_domains::OrganizationDomain;
 
 /// [WorkOS Docs: `organization_domain.created` event](https://workos.com/docs/events/organization-domain).
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]

src/events/types/events/organization_domain_deleted.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::organizations::OrganizationDomain;
+use crate::organization_domains::OrganizationDomain;
 
 /// [WorkOS Docs: `organization_domain.deleted` event](https://workos.com/docs/events/organization-domain).
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]

src/events/types/events/organization_domain_updated.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::organizations::OrganizationDomain;
+use crate::organization_domains::OrganizationDomain;
 
 /// [WorkOS Docs: `organization_domain.updated` event](https://workos.com/docs/events/organization-domain).
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]

src/events/types/events/organization_domain_verification_failed.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::organizations::OrganizationDomain;
+use crate::organization_domains::OrganizationDomain;
 
 /// [WorkOS Docs: `organization_domain.verification_failed` event](https://workos.com/docs/events/organization-domain).
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]

src/events/types/events/organization_domain_verified.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::organizations::OrganizationDomain;
+use crate::organization_domains::OrganizationDomain;
 
 /// [WorkOS Docs: `organization_domain.verified` event](https://workos.com/docs/events/organization-domain).
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]

src/lib.rs

@@ -9,6 +9,7 @@ mod workos;
 pub mod directory_sync;
 pub mod events;
 pub mod mfa;
+pub mod organization_domains;
 pub mod organizations;
 pub mod portal;
 pub mod roles;

src/organization_domains.rs

@@ -0,0 +1,25 @@
+//! A module for interacting with the WorkOS Organization Domains API.
+//!
+//! [WorkOS Docs: Domain Verification Guide](https://workos.com/docs/domain-verification/guide)
+
+mod operations;
+mod types;
+
+pub use operations::*;
+pub use types::*;
+
+use crate::WorkOs;
+
+/// Organization Domains.
+///
+/// [WorkOS Docs: Domain Verification Guide](https://workos.com/docs/domain-verification/guide)
+pub struct OrganizationDomains<'a> {
+    workos: &'a WorkOs,
+}
+
+impl<'a> OrganizationDomains<'a> {
+    /// Returns a new [`OrganizationDomains`] instance for the provided WorkOS client.
+    pub fn new(workos: &'a WorkOs) -> Self {
+        Self { workos }
+    }
+}

src/organization_domains/operations.rs

@@ -0,0 +1,9 @@
+mod create_organization_domain;
+mod delete_organization_domain;
+mod get_organization_domain;
+mod verify_organization_domain;
+
+pub use create_organization_domain::*;
+pub use delete_organization_domain::*;
+pub use get_organization_domain::*;
+pub use verify_organization_domain::*;

src/organization_domains/operations/create_organization_domain.rs

@@ -0,0 +1,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")
+        )
+    }
+}