unique_sdk 0.10.23__tar.gz → 0.10.25__tar.gz

{unique_sdk-0.10.23 → unique_sdk-0.10.25}/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.25] - 2025-09-18
+- Add support for udpate and delete files by file or folder path.
+
+## [0.10.24] - 2025-09-17
+- Add function to update a folder.
+
 ## [0.10.23] - 2025-09-12
 - Revert to using default reasoning effort.
 

{unique_sdk-0.10.23 → unique_sdk-0.10.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.23
+Version: 0.10.25
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -558,21 +558,34 @@ Allows you to ingest a magic table sheet, each row is processed and converted in
 
 #### `unique_sdk.Content.update` (Compatible with release >.36)
 
-Allows you to update a file specified by its `contentId`.
+Allows you to update a file specified by its `contentId` or by its `filePath`.
 
-- `contentId` the id of the file to be updated
+- `contentId` optional if `filePath` is provided, the id of the file to be updated
+- `filePath` optional if `contentId` is provided, the absolute path of the file to be updated
 
 Currently, the following updates are supported:
 
 Title update:
 - `title` optional, allows updating the title of the file
 
-Move the file to a different folder. this can be done by specifying either the `ownerId`.
-- `ownerId` optional, allows moving the file to a different folder. Represents the new folder for the file and it should be the id of a folder e.g.: `scope_dhjfieurfloakmdle`. 
+Move the file to a different folder. This can be done by specifying either the `ownerId` or the `parentFolderPath`.
+- `ownerId` optional, allows moving the file to a different folder. Represents the new folder for the file and it should be the id of a folder e.g.: `scope_dhjfieurfloakmdle`.
+- `parentFolderPath` optional, allows moving the file to a different folder. Represents the path new folder for the file.
 
 Metadata update:
 - `metadata` optional, allows updating the metadata of the file. Default metadata can not be ovrriden. (Available with release >.40)
 
+Example of updating the title of a file specified by its path.
+
+```python
+unique_sdk.Content.update(
+    user_id=user_id,
+    company_id=company_id,
+    filePath="/Company/finance/january.xls",
+    title="Revision Deck"
+)
+```
+
 Example of moving a file specified by its content id.
 
 ```python
@@ -599,12 +612,25 @@ unique_sdk.Content.update(
 )
 ```
 
+Example of moving a file to a folder specified by its path.
+
+```python
+unique_sdk.Content.update(
+    user_id=user_id,
+    company_id=company_id,
+    contentId="cont_ok2343q5owbce80w78hudawu5",
+    ownerId="scope_e68yz5asho7glfh7c7d041el",
+    parentFolderPath="/Company/Revisions"
+)
+```
+
 #### `unique_sdk.Content.delete` (Compatible with release >.36)
 
 Allows you to delete a file by its `contentId`. If the file is part of a chat, the `chatId` also needs do be set.
 
-- `contentId` the id of the file to be deleted
+- `contentId` optional if `filePath` is provided, the id of the file to be deleted
 - `chatId` optional, the id of the chat where the file is. Only needed if the file is part of a chat
+- `filePath` optional if `contentId` is provided, the absolute path of the file to be deleted
 
 Example of deleting a file from a chat.
 
@@ -617,6 +643,17 @@ unique_sdk.Content.delete(
 )
 ```
 
+Example of deleting a file by its path.
+
+```python
+unique_sdk.Content.delete(
+    user_id=user_id,
+    company_id=company_id,
+    filePath="/Company/finance/january.xls",
+)
+```
+
+
 ### Message
 
 #### `unique_sdk.Message.list`
@@ -1143,6 +1180,49 @@ unique_sdk.Folder.remove_access(
 )
 ```
 
+#### `unique_sdk.Folder.update`
+Uupdate a folder specified by its `scopeId` or path. The following properties can be updated:
+- parent folder - move the folder to a new parent folder specified by its `scopeId` or path. If the new parent folder is the root folder, the `parentId` should be explicitly specificed by setting `newParentId` to `None`.
+- name - update the name by setting the `name` field to the new name.
+
+Examples:
+
+Move the folder specified by its `scopeId` to a new parent folder specified by its path.
+
+```python
+unique_sdk.Folder.update(
+    user_id=user_id,
+    company_id=company_id,
+    scopeId="scope_dwekjnf3330woioppm",
+    parentFolderPath="/Company/folder1/folder2"
+)
+```
+
+Move the parent of a folder specified by its path to a new parent folder specified by its `scopeId` and update the name to "January".
+
+```python
+unique_sdk.Folder.update(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1",
+    parentId="scope_dweekjrfhirtuhgroppm",
+    name="January"
+)
+```
+
+Move the parent of a folder specified by its path to the root folder and update the name to "January".
+
+```python
+unique_sdk.Folder.update(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1",
+    parentId=None,
+    name="January"
+)
+```
+
+
 #### `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.
@@ -1582,6 +1662,12 @@ 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.25] - 2025-09-18
+- Add support for udpate and delete files by file or folder path.
+
+## [0.10.24] - 2025-09-17
+- Add function to update a folder.
+
 ## [0.10.23] - 2025-09-12
 - Revert to using default reasoning effort.
 

{unique_sdk-0.10.23 → unique_sdk-0.10.25}/README.md

@@ -540,21 +540,34 @@ Allows you to ingest a magic table sheet, each row is processed and converted in
 
 #### `unique_sdk.Content.update` (Compatible with release >.36)
 
-Allows you to update a file specified by its `contentId`.
+Allows you to update a file specified by its `contentId` or by its `filePath`.
 
-- `contentId` the id of the file to be updated
+- `contentId` optional if `filePath` is provided, the id of the file to be updated
+- `filePath` optional if `contentId` is provided, the absolute path of the file to be updated
 
 Currently, the following updates are supported:
 
 Title update:
 - `title` optional, allows updating the title of the file
 
-Move the file to a different folder. this can be done by specifying either the `ownerId`.
-- `ownerId` optional, allows moving the file to a different folder. Represents the new folder for the file and it should be the id of a folder e.g.: `scope_dhjfieurfloakmdle`. 
+Move the file to a different folder. This can be done by specifying either the `ownerId` or the `parentFolderPath`.
+- `ownerId` optional, allows moving the file to a different folder. Represents the new folder for the file and it should be the id of a folder e.g.: `scope_dhjfieurfloakmdle`.
+- `parentFolderPath` optional, allows moving the file to a different folder. Represents the path new folder for the file.
 
 Metadata update:
 - `metadata` optional, allows updating the metadata of the file. Default metadata can not be ovrriden. (Available with release >.40)
 
+Example of updating the title of a file specified by its path.
+
+```python
+unique_sdk.Content.update(
+    user_id=user_id,
+    company_id=company_id,
+    filePath="/Company/finance/january.xls",
+    title="Revision Deck"
+)
+```
+
 Example of moving a file specified by its content id.
 
 ```python
@@ -581,12 +594,25 @@ unique_sdk.Content.update(
 )
 ```
 
+Example of moving a file to a folder specified by its path.
+
+```python
+unique_sdk.Content.update(
+    user_id=user_id,
+    company_id=company_id,
+    contentId="cont_ok2343q5owbce80w78hudawu5",
+    ownerId="scope_e68yz5asho7glfh7c7d041el",
+    parentFolderPath="/Company/Revisions"
+)
+```
+
 #### `unique_sdk.Content.delete` (Compatible with release >.36)
 
 Allows you to delete a file by its `contentId`. If the file is part of a chat, the `chatId` also needs do be set.
 
-- `contentId` the id of the file to be deleted
+- `contentId` optional if `filePath` is provided, the id of the file to be deleted
 - `chatId` optional, the id of the chat where the file is. Only needed if the file is part of a chat
+- `filePath` optional if `contentId` is provided, the absolute path of the file to be deleted
 
 Example of deleting a file from a chat.
 
@@ -599,6 +625,17 @@ unique_sdk.Content.delete(
 )
 ```
 
+Example of deleting a file by its path.
+
+```python
+unique_sdk.Content.delete(
+    user_id=user_id,
+    company_id=company_id,
+    filePath="/Company/finance/january.xls",
+)
+```
+
+
 ### Message
 
 #### `unique_sdk.Message.list`
@@ -1125,6 +1162,49 @@ unique_sdk.Folder.remove_access(
 )
 ```
 
+#### `unique_sdk.Folder.update`
+Uupdate a folder specified by its `scopeId` or path. The following properties can be updated:
+- parent folder - move the folder to a new parent folder specified by its `scopeId` or path. If the new parent folder is the root folder, the `parentId` should be explicitly specificed by setting `newParentId` to `None`.
+- name - update the name by setting the `name` field to the new name.
+
+Examples:
+
+Move the folder specified by its `scopeId` to a new parent folder specified by its path.
+
+```python
+unique_sdk.Folder.update(
+    user_id=user_id,
+    company_id=company_id,
+    scopeId="scope_dwekjnf3330woioppm",
+    parentFolderPath="/Company/folder1/folder2"
+)
+```
+
+Move the parent of a folder specified by its path to a new parent folder specified by its `scopeId` and update the name to "January".
+
+```python
+unique_sdk.Folder.update(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1",
+    parentId="scope_dweekjrfhirtuhgroppm",
+    name="January"
+)
+```
+
+Move the parent of a folder specified by its path to the root folder and update the name to "January".
+
+```python
+unique_sdk.Folder.update(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1",
+    parentId=None,
+    name="January"
+)
+```
+
+
 #### `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.

{unique_sdk-0.10.23 → unique_sdk-0.10.25}/pyproject.toml

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

{unique_sdk-0.10.23 → unique_sdk-0.10.25}/unique_sdk/api_resources/_content.py

@@ -12,6 +12,7 @@ from typing import (
 
 from typing_extensions import NotRequired, Unpack
 
+import unique_sdk
 from unique_sdk._api_resource import APIResource
 from unique_sdk._request_options import RequestOptions
 
@@ -81,7 +82,7 @@ class Content(APIResource["Content"]):
         This is used to retrieve information about content based on various filters.
         """
 
-        metadataFilter: dict
+        metadataFilter: NotRequired[dict]
         skip: NotRequired[int]
         take: NotRequired[int]
         filePath: NotRequired[str]
@@ -117,7 +118,7 @@ class Content(APIResource["Content"]):
         ownerId: str
         byteSize: Optional[int]
         ingestionConfig: "Content.IngestionConfig"
-        metadata: dict[str, Any] | None = None
+        metadata: NotRequired[dict[str, str | None]]
 
     class UpsertParams(RequestOptions):
         input: "Content.Input"
@@ -129,7 +130,9 @@ class Content(APIResource["Content"]):
 
     class UpdateParams(RequestOptions):
         contentId: NotRequired[str]
+        filePath: NotRequired[str]
         ownerId: NotRequired[str]
+        parentFolderPath: NotRequired[str]
         title: NotRequired[str]
         metadata: NotRequired[dict[str, str | None]]
 
@@ -161,11 +164,16 @@ class Content(APIResource["Content"]):
         expiredAt: str | None
 
     class PaginatedContentInfo(TypedDict):
+        contentInfo: List["Content.ContentInfo"]
+        totalCount: int
+
+    class PaginatedContentInfos(TypedDict):
         contentInfos: List["Content.ContentInfo"]
         totalCount: int
 
     class DeleteParams(RequestOptions):
         contentId: NotRequired[str]
+        filePath: NotRequired[str]
         chatId: NotRequired[str]
 
     class DeleteResponse(TypedDict):
@@ -284,9 +292,9 @@ class Content(APIResource["Content"]):
         user_id: str,
         company_id: str,
         **params: Unpack["Content.ContentInfoParams"],
-    ) -> "Content.PaginatedContentInfo":
+    ) -> "Content.PaginatedContentInfos":
         return cast(
-            Content.PaginatedContentInfo,
+            Content.PaginatedContentInfos,
             cls._static_request(
                 "post",
                 "/content/infos",
@@ -302,9 +310,9 @@ class Content(APIResource["Content"]):
         user_id: str,
         company_id: str,
         **params: Unpack["Content.ContentInfoParams"],
-    ) -> "Content.PaginatedContentInfo":
+    ) -> "Content.PaginatedContentInfos":
         return cast(
-            Content.PaginatedContentInfo,
+            Content.PaginatedContentInfos,
             await cls._static_request_async(
                 "post",
                 "/content/infos",
@@ -403,11 +411,29 @@ class Content(APIResource["Content"]):
         company_id: str,
         **params: Unpack["Content.UpdateParams"],
     ) -> "Content.ContentInfo":
+        content_id = cls.resolve_content_id_from_file_path(
+            user_id=user_id,
+            company_id=company_id,
+            content_id=params.get("contentId"),
+            file_path=params.get("filePath"),
+        )
+        owner_id = unique_sdk.Folder.resolve_scope_id_from_folder_path(
+            user_id,
+            company_id,
+            params.get("ownerId"),
+            params.get("parentFolderPath"),
+        )
+        params.pop("contentId", None)
+        params.pop("filePath", None)
+        params.pop("parentFolderPath", None)
+        if owner_id is not None:
+            params["ownerId"] = owner_id
+
         return cast(
             "Content.ContentInfo",
             cls._static_request(
                 "patch",
-                f"/content/{params.get('contentId')}",
+                f"/content/{content_id}",
                 user_id,
                 company_id,
                 params=params,
@@ -421,11 +447,29 @@ class Content(APIResource["Content"]):
         company_id: str,
         **params: Unpack["Content.UpdateParams"],
     ) -> "Content.ContentInfo":
+        content_id = cls.resolve_content_id_from_file_path(
+            user_id,
+            company_id,
+            params.get("contentId"),
+            params.get("filePath"),
+        )
+        owner_id = unique_sdk.Folder.resolve_scope_id_from_folder_path(
+            user_id,
+            company_id,
+            params.get("ownerId"),
+            params.get("parentFolderPath"),
+        )
+        params.pop("contentId", None)
+        params.pop("filePath", None)
+        params.pop("parentFolderPath", None)
+        if owner_id is not None:
+            params["ownerId"] = owner_id
+
         return cast(
             "Content.ContentInfo",
             await cls._static_request_async(
                 "patch",
-                f"/content/{params.get('contentId')}",
+                f"/content/{content_id}",
                 user_id,
                 company_id,
                 params=params,
@@ -437,17 +481,25 @@ class Content(APIResource["Content"]):
         cls,
         user_id: str,
         company_id: str,
-        **params: "Content.DeleteParams",
+        **params: Unpack["Content.DeleteParams"],
     ) -> "Content.DeleteResponse":
         """
         Deletes a content by its id or file path.
         """
+        content_id = cls.resolve_content_id_from_file_path(
+            user_id,
+            company_id,
+            params.get("contentId"),
+            params.get("filePath"),
+        )
+        params.pop("contentId", None)
+        params.pop("filePath", None)
 
         return cast(
             "Content.DeleteResponse",
             cls._static_request(
                 "delete",
-                f"/content/{params.get('contentId')}",
+                f"/content/{content_id}",
                 user_id,
                 company_id,
                 params=params,
@@ -459,17 +511,25 @@ class Content(APIResource["Content"]):
         cls,
         user_id: str,
         company_id: str,
-        **params: "Content.DeleteParams",
+        **params: Unpack["Content.DeleteParams"],
     ) -> "Content.DeleteResponse":
         """
         Async deletes a content by its id or file path.
         """
+        content_id = cls.resolve_content_id_from_file_path(
+            user_id,
+            company_id,
+            params.get("contentId"),
+            params.get("filePath"),
+        )
+        params.pop("contentId", None)
+        params.pop("filePath", None)
 
         return cast(
             "Content.DeleteResponse",
             await cls._static_request_async(
                 "delete",
-                f"/content/{params.get('contentId')}",
+                f"/content/{content_id}",
                 user_id,
                 company_id,
                 params=params,
@@ -483,7 +543,7 @@ class Content(APIResource["Content"]):
         company_id: str,
         content_id: str | None = None,
         file_path: str | None = None,
-    ) -> str:
+    ) -> str | None:
         """
         Returns the contentId to use: if content_id is provided, returns it;
         if not, but file_path is provided, resolves and returns the id for that file path.
@@ -496,9 +556,12 @@ class Content(APIResource["Content"]):
                 company_id=company_id,
                 filePath=file_path,
             )
+            content_infos = file_info.get("contentInfo")
             resolved_id = (
-                file_info.get("contentInfo")[0].get("id")
+                content_infos[0].get("id")
                 if file_info.get("totalCount", 0) > 0
+                and content_infos is not None
+                and len(content_infos) > 0
                 else None
             )
             if not resolved_id:

{unique_sdk-0.10.23 → unique_sdk-0.10.25}/unique_sdk/api_resources/_folder.py

@@ -1,4 +1,3 @@
-from enum import Enum
 from typing import (
     ClassVar,
     List,
@@ -23,26 +22,10 @@ class Folder(APIResource["Folder"]):
         Represents the access level of a scope.
         """
 
-        class ScopeAccessType(Enum):
-            """
-            Enum for scope access levels.
-            """
-
-            READ = "READ"
-            WRITE = "WRITE"
-
-        class ScopeAccessEntityType(Enum):
-            """
-            Enum for scope access entity types.
-            """
-
-            USER = "USER"
-            GROUP = "GROUP"
-
         entityId: str
-        type: ScopeAccessType
-        entityType: ScopeAccessEntityType
-        createdAt: str | None = None
+        type: Literal["READ", "WRITE"]
+        entityType: Literal["USER", "GROUP"]
+        createdAt: NotRequired[str]
 
     class Children(TypedDict):
         """
@@ -149,8 +132,19 @@ class Folder(APIResource["Folder"]):
         Parameters for getting a folder by its Id or path.
         """
 
-        scopeId: str | None = None
-        folderPath: str | None = None
+        scopeId: NotRequired[str]
+        folderPath: NotRequired[str]
+
+    class UpdateParams(RequestOptions):
+        """
+        Parameters for updating a folder.
+        """
+
+        scopeId: NotRequired[str]
+        folderPath: NotRequired[str]
+        parentFolderPath: NotRequired[str]
+        parentId: NotRequired[str]
+        name: NotRequired[str]
 
     class GetInfosParams(RequestOptions):
         """
@@ -407,6 +401,84 @@ class Folder(APIResource["Folder"]):
             ),
         )
 
+    @classmethod
+    def update(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Folder.UpdateParams"],
+    ) -> "Folder.FolderInfo":
+        """
+        Update a folder given its id or path. Can update the name or the parent folder by specifying its id or path.
+        """
+
+        scopeId = cls.resolve_scope_id_from_folder_path(
+            user_id=user_id,
+            company_id=company_id,
+            scope_id=params.get("scopeId"),
+            folder_path=params.get("folderPath"),
+        )
+        parentId = cls.resolve_scope_id_from_folder_path(
+            user_id=user_id,
+            company_id=company_id,
+            scope_id=params.get("parentId"),
+            folder_path=params.get("parentFolderPath"),
+        )
+        params.pop("folderPath", None)
+        params.pop("parentFolderPath", None)
+        if parentId:
+            params["parentId"] = parentId
+
+        return cast(
+            "Folder.FolderInfo",
+            cls._static_request(
+                "patch",
+                f"{cls.RESOURCE_URL}/{scopeId}",
+                user_id,
+                company_id=company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def update_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["Folder.UpdateParams"],
+    ) -> "Folder.FolderInfo":
+        """
+        Async update a folder given its id or path. Can update the name or the parent folder by specifying its id or path.
+        """
+
+        scopeId = cls.resolve_scope_id_from_folder_path(
+            user_id=user_id,
+            company_id=company_id,
+            scope_id=params.get("scopeId"),
+            folder_path=params.get("folderPath"),
+        )
+        parentId = cls.resolve_scope_id_from_folder_path(
+            user_id=user_id,
+            company_id=company_id,
+            scope_id=params.get("parentId"),
+            folder_path=params.get("parentFolderPath"),
+        )
+        params.pop("folderPath", None)
+        params.pop("parentFolderPath", None)
+        if parentId:
+            params["parentId"] = parentId
+
+        return cast(
+            "Folder.FolderInfo",
+            await cls._static_request_async(
+                "patch",
+                f"{cls.RESOURCE_URL}/{scopeId}",
+                user_id,
+                company_id=company_id,
+                params=params,
+            ),
+        )
+
     @classmethod
     def delete(
         cls,