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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.3.0
+Version: 0.6.0
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT
@@ -84,26 +84,23 @@ vortex = Vortex(api_key="your-vortex-api-key", base_url="https://custom-api.exam
 user = {
     "id": "user-123",
     "email": "user@example.com",
-    "admin_scopes": ["autojoin"]  # Optional - included as adminScopes array in JWT
+    "user_name": "Jane Doe",                                    # Optional: user's display name
+    "user_avatar_url": "https://example.com/avatars/jane.jpg",  # Optional: user's avatar URL
+    "admin_scopes": ["autojoin"]                                # Optional: grants autojoin admin privileges
 }
 
 jwt = vortex.generate_jwt(user=user)
 print(f"JWT: {jwt}")
 
-# With additional properties
-jwt = vortex.generate_jwt(
-    user=user,
-    role="admin",
-    department="Engineering"
-)
-
 # Or using type-safe models
 from vortex_sdk import User
 
 user = User(
     id="user-123",
     email="user@example.com",
-    admin_scopes=["autojoin"]
+    user_name="Jane Doe",                                       # Optional
+    user_avatar_url="https://example.com/avatars/jane.jpg",     # Optional
+    admin_scopes=["autojoin"]                              # Optional
 )
 
 jwt = vortex.generate_jwt(user=user)

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

@@ -46,26 +46,23 @@ vortex = Vortex(api_key="your-vortex-api-key", base_url="https://custom-api.exam
 user = {
     "id": "user-123",
     "email": "user@example.com",
-    "admin_scopes": ["autojoin"]  # Optional - included as adminScopes array in JWT
+    "user_name": "Jane Doe",                                    # Optional: user's display name
+    "user_avatar_url": "https://example.com/avatars/jane.jpg",  # Optional: user's avatar URL
+    "admin_scopes": ["autojoin"]                                # Optional: grants autojoin admin privileges
 }
 
 jwt = vortex.generate_jwt(user=user)
 print(f"JWT: {jwt}")
 
-# With additional properties
-jwt = vortex.generate_jwt(
-    user=user,
-    role="admin",
-    department="Engineering"
-)
-
 # Or using type-safe models
 from vortex_sdk import User
 
 user = User(
     id="user-123",
     email="user@example.com",
-    admin_scopes=["autojoin"]
+    user_name="Jane Doe",                                       # Optional
+    user_avatar_url="https://example.com/avatars/jane.jpg",     # Optional
+    admin_scopes=["autojoin"]                              # Optional
 )
 
 jwt = vortex.generate_jwt(user=user)

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-python-sdk
-Version: 0.3.0
+Version: 0.6.0
 Summary: Vortex Python SDK for invitation management and JWT generation
 Author-email: TeamVortexSoftware <support@vortexsoftware.com>
 License-Expression: MIT
@@ -84,26 +84,23 @@ vortex = Vortex(api_key="your-vortex-api-key", base_url="https://custom-api.exam
 user = {
     "id": "user-123",
     "email": "user@example.com",
-    "admin_scopes": ["autojoin"]  # Optional - included as adminScopes array in JWT
+    "user_name": "Jane Doe",                                    # Optional: user's display name
+    "user_avatar_url": "https://example.com/avatars/jane.jpg",  # Optional: user's avatar URL
+    "admin_scopes": ["autojoin"]                                # Optional: grants autojoin admin privileges
 }
 
 jwt = vortex.generate_jwt(user=user)
 print(f"JWT: {jwt}")
 
-# With additional properties
-jwt = vortex.generate_jwt(
-    user=user,
-    role="admin",
-    department="Engineering"
-)
-
 # Or using type-safe models
 from vortex_sdk import User
 
 user = User(
     id="user-123",
     email="user@example.com",
-    admin_scopes=["autojoin"]
+    user_name="Jane Doe",                                       # Optional
+    user_avatar_url="https://example.com/avatars/jane.jpg",     # Optional
+    admin_scopes=["autojoin"]                              # Optional
 )
 
 jwt = vortex.generate_jwt(user=user)

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

@@ -61,16 +61,16 @@ class User(BaseModel):
     - email: User's email address
 
     Optional fields:
-    - name: User's display name
-    - avatar_url: User's avatar URL (must be HTTPS, max 2000 chars)
+    - 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'])
 
     Additional fields are allowed via extra parameter
     """
     id: str
     email: str
-    name: Optional[str] = None
-    avatar_url: Optional[str] = None
+    user_name: Optional[str] = Field(None, alias="userName")
+    user_avatar_url: Optional[str] = Field(None, alias="userAvatarUrl")
     admin_scopes: Optional[List[str]] = None
 
     class Config:
@@ -129,8 +129,13 @@ class JwtPayload(BaseModel):
 
 
 class InvitationTarget(BaseModel):
-    type: Literal["email", "phone"]
+    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):
@@ -194,6 +199,7 @@ class InvitationResult(BaseModel):
     status: Literal[
         "queued",
         "sending",
+        "sent",
         "delivered",
         "accepted",
         "shared",
@@ -214,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")
 
@@ -280,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):
@@ -289,8 +301,8 @@ class Inviter(BaseModel):
     """
     user_id: str = Field(alias="userId")
     user_email: Optional[str] = Field(None, alias="userEmail")
-    name: Optional[str] = None
-    avatar_url: Optional[str] = Field(None, alias="avatarUrl")
+    user_name: Optional[str] = Field(None, alias="userName")
+    user_avatar_url: Optional[str] = Field(None, alias="userAvatarUrl")
 
     class Config:
         populate_by_name = True
@@ -306,6 +318,21 @@ class CreateInvitationGroup(BaseModel):
         populate_by_name = True
 
 
+class UnfurlConfig(BaseModel):
+    """
+    Configuration for link unfurl (Open Graph) metadata.
+    Controls how the invitation link appears when shared on social platforms or messaging apps.
+    """
+    title: Optional[str] = None  # og:title
+    description: Optional[str] = None  # og:description
+    image: Optional[str] = None  # og:image - must be HTTPS
+    type: Optional[Literal["website", "article", "video", "music", "book", "profile", "product"]] = None  # og:type
+    site_name: Optional[str] = Field(None, alias="siteName")  # og:site_name
+
+    class Config:
+        populate_by_name = True
+
+
 class BackendCreateInvitationRequest(BaseModel):
     """
     Request body for creating an invitation via the public API (backend SDK use).
@@ -315,8 +342,10 @@ 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")
 
     class Config:
         populate_by_name = True

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

@@ -126,13 +126,13 @@ class Vortex:
             "expires": expires,
         }
 
-        # Add name if present (convert snake_case to camelCase for JWT)
-        if user.name:
-            jwt_payload["name"] = user.name
+        # Add userName if present
+        if user.user_name:
+            jwt_payload["userName"] = user.user_name
 
-        # Add avatarUrl if present (convert snake_case to camelCase for JWT)
-        if user.avatar_url:
-            jwt_payload["avatarUrl"] = user.avatar_url
+        # Add userAvatarUrl if present
+        if user.user_avatar_url:
+            jwt_payload["userAvatarUrl"] = user.user_avatar_url
 
         # Add adminScopes if present
         if user.admin_scopes: