evo-files 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

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.3.dist-info → evo_files-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evo-files
-Version: 0.2.3
+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.3.dist-info → evo_files-0.2.4.dist-info}/RECORD

@@ -1,6 +1,6 @@
 evo/files/__init__.py,sha256=jX2_a4BNg92QZFNEXaBpvpcSgbqRyOXrWx1JIkLUZqk,887
 evo/files/_model_config.py,sha256=612yrPQyY-vquEboZdmSWkt8nT2ttbfBy476FyruV30,827
-evo/files/client.py,sha256=-zfbeym3l9_3t-OjenWj-1k5ZVpLtpsNdmTiMi3PUVU,12847
+evo/files/client.py,sha256=K0xYOrN6-B5CGE9ICXYmTs8o70SlpUAPh_uOAyQs3XE,14485
 evo/files/data.py,sha256=J9hieUY6LAeYhmIpRorMNcgjsYuSsO5R7_s1qnDAIlM,2380
 evo/files/io.py,sha256=wlHEXusTOhSRLCU1FWUD4q0p7xiav6VPVEWNP4I40xk,6689
 evo/files/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -8,7 +8,7 @@ evo/files/endpoints/__init__.py,sha256=R2TBKqKH94CPUgEuftAAdm_gVp24Eepzv6romBDkD
 evo/files/endpoints/models.py,sha256=rz7wqkhfen9_wqQqj0mEUbKKnkA0AYniEe9QnoigdPY,4640
 evo/files/endpoints/api/__init__.py,sha256=dHngHmRPwy-Kixoz7BP4ur4qzV4z9T2e8ccTqBtpuio,650
 evo/files/endpoints/api/file_v2_api.py,sha256=1eLvxPuJuB_24u_pdPow-Dcsw8vP-nW0ghsAnzyt7qU,34401
-evo_files-0.2.3.dist-info/METADATA,sha256=suQ3vq7fFWUGfScEP_cmsqx0VrpFbkd4mLjk-eNFgEA,3703
-evo_files-0.2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-evo_files-0.2.3.dist-info/licenses/LICENSE.md,sha256=HcFeRdOI-VP5WPEymQerlwLvEj2z_1Yh66RkN-wN7Oc,10778
-evo_files-0.2.3.dist-info/RECORD,,
+evo_files-0.2.4.dist-info/METADATA,sha256=QnaVgwpaB8yY2yFaBZupKAoKy1rLXS3v0Z13KzMmqCs,3703
+evo_files-0.2.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+evo_files-0.2.4.dist-info/licenses/LICENSE.md,sha256=HcFeRdOI-VP5WPEymQerlwLvEj2z_1Yh66RkN-wN7Oc,10778
+evo_files-0.2.4.dist-info/RECORD,,

{evo_files-0.2.3.dist-info → evo_files-0.2.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any