vortex-python-sdk 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

{vortex_python_sdk-0.0.3.dist-info → vortex_python_sdk-0.0.5.dist-info}/METADATA

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

vortex_python_sdk-0.0.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+vortex_python_sdk-0.0.5.dist-info/licenses/LICENSE,sha256=VndlWxbL4-w3YDf2yE5gJscj4zVXF0qlSq0LDtay3lo,1074
+vortex_sdk/__init__.py,sha256=_39nOXzridOgUJS7MrGv6jt097egE44yVCm6ZkDbFMs,711
+vortex_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vortex_sdk/types.py,sha256=2YAqEjR5ttZjB1_JfOQWJuPekbc0F-vGlqu8t-jIeho,3344
+vortex_sdk/vortex.py,sha256=qvKWMcd1ISePtV3q8N8-BwBxRdbLQ7sG34nCnLtbpKc,15033
+vortex_python_sdk-0.0.5.dist-info/METADATA,sha256=k_glnwxag_W43RzWI6BJ6wU8NhpjR8GsLcXaK48wutk,6237
+vortex_python_sdk-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+vortex_python_sdk-0.0.5.dist-info/top_level.txt,sha256=xFDlEcXIIi_sBhkse0YfMnSdg2IlaYUd0oP2UCDc_Y0,11
+vortex_python_sdk-0.0.5.dist-info/RECORD,,

vortex_sdk/__init__.py

@@ -4,21 +4,21 @@ Vortex Python SDK
 A Python SDK for Vortex invitation management and JWT generation.
 """
 
-from .vortex import Vortex
 from .types import (
+    AcceptInvitationsRequest,
+    ApiResponse,
     AuthenticatedUser,
-    JwtPayload,
-    IdentifierInput,
+    CreateInvitationRequest,
     GroupInput,
-    InvitationTarget,
+    IdentifierInput,
     Invitation,
-    CreateInvitationRequest,
-    AcceptInvitationsRequest,
-    ApiResponse,
-    VortexApiError
+    InvitationTarget,
+    JwtPayload,
+    VortexApiError,
 )
+from .vortex import Vortex
 
-__version__ = "0.0.3"
+__version__ = "0.0.5"
 __author__ = "TeamVortexSoftware"
 __email__ = "support@vortexsoftware.com"
 
@@ -34,4 +34,4 @@ __all__ = [
     "AcceptInvitationsRequest",
     "ApiResponse",
     "VortexApiError",
-]
+]

vortex_sdk/types.py

@@ -1,18 +1,23 @@
-from typing import Dict, List, Optional, Union, Literal, Any
+from typing import Any, Dict, List, Literal, Optional, Union
+
 from pydantic import BaseModel, Field
 
 
 class IdentifierInput(BaseModel):
     """Identifier structure for JWT generation"""
+
     type: Literal["email", "sms"]
     value: str
 
 
 class GroupInput(BaseModel):
     """Group structure for JWT generation (input)"""
+
     type: str
     id: Optional[str] = None  # Legacy field (deprecated, use groupId)
-    groupId: Optional[str] = Field(None, alias="group_id", serialization_alias="groupId")  # Preferred: Customer's group ID
+    groupId: Optional[str] = Field(
+        None, alias="group_id", serialization_alias="groupId"
+    )  # Preferred: Customer's group ID
     name: str
 
     class Config:
@@ -24,12 +29,13 @@ class InvitationGroup(BaseModel):
     Invitation group from API responses
     This matches the MemberGroups table structure from the API
     """
+
     id: str  # Vortex internal UUID
-    account_id: str  # Vortex account ID (camelCase in JSON: accountId)
-    group_id: str  # Customer's group ID (camelCase in JSON: groupId)
+    account_id: str = Field(alias="accountId")  # Vortex account ID
+    group_id: str = Field(alias="groupId")  # Customer's group ID
     type: str  # Group type (e.g., "workspace", "team")
     name: str  # Group name
-    created_at: str  # ISO 8601 timestamp (camelCase in JSON: createdAt)
+    created_at: str = Field(alias="createdAt")  # ISO 8601 timestamp
 
     class Config:
         # Allow both snake_case (Python) and camelCase (JSON) field names
@@ -41,7 +47,7 @@ class InvitationGroup(BaseModel):
                 "groupId": "workspace-123",
                 "type": "workspace",
                 "name": "My Workspace",
-                "createdAt": "2025-01-27T12:00:00.000Z"
+                "createdAt": "2025-01-27T12:00:00.000Z",
             }
         }
 
@@ -68,14 +74,17 @@ class InvitationTarget(BaseModel):
 
 class Invitation(BaseModel):
     id: str
-    target: InvitationTarget
-    groups: Optional[List[InvitationGroup]] = None  # Full group information
+    target: Union[InvitationTarget, List[InvitationTarget]]  # API returns list or single
+    groups: Optional[List[Optional[InvitationGroup]]] = None  # Full group information, can contain None
     status: str
-    created_at: str
-    updated_at: Optional[str] = None
-    expires_at: Optional[str] = None
+    created_at: Optional[str] = Field(None, alias="createdAt")  # API uses camelCase
+    updated_at: Optional[str] = Field(None, alias="updatedAt")
+    expires_at: Optional[str] = Field(None, alias="expiresAt")
     metadata: Optional[Dict[str, Union[str, int, bool]]] = None
 
+    class Config:
+        populate_by_name = True
+
 
 class CreateInvitationRequest(BaseModel):
     target: InvitationTarget
@@ -100,4 +109,4 @@ class VortexApiError(Exception):
     def __init__(self, message: str, status_code: int = 500):
         self.message = message
         self.status_code = status_code
-        super().__init__(message)
+        super().__init__(message)

vortex_sdk/vortex.py

@@ -1,34 +1,44 @@
-import json
-import hmac
-import hashlib
 import base64
+import hashlib
+import hmac
+import json
 import time
 import uuid
-from typing import Dict, List, Optional, Union, Literal
+from typing import Dict, List, Literal, Optional, Union
 from urllib.parse import urlencode
+
 import httpx
+
 from .types import (
-    JwtPayload,
-    InvitationTarget,
-    Invitation,
-    CreateInvitationRequest,
     AcceptInvitationsRequest,
     ApiResponse,
-    VortexApiError
+    CreateInvitationRequest,
+    Invitation,
+    InvitationTarget,
+    JwtPayload,
+    VortexApiError,
 )
 
 
+def _get_version():
+    """Lazy import of version to avoid circular import"""
+    from . import __version__
+    return __version__
+
+
 class Vortex:
-    def __init__(self, api_key: str, base_url: str = "https://api.vortexsoftware.com"):
+    def __init__(
+        self, api_key: str, base_url: str = "https://api.vortexsoftware.com/api/v1"
+    ):
         """
         Initialize Vortex client
 
         Args:
             api_key: Your Vortex API key
-            base_url: Base URL for Vortex API (default: https://api.vortexsoftware.com)
+            base_url: Base URL for Vortex API (default: https://api.vortexsoftware.com/api/v1)
         """
         self.api_key = api_key
-        self.base_url = base_url.rstrip('/')
+        self.base_url = base_url.rstrip("/")
         self._client = httpx.AsyncClient()
         self._sync_client = httpx.Client()
 
@@ -49,20 +59,20 @@ class Vortex:
             payload = JwtPayload(**payload)
 
         # Parse API key (format: VRTX.base64url(uuid).key)
-        parts = self.api_key.split('.')
+        parts = self.api_key.split(".")
         if len(parts) != 3:
-            raise ValueError('Invalid API key format. Expected: VRTX.{encodedId}.{key}')
+            raise ValueError("Invalid API key format. Expected: VRTX.{encodedId}.{key}")
 
         prefix, encoded_id, key = parts
 
-        if prefix != 'VRTX':
-            raise ValueError('Invalid API key prefix. Expected: VRTX')
+        if prefix != "VRTX":
+            raise ValueError("Invalid API key prefix. Expected: VRTX")
 
         # Decode UUID from base64url
         # Add padding if needed
         padding = 4 - len(encoded_id) % 4
         if padding != 4:
-            encoded_id_padded = encoded_id + ('=' * padding)
+            encoded_id_padded = encoded_id + ("=" * padding)
         else:
             encoded_id_padded = encoded_id
 
@@ -70,75 +80,76 @@ class Vortex:
             uuid_bytes = base64.urlsafe_b64decode(encoded_id_padded)
             kid = str(uuid.UUID(bytes=uuid_bytes))
         except Exception as e:
-            raise ValueError(f'Invalid UUID in API key: {e}')
+            raise ValueError(f"Invalid UUID in API key: {e}")
 
         # Generate timestamps
         iat = int(time.time())
         expires = iat + 3600
 
         # Step 1: Derive signing key from API key + UUID
-        signing_key = hmac.new(
-            key.encode(),
-            kid.encode(),
-            hashlib.sha256
-        ).digest()
+        signing_key = hmac.new(key.encode(), kid.encode(), hashlib.sha256).digest()
 
         # Step 2: Build header + payload
         header = {
-            'iat': iat,
-            'alg': 'HS256',
-            'typ': 'JWT',
-            'kid': kid,
+            "iat": iat,
+            "alg": "HS256",
+            "typ": "JWT",
+            "kid": kid,
         }
 
         # Serialize identifiers
-        identifiers_list = [{"type": id.type, "value": id.value} for id in payload.identifiers]
+        identifiers_list = [
+            {"type": id.type, "value": id.value} for id in payload.identifiers
+        ]
 
         # Serialize groups
         groups_list = None
         if payload.groups is not None:
             groups_list = [
-                {k: v for k, v in group.model_dump(by_alias=True, exclude_none=True).items()}
+                {
+                    k: v
+                    for k, v in group.model_dump(
+                        by_alias=True, exclude_none=True
+                    ).items()
+                }
                 for group in payload.groups
             ]
 
         jwt_payload = {
-            'userId': payload.user_id,
-            'groups': groups_list,
-            'role': payload.role,
-            'expires': expires,
-            'identifiers': identifiers_list,
+            "userId": payload.user_id,
+            "groups": groups_list,
+            "role": payload.role,
+            "expires": expires,
+            "identifiers": identifiers_list,
         }
 
         # Add attributes if provided
-        if hasattr(payload, 'attributes') and payload.attributes:
-            jwt_payload['attributes'] = payload.attributes
+        if hasattr(payload, "attributes") and payload.attributes:
+            jwt_payload["attributes"] = payload.attributes
 
         # Step 3: Base64URL encode (without padding)
-        header_json = json.dumps(header, separators=(',', ':'))
-        payload_json = json.dumps(jwt_payload, separators=(',', ':'))
+        header_json = json.dumps(header, separators=(",", ":"))
+        payload_json = json.dumps(jwt_payload, separators=(",", ":"))
 
-        header_b64 = base64.urlsafe_b64encode(header_json.encode()).decode().rstrip('=')
-        payload_b64 = base64.urlsafe_b64encode(payload_json.encode()).decode().rstrip('=')
+        header_b64 = base64.urlsafe_b64encode(header_json.encode()).decode().rstrip("=")
+        payload_b64 = (
+            base64.urlsafe_b64encode(payload_json.encode()).decode().rstrip("=")
+        )
 
         # Step 4: Sign
-        to_sign = f'{header_b64}.{payload_b64}'
-        signature = hmac.new(
-            signing_key,
-            to_sign.encode(),
-            hashlib.sha256
-        ).digest()
+        to_sign = f"{header_b64}.{payload_b64}"
+        signature = hmac.new(signing_key, to_sign.encode(), hashlib.sha256).digest()
 
-        signature_b64 = base64.urlsafe_b64encode(signature).decode().rstrip('=')
+        signature_b64 = base64.urlsafe_b64encode(signature).decode().rstrip("=")
 
-        return f'{to_sign}.{signature_b64}'
+        return f"{to_sign}.{signature_b64}"
 
     async def _vortex_api_request(
         self,
         method: str,
         endpoint: str,
         data: Optional[Dict] = None,
-        params: Optional[Dict] = None
+        params: Optional[Dict] = None,
     ) -> Dict:
         """
         Make an API request to Vortex
@@ -157,26 +168,27 @@ class Vortex:
         """
         url = f"{self.base_url}{endpoint}"
         headers = {
-            "Authorization": f"Bearer {self.api_key}",
+            "x-api-key": f"{self.api_key}",
             "Content-Type": "application/json",
-            "User-Agent": "vortex-python-sdk/0.0.1"
+            "User-Agent": f"vortex-python-sdk/{_get_version()}",
         }
 
         try:
             response = await self._client.request(
-                method=method,
-                url=url,
-                json=data,
-                params=params,
-                headers=headers
+                method=method, url=url, json=data, params=params, headers=headers
             )
 
             if response.status_code >= 400:
                 try:
                     error_data = response.json()
-                    error_message = error_data.get('error', f'API request failed with status {response.status_code}')
+                    error_message = error_data.get(
+                        "error",
+                        f"API request failed with status {response.status_code}",
+                    )
                 except:
-                    error_message = f'API request failed with status {response.status_code}'
+                    error_message = (
+                        f"API request failed with status {response.status_code}"
+                    )
 
                 raise VortexApiError(error_message, response.status_code)
 
@@ -190,7 +202,7 @@ class Vortex:
         method: str,
         endpoint: str,
         data: Optional[Dict] = None,
-        params: Optional[Dict] = None
+        params: Optional[Dict] = None,
     ) -> Dict:
         """
         Make a synchronous API request to Vortex
@@ -209,26 +221,27 @@ class Vortex:
         """
         url = f"{self.base_url}{endpoint}"
         headers = {
-            "Authorization": f"Bearer {self.api_key}",
+            "x-api-key": f"{self.api_key}",
             "Content-Type": "application/json",
-            "User-Agent": "vortex-python-sdk/0.0.1"
+            "User-Agent": f"vortex-python-sdk/{_get_version()}",
         }
 
         try:
             response = self._sync_client.request(
-                method=method,
-                url=url,
-                json=data,
-                params=params,
-                headers=headers
+                method=method, url=url, json=data, params=params, headers=headers
             )
 
             if response.status_code >= 400:
                 try:
                     error_data = response.json()
-                    error_message = error_data.get('error', f'API request failed with status {response.status_code}')
+                    error_message = error_data.get(
+                        "error",
+                        f"API request failed with status {response.status_code}",
+                    )
                 except:
-                    error_message = f'API request failed with status {response.status_code}'
+                    error_message = (
+                        f"API request failed with status {response.status_code}"
+                    )
 
                 raise VortexApiError(error_message, response.status_code)
 
@@ -240,7 +253,7 @@ class Vortex:
     async def get_invitations_by_target(
         self,
         target_type: Literal["email", "username", "phoneNumber"],
-        target_value: str
+        target_value: str,
     ) -> List[Invitation]:
         """
         Get invitations for a specific target
@@ -252,18 +265,17 @@ class Vortex:
         Returns:
             List of invitations
         """
-        params = {
-            "targetType": target_type,
-            "targetValue": target_value
-        }
+        params = {"targetType": target_type, "targetValue": target_value}
 
-        response = await self._vortex_api_request("GET", "/invitations/by-target", params=params)
+        response = await self._vortex_api_request(
+            "GET", "/invitations/by-target", params=params
+        )
         return [Invitation(**inv) for inv in response.get("invitations", [])]
 
     def get_invitations_by_target_sync(
         self,
         target_type: Literal["email", "username", "phoneNumber"],
-        target_value: str
+        target_value: str,
     ) -> List[Invitation]:
         """
         Get invitations for a specific target (synchronous)
@@ -275,12 +287,11 @@ class Vortex:
         Returns:
             List of invitations
         """
-        params = {
-            "targetType": target_type,
-            "targetValue": target_value
-        }
+        params = {"targetType": target_type, "targetValue": target_value}
 
-        response = self._vortex_api_request_sync("GET", "/invitations/by-target", params=params)
+        response = self._vortex_api_request_sync(
+            "GET", "/invitations/by-target", params=params
+        )
         return [Invitation(**inv) for inv in response.get("invitations", [])]
 
     async def get_invitation(self, invitation_id: str) -> Invitation:
@@ -293,7 +304,9 @@ class Vortex:
         Returns:
             Invitation object
         """
-        response = await self._vortex_api_request("GET", f"/invitations/{invitation_id}")
+        response = await self._vortex_api_request(
+            "GET", f"/invitations/{invitation_id}"
+        )
         return Invitation(**response)
 
     def get_invitation_sync(self, invitation_id: str) -> Invitation:
@@ -310,9 +323,7 @@ class Vortex:
         return Invitation(**response)
 
     async def accept_invitations(
-        self,
-        invitation_ids: List[str],
-        target: Union[InvitationTarget, Dict[str, str]]
+        self, invitation_ids: List[str], target: Union[InvitationTarget, Dict[str, str]]
     ) -> Dict:
         """
         Accept multiple invitations
@@ -327,17 +338,12 @@ class Vortex:
         if isinstance(target, dict):
             target = InvitationTarget(**target)
 
-        data = {
-            "invitationIds": invitation_ids,
-            "target": target.model_dump()
-        }
+        data = {"invitationIds": invitation_ids, "target": target.model_dump()}
 
         return await self._vortex_api_request("POST", "/invitations/accept", data=data)
 
     def accept_invitations_sync(
-        self,
-        invitation_ids: List[str],
-        target: Union[InvitationTarget, Dict[str, str]]
+        self, invitation_ids: List[str], target: Union[InvitationTarget, Dict[str, str]]
     ) -> Dict:
         """
         Accept multiple invitations (synchronous)
@@ -352,10 +358,7 @@ class Vortex:
         if isinstance(target, dict):
             target = InvitationTarget(**target)
 
-        data = {
-            "invitationIds": invitation_ids,
-            "target": target.model_dump()
-        }
+        data = {"invitationIds": invitation_ids, "target": target.model_dump()}
 
         return self._vortex_api_request_sync("POST", "/invitations/accept", data=data)
 
@@ -384,9 +387,7 @@ class Vortex:
         return self._vortex_api_request_sync("DELETE", f"/invitations/{invitation_id}")
 
     async def get_invitations_by_group(
-        self,
-        group_type: str,
-        group_id: str
+        self, group_type: str, group_id: str
     ) -> List[Invitation]:
         """
         Get invitations for a specific group
@@ -398,13 +399,13 @@ class Vortex:
         Returns:
             List of invitations
         """
-        response = await self._vortex_api_request("GET", f"/invitations/by-group/{group_type}/{group_id}")
+        response = await self._vortex_api_request(
+            "GET", f"/invitations/by-group/{group_type}/{group_id}"
+        )
         return [Invitation(**inv) for inv in response.get("invitations", [])]
 
     def get_invitations_by_group_sync(
-        self,
-        group_type: str,
-        group_id: str
+        self, group_type: str, group_id: str
     ) -> List[Invitation]:
         """
         Get invitations for a specific group (synchronous)
@@ -416,14 +417,12 @@ class Vortex:
         Returns:
             List of invitations
         """
-        response = self._vortex_api_request_sync("GET", f"/invitations/by-group/{group_type}/{group_id}")
+        response = self._vortex_api_request_sync(
+            "GET", f"/invitations/by-group/{group_type}/{group_id}"
+        )
         return [Invitation(**inv) for inv in response.get("invitations", [])]
 
-    async def delete_invitations_by_group(
-        self,
-        group_type: str,
-        group_id: str
-    ) -> Dict:
+    async def delete_invitations_by_group(self, group_type: str, group_id: str) -> Dict:
         """
         Delete all invitations for a specific group
 
@@ -434,13 +433,11 @@ class Vortex:
         Returns:
             API response
         """
-        return await self._vortex_api_request("DELETE", f"/invitations/by-group/{group_type}/{group_id}")
+        return await self._vortex_api_request(
+            "DELETE", f"/invitations/by-group/{group_type}/{group_id}"
+        )
 
-    def delete_invitations_by_group_sync(
-        self,
-        group_type: str,
-        group_id: str
-    ) -> Dict:
+    def delete_invitations_by_group_sync(self, group_type: str, group_id: str) -> Dict:
         """
         Delete all invitations for a specific group (synchronous)
 
@@ -451,7 +448,9 @@ class Vortex:
         Returns:
             API response
         """
-        return self._vortex_api_request_sync("DELETE", f"/invitations/by-group/{group_type}/{group_id}")
+        return self._vortex_api_request_sync(
+            "DELETE", f"/invitations/by-group/{group_type}/{group_id}"
+        )
 
     async def reinvite(self, invitation_id: str) -> Invitation:
         """
@@ -463,7 +462,9 @@ class Vortex:
         Returns:
             Updated invitation object
         """
-        response = await self._vortex_api_request("POST", f"/invitations/{invitation_id}/reinvite")
+        response = await self._vortex_api_request(
+            "POST", f"/invitations/{invitation_id}/reinvite"
+        )
         return Invitation(**response)
 
     def reinvite_sync(self, invitation_id: str) -> Invitation:
@@ -476,7 +477,9 @@ class Vortex:
         Returns:
             Updated invitation object
         """
-        response = self._vortex_api_request_sync("POST", f"/invitations/{invitation_id}/reinvite")
+        response = self._vortex_api_request_sync(
+            "POST", f"/invitations/{invitation_id}/reinvite"
+        )
         return Invitation(**response)
 
     async def close(self):
@@ -501,4 +504,4 @@ class Vortex:
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         """Context manager exit"""
-        self.close_sync()
+        self.close_sync()

vortex_python_sdk-0.0.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-vortex_python_sdk-0.0.3.dist-info/licenses/LICENSE,sha256=VndlWxbL4-w3YDf2yE5gJscj4zVXF0qlSq0LDtay3lo,1074
-vortex_sdk/__init__.py,sha256=0Q9cyxYBvCQtLsKWJJu-lAjPFp5HCXnIYKtp6xYAYFA,709
-vortex_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vortex_sdk/types.py,sha256=Si5fXbf2gkcK3FoirJURNBBPLOJM090P5uhlHx6kXZQ,3079
-vortex_sdk/vortex.py,sha256=B7XAT8CAEJLEH5kxYF3KpMo4kAO_LwCBs8-VEBgC3cw,14754
-vortex_python_sdk-0.0.3.dist-info/METADATA,sha256=bACa6c5OMHoIwGBKC2oH8uNKVIdHmlIzzrHYnftqr5w,6237
-vortex_python_sdk-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vortex_python_sdk-0.0.3.dist-info/top_level.txt,sha256=xFDlEcXIIi_sBhkse0YfMnSdg2IlaYUd0oP2UCDc_Y0,11
-vortex_python_sdk-0.0.3.dist-info/RECORD,,