vortex-python-sdk 0.0.1__tar.gz → 0.0.2__tar.gz

{vortex_python_sdk-0.0.1 → vortex_python_sdk-0.0.2}/CHANGELOG.md

@@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.2] - 2025-01-31
+
+### Fixed
+- **BREAKING FIX**: JWT payload format now matches TypeScript SDK
+  - `identifiers` changed from `Dict[str, str]` to `List[Dict]` with `type` and `value` fields
+  - `groups` structure now properly includes `type`, `id`/`groupId`, and `name` fields
+  - Added `IdentifierInput` type for type-safe identifier creation
+  - Updated `GroupInput` to support both `id` (legacy) and `groupId` (preferred) with proper camelCase serialization
+- Updated documentation with correct JWT generation examples
+
+### Migration Guide
+If you're upgrading from 0.0.1, update your JWT generation code:
+
+**Before (0.0.1):**
+```python
+jwt = vortex.generate_jwt({
+    "user_id": "user-123",
+    "identifiers": {"email": "user@example.com"},  # Dict
+    "groups": ["admin"],  # List of strings
+})
+```
+
+**After (0.0.2):**
+```python
+jwt = vortex.generate_jwt({
+    "user_id": "user-123",
+    "identifiers": [{"type": "email", "value": "user@example.com"}],  # List of dicts
+    "groups": [{"type": "team", "id": "team-1", "name": "Engineering"}],  # List of objects
+})
+```
+
 ## [0.0.1] - 2024-10-10
 
 ### Added

{vortex_python_sdk-0.0.1/src/vortex_python_sdk.egg-info → vortex_python_sdk-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.0.1
+Version: 0.0.2
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT
@@ -67,16 +67,33 @@ vortex = Vortex(api_key="your-api-key", base_url="https://custom-api.example.com
 ```python
 # Generate JWT for a user
 jwt = vortex.generate_jwt({
-    "user_id": "user123",
-    "identifiers": {
-        "email": "user@example.com",
-        "username": "johndoe"
-    },
-    "groups": ["admin", "users"],
+    "user_id": "user-123",
+    "identifiers": [
+        {"type": "email", "value": "user@example.com"}
+    ],
+    "groups": [
+        {"type": "team", "id": "team-1", "name": "Engineering"}
+    ],
     "role": "admin"
 })
 
 print(f"JWT: {jwt}")
+
+# Or using type-safe models
+from vortex_sdk import JwtPayload, IdentifierInput, GroupInput
+
+jwt = vortex.generate_jwt(
+    JwtPayload(
+        user_id="user-123",
+        identifiers=[
+            IdentifierInput(type="email", value="user@example.com")
+        ],
+        groups=[
+            GroupInput(type="team", id="team-1", name="Engineering")
+        ],
+        role="admin"
+    )
+)
 ```
 
 ### Invitation Management

{vortex_python_sdk-0.0.1 → vortex_python_sdk-0.0.2}/README.md

@@ -29,16 +29,33 @@ vortex = Vortex(api_key="your-api-key", base_url="https://custom-api.example.com
 ```python
 # Generate JWT for a user
 jwt = vortex.generate_jwt({
-    "user_id": "user123",
-    "identifiers": {
-        "email": "user@example.com",
-        "username": "johndoe"
-    },
-    "groups": ["admin", "users"],
+    "user_id": "user-123",
+    "identifiers": [
+        {"type": "email", "value": "user@example.com"}
+    ],
+    "groups": [
+        {"type": "team", "id": "team-1", "name": "Engineering"}
+    ],
     "role": "admin"
 })
 
 print(f"JWT: {jwt}")
+
+# Or using type-safe models
+from vortex_sdk import JwtPayload, IdentifierInput, GroupInput
+
+jwt = vortex.generate_jwt(
+    JwtPayload(
+        user_id="user-123",
+        identifiers=[
+            IdentifierInput(type="email", value="user@example.com")
+        ],
+        groups=[
+            GroupInput(type="team", id="team-1", name="Engineering")
+        ],
+        role="admin"
+    )
+)
 ```
 
 ### Invitation Management

{vortex_python_sdk-0.0.1 → vortex_python_sdk-0.0.2}/pyproject.toml

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

{vortex_python_sdk-0.0.1 → vortex_python_sdk-0.0.2/src/vortex_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.0.1
+Version: 0.0.2
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT
@@ -67,16 +67,33 @@ vortex = Vortex(api_key="your-api-key", base_url="https://custom-api.example.com
 ```python
 # Generate JWT for a user
 jwt = vortex.generate_jwt({
-    "user_id": "user123",
-    "identifiers": {
-        "email": "user@example.com",
-        "username": "johndoe"
-    },
-    "groups": ["admin", "users"],
+    "user_id": "user-123",
+    "identifiers": [
+        {"type": "email", "value": "user@example.com"}
+    ],
+    "groups": [
+        {"type": "team", "id": "team-1", "name": "Engineering"}
+    ],
     "role": "admin"
 })
 
 print(f"JWT: {jwt}")
+
+# Or using type-safe models
+from vortex_sdk import JwtPayload, IdentifierInput, GroupInput
+
+jwt = vortex.generate_jwt(
+    JwtPayload(
+        user_id="user-123",
+        identifiers=[
+            IdentifierInput(type="email", value="user@example.com")
+        ],
+        groups=[
+            GroupInput(type="team", id="team-1", name="Engineering")
+        ],
+        role="admin"
+    )
+)
 ```
 
 ### Invitation Management

{vortex_python_sdk-0.0.1 → vortex_python_sdk-0.0.2}/src/vortex_sdk/__init__.py

@@ -8,6 +8,8 @@ from .vortex import Vortex
 from .types import (
     AuthenticatedUser,
     JwtPayload,
+    IdentifierInput,
+    GroupInput,
     InvitationTarget,
     Invitation,
     CreateInvitationRequest,
@@ -16,7 +18,7 @@ from .types import (
     VortexApiError
 )
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 __author__ = "TeamVortexSoftware"
 __email__ = "support@vortexsoftware.com"
 
@@ -24,6 +26,8 @@ __all__ = [
     "Vortex",
     "AuthenticatedUser",
     "JwtPayload",
+    "IdentifierInput",
+    "GroupInput",
     "InvitationTarget",
     "Invitation",
     "CreateInvitationRequest",

vortex_python_sdk-0.0.2/src/vortex_sdk/types.py

@@ -0,0 +1,102 @@
+from typing import Dict, List, Optional, Union, Literal
+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
+    name: str
+
+    class Config:
+        populate_by_name = True
+
+
+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)
+    type: str  # Group type (e.g., "workspace", "team")
+    name: str  # Group name
+    created_at: str  # ISO 8601 timestamp (camelCase in JSON: createdAt)
+
+    class Config:
+        # Allow both snake_case (Python) and camelCase (JSON) field names
+        populate_by_name = True
+        json_schema_extra = {
+            "example": {
+                "id": "550e8400-e29b-41d4-a716-446655440000",
+                "accountId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
+                "groupId": "workspace-123",
+                "type": "workspace",
+                "name": "My Workspace",
+                "createdAt": "2025-01-27T12:00:00.000Z"
+            }
+        }
+
+
+class AuthenticatedUser(BaseModel):
+    user_id: str
+    identifiers: List[IdentifierInput]
+    groups: Optional[List[GroupInput]] = None
+    role: Optional[str] = None
+
+
+class JwtPayload(BaseModel):
+    user_id: str
+    identifiers: List[IdentifierInput]
+    groups: Optional[List[GroupInput]] = None
+    role: Optional[str] = None
+
+
+class InvitationTarget(BaseModel):
+    type: Literal["email", "username", "phoneNumber"]
+    value: str
+
+
+class Invitation(BaseModel):
+    id: str
+    target: InvitationTarget
+    groups: Optional[List[InvitationGroup]] = None  # Full group information
+    status: str
+    created_at: str
+    updated_at: Optional[str] = None
+    expires_at: Optional[str] = None
+    metadata: Optional[Dict[str, Union[str, int, bool]]] = None
+
+
+class CreateInvitationRequest(BaseModel):
+    target: InvitationTarget
+    group_type: Optional[str] = None
+    group_id: Optional[str] = None
+    expires_at: Optional[str] = None
+    metadata: Optional[Dict[str, Union[str, int, bool]]] = None
+
+
+class AcceptInvitationsRequest(BaseModel):
+    invitation_ids: List[str]
+    target: InvitationTarget
+
+
+class ApiResponse(BaseModel):
+    data: Optional[Dict] = None
+    error: Optional[str] = None
+    status_code: int = 200
+
+
+class VortexApiError(Exception):
+    def __init__(self, message: str, status_code: int = 500):
+        self.message = message
+        self.status_code = status_code
+        super().__init__(message)

{vortex_python_sdk-0.0.1 → vortex_python_sdk-0.0.2}/src/vortex_sdk/vortex.py

@@ -49,14 +49,18 @@ class Vortex:
             "typ": "JWT"
         }
 
-        # JWT Payload
+        # JWT Payload - serialize identifiers and groups to dicts
         jwt_payload = {
             "userId": payload.user_id,
-            "identifiers": payload.identifiers,
+            "identifiers": [{"type": id.type, "value": id.value} for id in payload.identifiers],
         }
 
         if payload.groups is not None:
-            jwt_payload["groups"] = payload.groups
+            # Serialize groups, using model_dump to handle camelCase conversion
+            jwt_payload["groups"] = [
+                {k: v for k, v in group.model_dump(by_alias=True, exclude_none=True).items()}
+                for group in payload.groups
+            ]
         if payload.role is not None:
             jwt_payload["role"] = payload.role
 

vortex_python_sdk-0.0.1/src/vortex_sdk/types.py

@@ -1,59 +0,0 @@
-from typing import Dict, List, Optional, Union, Literal
-from pydantic import BaseModel
-
-
-class AuthenticatedUser(BaseModel):
-    user_id: str
-    identifiers: Dict[str, str]
-    groups: Optional[List[str]] = None
-    role: Optional[str] = None
-
-
-class JwtPayload(BaseModel):
-    user_id: str
-    identifiers: Dict[str, str]
-    groups: Optional[List[str]] = None
-    role: Optional[str] = None
-
-
-class InvitationTarget(BaseModel):
-    type: Literal["email", "username", "phoneNumber"]
-    value: str
-
-
-class Invitation(BaseModel):
-    id: str
-    target: InvitationTarget
-    group_type: Optional[str] = None
-    group_id: Optional[str] = None
-    status: str
-    created_at: str
-    updated_at: Optional[str] = None
-    expires_at: Optional[str] = None
-    metadata: Optional[Dict[str, Union[str, int, bool]]] = None
-
-
-class CreateInvitationRequest(BaseModel):
-    target: InvitationTarget
-    group_type: Optional[str] = None
-    group_id: Optional[str] = None
-    expires_at: Optional[str] = None
-    metadata: Optional[Dict[str, Union[str, int, bool]]] = None
-
-
-class AcceptInvitationsRequest(BaseModel):
-    invitation_ids: List[str]
-    target: InvitationTarget
-
-
-class ApiResponse(BaseModel):
-    data: Optional[Dict] = None
-    error: Optional[str] = None
-    status_code: int = 200
-
-
-class VortexApiError(Exception):
-    def __init__(self, message: str, status_code: int = 500):
-        self.message = message
-        self.status_code = status_code
-        super().__init__(message)