vortex-python-sdk 0.6.0__tar.gz → 0.9.0__tar.gz

{vortex_python_sdk-0.6.0/src/vortex_python_sdk.egg-info → vortex_python_sdk-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.6.0
+Version: 0.9.0
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT
@@ -123,21 +123,21 @@ async def get_user_invitations():
 invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
 ```
 
-#### Accept Invitations
+#### Accept an Invitation
 
 ```python
-async def accept_user_invitations():
+async def accept_user_invitation():
     # Async version
-    result = await vortex.accept_invitations(
-        invitation_ids=["inv1", "inv2"],
-        target={"type": "email", "value": "user@example.com"}
+    result = await vortex.accept_invitation(
+        invitation_id="inv-123",
+        user={"email": "user@example.com"}
     )
     print(f"Result: {result}")
 
 # Sync version
-result = vortex.accept_invitations_sync(
-    invitation_ids=["inv1", "inv2"],
-    target={"type": "email", "value": "user@example.com"}
+result = vortex.accept_invitation_sync(
+    invitation_id="inv-123",
+    user={"email": "user@example.com"}
 )
 ```
 

{vortex_python_sdk-0.6.0 → vortex_python_sdk-0.9.0}/README.md

@@ -85,21 +85,21 @@ async def get_user_invitations():
 invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
 ```
 
-#### Accept Invitations
+#### Accept an Invitation
 
 ```python
-async def accept_user_invitations():
+async def accept_user_invitation():
     # Async version
-    result = await vortex.accept_invitations(
-        invitation_ids=["inv1", "inv2"],
-        target={"type": "email", "value": "user@example.com"}
+    result = await vortex.accept_invitation(
+        invitation_id="inv-123",
+        user={"email": "user@example.com"}
     )
     print(f"Result: {result}")
 
 # Sync version
-result = vortex.accept_invitations_sync(
-    invitation_ids=["inv1", "inv2"],
-    target={"type": "email", "value": "user@example.com"}
+result = vortex.accept_invitation_sync(
+    invitation_id="inv-123",
+    user={"email": "user@example.com"}
 )
 ```
 

{vortex_python_sdk-0.6.0 → vortex_python_sdk-0.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortex-python-sdk"
-version = "0.6.0"
+version = "0.9.0"
 description = "Vortex Python SDK for invitation management and JWT generation"
 authors = [{name = "TeamVortexSoftware", email = "support@vortexsoftware.com"}]
 readme = "README.md"

{vortex_python_sdk-0.6.0 → vortex_python_sdk-0.9.0/src/vortex_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.6.0
+Version: 0.9.0
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT
@@ -123,21 +123,21 @@ async def get_user_invitations():
 invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
 ```
 
-#### Accept Invitations
+#### Accept an Invitation
 
 ```python
-async def accept_user_invitations():
+async def accept_user_invitation():
     # Async version
-    result = await vortex.accept_invitations(
-        invitation_ids=["inv1", "inv2"],
-        target={"type": "email", "value": "user@example.com"}
+    result = await vortex.accept_invitation(
+        invitation_id="inv-123",
+        user={"email": "user@example.com"}
     )
     print(f"Result: {result}")
 
 # Sync version
-result = vortex.accept_invitations_sync(
-    invitation_ids=["inv1", "inv2"],
-    target={"type": "email", "value": "user@example.com"}
+result = vortex.accept_invitation_sync(
+    invitation_id="inv-123",
+    user={"email": "user@example.com"}
 )
 ```
 

{vortex_python_sdk-0.6.0 → vortex_python_sdk-0.9.0}/src/vortex_sdk/__init__.py

@@ -11,6 +11,9 @@ from .types import (
     ApiResponse,
     ApiResponseJson,
     AuthenticatedUser,
+    AutojoinDomain,
+    AutojoinDomainsResponse,
+    ConfigureAutojoinRequest,
     CreateInvitationRequest,
     GroupInput,
     IdentifierInput,
@@ -24,7 +27,7 @@ from .types import (
 )
 from .vortex import Vortex
 
-__version__ = "0.0.6"
+__version__ = "0.7.0"
 __author__ = "TeamVortexSoftware"
 __email__ = "support@vortexsoftware.com"
 
@@ -42,6 +45,9 @@ __all__ = [
     "CreateInvitationRequest",
     "AcceptInvitationRequest",
     "AcceptInvitationsRequest",  # Alias for AcceptInvitationRequest
+    "AutojoinDomain",
+    "AutojoinDomainsResponse",
+    "ConfigureAutojoinRequest",
     "ApiResponse",
     "ApiResponseJson",
     "ApiRequestBody",

{vortex_python_sdk-0.6.0 → vortex_python_sdk-0.9.0}/src/vortex_sdk/types.py

@@ -64,6 +64,8 @@ class User(BaseModel):
     - user_name: User's display name
     - user_avatar_url: User's avatar URL (must be HTTPS, max 2000 chars)
     - admin_scopes: List of admin scopes (e.g., ['autojoin'])
+    - allowed_email_domains: List of allowed email domains for invitation restrictions
+                            (e.g., ['acme.com', 'acme.org'])
 
     Additional fields are allowed via extra parameter
     """
@@ -72,9 +74,11 @@ class User(BaseModel):
     user_name: Optional[str] = Field(None, alias="userName")
     user_avatar_url: Optional[str] = Field(None, alias="userAvatarUrl")
     admin_scopes: Optional[List[str]] = None
+    allowed_email_domains: Optional[List[str]] = Field(None, alias="allowedEmailDomains")
 
     class Config:
         extra = "allow"  # Allow additional fields
+        populate_by_name = True
 
 
 class AuthenticatedUser(BaseModel):
@@ -360,3 +364,33 @@ class CreateInvitationResponse(BaseModel):
 
     class Config:
         populate_by_name = True
+
+
+# --- Types for autojoin domain management ---
+
+class AutojoinDomain(BaseModel):
+    """Autojoin domain configuration"""
+    id: str
+    domain: str
+
+
+class AutojoinDomainsResponse(BaseModel):
+    """Response from autojoin API endpoints"""
+    autojoin_domains: List[AutojoinDomain] = Field(alias="autojoinDomains")
+    invitation: Optional[InvitationResult] = None
+
+    class Config:
+        populate_by_name = True
+
+
+class ConfigureAutojoinRequest(BaseModel):
+    """Request body for configuring autojoin domains"""
+    scope: str
+    scope_type: str = Field(alias="scopeType")
+    scope_name: Optional[str] = Field(None, alias="scopeName")
+    domains: List[str]
+    widget_id: str = Field(alias="widgetId")
+    metadata: Optional[Dict[str, Any]] = None
+
+    class Config:
+        populate_by_name = True

{vortex_python_sdk-0.6.0 → vortex_python_sdk-0.9.0}/src/vortex_sdk/vortex.py

@@ -13,7 +13,9 @@ logger = logging.getLogger(__name__)
 
 from .types import (
     AcceptUser,
+    AutojoinDomainsResponse,
     BackendCreateInvitationRequest,
+    ConfigureAutojoinRequest,
     CreateInvitationGroup,
     CreateInvitationResponse,
     CreateInvitationTarget,
@@ -138,6 +140,10 @@ class Vortex:
         if user.admin_scopes:
             jwt_payload["adminScopes"] = user.admin_scopes
 
+        # Add allowedEmailDomains if present (for domain-restricted invitations)
+        if user.allowed_email_domains:
+            jwt_payload["allowedEmailDomains"] = user.allowed_email_domains
+
         # Add any additional properties from user.model_extra
         if hasattr(user, "model_extra") and user.model_extra:
             jwt_payload.update(user.model_extra)
@@ -442,6 +448,58 @@ class Vortex:
 
         return await self._vortex_api_request("POST", "/invitations/accept", data=data)
 
+    async def accept_invitation(
+        self,
+        invitation_id: str,
+        user: Union[AcceptUser, Dict[str, Any]],
+    ) -> Dict:
+        """
+        Accept a single invitation (recommended method)
+
+        This is the recommended method for accepting invitations.
+
+        Args:
+            invitation_id: Single invitation ID to accept
+            user: User object with email/phone/name
+
+        Returns:
+            API response
+
+        Example:
+            user = AcceptUser(email="user@example.com", name="John Doe")
+            result = await client.accept_invitation("inv-123", user)
+
+            # Or with a dict:
+            result = await client.accept_invitation("inv-123", {"email": "user@example.com"})
+        """
+        return await self.accept_invitations([invitation_id], user)
+
+    def accept_invitation_sync(
+        self,
+        invitation_id: str,
+        user: Union[AcceptUser, Dict[str, Any]],
+    ) -> Dict:
+        """
+        Accept a single invitation (synchronous, recommended method)
+
+        This is the recommended method for accepting invitations.
+
+        Args:
+            invitation_id: Single invitation ID to accept
+            user: User object with email/phone/name
+
+        Returns:
+            API response
+
+        Example:
+            user = AcceptUser(email="user@example.com", name="John Doe")
+            result = client.accept_invitation_sync("inv-123", user)
+
+            # Or with a dict:
+            result = client.accept_invitation_sync("inv-123", {"email": "user@example.com"})
+        """
+        return self.accept_invitations_sync([invitation_id], user)
+
     def accept_invitations_sync(
         self,
         invitation_ids: List[str],
@@ -781,6 +839,160 @@ class Vortex:
         )
         return CreateInvitationResponse(**response)
 
+    async def get_autojoin_domains(
+        self, scope_type: str, scope: str
+    ) -> AutojoinDomainsResponse:
+        """
+        Get autojoin domains configured for a specific scope
+
+        Args:
+            scope_type: The type of scope (e.g., "organization", "team", "project")
+            scope: The scope identifier (customer's group ID)
+
+        Returns:
+            AutojoinDomainsResponse with autojoin_domains and associated invitation
+
+        Example:
+            result = await vortex.get_autojoin_domains("organization", "acme-org")
+            print(result.autojoin_domains)  # [AutojoinDomain(id='...', domain='acme.com')]
+        """
+        from urllib.parse import quote
+
+        response = await self._vortex_api_request(
+            "GET",
+            f"/invitations/by-scope/{quote(scope_type, safe='')}/{quote(scope, safe='')}/autojoin",
+        )
+        return AutojoinDomainsResponse(**response)
+
+    def get_autojoin_domains_sync(
+        self, scope_type: str, scope: str
+    ) -> AutojoinDomainsResponse:
+        """
+        Get autojoin domains configured for a specific scope (synchronous)
+
+        Args:
+            scope_type: The type of scope (e.g., "organization", "team", "project")
+            scope: The scope identifier (customer's group ID)
+
+        Returns:
+            AutojoinDomainsResponse with autojoin_domains and associated invitation
+
+        Example:
+            result = vortex.get_autojoin_domains_sync("organization", "acme-org")
+            print(result.autojoin_domains)  # [AutojoinDomain(id='...', domain='acme.com')]
+        """
+        from urllib.parse import quote
+
+        response = self._vortex_api_request_sync(
+            "GET",
+            f"/invitations/by-scope/{quote(scope_type, safe='')}/{quote(scope, safe='')}/autojoin",
+        )
+        return AutojoinDomainsResponse(**response)
+
+    async def configure_autojoin(
+        self,
+        scope: str,
+        scope_type: str,
+        domains: List[str],
+        widget_id: str,
+        scope_name: Optional[str] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> AutojoinDomainsResponse:
+        """
+        Configure autojoin domains for a specific scope
+
+        This endpoint syncs autojoin domains - it will add new domains, remove domains
+        not in the provided list, and deactivate the autojoin invitation if all domains
+        are removed (empty array).
+
+        Args:
+            scope: The scope identifier (customer's group ID)
+            scope_type: The type of scope (e.g., "organization", "team")
+            domains: Array of domains to configure for autojoin
+            widget_id: The widget configuration ID
+            scope_name: Optional display name for the scope
+            metadata: Optional metadata to attach to the invitation
+
+        Returns:
+            AutojoinDomainsResponse with updated autojoin_domains and associated invitation
+
+        Example:
+            result = await vortex.configure_autojoin(
+                scope="acme-org",
+                scope_type="organization",
+                domains=["acme.com", "acme.org"],
+                widget_id="widget-123",
+                scope_name="Acme Corporation",
+            )
+        """
+        request = ConfigureAutojoinRequest(
+            scope=scope,
+            scope_type=scope_type,
+            domains=domains,
+            widget_id=widget_id,
+            scope_name=scope_name,
+            metadata=metadata,
+        )
+
+        response = await self._vortex_api_request(
+            "POST",
+            "/invitations/autojoin",
+            data=request.model_dump(by_alias=True, exclude_none=True),
+        )
+        return AutojoinDomainsResponse(**response)
+
+    def configure_autojoin_sync(
+        self,
+        scope: str,
+        scope_type: str,
+        domains: List[str],
+        widget_id: str,
+        scope_name: Optional[str] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> AutojoinDomainsResponse:
+        """
+        Configure autojoin domains for a specific scope (synchronous)
+
+        This endpoint syncs autojoin domains - it will add new domains, remove domains
+        not in the provided list, and deactivate the autojoin invitation if all domains
+        are removed (empty array).
+
+        Args:
+            scope: The scope identifier (customer's group ID)
+            scope_type: The type of scope (e.g., "organization", "team")
+            domains: Array of domains to configure for autojoin
+            widget_id: The widget configuration ID
+            scope_name: Optional display name for the scope
+            metadata: Optional metadata to attach to the invitation
+
+        Returns:
+            AutojoinDomainsResponse with updated autojoin_domains and associated invitation
+
+        Example:
+            result = vortex.configure_autojoin_sync(
+                scope="acme-org",
+                scope_type="organization",
+                domains=["acme.com", "acme.org"],
+                widget_id="widget-123",
+                scope_name="Acme Corporation",
+            )
+        """
+        request = ConfigureAutojoinRequest(
+            scope=scope,
+            scope_type=scope_type,
+            domains=domains,
+            widget_id=widget_id,
+            scope_name=scope_name,
+            metadata=metadata,
+        )
+
+        response = self._vortex_api_request_sync(
+            "POST",
+            "/invitations/autojoin",
+            data=request.model_dump(by_alias=True, exclude_none=True),
+        )
+        return AutojoinDomainsResponse(**response)
+
     async def close(self) -> None:
         """Close the HTTP client"""
         await self._client.aclose()