cyberdesk 1.8.0__tar.gz → 1.10.0__tar.gz

{cyberdesk-1.8.0 → cyberdesk-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberdesk
-Version: 1.8.0
+Version: 1.10.0
 Summary: The official Python SDK for Cyberdesk
 Author-email: Cyberdesk Team <dev@cyberdesk.io>
 License-Expression: MIT
@@ -26,30 +26,52 @@ pip install cyberdesk
 
 ## Quick Start
 
+The most common use case is to execute workflows that you've created in the [Cyberdesk Dashboard](https://cyberdesk.io/dashboard).
+
 ```python
-from cyberdesk import CyberdeskClient
+from cyberdesk import CyberdeskClient, RunCreate
+import time
 
 # Initialize the client
 client = CyberdeskClient(api_key="your-api-key")
 
-# List machines
-response = client.machines.list_sync()
-if response.data:
-    for machine in response.data.items:
-        print(f"Machine: {machine.name} - Status: {machine.status}")
-
-# Create a workflow
-from cyberdesk import WorkflowCreate
-
-workflow_data = WorkflowCreate(
-    name="My Workflow",
-    description="Automated task workflow"
+# Create a run for your workflow
+run_data = RunCreate(
+    workflow_id="your-workflow-id",
+    machine_id="your-machine-id",
+    input_values={
+        # Your workflow-specific input data
+        "patient_id": "12345",
+        "patient_first_name": "John",
+        "patient_last_name": "Doe"
+    }
 )
-response = client.workflows.create_sync(workflow_data)
-if response.data:
-    print(f"Created workflow: {response.data.id}")
+
+response = client.runs.create_sync(run_data)
+if response.error:
+    print(f"Error creating run: {response.error}")
+else:
+    run = response.data
+    
+    # Wait for the run to complete
+    while run.status in ["scheduling", "running"]:
+        time.sleep(5)  # Wait 5 seconds
+        response = client.runs.get_sync(run.id)
+        run = response.data
+    
+    # Get the output data
+    if run.status == "success":
+        print("Result:", run.output_data)
+    else:
+        print("Run failed:", ", ".join(run.error or []))
 ```
 
+## Full Documentation
+
+For complete documentation including async/sync usage, error handling, and all available methods, visit:
+
+**[https://docs.cyberdesk.io/sdk-guides/python](https://docs.cyberdesk.io/sdk-guides/python)**
+
 ## Async Support
 
 The SDK provides both synchronous and asynchronous methods for all operations:

{cyberdesk-1.8.0 → cyberdesk-1.10.0}/README.md

@@ -10,30 +10,52 @@ pip install cyberdesk
 
 ## Quick Start
 
+The most common use case is to execute workflows that you've created in the [Cyberdesk Dashboard](https://cyberdesk.io/dashboard).
+
 ```python
-from cyberdesk import CyberdeskClient
+from cyberdesk import CyberdeskClient, RunCreate
+import time
 
 # Initialize the client
 client = CyberdeskClient(api_key="your-api-key")
 
-# List machines
-response = client.machines.list_sync()
-if response.data:
-    for machine in response.data.items:
-        print(f"Machine: {machine.name} - Status: {machine.status}")
-
-# Create a workflow
-from cyberdesk import WorkflowCreate
-
-workflow_data = WorkflowCreate(
-    name="My Workflow",
-    description="Automated task workflow"
+# Create a run for your workflow
+run_data = RunCreate(
+    workflow_id="your-workflow-id",
+    machine_id="your-machine-id",
+    input_values={
+        # Your workflow-specific input data
+        "patient_id": "12345",
+        "patient_first_name": "John",
+        "patient_last_name": "Doe"
+    }
 )
-response = client.workflows.create_sync(workflow_data)
-if response.data:
-    print(f"Created workflow: {response.data.id}")
+
+response = client.runs.create_sync(run_data)
+if response.error:
+    print(f"Error creating run: {response.error}")
+else:
+    run = response.data
+    
+    # Wait for the run to complete
+    while run.status in ["scheduling", "running"]:
+        time.sleep(5)  # Wait 5 seconds
+        response = client.runs.get_sync(run.id)
+        run = response.data
+    
+    # Get the output data
+    if run.status == "success":
+        print("Result:", run.output_data)
+    else:
+        print("Run failed:", ", ".join(run.error or []))
 ```
 
+## Full Documentation
+
+For complete documentation including async/sync usage, error handling, and all available methods, visit:
+
+**[https://docs.cyberdesk.io/sdk-guides/python](https://docs.cyberdesk.io/sdk-guides/python)**
+
 ## Async Support
 
 The SDK provides both synchronous and asynchronous methods for all operations:

{cyberdesk-1.8.0 → cyberdesk-1.10.0}/cyberdesk/__init__.py

@@ -13,15 +13,21 @@ from .client import (
     RunUpdate,
     RunResponse,
     RunStatus,
+    FileInput,
     ConnectionCreate,
     ConnectionResponse,
     ConnectionStatus,
     TrajectoryCreate,
     TrajectoryUpdate,
     TrajectoryResponse,
+    RunAttachmentCreate,
+    RunAttachmentUpdate,
+    RunAttachmentResponse,
+    RunAttachmentDownloadUrlResponse,
+    AttachmentType,
 )
 
-__version__ = "1.8.0"
+__version__ = "1.10.0"
 
 __all__ = [
     "CyberdeskClient",
@@ -36,10 +42,16 @@ __all__ = [
     "RunUpdate",
     "RunResponse",
     "RunStatus",
+    "FileInput",
     "ConnectionCreate",
     "ConnectionResponse",
     "ConnectionStatus",
     "TrajectoryCreate",
     "TrajectoryUpdate",
     "TrajectoryResponse",
+    "RunAttachmentCreate",
+    "RunAttachmentUpdate",
+    "RunAttachmentResponse",
+    "RunAttachmentDownloadUrlResponse",
+    "AttachmentType",
 ] 

{cyberdesk-1.8.0 → cyberdesk-1.10.0}/cyberdesk/client.py

@@ -1,6 +1,7 @@
 """Cyberdesk Python SDK Client."""
 from typing import Optional, Dict, Any, Union
 from uuid import UUID
+from pathlib import Path
 import httpx
 from dataclasses import dataclass
 
@@ -40,6 +41,15 @@ from openapi_client.cyberdesk_cloud_client.api.trajectories import (
     delete_trajectory_v1_trajectories_trajectory_id_delete,
     get_latest_trajectory_for_workflow_v1_workflows_workflow_id_latest_trajectory_get,
 )
+from openapi_client.cyberdesk_cloud_client.api.run_attachments import (
+    list_run_attachments_v1_run_attachments_get,
+    create_run_attachment_v1_run_attachments_post,
+    get_run_attachment_v1_run_attachments_attachment_id_get,
+    download_run_attachment_v1_run_attachments_attachment_id_download_get,
+    get_run_attachment_download_url_v1_run_attachments_attachment_id_download_url_get,
+    update_run_attachment_v1_run_attachments_attachment_id_put,
+    delete_run_attachment_v1_run_attachments_attachment_id_delete,
+)
 
 # Import models
 from openapi_client.cyberdesk_cloud_client.models import (
@@ -54,17 +64,24 @@ from openapi_client.cyberdesk_cloud_client.models import (
     RunUpdate,
     RunResponse,
     RunStatus,
+    FileInput,
     ConnectionCreate,
     ConnectionResponse,
     ConnectionStatus,
     TrajectoryCreate,
     TrajectoryUpdate,
     TrajectoryResponse,
+    RunAttachmentCreate,
+    RunAttachmentUpdate,
+    RunAttachmentResponse,
+    RunAttachmentDownloadUrlResponse,
+    AttachmentType,
     PaginatedResponseMachineResponse,
     PaginatedResponseWorkflowResponse,
     PaginatedResponseRunResponse,
     PaginatedResponseConnectionResponse,
     PaginatedResponseTrajectoryResponse,
+    PaginatedResponseRunAttachmentResponse,
 )
 
 # Re-export common types
@@ -81,12 +98,18 @@ __all__ = [
     "RunUpdate",
     "RunResponse",
     "RunStatus",
+    "FileInput",
     "ConnectionCreate",
     "ConnectionResponse",
     "ConnectionStatus",
     "TrajectoryCreate",
     "TrajectoryUpdate",
     "TrajectoryResponse",
+    "RunAttachmentCreate",
+    "RunAttachmentUpdate",
+    "RunAttachmentResponse",
+    "RunAttachmentDownloadUrlResponse",
+    "AttachmentType",
 ]
 
 DEFAULT_API_BASE_URL = "https://api.cyberdesk.io"
@@ -738,6 +761,339 @@ class TrajectoriesAPI:
             return ApiResponse(error=e)
 
 
+class RunAttachmentsAPI:
+    """Run Attachments API endpoints."""
+    
+    def __init__(self, client: AuthenticatedClient):
+        self.client = client
+    
+    async def list(
+        self,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        run_id: Optional[str] = None,
+        attachment_type: Optional[AttachmentType] = None
+    ) -> ApiResponse:
+        """List run attachments with optional filtering."""
+        try:
+            response = await list_run_attachments_v1_run_attachments_get.asyncio(
+                client=self.client,
+                skip=_to_unset_or_value(skip),
+                limit=_to_unset_or_value(limit),
+                run_id=_to_uuid(run_id) if run_id else UNSET,
+                attachment_type=attachment_type
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def list_sync(
+        self,
+        skip: Optional[int] = None,
+        limit: Optional[int] = None,
+        run_id: Optional[str] = None,
+        attachment_type: Optional[AttachmentType] = None
+    ) -> ApiResponse:
+        """List run attachments with optional filtering (synchronous)."""
+        try:
+            response = list_run_attachments_v1_run_attachments_get.sync(
+                client=self.client,
+                skip=_to_unset_or_value(skip),
+                limit=_to_unset_or_value(limit),
+                run_id=_to_uuid(run_id) if run_id else UNSET,
+                attachment_type=attachment_type
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def create(self, data: RunAttachmentCreate) -> ApiResponse:
+        """Create a new run attachment."""
+        try:
+            response = await create_run_attachment_v1_run_attachments_post.asyncio(
+                client=self.client,
+                body=data
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def create_sync(self, data: RunAttachmentCreate) -> ApiResponse:
+        """Create a new run attachment (synchronous)."""
+        try:
+            response = create_run_attachment_v1_run_attachments_post.sync(
+                client=self.client,
+                body=data
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def get(self, attachment_id: str) -> ApiResponse:
+        """Get a specific run attachment by ID."""
+        try:
+            response = await get_run_attachment_v1_run_attachments_attachment_id_get.asyncio(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id)
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def get_sync(self, attachment_id: str) -> ApiResponse:
+        """Get a specific run attachment by ID (synchronous)."""
+        try:
+            response = get_run_attachment_v1_run_attachments_attachment_id_get.sync(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id)
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def get_download_url(
+        self, 
+        attachment_id: str,
+        expires_in: Optional[int] = None
+    ) -> ApiResponse:
+        """Get a signed download URL for a run attachment.
+        
+        The returned URL will trigger an automatic download when accessed in a browser.
+        
+        Args:
+            attachment_id: The ID of the attachment
+            expires_in: URL expiration time in seconds (10-3600). Default: 300 (5 minutes)
+        
+        Returns:
+            ApiResponse with RunAttachmentDownloadUrlResponse containing:
+                - url: The signed download URL
+                - expires_in: The expiration time in seconds
+        """
+        try:
+            response = await get_run_attachment_download_url_v1_run_attachments_attachment_id_download_url_get.asyncio(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id),
+                expires_in=_to_unset_or_value(expires_in)
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def get_download_url_sync(
+        self, 
+        attachment_id: str,
+        expires_in: Optional[int] = None
+    ) -> ApiResponse:
+        """Get a signed download URL for a run attachment (synchronous).
+        
+        The returned URL will trigger an automatic download when accessed in a browser.
+        
+        Args:
+            attachment_id: The ID of the attachment
+            expires_in: URL expiration time in seconds (10-3600). Default: 300 (5 minutes)
+        
+        Returns:
+            ApiResponse with RunAttachmentDownloadUrlResponse containing:
+                - url: The signed download URL
+                - expires_in: The expiration time in seconds
+        """
+        try:
+            response = get_run_attachment_download_url_v1_run_attachments_attachment_id_download_url_get.sync(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id),
+                expires_in=_to_unset_or_value(expires_in)
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def download(self, attachment_id: str) -> ApiResponse:
+        """Download a run attachment file directly.
+        
+        This method returns the raw file content as bytes. For a download URL instead,
+        use get_download_url().
+        
+        Args:
+            attachment_id: The ID of the attachment to download
+        
+        Returns:
+            ApiResponse with data containing the raw file bytes
+        """
+        try:
+            response = await download_run_attachment_v1_run_attachments_attachment_id_download_get.asyncio(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id)
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def download_sync(self, attachment_id: str) -> ApiResponse:
+        """Download a run attachment file directly (synchronous).
+        
+        This method returns the raw file content as bytes. For a download URL instead,
+        use get_download_url_sync().
+        
+        Args:
+            attachment_id: The ID of the attachment to download
+        
+        Returns:
+            ApiResponse with data containing the raw file bytes
+        """
+        try:
+            response = download_run_attachment_v1_run_attachments_attachment_id_download_get.sync(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id)
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def update(self, attachment_id: str, data: RunAttachmentUpdate) -> ApiResponse:
+        """Update a run attachment (e.g., set expiration)."""
+        try:
+            response = await update_run_attachment_v1_run_attachments_attachment_id_put.asyncio(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id),
+                body=data
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def update_sync(self, attachment_id: str, data: RunAttachmentUpdate) -> ApiResponse:
+        """Update a run attachment (e.g., set expiration) (synchronous)."""
+        try:
+            response = update_run_attachment_v1_run_attachments_attachment_id_put.sync(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id),
+                body=data
+            )
+            return ApiResponse(data=response)
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def delete(self, attachment_id: str) -> ApiResponse:
+        """Delete a run attachment."""
+        try:
+            await delete_run_attachment_v1_run_attachments_attachment_id_delete.asyncio(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id)
+            )
+            return ApiResponse(data={"success": True})
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def delete_sync(self, attachment_id: str) -> ApiResponse:
+        """Delete a run attachment (synchronous)."""
+        try:
+            delete_run_attachment_v1_run_attachments_attachment_id_delete.sync(
+                client=self.client,
+                attachment_id=_to_uuid(attachment_id)
+            )
+            return ApiResponse(data={"success": True})
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    async def save_to_file(
+        self,
+        attachment_id: str,
+        output_path: Optional[Union[str, Path]] = None,
+        use_original_filename: bool = True
+    ) -> ApiResponse:
+        """Download and save a run attachment to a file.
+        
+        This is a convenience method that combines getting attachment info
+        and downloading the file content.
+        
+        Args:
+            attachment_id: The ID of the attachment to download
+            output_path: Path where to save the file. If None and use_original_filename
+                        is True, saves to current directory with original filename.
+            use_original_filename: If True and output_path is a directory, uses the
+                                 attachment's original filename.
+        
+        Returns:
+            ApiResponse with data containing the saved file path
+        """
+        try:
+            # Get attachment info for filename
+            info_response = await self.get(attachment_id)
+            if info_response.error:
+                return info_response
+            
+            attachment_info = info_response.data
+            
+            # Download the file content
+            download_response = await self.download(attachment_id)
+            if download_response.error:
+                return download_response
+            
+            # Determine output path
+            if output_path is None:
+                output_path = Path(attachment_info.filename)
+            else:
+                output_path = Path(output_path)
+                if output_path.is_dir() and use_original_filename:
+                    output_path = output_path / attachment_info.filename
+            
+            # Save to file
+            output_path.write_bytes(download_response.data)
+            
+            return ApiResponse(data={"path": str(output_path), "size": len(download_response.data)})
+        except Exception as e:
+            return ApiResponse(error=e)
+    
+    def save_to_file_sync(
+        self,
+        attachment_id: str,
+        output_path: Optional[Union[str, Path]] = None,
+        use_original_filename: bool = True
+    ) -> ApiResponse:
+        """Download and save a run attachment to a file (synchronous).
+        
+        This is a convenience method that combines getting attachment info
+        and downloading the file content.
+        
+        Args:
+            attachment_id: The ID of the attachment to download
+            output_path: Path where to save the file. If None and use_original_filename
+                        is True, saves to current directory with original filename.
+            use_original_filename: If True and output_path is a directory, uses the
+                                 attachment's original filename.
+        
+        Returns:
+            ApiResponse with data containing the saved file path
+        """
+        try:
+            # Get attachment info for filename
+            info_response = self.get_sync(attachment_id)
+            if info_response.error:
+                return info_response
+            
+            attachment_info = info_response.data
+            
+            # Download the file content
+            download_response = self.download_sync(attachment_id)
+            if download_response.error:
+                return download_response
+            
+            # Determine output path
+            if output_path is None:
+                output_path = Path(attachment_info.filename)
+            else:
+                output_path = Path(output_path)
+                if output_path.is_dir() and use_original_filename:
+                    output_path = output_path / attachment_info.filename
+            
+            # Save to file
+            output_path.write_bytes(download_response.data)
+            
+            return ApiResponse(data={"path": str(output_path), "size": len(download_response.data)})
+        except Exception as e:
+            return ApiResponse(error=e)
+
+
 class CyberdeskClient:
     """Main Cyberdesk SDK client."""
     
@@ -762,6 +1118,7 @@ class CyberdeskClient:
         self.runs = RunsAPI(self._client)
         self.connections = ConnectionsAPI(self._client)
         self.trajectories = TrajectoriesAPI(self._client)
+        self.run_attachments = RunAttachmentsAPI(self._client)
         
         # TODO: Add computer API for screenshot functionality
         # The openapi-python-client doesn't generate code for binary responses like PNG images

{cyberdesk-1.8.0 → cyberdesk-1.10.0}/cyberdesk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberdesk
-Version: 1.8.0
+Version: 1.10.0
 Summary: The official Python SDK for Cyberdesk
 Author-email: Cyberdesk Team <dev@cyberdesk.io>
 License-Expression: MIT
@@ -26,30 +26,52 @@ pip install cyberdesk
 
 ## Quick Start
 
+The most common use case is to execute workflows that you've created in the [Cyberdesk Dashboard](https://cyberdesk.io/dashboard).
+
 ```python
-from cyberdesk import CyberdeskClient
+from cyberdesk import CyberdeskClient, RunCreate
+import time
 
 # Initialize the client
 client = CyberdeskClient(api_key="your-api-key")
 
-# List machines
-response = client.machines.list_sync()
-if response.data:
-    for machine in response.data.items:
-        print(f"Machine: {machine.name} - Status: {machine.status}")
-
-# Create a workflow
-from cyberdesk import WorkflowCreate
-
-workflow_data = WorkflowCreate(
-    name="My Workflow",
-    description="Automated task workflow"
+# Create a run for your workflow
+run_data = RunCreate(
+    workflow_id="your-workflow-id",
+    machine_id="your-machine-id",
+    input_values={
+        # Your workflow-specific input data
+        "patient_id": "12345",
+        "patient_first_name": "John",
+        "patient_last_name": "Doe"
+    }
 )
-response = client.workflows.create_sync(workflow_data)
-if response.data:
-    print(f"Created workflow: {response.data.id}")
+
+response = client.runs.create_sync(run_data)
+if response.error:
+    print(f"Error creating run: {response.error}")
+else:
+    run = response.data
+    
+    # Wait for the run to complete
+    while run.status in ["scheduling", "running"]:
+        time.sleep(5)  # Wait 5 seconds
+        response = client.runs.get_sync(run.id)
+        run = response.data
+    
+    # Get the output data
+    if run.status == "success":
+        print("Result:", run.output_data)
+    else:
+        print("Run failed:", ", ".join(run.error or []))
 ```
 
+## Full Documentation
+
+For complete documentation including async/sync usage, error handling, and all available methods, visit:
+
+**[https://docs.cyberdesk.io/sdk-guides/python](https://docs.cyberdesk.io/sdk-guides/python)**
+
 ## Async Support
 
 The SDK provides both synchronous and asynchronous methods for all operations: