unique_sdk 0.10.23__tar.gz → 0.10.24__tar.gz

{unique_sdk-0.10.23 → unique_sdk-0.10.24}/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.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.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.10.23
+Version: 0.10.24
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -1143,6 +1143,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 +1625,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.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.24}/README.md

@@ -1125,6 +1125,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.24}/pyproject.toml

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

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

@@ -152,6 +152,17 @@ class Folder(APIResource["Folder"]):
         scopeId: str | None = None
         folderPath: str | None = None
 
+    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):
         """
         Parameters for getting multiple paginated folders by their parent Id.
@@ -407,6 +418,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,