kodexa 7.0.12399293688__py3-none-any.whl → 7.4.5a13228665254__py3-none-any.whl

kodexa/platform/client.py

@@ -86,7 +86,8 @@ from kodexa.model.objects import (
     PageExtensionPack,
     PageOrganization,
     DocumentFamilyStatistics, MessageContext, PagePrompt, Prompt, GuidanceSet, PageGuidanceSet, DocumentEmbedding,
-    DocumentExternalData, Task, PageTask, RetainedGuidance, PageRetainedGuidance,
+    DocumentExternalData, Task, PageTask, RetainedGuidance, PageRetainedGuidance, TaskTemplate, TaskStatus,
+    TaskActivity, TaskDocumentFamily, TaskTag,
 )
 
 logger = logging.getLogger()
@@ -1174,8 +1175,166 @@ class PagePipelineEndpoint(PagePipeline, PageEndpoint):
 
 
 class PageTaskEndpoint(PageTask, PageEndpoint):
+    """
+    Represents a page of tasks.
+    """
+    def get_type(self) -> Optional[str]:
+        return "tasks"
+
+class PageTaskActivityEndpoint(PageEndpoint):
+    """
+    Represents a page of task activities.
+    """
+    def get_type(self) -> Optional[str]:
+        return "taskActivities"
+
+class PageTaskDocumentFamilyEndpoint(PageEndpoint):
+    """
+    Represents a page of task document families.
+    """
+    def get_type(self) -> Optional[str]:
+        return "taskDocumentFamilies"
+
+class PageTaskTagEndpoint(PageEndpoint):
+    """
+    Represents a page of task tags.
+    """
     def get_type(self) -> Optional[str]:
-        return "task"
+        return "taskTags"
+
+class TaskEndpoint(EntityEndpoint, Task):
+    """
+    Represents a task endpoint.
+    """
+    def get_type(self) -> str:
+        return "tasks"
+
+    def create_with_request(self, task: Task, task_template: Optional[TaskTemplate] = None, document_families: Optional[List[DocumentFamily]] = None):
+        """Create a task with the given request."""
+        url = "/api/tasks/createTaskWithRequest"
+        response = self.client.post(url, body={
+            "task": task.model_dump(mode="json", by_alias=True),
+            "taskTemplate": task_template.model_dump(mode="json", by_alias=True) if task_template else None,
+            "documentFamilies": [df.model_dump(mode="json", by_alias=True) for df in document_families] if document_families else None
+        })
+        return TaskEndpoint.model_validate(response.json()).set_client(self.client)
+
+    def update_status(self, status: TaskStatus):
+        """Update the status of the task."""
+        url = f"/api/tasks/{self.id}/status"
+        response = self.client.put(url, body=status)
+        return TaskEndpoint.model_validate(response.json()).set_client(self.client)
+
+    def remove_status(self):
+        """Remove the task status."""
+        url = f"/api/tasks/{self.id}/status"
+        response = self.client.delete(url)
+        return TaskEndpoint.model_validate(response.json()).set_client(self.client)
+
+    def update_assignee(self, assignee: User):
+        """Update the assignee of the task."""
+        url = f"/api/tasks/{self.id}/assignee"
+        response = self.client.put(url, body=assignee.model_dump(mode="json", by_alias=True))
+        return TaskEndpoint.model_validate(response.json()).set_client(self.client)
+
+    def remove_assignee(self):
+        """Remove the task assignee."""
+        url = f"/api/tasks/{self.id}/assignee"
+        response = self.client.delete(url)
+        return TaskEndpoint.model_validate(response.json()).set_client(self.client)
+
+class TasksEndpoint(EntitiesEndpoint):
+    """
+    Represents tasks endpoints.
+    """
+    def get_type(self) -> str:
+        return "tasks"
+
+    def get_instance_class(self, object_dict=None):
+        return TaskEndpoint
+
+    def get_page_class(self, object_dict=None):
+        return PageTaskEndpoint
+
+class TaskTemplateEndpoint(EntityEndpoint, TaskTemplate):
+    """
+    Represents a task template endpoint.
+    """
+    def get_type(self) -> str:
+        return "taskTemplates"
+
+class TaskTemplatesEndpoint(EntitiesEndpoint):
+    """
+    Represents task templates endpoints.
+    """
+    def get_type(self) -> str:
+        return "taskTemplates"
+
+    def get_instance_class(self, object_dict=None):
+        return TaskTemplateEndpoint
+
+    def get_page_class(self, object_dict=None):
+        return PageTaskTemplateEndpoint
+
+class TaskActivityEndpoint(EntityEndpoint, TaskActivity):
+    """
+    Represents a task activity endpoint.
+    """
+    def get_type(self) -> str:
+        return "taskActivities"
+
+class TaskActivitiesEndpoint(EntitiesEndpoint):
+    """
+    Represents task activities endpoints.
+    """
+    def get_type(self) -> str:
+        return "taskActivities"
+
+    def get_instance_class(self, object_dict=None):
+        return TaskActivityEndpoint
+
+    def get_page_class(self, object_dict=None):
+        return PageTaskActivityEndpoint
+
+class TaskDocumentFamilyEndpoint(EntityEndpoint, TaskDocumentFamily):
+    """
+    Represents a task document family endpoint.
+    """
+    def get_type(self) -> str:
+        return "taskDocumentFamilies"
+
+class TaskDocumentFamiliesEndpoint(EntitiesEndpoint):
+    """
+    Represents task document families endpoints.
+    """
+    def get_type(self) -> str:
+        return "taskDocumentFamilies"
+
+    def get_instance_class(self, object_dict=None):
+        return TaskDocumentFamilyEndpoint
+
+    def get_page_class(self, object_dict=None):
+        return PageTaskDocumentFamilyEndpoint
+
+class TaskTagEndpoint(EntityEndpoint, TaskTag):
+    """
+    Represents a task tag endpoint.
+    """
+    def get_type(self) -> str:
+        return "taskTags"
+
+class TaskTagsEndpoint(EntitiesEndpoint):
+    """
+    Represents task tags endpoints.
+    """
+    def get_type(self) -> str:
+        return "taskTags"
+
+    def get_instance_class(self, object_dict=None):
+        return TaskTagEndpoint
+
+    def get_page_class(self, object_dict=None):
+        return PageTaskTagEndpoint
 
 
 class PageRetainedGuidanceEndpoint(PageRetainedGuidance, PageEndpoint):
@@ -4577,7 +4736,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 +4775,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 +4839,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 +4848,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 +4857,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 +4873,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}")
 
@@ -4783,7 +4976,8 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
         self.client.put(url, body=document_status.model_dump(by_alias=True))
 
     def add_document(
-            self, document: Document, content_object: Optional[ContentObject] = None
+            self, document: Document, content_object: Optional[ContentObject] = None,
+            taxonomies: Optional[List[Taxonomy]] = None, data_store: Optional[Store] = None
     ):
         """
         Add a document to the document family.
@@ -4791,22 +4985,36 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
         Args:
             document (Document): The document to add.
             content_object (Optional[ContentObject]): The content object. Defaults to None.
+            taxonomies (Optional[List[Taxonomy]]): List of taxonomies to use. Defaults to None.
+            data_store (Optional[Store]): Data store to add document to. Defaults to None.
         """
         url = (
             f'/api/stores/{self.store_ref.replace(":", "/")}/families/{self.id}/objects'
         )
         if content_object is None:
             content_object = self.content_objects[-1]
+
+        params = {
+            "sourceContentObjectId": content_object.id,
+            "transitionType": "DERIVED",
+            "documentVersion": document.version
+        }
+
+        # If we have a store but no taxonomies or the other way around then we need to throw an error
+        if (data_store and not taxonomies) or (taxonomies and not data_store):
+            raise Exception("If you provide a data store you must also provide taxonomies and vice-versa")
+
+        if taxonomies:
+            params["taxonomyRefs"] = ",".join([taxonomy.ref for taxonomy in taxonomies])
+
+        if data_store:
+            params["dataStoreRef"] = data_store.ref
+
         self.client.post(
             url,
-            params={
-                "sourceContentObjectId": content_object.id,
-                "transitionType": "DERIVED",
-                "documentVersion": document.version,
-            },
+            params=params,
             files={"file": document.to_kddb()},
         )
-
     def export_as_zip(self) -> bytes:
         """
         Export the document family as bytes.
@@ -5123,7 +5331,7 @@ class DataStoreEndpoint(StoreEndpoint):
 
         response = self.client.get(url, params=params)
         return response.text
-
+    
     def get_taxonomies(self) -> List[Taxonomy]:
         """Get the taxonomies of the store
 
@@ -5428,6 +5636,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             replace=False,
             additional_metadata: Optional[dict] = None,
             external_data: Optional[dict] = None,
+            document: Optional[Document] = None,
     ):
         """
         Upload a file to the store.
@@ -5438,6 +5647,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             replace (bool): Replace the file if it already exists (Default False).
             additional_metadata (Optional[dict]): Additional metadata to add to the file (Default None).
             external_data (Optional[dict]): External data to add to the file (Default None).
+            document (Optional[Document]): The document to add to the file (Default None).
         """
         if Path(file_path).is_file():
             logger.info(f"Uploading {file_path}")
@@ -5447,7 +5657,8 @@ class DocumentStoreEndpoint(StoreEndpoint):
                     content=path_content,
                     replace=replace,
                     additional_metadata=additional_metadata,
-                    external_data=external_data
+                    external_data=external_data,
+                    document=document,
                 )
         else:
             raise Exception(f"{file_path} is not a file")
@@ -5459,6 +5670,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             replace=False,
             additional_metadata: Optional[dict] = None,
             external_data: Optional[dict] = None,
+            document: Optional[Document] = None,
     ) -> DocumentFamilyEndpoint:
         """
         Put the content into the store at the given path.
@@ -5469,11 +5681,12 @@ class DocumentStoreEndpoint(StoreEndpoint):
             replace (bool): Replace the content if it exists.
             additional_metadata (Optional[dict]): Additional metadata to store with the document (not it can't include 'path').
             external_data (Optional[dict]): External data to store with the document.
+            document (Optional[Document]): The document to store with the content.
 
         Returns:
             DocumentFamilyEndpoint: The document family that was created.
         """
-        files = {"file": content}
+        files = {"file": content, "document": document.to_kddb()} if document else {"file": content}
 
         if additional_metadata is None:
             additional_metadata = {}

{kodexa-7.0.12399293688.dist-info → kodexa-7.4.5a13228665254.dist-info}/METADATA

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

{kodexa-7.0.12399293688.dist-info → kodexa-7.4.5a13228665254.dist-info}/RECORD

@@ -3,22 +3,23 @@ kodexa/assistant/__init__.py,sha256=nlXm_YnV_50hgn0TIT2Fkc2fQ-86OjmctY_j8My9nc4,
 kodexa/assistant/assistant.py,sha256=5KFdbqFSLIZJyDRyZdpcfr448fT-CW4JhYu9A6B9DGY,14663
 kodexa/connectors/__init__.py,sha256=WF6G_MUeU32TlKSUKkpNoNX7dq8iBPliFMep4E8BmZc,328
 kodexa/connectors/connectors.py,sha256=FpUZDkSyHld2b9eYRuVOWzaFtuGoaRuPXXicJB7THbc,10413
-kodexa/dataclasses/__init__.py,sha256=DKLWMALnUWYFDMraEc9We85GI_rvpp-z7Q1fKX-3jQI,18561
+kodexa/dataclasses/__init__.py,sha256=CHMNsOamWA3gY5203gn8Ef5q1fgcczMtWKEvNjIOzPs,19486
 kodexa/dataclasses/templates/llm_data_class.j2,sha256=YWjStW136chV_59JM3AYis3i-0jdrqDvLXsISUW9zDU,660
 kodexa/model/__init__.py,sha256=rtLXYJBxB-rnukhslN9rlqoB3--1H3253HyHGbD_Gc8,796
 kodexa/model/base.py,sha256=CaZK8nMhT1LdCpt4aLhebJGcorjq9qRID1FjnXnP14M,521
 kodexa/model/entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kodexa/model/entities/check_response.py,sha256=eqBHxO6G2OAziL3p9bHGI-oiPkAG82H6Choc8wyvtM4,3949
-kodexa/model/entities/product.py,sha256=ZDpHuBE_9FJ-klnkyBvTfPwYOqBkM1wraZMtHqNA8FQ,3526
+kodexa/model/entities/product.py,sha256=StUhTEeLXmc05cj6XnZppQfeJsqCPbX1jdhsysHH--Q,5787
+kodexa/model/entities/product_group.py,sha256=540fRGyUf34h1BzAN1DiWu6rGgvaj3xDFhZ2k-RvSFY,3617
 kodexa/model/entities/product_subscription.py,sha256=UcmWR-qgLfdV7VCtJNwzgkanoS8nBSL6ngVuxQUK1M8,3810
-kodexa/model/model.py,sha256=Bjy1n6_9kQLLch-wCUDpT31sTctE2kCGdi4cb1ptZN4,118647
-kodexa/model/objects.py,sha256=4Oyjs6omlHfwziAK1m2tFk4jSnzN7lFdXACog07ed1c,185124
-kodexa/model/persistence.py,sha256=P4DmC9UdczmjJgXNeeTlhwKH9nSAdzYZOaDTyqaDPOA,69501
+kodexa/model/model.py,sha256=qh1YUew3UgtjU0t4fAwSXYYuzQjXTOZWZkafyFp_w8M,118801
+kodexa/model/objects.py,sha256=x9Iah3Wo2UvQKDrL1BcrN4qF68ljCQDRnlyKJ4OgKsE,188900
+kodexa/model/persistence.py,sha256=HX_uIkGs8bqHwqyE5wB2qMlGIG5ZnjuTu7xMdvKhEzA,72033
 kodexa/model/utils.py,sha256=6R-3rFiW9irBwj0Mq5yhp7EDXkNUFaeFhr3bWmnlW4g,2961
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
-kodexa/pipeline/pipeline.py,sha256=ZYpJAWcwV4YRK589DUhU0vXGQlkNSj4J2TsGbYqTLjo,25221
+kodexa/pipeline/pipeline.py,sha256=Z4O6UwoISeP_HMlxm6l6kbcvFBDw3Glm7lT4cUibri4,25461
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=PWn-Xk3vH993Ne5YXDKqJT9rmj7okwVBivuQv9rt2UQ,226591
+kodexa/platform/client.py,sha256=kw1UOSwGV0zl_V0oOsSS7sP-IJzCQNyua4P52HFpO7U,233867
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
 kodexa/platform/kodexa.py,sha256=tPXHO500q3S75GhKGDcaxO51Viq2PNlHmAzpBZlahgo,34857
 kodexa/selectors/__init__.py,sha256=xA9-4vpyaAZWPSk3bh2kvDLkdv6XEmm7PjFbpziiTIk,100
@@ -43,7 +44,7 @@ kodexa/testing/test_utils.py,sha256=v44p__gE7ia67W7WeHN2HBFCWSCUrCZt7G4xBNCmwf8,
 kodexa/training/__init__.py,sha256=xs2L62YpRkIRfslQwtQZ5Yxjhm7sLzX2TrVX6EuBnZQ,52
 kodexa/training/train_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kodexa/utils/__init__.py,sha256=Pnim1o9_db5YEnNvDTxpM7HG-qTlL6n8JwFwOafU9wo,5928
-kodexa-7.0.12399293688.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.0.12399293688.dist-info/METADATA,sha256=oQ8cDBBYml0HvYWVGK-klGpt_kpMzPARlO5JY0l0wdY,3527
-kodexa-7.0.12399293688.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.0.12399293688.dist-info/RECORD,,
+kodexa-7.4.5a13228665254.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.4.5a13228665254.dist-info/METADATA,sha256=G1W-0oXbyNlThnUxTzTZrxLQSX3KfRkG12lVTEqV_vU,3529
+kodexa-7.4.5a13228665254.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.4.5a13228665254.dist-info/RECORD,,