cyberdesk 1.9.0__tar.gz → 1.10.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberdesk
-Version: 1.9.0
+Version: 1.10.0
 Summary: The official Python SDK for Cyberdesk
 Author-email: Cyberdesk Team <dev@cyberdesk.io>
 License-Expression: MIT

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

@@ -23,10 +23,11 @@ from .client import (
     RunAttachmentCreate,
     RunAttachmentUpdate,
     RunAttachmentResponse,
+    RunAttachmentDownloadUrlResponse,
     AttachmentType,
 )
 
-__version__ = "1.9.0"
+__version__ = "1.10.0"
 
 __all__ = [
     "CyberdeskClient",
@@ -51,5 +52,6 @@ __all__ = [
     "RunAttachmentCreate",
     "RunAttachmentUpdate",
     "RunAttachmentResponse",
+    "RunAttachmentDownloadUrlResponse",
     "AttachmentType",
 ] 

{cyberdesk-1.9.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
 
@@ -45,6 +46,7 @@ from openapi_client.cyberdesk_cloud_client.api.run_attachments import (
     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,
 )
@@ -72,6 +74,7 @@ from openapi_client.cyberdesk_cloud_client.models import (
     RunAttachmentCreate,
     RunAttachmentUpdate,
     RunAttachmentResponse,
+    RunAttachmentDownloadUrlResponse,
     AttachmentType,
     PaginatedResponseMachineResponse,
     PaginatedResponseWorkflowResponse,
@@ -105,6 +108,7 @@ __all__ = [
     "RunAttachmentCreate",
     "RunAttachmentUpdate",
     "RunAttachmentResponse",
+    "RunAttachmentDownloadUrlResponse",
     "AttachmentType",
 ]
 
@@ -847,14 +851,75 @@ class RunAttachmentsAPI:
         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.
+        """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 file bytes or a download URL
+            ApiResponse with data containing the raw file bytes
         """
         try:
-            # The download endpoint typically returns binary data or a redirect URL
             response = await download_run_attachment_v1_run_attachments_attachment_id_download_get.asyncio(
                 client=self.client,
                 attachment_id=_to_uuid(attachment_id)
@@ -864,10 +929,16 @@ class RunAttachmentsAPI:
             return ApiResponse(error=e)
     
     def download_sync(self, attachment_id: str) -> ApiResponse:
-        """Download a run attachment file (synchronous).
+        """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 file bytes or a download URL
+            ApiResponse with data containing the raw file bytes
         """
         try:
             response = download_run_attachment_v1_run_attachments_attachment_id_download_get.sync(
@@ -923,6 +994,104 @@ class RunAttachmentsAPI:
             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:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberdesk
-Version: 1.9.0
+Version: 1.10.0
 Summary: The official Python SDK for Cyberdesk
 Author-email: Cyberdesk Team <dev@cyberdesk.io>
 License-Expression: MIT

{cyberdesk-1.9.0 → cyberdesk-1.10.0}/cyberdesk.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ openapi_client/cyberdesk_cloud_client/api/run_attachments/__init__.py
 openapi_client/cyberdesk_cloud_client/api/run_attachments/create_run_attachment_v1_run_attachments_post.py
 openapi_client/cyberdesk_cloud_client/api/run_attachments/delete_run_attachment_v1_run_attachments_attachment_id_delete.py
 openapi_client/cyberdesk_cloud_client/api/run_attachments/download_run_attachment_v1_run_attachments_attachment_id_download_get.py
+openapi_client/cyberdesk_cloud_client/api/run_attachments/get_run_attachment_download_url_v1_run_attachments_attachment_id_download_url_get.py
 openapi_client/cyberdesk_cloud_client/api/run_attachments/get_run_attachment_v1_run_attachments_attachment_id_get.py
 openapi_client/cyberdesk_cloud_client/api/run_attachments/list_run_attachments_v1_run_attachments_get.py
 openapi_client/cyberdesk_cloud_client/api/run_attachments/update_run_attachment_v1_run_attachments_attachment_id_put.py
@@ -119,6 +120,7 @@ openapi_client/cyberdesk_cloud_client/models/request_log_create.py
 openapi_client/cyberdesk_cloud_client/models/request_log_response.py
 openapi_client/cyberdesk_cloud_client/models/request_log_update.py
 openapi_client/cyberdesk_cloud_client/models/run_attachment_create.py
+openapi_client/cyberdesk_cloud_client/models/run_attachment_download_url_response.py
 openapi_client/cyberdesk_cloud_client/models/run_attachment_response.py
 openapi_client/cyberdesk_cloud_client/models/run_attachment_update.py
 openapi_client/cyberdesk_cloud_client/models/run_create.py

{cyberdesk-1.9.0 → cyberdesk-1.10.0}/openapi_client/cyberdesk_cloud_client/api/run_attachments/download_run_attachment_v1_run_attachments_attachment_id_download_get.py

@@ -57,7 +57,7 @@ def sync_detailed(
 
      Download a run attachment file.
 
-    Returns the file content as a streaming response.
+    Returns the raw file content as a streaming response.
 
     Args:
         attachment_id (UUID):
@@ -90,7 +90,7 @@ def sync(
 
      Download a run attachment file.
 
-    Returns the file content as a streaming response.
+    Returns the raw file content as a streaming response.
 
     Args:
         attachment_id (UUID):
@@ -118,7 +118,7 @@ async def asyncio_detailed(
 
      Download a run attachment file.
 
-    Returns the file content as a streaming response.
+    Returns the raw file content as a streaming response.
 
     Args:
         attachment_id (UUID):
@@ -149,7 +149,7 @@ async def asyncio(
 
      Download a run attachment file.
 
-    Returns the file content as a streaming response.
+    Returns the raw file content as a streaming response.
 
     Args:
         attachment_id (UUID):

cyberdesk-1.10.0/openapi_client/cyberdesk_cloud_client/api/run_attachments/get_run_attachment_download_url_v1_run_attachments_attachment_id_download_url_get.py

@@ -0,0 +1,209 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.run_attachment_download_url_response import RunAttachmentDownloadUrlResponse
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    attachment_id: UUID,
+    *,
+    expires_in: Union[Unset, int] = 300,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["expires_in"] = expires_in
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/v1/run-attachments/{attachment_id}/download-url",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]:
+    if response.status_code == 200:
+        response_200 = RunAttachmentDownloadUrlResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    attachment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    expires_in: Union[Unset, int] = 300,
+) -> Response[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]:
+    """Get Run Attachment Download Url
+
+     Get a signed download URL for a run attachment file.
+
+    Returns a signed URL that triggers automatic download when accessed.
+
+    Args:
+        attachment_id: The ID of the attachment to download
+        expires_in: URL expiration time in seconds (10-3600). Default: 300 (5 minutes)
+
+    Args:
+        attachment_id (UUID):
+        expires_in (Union[Unset, int]): URL expiration time in seconds (10-3600) Default: 300.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        attachment_id=attachment_id,
+        expires_in=expires_in,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    attachment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    expires_in: Union[Unset, int] = 300,
+) -> Optional[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]:
+    """Get Run Attachment Download Url
+
+     Get a signed download URL for a run attachment file.
+
+    Returns a signed URL that triggers automatic download when accessed.
+
+    Args:
+        attachment_id: The ID of the attachment to download
+        expires_in: URL expiration time in seconds (10-3600). Default: 300 (5 minutes)
+
+    Args:
+        attachment_id (UUID):
+        expires_in (Union[Unset, int]): URL expiration time in seconds (10-3600) Default: 300.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]
+    """
+
+    return sync_detailed(
+        attachment_id=attachment_id,
+        client=client,
+        expires_in=expires_in,
+    ).parsed
+
+
+async def asyncio_detailed(
+    attachment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    expires_in: Union[Unset, int] = 300,
+) -> Response[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]:
+    """Get Run Attachment Download Url
+
+     Get a signed download URL for a run attachment file.
+
+    Returns a signed URL that triggers automatic download when accessed.
+
+    Args:
+        attachment_id: The ID of the attachment to download
+        expires_in: URL expiration time in seconds (10-3600). Default: 300 (5 minutes)
+
+    Args:
+        attachment_id (UUID):
+        expires_in (Union[Unset, int]): URL expiration time in seconds (10-3600) Default: 300.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        attachment_id=attachment_id,
+        expires_in=expires_in,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    attachment_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    expires_in: Union[Unset, int] = 300,
+) -> Optional[Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]]:
+    """Get Run Attachment Download Url
+
+     Get a signed download URL for a run attachment file.
+
+    Returns a signed URL that triggers automatic download when accessed.
+
+    Args:
+        attachment_id: The ID of the attachment to download
+        expires_in: URL expiration time in seconds (10-3600). Default: 300 (5 minutes)
+
+    Args:
+        attachment_id (UUID):
+        expires_in (Union[Unset, int]): URL expiration time in seconds (10-3600) Default: 300.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, RunAttachmentDownloadUrlResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            attachment_id=attachment_id,
+            client=client,
+            expires_in=expires_in,
+        )
+    ).parsed

{cyberdesk-1.9.0 → cyberdesk-1.10.0}/openapi_client/cyberdesk_cloud_client/models/__init__.py

@@ -57,6 +57,7 @@ from .request_log_create import RequestLogCreate
 from .request_log_response import RequestLogResponse
 from .request_log_update import RequestLogUpdate
 from .run_attachment_create import RunAttachmentCreate
+from .run_attachment_download_url_response import RunAttachmentDownloadUrlResponse
 from .run_attachment_response import RunAttachmentResponse
 from .run_attachment_update import RunAttachmentUpdate
 from .run_create import RunCreate
@@ -126,6 +127,7 @@ __all__ = (
     "RequestLogResponse",
     "RequestLogUpdate",
     "RunAttachmentCreate",
+    "RunAttachmentDownloadUrlResponse",
     "RunAttachmentResponse",
     "RunAttachmentUpdate",
     "RunCreate",

cyberdesk-1.10.0/openapi_client/cyberdesk_cloud_client/models/run_attachment_download_url_response.py

@@ -0,0 +1,68 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="RunAttachmentDownloadUrlResponse")
+
+
+@_attrs_define
+class RunAttachmentDownloadUrlResponse:
+    """Response schema for run attachment download URL
+
+    Attributes:
+        url (str): Signed URL for downloading the attachment
+        expires_in (int): Seconds until the URL expires
+    """
+
+    url: str
+    expires_in: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        url = self.url
+
+        expires_in = self.expires_in
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "url": url,
+                "expires_in": expires_in,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        url = d.pop("url")
+
+        expires_in = d.pop("expires_in")
+
+        run_attachment_download_url_response = cls(
+            url=url,
+            expires_in=expires_in,
+        )
+
+        run_attachment_download_url_response.additional_properties = d
+        return run_attachment_download_url_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

{cyberdesk-1.9.0 → cyberdesk-1.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cyberdesk"
-version = "1.9.0"
+version = "1.10.0"
 description = "The official Python SDK for Cyberdesk"
 authors = [{name = "Cyberdesk Team", email = "dev@cyberdesk.io"}]
 readme = "README.md"