kodexa 7.4.412795054059__tar.gz → 7.4.412806034916__tar.gz

{kodexa-7.4.412795054059 → kodexa-7.4.412806034916}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 7.4.412795054059
+Version: 7.4.412806034916
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com

{kodexa-7.4.412795054059 → kodexa-7.4.412806034916}/kodexa/platform/client.py

@@ -4577,7 +4577,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
 
     def unlock(self):
         """
-        Lock the document family.
+        Unlock the document family.
         """
         url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}/unlock"
         response = self.client.put(url)
@@ -4616,6 +4616,35 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
         url = f"/api/documentFamilies/{self.id}/externalData"
         response = self.client.put(url, body=external_data)
         return response.json()
+        
+    def get_json(
+            self,
+            project_id: str,
+            friendly_names=False,            
+    ) -> str:
+        """Get the JSON export for the document family
+
+        Args:
+            project_id str: The project ID
+            friendly_names (bool): Whether to use friendly names. Defaults to False
+
+        Returns:
+            str: The JSON
+        """
+        if project_id is None:
+            raise Exception(
+                f"Project ID is required"
+            )
+        
+        url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}/dataObjects"
+        params = {
+            "format": "json",
+            "friendlyNames": friendly_names,
+            "projectId": project_id,
+        }
+
+        response = self.client.get(url, params=params)
+        return response.text
 
     def export(self) -> bytes:
         """
@@ -4651,6 +4680,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             mixin: Optional[str] = None,
             label: Optional[str] = None,
             timeout: int = 60,
+            polling_delay_in_seconds: int = 5,
     ) -> "DocumentFamilyEndpoint":
         """
         Wait for the document family to be ready.
@@ -4659,6 +4689,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             mixin (Optional[str]): The mixin. Defaults to None.
             label (Optional[str]): The label. Defaults to None.
             timeout (int): The timeout. Defaults to 60.
+            polling_delay_in_seconds (int): The polling delay in seconds. Defaults to 5. 5 is the minimum value.
 
         Returns:
             DocumentFamilyEndpoint: The updated document family endpoint.
@@ -4667,6 +4698,9 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             "Waiting for mixin and/or label to be available on document family %s",
             self.id,
         )
+        if polling_delay_in_seconds < 5:        
+            polling_delay_in_seconds = 5
+            
         start = time.time()
         while time.time() - start < timeout:
             url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}"
@@ -4680,7 +4714,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             ):
                 return updated_document_family
 
-            time.sleep(5)
+            time.sleep(polling_delay_in_seconds)
 
         raise Exception(f"Not available on document family {self.id}")
 
@@ -5108,7 +5142,6 @@ class DataStoreEndpoint(StoreEndpoint):
             path: Optional[str] = None,
             root_name: str = "",
             friendly_names=True,
-            project_id: Optional[str] = None,
     ) -> str:
         """Get the data objects export of the store
 
@@ -5118,7 +5151,6 @@ class DataStoreEndpoint(StoreEndpoint):
             path (Optional[str]): The path to the data object
             root_name (str): The root name of the data objects export
             friendly_names (bool): Whether to use friendly names. Defaults to True
-            project_id (Optional[str]): The project ID
 
         Returns:
             str: The data objects export of the store
@@ -5134,16 +5166,13 @@ class DataStoreEndpoint(StoreEndpoint):
 
         if path:
             params["path"] = path
-            
-        if project_id:
-            params["projectId"] = project_id
 
         if output_format == "csv" and not path:
             raise ValueError("CSV output requires a path")
 
         response = self.client.get(url, params=params)
         return response.text
-
+    
     def get_taxonomies(self) -> List[Taxonomy]:
         """Get the taxonomies of the store
 

{kodexa-7.4.412795054059 → kodexa-7.4.412806034916}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kodexa"
-version = "7.4.412795054059"
+version = "7.4.412806034916"
 description = "Python SDK for the Kodexa Platform"
 authors = ["Austin Redenbaugh <austin@kodexa.com>", "Philip Dodds <philip@kodexa.com>", "Romar Cablao <rcablao@kodexa.com>", "Amadea Paula Dodds <amadeapaula@kodexa.com>"]
 readme = "README.md"