unique_sdk 0.10.13__tar.gz → 0.10.14__tar.gz

{unique_sdk-0.10.13 → unique_sdk-0.10.14}/CHANGELOG.md

@@ -5,6 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.14] - 2025-08-28
+- Add function to delete folders and files recursively
+
 ## [0.10.13] - 2025-08-24
 - Add functions to create, get and update a message eecution and create and update a message log.
 

{unique_sdk-0.10.13 → unique_sdk-0.10.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.13
+Version: 0.10.14
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -1080,6 +1080,34 @@ unique_sdk.Folder.remove_access(
 )
 ```
 
+#### `unique_sdk.Folder.delete` (Compatible with release >.36)
+
+Given a `scopeId` or `folderPath`, the function deletes the folder. If the folder is not empty or if the user has no WRITE access, the delete will fail.
+
+If `recursive` is set to true, the function also deletes its subfolders and its contents, behaving exactly like the `rm -rf`. In case a subfolder has no write access, that folder is considered as failed to delete and the function continues with the other subfolders. At the end, the function returns a list of `successFolders` and `failedFolders`.
+
+Examples:
+Deleting recursively by scope id:
+
+```python
+unique_sdk.Folder.delete(
+   user_id=user_id,
+   company_id=company_id,
+   scopeId="scope_w78wfn114va9o22s13r03yq",
+   recursive=True
+)
+```
+
+Deleting by path (non-recursive):
+
+```python
+unique_sdk.Folder.delete(
+   user_id=user_id,
+   company_id=company_id,
+   folderPath="/Company/Atlas/Due Dilligence/Arch",
+)
+```
+
 ### Space
 
 #### `unique_sdk.Space.delete_chat`
@@ -1488,6 +1516,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.14] - 2025-08-28
+- Add function to delete folders and files recursively
+
 ## [0.10.13] - 2025-08-24
 - Add functions to create, get and update a message eecution and create and update a message log.
 

{unique_sdk-0.10.13 → unique_sdk-0.10.14}/README.md

@@ -1064,6 +1064,34 @@ unique_sdk.Folder.remove_access(
 )
 ```
 
+#### `unique_sdk.Folder.delete` (Compatible with release >.36)
+
+Given a `scopeId` or `folderPath`, the function deletes the folder. If the folder is not empty or if the user has no WRITE access, the delete will fail.
+
+If `recursive` is set to true, the function also deletes its subfolders and its contents, behaving exactly like the `rm -rf`. In case a subfolder has no write access, that folder is considered as failed to delete and the function continues with the other subfolders. At the end, the function returns a list of `successFolders` and `failedFolders`.
+
+Examples:
+Deleting recursively by scope id:
+
+```python
+unique_sdk.Folder.delete(
+   user_id=user_id,
+   company_id=company_id,
+   scopeId="scope_w78wfn114va9o22s13r03yq",
+   recursive=True
+)
+```
+
+Deleting by path (non-recursive):
+
+```python
+unique_sdk.Folder.delete(
+   user_id=user_id,
+   company_id=company_id,
+   folderPath="/Company/Atlas/Due Dilligence/Arch",
+)
+```
+
 ### Space
 
 #### `unique_sdk.Space.delete_chat`

{unique_sdk-0.10.13 → unique_sdk-0.10.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_sdk"
-version = "0.10.13"
+version = "0.10.14"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",

{unique_sdk-0.10.13 → unique_sdk-0.10.14}/unique_sdk/api_resources/_folder.py

@@ -135,6 +135,15 @@ class Folder(APIResource["Folder"]):
         scopeAccesses: List["Folder.ScopeAccess"]
         applyToSubScopes: bool
 
+    class DeleteFolderParams(TypedDict):
+        """
+        Parameters for deleting a folder.
+        """
+
+        scopeId: NotRequired[str]
+        folderPath: NotRequired[str]
+        recursive: NotRequired[bool]
+
     class GetParams(RequestOptions):
         """
         Parameters for getting a folder by its Id or path.
@@ -152,6 +161,24 @@ class Folder(APIResource["Folder"]):
         take: NotRequired[int]
         skip: NotRequired[int]
 
+    class DeleteFolderResponse(TypedDict):
+        """
+        Response for deleting a folder.
+        """
+
+        id: str
+        name: str
+        path: str
+        failReason: NotRequired[str]
+
+    class DeleteResponse(TypedDict):
+        """
+        Response for deleting a folder.
+        """
+
+        successFolders: List["Folder.DeleteFolderResponse"]
+        failedFolders: List["Folder.DeleteFolderResponse"]
+
     @classmethod
     def get_info(
         cls, user_id: str, company_id: str, **params: Unpack["Folder.GetParams"]
@@ -379,3 +406,86 @@ class Folder(APIResource["Folder"]):
                 params=params,
             ),
         )
+
+    @classmethod
+    def delete(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Folder.DeleteFolderParams"],
+    ) -> "Folder.DeleteResponse":
+        """
+        Delete a folder by its ID or path.
+        """
+
+        scopeId = cls.resolve_scope_id(
+            user_id, company_id, params.get("scopeId"), params.get("folderPath")
+        )
+        params.pop("scopeId", None)
+        params.pop("folderPath", None)
+
+        return cast(
+            "Folder.DeleteResponse",
+            cls._static_request(
+                "delete",
+                f"{cls.RESOURCE_URL}/{scopeId}",
+                user_id,
+                company_id=company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def delete_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Folder.DeleteFolderParams"],
+    ) -> "Folder.DeleteResponse":
+        """
+        Async delete a folder by its ID or path.
+        """
+        scopeId = cls.resolve_scope_id(
+            user_id, company_id, params.get("scopeId"), params.get("folderPath")
+        )
+        params.pop("scopeId", None)
+        params.pop("folderPath", None)
+
+        return cast(
+            "Folder.DeleteResponse",
+            await cls._static_request_async(
+                "delete",
+                f"{cls.RESOURCE_URL}/{scopeId}",
+                user_id,
+                company_id=company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    def resolve_scope_id(
+        cls,
+        user_id: str,
+        company_id: str,
+        scope_id: str | None = None,
+        folder_path: str | None = None,
+    ) -> str | None:
+        """
+        Returns the scopeId to use: if scope_id is provided, returns it;
+        if not, but folder_path is provided, resolves and returns the id for that folder path.
+        """
+        if scope_id:
+            return scope_id
+        if folder_path:
+            folder_info = cls.get_info(
+                user_id=user_id,
+                company_id=company_id,
+                folderPath=folder_path,
+            )
+            resolved_id = folder_info.get("id")
+            if not resolved_id:
+                raise ValueError(
+                    f"Could not find a folder with folderPath: {folder_path}"
+                )
+            return resolved_id
+        return None