vortex-python-sdk 0.0.5__tar.gz → 0.0.6__tar.gz

{vortex_python_sdk-0.0.5/src/vortex_python_sdk.egg-info → vortex_python_sdk-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.0.5
+Version: 0.0.6
 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 → vortex_python_sdk-0.0.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortex-python-sdk"
-version = "0.0.5"
+version = "0.0.6"
 description = "Vortex Python SDK for invitation management and JWT generation"
 authors = [{name = "TeamVortexSoftware", email = "support@vortexsoftware.com"}]
 readme = "README.md"
@@ -68,7 +68,7 @@ profile = "black"
 line_length = 88
 
 [tool.mypy]
-python_version = "3.8"
+python_version = "3.9"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true
@@ -83,6 +83,8 @@ warn_unreachable = true
 [tool.ruff]
 target-version = "py38"
 line-length = 88
+
+[tool.ruff.lint]
 select = [
     "E",  # pycodestyle errors
     "W",  # pycodestyle warnings

{vortex_python_sdk-0.0.5 → vortex_python_sdk-0.0.6/src/vortex_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.0.5
+Version: 0.0.6
 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 → vortex_python_sdk-0.0.6}/src/vortex_sdk/__init__.py

@@ -5,20 +5,26 @@ A Python SDK for Vortex invitation management and JWT generation.
 """
 
 from .types import (
+    AcceptInvitationRequest,
     AcceptInvitationsRequest,
+    ApiRequestBody,
     ApiResponse,
+    ApiResponseJson,
     AuthenticatedUser,
     CreateInvitationRequest,
     GroupInput,
     IdentifierInput,
     Invitation,
+    InvitationAcceptance,
+    InvitationGroup,
+    InvitationResult,
     InvitationTarget,
     JwtPayload,
     VortexApiError,
 )
 from .vortex import Vortex
 
-__version__ = "0.0.5"
+__version__ = "0.0.6"
 __author__ = "TeamVortexSoftware"
 __email__ = "support@vortexsoftware.com"
 
@@ -29,9 +35,15 @@ __all__ = [
     "IdentifierInput",
     "GroupInput",
     "InvitationTarget",
-    "Invitation",
+    "InvitationGroup",
+    "InvitationAcceptance",
+    "InvitationResult",
+    "Invitation",  # Alias for InvitationResult
     "CreateInvitationRequest",
-    "AcceptInvitationsRequest",
+    "AcceptInvitationRequest",
+    "AcceptInvitationsRequest",  # Alias for AcceptInvitationRequest
     "ApiResponse",
+    "ApiResponseJson",
+    "ApiRequestBody",
     "VortexApiError",
 ]

{vortex_python_sdk-0.0.5 → vortex_python_sdk-0.0.6}/src/vortex_sdk/types.py

@@ -68,24 +68,69 @@ class JwtPayload(BaseModel):
 
 
 class InvitationTarget(BaseModel):
-    type: Literal["email", "username", "phoneNumber"]
+    type: Literal["email", "sms"]
     value: str
 
 
-class Invitation(BaseModel):
+class InvitationAcceptance(BaseModel):
+    """Represents an acceptance of an invitation"""
+
     id: str
-    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: 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
+    account_id: str = Field(alias="accountId")
+    project_id: str = Field(alias="projectId")
+    accepted_at: str = Field(alias="acceptedAt")
+    target: InvitationTarget
+
+    class Config:
+        populate_by_name = True
+
+
+class InvitationResult(BaseModel):
+    """
+    Complete invitation result from API responses.
+    This is the exact port of the Node.js SDK's InvitationResult type.
+    """
+
+    id: str
+    account_id: str = Field(alias="accountId")
+    click_throughs: int = Field(alias="clickThroughs")
+    configuration_attributes: Optional[Dict[str, Any]] = Field(
+        None, alias="configurationAttributes"
+    )
+    attributes: Optional[Dict[str, Any]] = None
+    created_at: str = Field(alias="createdAt")
+    deactivated: bool
+    delivery_count: int = Field(alias="deliveryCount")
+    delivery_types: List[Literal["email", "sms", "share"]] = Field(
+        alias="deliveryTypes"
+    )
+    foreign_creator_id: str = Field(alias="foreignCreatorId")
+    invitation_type: Literal["single_use", "multi_use"] = Field(alias="invitationType")
+    modified_at: Optional[str] = Field(None, alias="modifiedAt")
+    status: Literal[
+        "queued",
+        "sending",
+        "delivered",
+        "accepted",
+        "shared",
+        "unfurled",
+        "accepted_elsewhere",
+    ]
+    target: List[InvitationTarget]
+    views: int
+    widget_configuration_id: str = Field(alias="widgetConfigurationId")
+    project_id: str = Field(alias="projectId")
+    groups: List[Optional[InvitationGroup]] = Field(default_factory=list)
+    accepts: List[InvitationAcceptance] = Field(default_factory=list)
 
     class Config:
         populate_by_name = True
 
 
+# Alias for backward compatibility
+Invitation = InvitationResult
+
+
 class CreateInvitationRequest(BaseModel):
     target: InvitationTarget
     group_type: Optional[str] = None
@@ -94,10 +139,19 @@ class CreateInvitationRequest(BaseModel):
     metadata: Optional[Dict[str, Union[str, int, bool]]] = None
 
 
-class AcceptInvitationsRequest(BaseModel):
-    invitation_ids: List[str]
+class AcceptInvitationRequest(BaseModel):
+    """Request to accept one or more invitations"""
+
+    invitation_ids: List[str] = Field(alias="invitationIds")
     target: InvitationTarget
 
+    class Config:
+        populate_by_name = True
+
+
+# Alias for backward compatibility
+AcceptInvitationsRequest = AcceptInvitationRequest
+
 
 class ApiResponse(BaseModel):
     data: Optional[Dict] = None
@@ -110,3 +164,10 @@ class VortexApiError(Exception):
         self.message = message
         self.status_code = status_code
         super().__init__(message)
+
+
+# Type aliases to match Node.js SDK
+ApiResponseJson = Union[
+    InvitationResult, Dict[str, List[InvitationResult]], Dict[str, Any]
+]
+ApiRequestBody = Union[AcceptInvitationRequest, None]

{vortex_python_sdk-0.0.5 → vortex_python_sdk-0.0.6}/src/vortex_sdk/vortex.py

@@ -4,15 +4,11 @@ import hmac
 import json
 import time
 import uuid
-from typing import Dict, List, Literal, Optional, Union
-from urllib.parse import urlencode
+from typing import Any, Dict, List, Literal, Optional, Union
 
 import httpx
 
 from .types import (
-    AcceptInvitationsRequest,
-    ApiResponse,
-    CreateInvitationRequest,
     Invitation,
     InvitationTarget,
     JwtPayload,
@@ -20,9 +16,10 @@ from .types import (
 )
 
 
-def _get_version():
+def _get_version() -> str:
     """Lazy import of version to avoid circular import"""
     from . import __version__
+
     return __version__
 
 
@@ -80,7 +77,7 @@ 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}") from e
 
         # Generate timestamps
         iat = int(time.time())
@@ -106,16 +103,11 @@ class Vortex:
         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()
-                }
+                group.model_dump(by_alias=True, exclude_none=True)
                 for group in payload.groups
             ]
 
-        jwt_payload = {
+        jwt_payload: Dict[str, Any] = {
             "userId": payload.user_id,
             "groups": groups_list,
             "role": payload.role,
@@ -185,17 +177,17 @@ class Vortex:
                         "error",
                         f"API request failed with status {response.status_code}",
                     )
-                except:
+                except Exception:
                     error_message = (
                         f"API request failed with status {response.status_code}"
                     )
 
                 raise VortexApiError(error_message, response.status_code)
 
-            return response.json()
+            return response.json()  # type: ignore[no-any-return]
 
         except httpx.RequestError as e:
-            raise VortexApiError(f"Request failed: {str(e)}")
+            raise VortexApiError(f"Request failed: {str(e)}") from e
 
     def _vortex_api_request_sync(
         self,
@@ -238,17 +230,17 @@ class Vortex:
                         "error",
                         f"API request failed with status {response.status_code}",
                     )
-                except:
+                except Exception:
                     error_message = (
                         f"API request failed with status {response.status_code}"
                     )
 
                 raise VortexApiError(error_message, response.status_code)
 
-            return response.json()
+            return response.json()  # type: ignore[no-any-return]
 
         except httpx.RequestError as e:
-            raise VortexApiError(f"Request failed: {str(e)}")
+            raise VortexApiError(f"Request failed: {str(e)}") from e
 
     async def get_invitations_by_target(
         self,
@@ -335,10 +327,13 @@ class Vortex:
         Returns:
             API response
         """
+        target_obj: InvitationTarget
         if isinstance(target, dict):
-            target = InvitationTarget(**target)
+            target_obj = InvitationTarget(**target)  # type: ignore[arg-type]
+        else:
+            target_obj = target
 
-        data = {"invitationIds": invitation_ids, "target": target.model_dump()}
+        data = {"invitationIds": invitation_ids, "target": target_obj.model_dump()}
 
         return await self._vortex_api_request("POST", "/invitations/accept", data=data)
 
@@ -355,10 +350,13 @@ class Vortex:
         Returns:
             API response
         """
+        target_obj: InvitationTarget
         if isinstance(target, dict):
-            target = InvitationTarget(**target)
+            target_obj = InvitationTarget(**target)  # type: ignore[arg-type]
+        else:
+            target_obj = target
 
-        data = {"invitationIds": invitation_ids, "target": target.model_dump()}
+        data = {"invitationIds": invitation_ids, "target": target_obj.model_dump()}
 
         return self._vortex_api_request_sync("POST", "/invitations/accept", data=data)
 
@@ -482,26 +480,26 @@ class Vortex:
         )
         return Invitation(**response)
 
-    async def close(self):
+    async def close(self) -> None:
         """Close the HTTP client"""
         await self._client.aclose()
 
-    def close_sync(self):
+    def close_sync(self) -> None:
         """Close the synchronous HTTP client"""
         self._sync_client.close()
 
-    async def __aenter__(self):
+    async def __aenter__(self) -> "Vortex":
         """Async context manager entry"""
         return self
 
-    async def __aexit__(self, exc_type, exc_val, exc_tb):
+    async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         """Async context manager exit"""
         await self.close()
 
-    def __enter__(self):
+    def __enter__(self) -> "Vortex":
         """Context manager entry"""
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         """Context manager exit"""
         self.close_sync()