unique_sdk 0.9.32__tar.gz → 0.9.33__tar.gz

{unique_sdk-0.9.32 → unique_sdk-0.9.33}/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.9.33] - 2025-06-11
+- Add function to get a folder by id or by path.
+
 ## [0.9.32] - 2025-06-11
 - Add function to ingest magic table sheets.
 

{unique_sdk-0.9.32 → unique_sdk-0.9.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.32
+Version: 0.9.33
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -470,6 +470,30 @@ Allows you to ingest a magic table sheet, each row is processed and converted in
 
 ### Folder
 
+#### `unique_sdk.Folder.get`
+
+Get a folder by scope id or by path.
+
+By scope id:
+
+```python
+unique_sdk.Folder.get_info(
+   user_id=user_id,
+   company_id=company_id,
+   scopeId="scope_w78wfn114va9o22s13r03yq",
+)
+```
+
+By path:
+
+```python
+unique_sdk.Folder.get_info(
+   user_id=user_id,
+   company_id=company_id,
+   folderPath="/Company/Atlas/Due Dilligence/Arch,
+)
+```
+
 #### `unique_sdk.Folder.create_paths`
 
 Create each folder in the provided list of paths if it does not already exist.
@@ -1146,6 +1170,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.9.33] - 2025-06-11
+- Add function to get a folder by id or by path.
+
 ## [0.9.32] - 2025-06-11
 - Add function to ingest magic table sheets.
 

{unique_sdk-0.9.32 → unique_sdk-0.9.33}/README.md

@@ -454,6 +454,30 @@ Allows you to ingest a magic table sheet, each row is processed and converted in
 
 ### Folder
 
+#### `unique_sdk.Folder.get`
+
+Get a folder by scope id or by path.
+
+By scope id:
+
+```python
+unique_sdk.Folder.get_info(
+   user_id=user_id,
+   company_id=company_id,
+   scopeId="scope_w78wfn114va9o22s13r03yq",
+)
+```
+
+By path:
+
+```python
+unique_sdk.Folder.get_info(
+   user_id=user_id,
+   company_id=company_id,
+   folderPath="/Company/Atlas/Due Dilligence/Arch,
+)
+```
+
 #### `unique_sdk.Folder.create_paths`
 
 Create each folder in the provided list of paths if it does not already exist.

{unique_sdk-0.9.32 → unique_sdk-0.9.33}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_sdk"
-version = "0.9.32"
+version = "0.9.33"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",
@@ -20,7 +20,7 @@ requests = "^2.32.3"
 
 
 [tool.poetry.group.dev.dependencies]
-ruff = "0.4.10"
+ruff = "0.11.7"
 pytest = "^8.0"
 tox = "^4.11.4"
 pyright = "^1.1.341"

{unique_sdk-0.9.32 → unique_sdk-0.9.33}/unique_sdk/api_resources/_folder.py

@@ -78,6 +78,19 @@ class Folder(APIResource["Folder"]):
     class CreateParams(RequestOptions):
         paths: List[str]
 
+    class FolderInfo(TypedDict):
+        """
+        Represents the information of a folder.
+        """
+
+        id: str
+        name: str
+        ingestionConfig: "Folder.IngestionConfig"
+        createdAt: str | None
+        updatedAt: str | None
+        parentId: str | None
+        externalId: str | None
+
     id: str
     name: str
     scopeAccess: List[ScopeAccess]
@@ -107,6 +120,50 @@ class Folder(APIResource["Folder"]):
         scopeAccesses: List["Folder.ScopeAccess"]
         applyToSubScopes: bool
 
+    class GetParams(RequestOptions):
+        """
+        Parameters for getting a folder by its ID or path.
+        """
+
+        scopeId: str | None = None
+        folderPath: str | None = None
+
+    @classmethod
+    def get_info(
+        cls, user_id: str, company_id: str, **params: Unpack["Folder.GetParams"]
+    ) -> "Folder.FolderInfo":
+        """
+        Get a folder by its ID or path.
+        """
+        return cast(
+            "Folder.FolderInfo",
+            cls._static_request(
+                "get",
+                "/folder/info",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
+    @classmethod
+    async def get_info_async(
+        cls, user_id: str, company_id: str, **params: Unpack["Folder.GetParams"]
+    ) -> "Folder.FolderInfo":
+        """
+        Async get a folder by its ID or path.
+        """
+        return cast(
+            "Folder.FolderInfo",
+            await cls._static_request_async(
+                "get",
+                "/folder/info",
+                user_id,
+                company_id,
+                params=params,
+            ),
+        )
+
     @classmethod
     def create_paths(
         cls, user_id: str, company_id: str, **params: Unpack["Folder.CreateParams"]