kodexa 7.4.413228596953__py3-none-any.whl → 7.4.413229965531__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,171 @@ 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 "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 PageTaskTemplateEndpoint(PageTask, PageEndpoint):
     def get_type(self) -> Optional[str]:
-        return "task"
+        return "taskTemplate"
 
 
 class PageRetainedGuidanceEndpoint(PageRetainedGuidance, PageEndpoint):
@@ -2546,6 +2710,21 @@ class WorkspaceEndpoint(EntityEndpoint, Workspace):
             raise ValueError("Workspace has no channel")
 
 
+class TaskTemplateEndpoint(EntityEndpoint, Task):
+    """Represents a task endpoint.
+
+    This class is used to interact with the task endpoint of the API.
+    """
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint, in this case "projects".
+        """
+        return "taskTemplates"
+
+
 class TaskEndpoint(EntityEndpoint, Task):
     """Represents a task endpoint.
 
@@ -2906,6 +3085,37 @@ class AssistantsEndpoint(EntitiesEndpoint):
         return PageAssistantEndpoint
 
 
+class TaskTemplatesEndpoint(EntitiesEndpoint):
+    """Represents a projects endpoint"""
+
+    def get_type(self) -> str:
+        """
+        Get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "taskTemplates"
+
+    def get_instance_class(self, object_dict=None):
+        """
+        Get the instance class of the endpoint.
+
+        Returns:
+            ProjectEndpoint: The instance class of the endpoint.
+        """
+        return TaskTemplateEndpoint
+
+    def get_page_class(self, object_dict=None):
+        """
+        Get the page class of the endpoint.
+
+        Returns:
+            PageProjectEndpoint: The page class of the endpoint.
+        """
+        return PageTaskTemplateEndpoint
+
+
 class TasksEndpoint(EntitiesEndpoint):
     """Represents a projects endpoint"""
 
@@ -4616,11 +4826,11 @@ 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,            
+            friendly_names=False,
     ) -> str:
         """Get the JSON export for the document family
 
@@ -4635,7 +4845,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             raise Exception(
                 f"Project ID is required"
             )
-        
+
         url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}/dataObjects"
         params = {
             "format": "json",
@@ -4698,9 +4908,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:        
+        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}"
@@ -4856,6 +5066,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             params=params,
             files={"file": document.to_kddb()},
         )
+
     def export_as_zip(self) -> bytes:
         """
         Export the document family as bytes.
@@ -5172,7 +5383,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
 
@@ -6386,6 +6597,20 @@ OBJECT_TYPES = {
         "global": True,
         "endpoint": MembershipsEndpoint,
     },
+    "tasks": {
+        "name": "task",
+        "plural": "tasks",
+        "type": TaskEndpoint,
+        "global": True,
+        "endpoint": TasksEndpoint,
+    },
+    "taskTemplates": {
+        "name": "taskTemplate",
+        "plural": "taskTemplates",
+        "type": TaskTemplateEndpoint,
+        "global": True,
+        "endpoint": TaskTemplatesEndpoint,
+    }
 }
 
 

{kodexa-7.4.413228596953.dist-info → kodexa-7.4.413229965531.dist-info}/METADATA

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

{kodexa-7.4.413228596953.dist-info → kodexa-7.4.413229965531.dist-info}/RECORD

@@ -19,7 +19,7 @@ kodexa/model/utils.py,sha256=6R-3rFiW9irBwj0Mq5yhp7EDXkNUFaeFhr3bWmnlW4g,2961
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=Z4O6UwoISeP_HMlxm6l6kbcvFBDw3Glm7lT4cUibri4,25461
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=UdMLp_1fcWa8bJc30AD8kwLyqM6zxWLQp57cZKYZV9Q,228861
+kodexa/platform/client.py,sha256=odEggW0k-Y8R4jOcY3gSiDzrHnfcTihIQTMs0hhtcso,235436
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
 kodexa/platform/kodexa.py,sha256=tPXHO500q3S75GhKGDcaxO51Viq2PNlHmAzpBZlahgo,34857
 kodexa/selectors/__init__.py,sha256=xA9-4vpyaAZWPSk3bh2kvDLkdv6XEmm7PjFbpziiTIk,100
@@ -44,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.4.413228596953.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.4.413228596953.dist-info/METADATA,sha256=xfHJukntAuWThxb0FO0wtQ8ZU-SPV3MSzrz4JA6jUw8,3528
-kodexa-7.4.413228596953.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.4.413228596953.dist-info/RECORD,,
+kodexa-7.4.413229965531.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.4.413229965531.dist-info/METADATA,sha256=Hp1AzXcktjapvukfwkTv9nEzon8dlaiDZxxzhyUMSv0,3528
+kodexa-7.4.413229965531.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.4.413229965531.dist-info/RECORD,,