waveium 0.2.0__py3-none-any.whl

waveium/models/organizations.py

@@ -0,0 +1,51 @@
+"""Organization models for the Waveium SDK."""
+
+from datetime import datetime
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, Field
+
+
+class CreateOrganizationRequest(BaseModel):
+    """Request to create organization (admin only)."""
+
+    name: str = Field(description="Organization name")
+    contact: Optional[str] = Field(default=None, description="Contact info")
+    homepage: Optional[str] = Field(default=None, description="Homepage URL")
+    subscription_tier: Optional[str] = Field(
+        default="free", description="Subscription tier"
+    )
+
+
+class UpdateOrganizationRequest(BaseModel):
+    """Request to update organization."""
+
+    name: Optional[str] = Field(default=None, description="New name")
+    contact: Optional[str] = Field(default=None, description="New contact")
+    homepage: Optional[str] = Field(default=None, description="New homepage")
+
+
+class OrganizationResponse(BaseModel):
+    """Organization details."""
+
+    id: str = Field(description="Organization ID")
+    name: str = Field(description="Name")
+    contact: Optional[str] = Field(default=None, description="Contact")
+    homepage: Optional[str] = Field(default=None, description="Homepage")
+    subscription_tier: str = Field(description="Subscription tier")
+    max_users: int = Field(description="Max users")
+    max_storage_gb: int = Field(description="Max storage GB")
+    created_at: datetime = Field(description="Created at")
+    updated_at: Optional[datetime] = Field(
+        default=None, description="Updated at"
+    )
+
+
+class OrganizationStatsResponse(BaseModel):
+    """Organization statistics."""
+
+    organization: Dict[str, Any] = Field(description="Organization info")
+    users: Dict[str, Any] = Field(description="User stats")
+    scenes: Dict[str, Any] = Field(description="Scene stats")
+    executions: Dict[str, Any] = Field(description="Execution stats")
+    storage: Dict[str, Any] = Field(description="Storage stats")

waveium/models/projects.py

@@ -0,0 +1,177 @@
+"""Project models for the Waveium SDK."""
+
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+from .common import ProjectMemberType, ProjectRole
+
+
+class CreateProjectRequest(BaseModel):
+    """Request to create a project."""
+
+    name: str = Field(description="Project name", min_length=1, max_length=255)
+    description: Optional[str] = Field(
+        default=None, description="Project description"
+    )
+
+
+class UpdateProjectRequest(BaseModel):
+    """Request to update a project."""
+
+    name: Optional[str] = Field(
+        default=None,
+        description="New name",
+        min_length=1,
+        max_length=255,
+    )
+    description: Optional[str] = Field(
+        default=None, description="New description"
+    )
+
+
+class ProjectResponse(BaseModel):
+    """Project details."""
+
+    project_id: str = Field(description="Project ID")
+    organization_id: str = Field(description="Organization ID")
+    name: str = Field(description="Project name")
+    description: Optional[str] = Field(default=None, description="Description")
+    created_by_user_id: Optional[str] = Field(
+        default=None, description="Creator user ID"
+    )
+    created_at: datetime = Field(description="Created at")
+    updated_at: Optional[datetime] = Field(
+        default=None, description="Updated at"
+    )
+    archived_at: Optional[datetime] = Field(
+        default=None, description="Archived at"
+    )
+    member_count: Optional[int] = Field(
+        default=None, description="Member count"
+    )
+    environment_count: Optional[int] = Field(
+        default=None, description="Environment count"
+    )
+    scene_count: Optional[int] = Field(default=None, description="Scene count")
+    user_role: Optional[str] = Field(
+        default=None, description="Current user role"
+    )
+
+
+class ProjectListItem(BaseModel):
+    """Project list entry."""
+
+    project_id: str = Field(description="Project ID")
+    name: str = Field(description="Name")
+    description: Optional[str] = Field(default=None, description="Description")
+    created_at: datetime = Field(description="Created at")
+    updated_at: Optional[datetime] = Field(
+        default=None, description="Updated at"
+    )
+    member_count: Optional[int] = Field(
+        default=None, description="Member count"
+    )
+    environment_count: Optional[int] = Field(
+        default=None, description="Environment count"
+    )
+    scene_count: Optional[int] = Field(default=None, description="Scene count")
+    user_role: Optional[str] = Field(
+        default=None, description="Current user role"
+    )
+
+
+class PaginatedProjectResponse(BaseModel):
+    """Paginated project list."""
+
+    projects: List[ProjectListItem] = Field(description="List of projects")
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")
+
+
+class AddProjectMemberRequest(BaseModel):
+    """Request to add a project member."""
+
+    member_type: ProjectMemberType = Field(
+        description="Member type: user or team"
+    )
+    member_id: str = Field(description="User ID or Team ID")
+    role: Optional[ProjectRole] = Field(
+        default="member",
+        description="Role: owner, admin, or member",
+    )
+
+
+class UpdateProjectMemberRequest(BaseModel):
+    """Request to update member role."""
+
+    role: ProjectRole = Field(description="New role: owner, admin, or member")
+
+
+class ProjectMemberResponse(BaseModel):
+    """Project member details."""
+
+    id: str = Field(description="Member record ID")
+    project_id: str = Field(description="Project ID")
+    member_type: ProjectMemberType = Field(
+        description="Member type: user or team"
+    )
+    member_id: str = Field(description="Member ID")
+    member_name: Optional[str] = Field(default=None, description="Display name")
+    member_email: Optional[str] = Field(
+        default=None, description="Email (users only)"
+    )
+    role: ProjectRole = Field(description="Role: owner, admin, or member")
+    added_by_user_id: Optional[str] = Field(
+        default=None, description="Added by user ID"
+    )
+    added_at: datetime = Field(description="Added at")
+
+
+class PaginatedProjectMemberResponse(BaseModel):
+    """Paginated project member list."""
+
+    members: List[ProjectMemberResponse] = Field(description="List of members")
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")
+
+
+class AddProjectEnvironmentRequest(BaseModel):
+    """Request to add environment to project."""
+
+    environment_id: str = Field(description="Environment ID to add")
+
+
+class ProjectEnvironmentResponse(BaseModel):
+    """Project environment details."""
+
+    id: str = Field(description="Record ID")
+    project_id: str = Field(description="Project ID")
+    environment_id: str = Field(description="Environment ID")
+    environment_name: Optional[str] = Field(
+        default=None, description="Environment name"
+    )
+    environment_type: Optional[str] = Field(
+        default=None, description="Environment type"
+    )
+    environment_status: Optional[str] = Field(
+        default=None, description="Environment status"
+    )
+    added_by_user_id: Optional[str] = Field(
+        default=None, description="Added by user ID"
+    )
+    added_at: datetime = Field(description="Added at")
+
+
+class PaginatedProjectEnvironmentResponse(BaseModel):
+    """Paginated project environment list."""
+
+    environments: List[ProjectEnvironmentResponse] = Field(
+        description="List of environments"
+    )
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")

waveium/models/roles.py

@@ -0,0 +1,48 @@
+"""Role models for the Waveium SDK."""
+
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class PermissionResponse(BaseModel):
+    """Permission details."""
+
+    id: str = Field(description="Permission ID")
+    name: str = Field(description="Permission name")
+    resource: str = Field(description="Resource type")
+    action: str = Field(description="Action")
+    description: Optional[str] = Field(default=None, description="Description")
+    created_at: datetime = Field(description="Created at")
+
+
+class RoleResponse(BaseModel):
+    """Role details."""
+
+    id: str = Field(description="Role ID")
+    name: str = Field(description="Role name")
+    description: Optional[str] = Field(default=None, description="Description")
+    scope: str = Field(description="Scope")
+    is_system_role: bool = Field(description="Is system role")
+    created_at: datetime = Field(description="Created at")
+
+
+class RolePermissionResponse(BaseModel):
+    """Role-permission mapping."""
+
+    permission: PermissionResponse = Field(description="Permission details")
+
+
+class RoleDetailResponse(BaseModel):
+    """Role with permissions."""
+
+    id: str = Field(description="Role ID")
+    name: str = Field(description="Role name")
+    description: Optional[str] = Field(default=None, description="Description")
+    scope: str = Field(description="Scope")
+    is_system_role: bool = Field(description="Is system role")
+    created_at: datetime = Field(description="Created at")
+    role_permissions: List[RolePermissionResponse] = Field(
+        description="Permissions"
+    )

waveium/models/scenes.py

@@ -0,0 +1,222 @@
+"""Scene models for the Waveium SDK."""
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field
+
+from .common import _fmt_dt, _tabulate
+
+
+class SceneParameters(BaseModel):
+    """Parameters for scene configuration."""
+
+    stations: Optional[Dict[str, List[float]]] = Field(
+        default=None, description="Station positions"
+    )
+    stations_file_id: Optional[str] = Field(
+        default=None, description="Stations CSV file ID"
+    )
+    trajectory_file_ids: Optional[List[str]] = Field(
+        default=None, description="Trajectory file IDs"
+    )
+    trajectory_file_id: Optional[str] = Field(
+        default=None,
+        description="Deprecated: single trajectory file ID",
+    )
+    route: Optional[Dict[str, Any]] = Field(
+        default=None, description="Route parameters"
+    )
+
+
+class CreateSceneRequest(BaseModel):
+    """Request to create a new scene."""
+
+    environment_id: str = Field(description="Parent environment ID")
+    name: str = Field(description="Scene name", min_length=1, max_length=255)
+    description: Optional[str] = Field(
+        default=None, description="Scene description"
+    )
+    parameters: SceneParameters = Field(description="Scene parameters")
+    project_id: Optional[str] = Field(
+        default=None, description="Optional project ID"
+    )
+
+
+class UpdateSceneRequest(BaseModel):
+    """Request to fully update a scene."""
+
+    name: Optional[str] = Field(
+        default=None,
+        description="New name",
+        min_length=1,
+        max_length=255,
+    )
+    description: Optional[str] = Field(
+        default=None, description="New description"
+    )
+
+
+class PatchSceneRequest(BaseModel):
+    """Request to partially update a scene."""
+
+    name: Optional[str] = Field(
+        default=None,
+        description="New name",
+        min_length=1,
+        max_length=255,
+    )
+    description: Optional[str] = Field(
+        default=None, description="New description"
+    )
+    parameters: Optional[SceneParameters] = Field(
+        default=None,
+        description="Partial parameters to merge",
+    )
+
+
+class SceneResponse(BaseModel):
+    """Full scene response from the API."""
+
+    scene_id: str = Field(description="Scene ID")
+    environment_id: str = Field(description="Parent environment ID")
+    organization_id: str = Field(description="Organization ID")
+    created_by_user_id: Optional[str] = Field(
+        default=None, description="Creator user ID"
+    )
+    project_id: Optional[str] = Field(default=None, description="Project ID")
+    name: str = Field(description="Scene name")
+    description: Optional[str] = Field(default=None, description="Description")
+    parameters: Dict[str, Any] = Field(description="Scene parameters")
+    parameters_hash: str = Field(description="Parameters hash")
+    status: str = Field(description="Scene status")
+    storage_path: str = Field(description="Storage path")
+    storage_size_bytes: Optional[int] = Field(
+        default=None, description="Storage size"
+    )
+    created_at: datetime = Field(description="Created at")
+    started_at: Optional[datetime] = Field(
+        default=None, description="Started at"
+    )
+    completed_at: Optional[datetime] = Field(
+        default=None, description="Completed at"
+    )
+    exit_code: Optional[int] = Field(default=None, description="Exit code")
+    error_message: Optional[str] = Field(
+        default=None, description="Error message"
+    )
+    execution_count: Optional[int] = Field(
+        default=None, description="Execution count"
+    )
+    reused: bool = Field(
+        default=False,
+        description="Whether existing was returned",
+    )
+    missing_inputs: Optional[List[str]] = Field(
+        default=None,
+        description="Missing inputs before queueing",
+    )
+
+
+class SceneListItem(BaseModel):
+    """Summary item for scene listings."""
+
+    scene_id: str = Field(description="Scene ID")
+    environment_id: str = Field(description="Parent environment ID")
+    project_id: Optional[str] = Field(default=None, description="Project ID")
+    name: str = Field(description="Name")
+    description: Optional[str] = Field(default=None, description="Description")
+    status: str = Field(description="Status")
+    created_at: datetime = Field(description="Created at")
+    completed_at: Optional[datetime] = Field(
+        default=None, description="Completed at"
+    )
+    execution_count: Optional[int] = Field(
+        default=None, description="Execution count"
+    )
+
+
+class PaginatedSceneResponse(BaseModel):
+    """Paginated list of scenes."""
+
+    scenes: List[SceneListItem] = Field(description="List of scenes")
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")
+
+    def __repr__(self) -> str:
+        page = (self.offset // self.limit) + 1 if self.limit else 1
+        total_pages = (
+            (self.total + self.limit - 1) // self.limit if self.limit else 1
+        )
+        header = (
+            f"PaginatedSceneResponse: {self.total} scenes"
+            f" (page {page}/{total_pages})"
+        )
+        if not self.scenes:
+            return header
+
+        rows = []
+        for scene in self.scenes:
+            rows.append(
+                (
+                    scene.scene_id,
+                    scene.status,
+                    scene.name,
+                    scene.environment_id,
+                    _fmt_dt(scene.created_at),
+                    (
+                        str(scene.execution_count)
+                        if scene.execution_count is not None
+                        else "-"
+                    ),
+                )
+            )
+
+        table = _tabulate(
+            ("ID", "Status", "Name", "Environment", "Created", "Execs"),
+            rows,
+        )
+        return f"{header}\n{table}"
+
+
+class SimilarSceneResponse(BaseModel):
+    """Response listing similar scenes."""
+
+    similar_scenes: List[SceneListItem] = Field(description="Similar scenes")
+    parameters_hash: str = Field(description="Parameters hash")
+
+
+class SceneUploadRequest(BaseModel):
+    """Request to initiate a scene file upload."""
+
+    filename: str = Field(description="Filename", min_length=1, max_length=255)
+    content_type: Optional[str] = Field(
+        default="application/gpx+xml", description="MIME type"
+    )
+    purpose: Optional[str] = Field(
+        default=None,
+        description=("Upload purpose: trajectory or ap_positions"),
+    )
+
+
+class SceneUploadResponse(BaseModel):
+    """Response with signed upload URL for scene files."""
+
+    upload_id: str = Field(description="Upload ID")
+    upload_url: str = Field(description="Signed upload URL")
+    method: str = Field(default="PUT", description="HTTP method")
+    expires_at: datetime = Field(description="URL expiration")
+    file_id: str = Field(description="File ID")
+
+
+class SceneUploadCompleteResponse(BaseModel):
+    """Response after completing a scene file upload."""
+
+    file_id: str = Field(description="File ID")
+    message: str = Field(description="Status message")
+    queued: bool = Field(default=False, description="Deprecated: always false")
+    missing_inputs: Optional[List[str]] = Field(
+        default=None,
+        description="Remaining required inputs",
+    )

waveium/models/shares.py

@@ -0,0 +1,51 @@
+"""Share models for the Waveium SDK."""
+
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+from .common import PermissionLevel, ShareTargetType
+
+
+class CreateShareRequest(BaseModel):
+    """Request to share a resource."""
+
+    shared_with_type: ShareTargetType = Field(
+        description="Target type: user, team, or organization"
+    )
+    shared_with_id: str = Field(description="ID of user, team, or organization")
+    permission_level: PermissionLevel = Field(
+        description="Permission: view, use, or full"
+    )
+
+
+class ShareResponse(BaseModel):
+    """Share record."""
+
+    share_id: str = Field(description="Share ID")
+    resource_type: str = Field(
+        description="Resource type: environment or scene"
+    )
+    resource_id: str = Field(description="Resource ID")
+    shared_by_user_id: str = Field(description="Sharer user ID")
+    shared_with_type: ShareTargetType = Field(
+        description="Target type: user, team, organization"
+    )
+    shared_with_id: str = Field(description="Target ID")
+    shared_with_name: Optional[str] = Field(
+        default=None, description="Target display name"
+    )
+    permission_level: PermissionLevel = Field(
+        description="Permission: view, use, full"
+    )
+    created_at: datetime = Field(description="Created at")
+
+
+class PaginatedShareResponse(BaseModel):
+    """Paginated list of shares."""
+
+    shares: List[ShareResponse] = Field(description="List of shares")
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")

waveium/models/teams.py

@@ -0,0 +1,90 @@
+"""Team models for the Waveium SDK."""
+
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class CreateTeamRequest(BaseModel):
+    """Request to create a team."""
+
+    name: str = Field(description="Team name", min_length=1, max_length=255)
+    description: Optional[str] = Field(
+        default=None, description="Team description"
+    )
+
+
+class UpdateTeamRequest(BaseModel):
+    """Request to update a team."""
+
+    name: Optional[str] = Field(
+        default=None,
+        description="New name",
+        min_length=1,
+        max_length=255,
+    )
+    description: Optional[str] = Field(
+        default=None, description="New description"
+    )
+
+
+class TeamResponse(BaseModel):
+    """Team details."""
+
+    team_id: str = Field(description="Team ID")
+    organization_id: str = Field(description="Organization ID")
+    name: str = Field(description="Team name")
+    description: Optional[str] = Field(default=None, description="Description")
+    created_by_user_id: Optional[str] = Field(
+        default=None, description="Creator user ID"
+    )
+    created_at: datetime = Field(description="Created at")
+    updated_at: Optional[datetime] = Field(
+        default=None, description="Updated at"
+    )
+    member_count: Optional[int] = Field(
+        default=None, description="Member count"
+    )
+
+
+class PaginatedTeamResponse(BaseModel):
+    """Paginated team list."""
+
+    teams: List[TeamResponse] = Field(description="List of teams")
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")
+
+
+class AddTeamMemberRequest(BaseModel):
+    """Request to add a team member."""
+
+    user_id: str = Field(description="User ID to add")
+    role: Optional[str] = Field(
+        default="member", description="Role: member or admin"
+    )
+
+
+class TeamMemberResponse(BaseModel):
+    """Team member details."""
+
+    id: str = Field(description="Member record ID")
+    team_id: str = Field(description="Team ID")
+    user_id: str = Field(description="User ID")
+    user_email: Optional[str] = Field(default=None, description="User email")
+    user_name: Optional[str] = Field(default=None, description="User name")
+    role: str = Field(description="Role: member or admin")
+    added_by_user_id: Optional[str] = Field(
+        default=None, description="Added by user ID"
+    )
+    added_at: datetime = Field(description="Added at")
+
+
+class PaginatedTeamMemberResponse(BaseModel):
+    """Paginated team member list."""
+
+    members: List[TeamMemberResponse] = Field(description="List of members")
+    total: int = Field(description="Total count")
+    limit: int = Field(description="Page size")
+    offset: int = Field(description="Offset")