evo-files 0.2.2__tar.gz → 0.2.4__tar.gz

{evo_files-0.2.2 → evo_files-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evo-files
-Version: 0.2.2
+Version: 0.2.4
 Summary: Python SDK for using the Seequent Evo File API
 Project-URL: Source, https://github.com/SeequentEvo/evo-python-sdk
 Project-URL: Tracker, https://github.com/SeequentEvo/evo-python-sdk/issues

{evo_files-0.2.2 → evo_files-0.2.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "evo-files"
 description = "Python SDK for using the Seequent Evo File API"
-version = "0.2.2"
+version = "0.2.4"
 requires-python = ">=3.10"
 license-files = ["LICENSE.md"]
 dynamic = ["readme"]

{evo_files-0.2.2 → evo_files-0.2.4}/src/evo/files/client.py

@@ -15,7 +15,16 @@ from pathlib import PurePosixPath
 from uuid import UUID
 
 from evo import logging
-from evo.common import APIConnector, BaseAPIClient, Environment, HealthCheckType, Page, ServiceHealth, ServiceUser
+from evo.common import (
+    APIConnector,
+    BaseAPIClient,
+    Environment,
+    HealthCheckType,
+    Page,
+    ServiceHealth,
+    ServiceUser,
+)
+from evo.common.data import EmptyResponse
 from evo.common.utils import get_service_health
 
 from .data import FileMetadata, FileVersion
@@ -123,6 +132,7 @@ class FileAPIClient(BaseAPIClient):
         offset: int = 0,
         limit: int = 5000,
         name: str | None = None,
+        deleted: bool = False,
     ) -> Page[FileMetadata]:
         """List up to `limit` files in the workspace, starting at `offset`.
 
@@ -132,6 +142,7 @@ class FileAPIClient(BaseAPIClient):
         :param offset: The number of files to skip before listing.
         :param limit: Max number of files to list.
         :param name: Filter files by name.
+        :param deleted: Only include deleted files in the listing.
 
         :return: A page of all files from the query.
         """
@@ -143,6 +154,7 @@ class FileAPIClient(BaseAPIClient):
             limit=limit,
             offset=offset,
             file_name=name,
+            deleted=deleted,
         )
         return Page(
             offset=offset,
@@ -151,20 +163,23 @@ class FileAPIClient(BaseAPIClient):
             items=[self._metadata_from_listed_file(file) for file in response.files],
         )
 
-    async def list_all_files(self, limit_per_request: int = 5000, name: str | None = None) -> list[FileMetadata]:
+    async def list_all_files(
+        self, limit_per_request: int = 5000, name: str | None = None, deleted: bool = False
+    ) -> list[FileMetadata]:
         """List all files in the workspace.
 
         This method makes multiple calls to the `list_files` endpoint until all files have been listed.
 
         :param limit_per_request: The maximum number of files to list in one request.
         :param name: Filter files by name.
+        :param deleted: Only include deleted files in the listing.
 
         :return: A list of all files in the workspace.
         """
         items = []
         offset = 0
         while True:
-            page = await self.list_files(offset=offset, limit=limit_per_request, name=name)
+            page = await self.list_files(offset=offset, limit=limit_per_request, name=name, deleted=deleted)
             items += page.items()
             if page.is_last:
                 break
@@ -186,11 +201,12 @@ class FileAPIClient(BaseAPIClient):
         )
         return self._metadata_from_endpoint_model(file_response)
 
-    async def get_file_by_id(self, file_id: UUID, version_id: str | None = None) -> FileMetadata:
+    async def get_file_by_id(self, file_id: UUID, version_id: str | None = None, deleted: bool = False) -> FileMetadata:
         """Get a file by its ID.
 
         :param file_id: UUID of a file
         :param version_id: ID of the desired file version. By default, the response will return the latest version.
+        :param deleted: Optional flag to include deleted files.
         :return: A FileMetadata representation of the file on the service
         """
         file_response = await self._api.get_file_by_id(
@@ -198,6 +214,7 @@ class FileAPIClient(BaseAPIClient):
             workspace_id=str(self._environment.workspace_id),
             file_id=str(file_id),
             version_id=version_id,
+            deleted=deleted,
         )
         return self._metadata_from_endpoint_model(file_response)
 
@@ -215,10 +232,11 @@ class FileAPIClient(BaseAPIClient):
         )
         return _versions_from_listed_versions(file_response.versions)
 
-    async def list_versions_by_id(self, file_id: UUID) -> list[FileVersion]:
+    async def list_versions_by_id(self, file_id: UUID, deleted: bool = False) -> list[FileVersion]:
         """List the versions of a file by ID
 
         :param file_id: UUID of the file.
+        :param deleted: Optional flag to include deleted files.
         :return: A sorted list of file versions. The latest version is the first element of the list.
         """
         file_response = await self._api.get_file_by_id(
@@ -226,6 +244,7 @@ class FileAPIClient(BaseAPIClient):
             workspace_id=str(self._environment.workspace_id),
             file_id=str(file_id),
             include_versions=True,
+            deleted=deleted,
         )
         return _versions_from_listed_versions(file_response.versions)
 
@@ -246,12 +265,14 @@ class FileAPIClient(BaseAPIClient):
         metadata = self._metadata_from_endpoint_model(response)
         return FileAPIDownload(connector=self._connector, metadata=metadata, initial_url=response.download)
 
-    async def prepare_download_by_id(self, file_id: UUID, version_id: str | None = None) -> FileAPIDownload:
+    async def prepare_download_by_id(
+        self, file_id: UUID, version_id: str | None = None, deleted: bool = False
+    ) -> FileAPIDownload:
         """Prepares a file for download by ID.
 
         :param file_id: UUID of the file.
         :param version_id: Version of the file.
-
+        :param deleted: Optional flag to include deleted files.
         :return: A FileAPIDownload object.
         """
         response = await self._api.get_file_by_id(
@@ -259,6 +280,7 @@ class FileAPIClient(BaseAPIClient):
             workspace_id=str(self._environment.workspace_id),
             file_id=str(file_id),
             version_id=version_id,
+            deleted=deleted,
         )
         metadata = self._metadata_from_endpoint_model(response)
         return FileAPIDownload(connector=self._connector, metadata=metadata, initial_url=response.download)
@@ -304,6 +326,30 @@ class FileAPIClient(BaseAPIClient):
             initial_url=response.upload,
         )
 
+    async def restore_file_by_id(self, file_id: UUID) -> FileMetadata | None:
+        """Restore a deleted file by ID.
+
+        :param file_id: UUID of the file.
+
+        :return: FileMetadata if the file path changed during restore (HTTP 303),
+                 None if the file was restored without path change (HTTP 204).
+        """
+        response = await self._api.update_file_by_id(
+            organisation_id=str(self._environment.org_id),
+            workspace_id=str(self._environment.workspace_id),
+            file_id=str(file_id),
+            deleted=False,
+        )
+
+        if isinstance(response, DownloadFileResponse):
+            # HTTP 303: File restored with path change (e.g., rename on restore)
+            return self._metadata_from_endpoint_model(response)
+        elif isinstance(response, EmptyResponse):
+            # HTTP 204: File restored without path change
+            return None
+        else:
+            return None
+
     async def delete_file_by_path(self, path: str) -> None:
         """Deletes a file by path.
 

{evo_files-0.2.2 → evo_files-0.2.4}/src/evo/files/endpoints/__init__.py

@@ -24,7 +24,7 @@ For more information on using the File API, see [Overview](https://developer.see
 
 
 This code is generated from the OpenAPI specification for File API.
-API version: 2.8.0
+API version: 2.10.0
 """
 
 # Import endpoint apis.

{evo_files-0.2.2 → evo_files-0.2.4}/src/evo/files/endpoints/api/file_v2_api.py

@@ -24,11 +24,12 @@ For more information on using the File API, see [Overview](https://developer.see
 
 
 This code is generated from the OpenAPI specification for File API.
-API version: 2.8.0
+API version: 2.10.0
 """
 
 from evo.common.connector import APIConnector
 from evo.common.data import EmptyResponse, RequestMethod
+from evo.common.utils import get_header_metadata
 
 from ..models import *  # noqa: F403
 
@@ -95,7 +96,7 @@ class FileV2Api:
         }
 
         # Prepare the header parameters.
-        _header_params = {}
+        _header_params = {} | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)
 
@@ -161,7 +162,7 @@ class FileV2Api:
         }
 
         # Prepare the header parameters.
-        _header_params = {}
+        _header_params = {} | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)
 
@@ -249,7 +250,7 @@ class FileV2Api:
         # Prepare the header parameters.
         _header_params = {
             "Accept": "application/json",
-        }
+        } | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)
 
@@ -332,7 +333,7 @@ class FileV2Api:
         # Prepare the header parameters.
         _header_params = {
             "Accept": "application/json",
-        }
+        } | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)
 
@@ -458,7 +459,7 @@ class FileV2Api:
         # Prepare the header parameters.
         _header_params = {
             "Accept": "application/json",
-        }
+        } | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)
 
@@ -546,7 +547,7 @@ class FileV2Api:
         # Prepare the header parameters.
         _header_params = {
             "Accept": "application/json",
-        }
+        } | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)
 
@@ -626,7 +627,7 @@ class FileV2Api:
         # Prepare the header parameters.
         _header_params = {
             "Accept": "application/json",
-        }
+        } | get_header_metadata(__name__)
         if additional_headers is not None:
             _header_params.update(additional_headers)