vortex-python-sdk 0.4.0__tar.gz → 0.7.0__tar.gz

{vortex_python_sdk-0.4.0/src/vortex_python_sdk.egg-info → vortex_python_sdk-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.4.0
+Version: 0.7.0
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT

{vortex_python_sdk-0.4.0 → vortex_python_sdk-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortex-python-sdk"
-version = "0.4.0"
+version = "0.7.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.4.0 → vortex_python_sdk-0.7.0/src/vortex_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.4.0
+Version: 0.7.0
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT

{vortex_python_sdk-0.4.0 → vortex_python_sdk-0.7.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.4.0 → vortex_python_sdk-0.7.0}/src/vortex_sdk/types.py

@@ -131,6 +131,11 @@ class JwtPayload(BaseModel):
 class InvitationTarget(BaseModel):
     type: Literal["email", "phone", "share", "internal"]
     value: str
+    name: Optional[str] = None  # Display name of the person being invited
+    avatar_url: Optional[str] = Field(None, alias="avatarUrl")  # Avatar URL for the person being invited
+
+    class Config:
+        populate_by_name = True
 
 
 class AcceptUser(BaseModel):
@@ -215,6 +220,7 @@ class InvitationResult(BaseModel):
     metadata: Optional[Dict[str, Any]] = None
     pass_through: Optional[str] = Field(None, alias="passThrough")
     source: Optional[str] = None
+    subtype: Optional[str] = None  # Customer-defined subtype for analytics segmentation
     creator_name: Optional[str] = Field(None, alias="creatorName")
     creator_avatar_url: Optional[str] = Field(None, alias="creatorAvatarUrl")
 
@@ -281,6 +287,11 @@ class CreateInvitationTarget(BaseModel):
     """Target for creating an invitation"""
     type: Literal["email", "phone", "internal"]
     value: str
+    name: Optional[str] = None  # Display name of the person being invited
+    avatar_url: Optional[str] = Field(None, alias="avatarUrl")  # Avatar URL for the person being invited
+
+    class Config:
+        populate_by_name = True
 
 
 class Inviter(BaseModel):
@@ -331,6 +342,7 @@ class BackendCreateInvitationRequest(BaseModel):
     inviter: Inviter
     groups: Optional[List[CreateInvitationGroup]] = None
     source: Optional[str] = None
+    subtype: Optional[str] = None  # Customer-defined subtype for analytics segmentation (e.g., 'pymk', 'find-friends')
     template_variables: Optional[Dict[str, str]] = Field(None, alias="templateVariables")
     metadata: Optional[Dict[str, Any]] = None
     unfurl_config: Optional[UnfurlConfig] = Field(None, alias="unfurlConfig")
@@ -348,3 +360,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.4.0 → vortex_python_sdk-0.7.0}/src/vortex_sdk/vortex.py

@@ -13,7 +13,9 @@ logger = logging.getLogger(__name__)
 
 from .types import (
     AcceptUser,
+    AutojoinDomainsResponse,
     BackendCreateInvitationRequest,
+    ConfigureAutojoinRequest,
     CreateInvitationGroup,
     CreateInvitationResponse,
     CreateInvitationTarget,
@@ -781,6 +783,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()