unique_sdk 0.9.32__py3-none-any.whl → 0.9.35__py3-none-any.whl

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]
@@ -88,6 +101,8 @@ class Folder(APIResource["Folder"]):
         Parameters for updating folder ingestion config.
         """
 
+        scopeId: str | None
+        folderPath: str | None
         ingestionConfig: "Folder.IngestionConfig"
         applyToSubScopes: bool
 
@@ -96,6 +111,8 @@ class Folder(APIResource["Folder"]):
         Parameters for adding access to a folder.
         """
 
+        scopeId: str | None
+        folderPath: str | None
         scopeAccesses: List["Folder.ScopeAccess"]
         applyToSubScopes: bool
 
@@ -104,9 +121,55 @@ class Folder(APIResource["Folder"]):
         Parameters for removing access from a folder.
         """
 
+        scopeId: str | None
+        folderPath: str | None
         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"]
@@ -142,7 +205,6 @@ class Folder(APIResource["Folder"]):
         cls,
         user_id: str,
         company_id: str,
-        scope_id: str,
         **params: Unpack["Folder.UpdateIngestionConfigParams"],
     ) -> "Folder":
         """
@@ -152,7 +214,7 @@ class Folder(APIResource["Folder"]):
             "Folder",
             cls._static_request(
                 "patch",
-                f"/folder/{scope_id}/ingestion-config",
+                "/folder/ingestion-config",
                 user_id,
                 company_id,
                 params=params,
@@ -164,7 +226,6 @@ class Folder(APIResource["Folder"]):
         cls,
         user_id: str,
         company_id: str,
-        scope_id: str,
         **params: Unpack["Folder.UpdateIngestionConfigParams"],
     ) -> "Folder":
         """
@@ -174,7 +235,7 @@ class Folder(APIResource["Folder"]):
             "Folder",
             await cls._static_request_async(
                 "patch",
-                f"/folder/{scope_id}/ingestion-config",
+                "/folder/ingestion-config",
                 user_id,
                 company_id,
                 params=params,
@@ -186,7 +247,6 @@ class Folder(APIResource["Folder"]):
         cls,
         user_id: str,
         company_id: str,
-        scope_id: str,
         **params: Unpack["Folder.AddAccessParams"],
     ) -> "Folder":
         """
@@ -196,7 +256,7 @@ class Folder(APIResource["Folder"]):
             "Folder",
             cls._static_request(
                 "patch",
-                f"/folder/{scope_id}/access",
+                "/folder/add-access",
                 user_id,
                 company_id,
                 params=params,
@@ -208,7 +268,6 @@ class Folder(APIResource["Folder"]):
         cls,
         user_id: str,
         company_id: str,
-        scope_id: str,
         **params: Unpack["Folder.AddAccessParams"],
     ) -> "Folder":
         """
@@ -218,7 +277,7 @@ class Folder(APIResource["Folder"]):
             "Folder",
             await cls._static_request_async(
                 "patch",
-                f"/folder/{scope_id}/access",
+                "/folder/add-access",
                 user_id,
                 company_id,
                 params=params,
@@ -230,7 +289,6 @@ class Folder(APIResource["Folder"]):
         cls,
         user_id: str,
         company_id: str,
-        scope_id: str,
         **params: Unpack["Folder.RemoveAccessParams"],
     ) -> dict:
         """
@@ -240,7 +298,7 @@ class Folder(APIResource["Folder"]):
             dict,
             cls._static_request(
                 "patch",
-                f"/folder/{scope_id}/remove-access",
+                "/folder/remove-access",
                 user_id,
                 company_id,
                 params=params,
@@ -252,7 +310,6 @@ class Folder(APIResource["Folder"]):
         cls,
         user_id: str,
         company_id: str,
-        scope_id: str,
         **params: Unpack["Folder.RemoveAccessParams"],
     ) -> "Folder":
         """
@@ -262,7 +319,7 @@ class Folder(APIResource["Folder"]):
             "Folder",
             await cls._static_request_async(
                 "patch",
-                f"/folder/{scope_id}/remove-access",
+                "/folder/remove-access",
                 user_id,
                 company_id,
                 params=params,

{unique_sdk-0.9.32.dist-info → unique_sdk-0.9.35.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.32
+Version: 0.9.35
 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.
@@ -484,18 +508,35 @@ unique_sdk.Folder.create_paths(
 
 #### `unique_sdk.Folder.update_ingestion_config`
 
-Allows you to update the ingestion config of a folder and whether to apply to the subscopes or not: `
+Allows you to update the ingestion config of a folder and choose whether to apply to the subscopes or not: `
 
 - `ingestionConfig`
 - `applyToSubScopes`
 
-Example of updating the ingestion config of a folder and its subfolders.
+The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
+
+Example of updating the ingestion config of a folder and its subfolders using the id.
 
 ```python
 unique_sdk.Folder.update_ingestion_config(
     user_id=user_id,
     company_id=company_id,
-    scope_id=scope_id,
+    scopeId="scope_qbnkde820dbmuw2900,
+    ingestionConfig={
+        "chunkStrategy": "default",
+        "uniqueIngestionMode": "standard",
+    },
+    applyToSubScopes=True
+)
+```
+
+Example of updating the ingestion config of a folder and its subfolders using the path.
+
+```python
+unique_sdk.Folder.update_ingestion_config(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1/folder2",
     ingestionConfig={
         "chunkStrategy": "default",
         "uniqueIngestionMode": "standard",
@@ -511,13 +552,33 @@ Allows you to add access to a folder and apply to the subfolders or not: `
 - `scopeAccesses`
 - `applyToSubScopes`
 
-Example of adding access to a folder and its subfolders.
+The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
+
+Example of adding access to a folder and its subfolders using the id.
 
 ```python
 unique_sdk.Folder.add_access(
     user_id=user_id,
     company_id=company_id,
-    scope_id=scope_id,
+    scopeId="scope_231e4kjn4foffww34",
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
+Example of adding access to a folder and its subfolders using the folder path.
+
+```python
+unique_sdk.Folder.add_access(
+    user_id=user_id,
+    company_id=company_id,
+    folderPath="/Company/folder1/folder2"
     scopeAccesses=[
         {
             "entityId": "group_id",
@@ -536,13 +597,35 @@ Allows you to delete access from a folder and apply to the subfolders or not: `
 - `scopeAccesses`
 - `applyToSubScopes`
 
-Example of deleting the access from a folder and its subfolders.
+The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
+
+
+Example of deleting the access from a folder and its subfolders using the id.
+
+```python
+unique_sdk.Folder.remove_access(
+    user_id=user_id,
+    company_id=company_id,
+    scopeId="scope_dwekjnf3330woioppm,
+    scopeAccesses=[
+        {
+            "entityId": "group_id",
+            "type": "WRITE",
+            "entityType": "GROUP",
+        }
+    ],
+    applyToSubScopes=True,
+)
+```
+
+
+Example of deleting the access from a folder and its subfolders using the path.
 
 ```python
 unique_sdk.Folder.remove_access(
     user_id=user_id,
     company_id=company_id,
-    scope_id=scope_id,
+    folderPath="/Company/folder1/folder2"
     scopeAccesses=[
         {
             "entityId": "group_id",
@@ -1146,6 +1229,15 @@ 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.35] - 2025-06-18
+- Allow scope access updates (add/remove) on folder based on scope id or path.
+
+## [0.9.34] - 2025-06-17
+- Allow ingestion config updates on folder based on scope id or path.
+
+## [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.dist-info → unique_sdk-0.9.35.dist-info}/RECORD

@@ -19,7 +19,7 @@ unique_sdk/api_resources/_chat_completion.py,sha256=hAPPHxoljcoHeTboxoJkcXgpqA2h
 unique_sdk/api_resources/_content.py,sha256=BLv4qXdazSYy_L0Z9ihr0hquE3xFIY32CBpfbOkxSpE,9527
 unique_sdk/api_resources/_embedding.py,sha256=C6qak7cCUBMBINfPhgH8taCJZ9n6w1MUElqDJJ8dG10,1281
 unique_sdk/api_resources/_event.py,sha256=bpWF9vstdoAWbUzr-iiGP713ceP0zPk77GJXiImf9zg,374
-unique_sdk/api_resources/_folder.py,sha256=E-v4JAixhtYsOZXbEOTO8gyykPzPr62MraoPPy01vn8,6900
+unique_sdk/api_resources/_folder.py,sha256=dmPorUoOJSe-hcxlJq3RnkQeZg3gPqGF37ZsLgnloT0,8335
 unique_sdk/api_resources/_integrated.py,sha256=l1vS8kJiSLie61mqDO3KI2MNmYwFydmCIoJpP_tPhSI,2956
 unique_sdk/api_resources/_message.py,sha256=gEDIzg3METZU2k7m69meAuf0IWmZxnYOjbBKPRMwPYE,7688
 unique_sdk/api_resources/_message_assessment.py,sha256=SSfx6eW7zb_GKe8cFJzCqW-t-_eWEXxKP5cnIb0DhIc,2276
@@ -30,7 +30,7 @@ unique_sdk/utils/chat_history.py,sha256=5UqL9hF1O9pV7skbNOlEibF5rHdYsmG3m5-YEPUo
 unique_sdk/utils/file_io.py,sha256=YY8B7VJcTLOPmCXByiOfNerXGlAtjCC5EVNmAbQJ3dQ,4306
 unique_sdk/utils/sources.py,sha256=wfboE-neMKa0Wuq9QzfAEFMkNLrIrmm0v-QF33sLo6k,4952
 unique_sdk/utils/token.py,sha256=AzKuAA1AwBtnvSFxGcsHLpxXr_wWE5Mj4jYBbOz2ljA,1740
-unique_sdk-0.9.32.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
-unique_sdk-0.9.32.dist-info/METADATA,sha256=Wrj-GZIv--qHQYw3KeN7g4gW0VQWypWm3ljOqxOD84M,36689
-unique_sdk-0.9.32.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_sdk-0.9.32.dist-info/RECORD,,
+unique_sdk-0.9.35.dist-info/LICENSE,sha256=EJCWoHgrXVBUb47PnjeV4MFIEOR71MAdCOIgv61J-4k,1065
+unique_sdk-0.9.35.dist-info/METADATA,sha256=Dt2oGjlLS-BCKfEthkcQvpmzzm4_4GvTi1YI2cpF_Xs,39169
+unique_sdk-0.9.35.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_sdk-0.9.35.dist-info/RECORD,,