refactor(portal): update fields and types (#161)

Author: DanielleHuisman

src/lib.rs

@@ -6,12 +6,12 @@ mod core;
 mod known_or_unknown;
 mod workos;
 
-pub mod admin_portal;
 pub mod directory_sync;
 pub mod events;
 pub mod mfa;
 pub mod organizations;
 pub mod passwordless;
+pub mod portal;
 pub mod roles;
 pub mod sso;
 pub mod user_management;

src/admin_portal.rs src/portal.rssrc/admin_portal.rs renamed to src/portal.rs

@@ -3,19 +3,21 @@
 //! [WorkOS Docs: Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
 
 mod operations;
+mod types;
 
 pub use operations::*;
+pub use types::*;
 
 use crate::WorkOs;
 
 /// Admin Portal.
 ///
 /// [WorkOS Docs: Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
-pub struct AdminPortal<'a> {
+pub struct Portal<'a> {
     workos: &'a WorkOs,
 }
 
-impl<'a> AdminPortal<'a> {
+impl<'a> Portal<'a> {
     /// Returns a new [`AdminPortal`] instance for the provided WorkOS client.
     pub fn new(workos: &'a WorkOs) -> Self {
         Self { workos }

src/admin_portal/operations.rs src/portal/operations.rssrc/admin_portal/operations.rs renamed to src/portal/operations.rs

@@ -1,54 +1,33 @@
 use async_trait::async_trait;
 use serde::{Deserialize, Serialize};
 
-use crate::admin_portal::AdminPortal;
 use crate::organizations::OrganizationId;
+use crate::portal::{GeneratePortalLinkIntent, Portal};
 use crate::{ResponseExt, WorkOsResult};
 
-/// The intent of an Admin Portal session.
-#[derive(Clone, Copy, Debug, Serialize)]
-#[serde(rename_all = "snake_case")]
-pub enum AdminPortalIntent {
-    /// The Admin Portal will be used to setup Single Sign-On (SSO).
-    Sso,
-
-    /// The Admin Portal wil be used to setup Directory Sync.
-    #[serde(rename = "dsync")]
-    DirectorySync,
-}
-
-/// The target of the Admin Portal.
-#[derive(Debug, Serialize)]
-#[serde(untagged, rename_all = "snake_case")]
-pub enum AdminPortalTarget {
-    /// The Admin Portal session should target an organization.
-    Organization {
-        /// The ID of the organization.
-        #[serde(rename = "organization")]
-        organization_id: OrganizationId,
-
-        /// The intent of the Admin Portal session.
-        intent: AdminPortalIntent,
-    },
-}
-
 /// The parameters for [`GeneratePortalLink`].
 #[derive(Debug, Serialize)]
 pub struct GeneratePortalLinkParams<'a> {
-    /// The target of the Admin Portal.
-    #[serde(flatten)]
-    pub target: &'a AdminPortalTarget,
+    /// The ID of the organization.
+    #[serde(rename = "organization")]
+    pub organization_id: &'a OrganizationId,
+
+    /// The intent of the Admin Portal.
+    pub intent: GeneratePortalLinkIntent,
+
+    /// The URL to go to when an admin clicks on your logo in the Admin Portal.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub return_url: Option<&'a str>,
 
-    /// The URL to which the Admin Portal should send users when they click on the link
-    /// to return to your application.
+    /// The URL to redirect the admin to when they finish setup.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub return_url: Option<String>,
+    pub success_url: Option<&'a str>,
 }
 
 /// The response for [`GeneratePortalLink`].
 #[derive(Debug, Deserialize)]
 pub struct GeneratePortalLinkResponse {
-    /// The generate Admin Portal link.
+    /// An ephemeral link to initiate the Admin Portal.
     pub link: String,
 }
 
@@ -59,29 +38,28 @@ pub enum GeneratePortalLinkError {}
 /// [WorkOS Docs: Generate a Portal Link](https://workos.com/docs/reference/admin-portal/portal-link/generate)
 #[async_trait]
 pub trait GeneratePortalLink {
-    /// Generates an Admin Portal link.
+    /// Generate a Portal Link scoped to an Organization.
     ///
     /// [WorkOS Docs: Generate a Portal Link](https://workos.com/docs/reference/admin-portal/portal-link/generate)
     ///
     /// # Examples
     ///
     /// ```
     /// # use workos::WorkOsResult;
-    /// # use workos::admin_portal::*;
     /// # use workos::organizations::OrganizationId;
+    /// # use workos::portal::*;
     /// use workos::{ApiKey, WorkOs};
     ///
     /// # async fn run() -> WorkOsResult<(), GeneratePortalLinkError> {
     /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
     ///
     /// let GeneratePortalLinkResponse { link } = workos
-    ///     .admin_portal()
+    ///     .portal()
     ///     .generate_portal_link(&GeneratePortalLinkParams {
-    ///         target: &AdminPortalTarget::Organization {
-    ///             organization_id: OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"),
-    ///             intent: AdminPortalIntent::Sso,
-    ///         },
+    ///         organization_id: &OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"),
+    ///         intent: GeneratePortalLinkIntent::Sso,
     ///         return_url: None,
+    ///         success_url: None,
     ///     })
     ///     .await?;
     /// # Ok(())
@@ -94,13 +72,13 @@ pub trait GeneratePortalLink {
 }
 
 #[async_trait]
-impl GeneratePortalLink for AdminPortal<'_> {
+impl GeneratePortalLink for Portal<'_> {
     async fn generate_portal_link(
         &self,
         params: &GeneratePortalLinkParams<'_>,
     ) -> WorkOsResult<GeneratePortalLinkResponse, GeneratePortalLinkError> {
         let url = self.workos.base_url().join("/portal/generate_link")?;
-        let generate_link_response = self
+        let response = self
             .workos
             .client()
             .post(url)
@@ -113,12 +91,13 @@ impl GeneratePortalLink for AdminPortal<'_> {
             .json::<GeneratePortalLinkResponse>()
             .await?;
 
-        Ok(generate_link_response)
+        Ok(response)
     }
 }
 
 #[cfg(test)]
 mod test {
+    use mockito::Matcher;
     use serde_json::json;
     use tokio;
 
@@ -136,33 +115,34 @@ mod test {
             .unwrap()
             .build();
 
-        server.mock("POST", "/portal/generate_link")
+        server
+            .mock("POST", "/portal/generate_link")
             .match_header("Authorization", "Bearer sk_example_123456789")
-            .match_body(r#"{"organization":"org_01EHZNVPK3SFK441A1RGBFSHRT","intent":"sso"}"#)
+            .match_body(Matcher::Json(json!({
+                "organization": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                "intent": "sso",
+            })))
             .with_status(201)
             .with_body(
                 json!({
-                    "link": "https://setup.workos.com/portal/launch?secret=JteZqfJZqUcgWGaYCC6iI0gW0"
+                    "link": "https://setup.workos.com?token=token"
                 })
                 .to_string(),
             )
-            .create_async().await;
+            .create_async()
+            .await;
 
         let GeneratePortalLinkResponse { link } = workos
-            .admin_portal()
+            .portal()
             .generate_portal_link(&GeneratePortalLinkParams {
-                target: &AdminPortalTarget::Organization {
-                    organization_id: OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"),
-                    intent: AdminPortalIntent::Sso,
-                },
+                organization_id: &OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"),
+                intent: GeneratePortalLinkIntent::Sso,
                 return_url: None,
+                success_url: None,
             })
             .await
             .unwrap();
 
-        assert_eq!(
-            link,
-            "https://setup.workos.com/portal/launch?secret=JteZqfJZqUcgWGaYCC6iI0gW0".to_string()
-        )
+        assert_eq!(link, "https://setup.workos.com?token=token".to_string())
     }
 }

…ortal/operations/generate_portal_link.rs …ortal/operations/generate_portal_link.rssrc/admin_portal/operations/generate_portal_link.rs renamed to src/portal/operations/generate_portal_link.rs src/admin_portal/operations/generate_portal_link.rs renamed to src/portal/operations/generate_portal_link.rs

@@ -0,0 +1,3 @@
+mod generate_portal_link_intent;
+
+pub use generate_portal_link_intent::*;

src/portal/types.rs

@@ -0,0 +1,25 @@
+use serde::Serialize;
+
+/// The intent of the Admin Portal.
+#[derive(Clone, Copy, Debug, Serialize)]
+#[serde(rename_all = "snake_case")]
+pub enum GeneratePortalLinkIntent {
+    /// Launch Admin Portal for creating SSO connections
+    Sso,
+
+    /// Launch Admin Portal for creating Directory Sync connections
+    #[serde(rename = "dsync")]
+    DirectorySync,
+
+    /// Launch Admin Portal for viewing Audit Logs
+    AuditLogs,
+
+    /// Launch Admin Portal for creating Log Streams
+    LogStreams,
+
+    /// Launch Admin Portal for Domain Verification.
+    DomainVerification,
+
+    /// Launch Admin Portal for renewing SAML Certificates.
+    CertificateRenewal,
+}

src/portal/types/generate_portal_link_intent.rs

@@ -1,12 +1,12 @@
 use url::{ParseError, Url};
 
 use crate::ApiKey;
-use crate::admin_portal::AdminPortal;
 use crate::directory_sync::DirectorySync;
 use crate::events::Events;
 use crate::mfa::Mfa;
 use crate::organizations::Organizations;
 use crate::passwordless::Passwordless;
+use crate::portal::Portal;
 use crate::roles::Roles;
 use crate::sso::Sso;
 use crate::user_management::UserManagement;
@@ -42,11 +42,6 @@ impl WorkOs {
         &self.client
     }
 
-    /// Returns an [`AdminPortal`] instance.
-    pub fn admin_portal(&self) -> AdminPortal<'_> {
-        AdminPortal::new(self)
-    }
-
     /// Returns a [`DirectorySync`] instance.
     pub fn directory_sync(&self) -> DirectorySync<'_> {
         DirectorySync::new(self)
@@ -72,6 +67,11 @@ impl WorkOs {
         Passwordless::new(self)
     }
 
+    /// Returns an [`AdminPortal`] instance.
+    pub fn portal(&self) -> Portal<'_> {
+        Portal::new(self)
+    }
+
     /// Returns an [`Roles`] instance.
     pub fn roles(&self) -> Roles<'_> {
         Roles::new(self)