kodexa 7.4.413640242188__py3-none-any.whl → 7.4.413698864785__py3-none-any.whl

kodexa/model/objects.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import Optional, List, Dict, Any
+from typing import Optional, List, Dict, Any, Set
 from typing import Union
 
 from pydantic import AnyUrl, Field, RootModel, BaseModel, ConfigDict
@@ -2900,6 +2900,79 @@ class ProjectOptions(BaseModel):
     )
 
 
+class NodePosition(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    x: float = 0
+    y: float = 0
+
+
+class NodeDimensions(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    width: float = 0
+    height: float = 0
+
+
+class FlowViewPort(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    x: float = 0
+    y: float = 0
+    zoom: float = 1
+
+
+class DataFlowNode(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    id: Optional[str] = None
+    parent_id: Optional[str] = Field(None, alias="parentId")
+    type: Optional[str] = None
+    position: Optional[NodePosition] = None
+    dimensions: Optional[NodeDimensions] = None
+    properties: Dict[str, Any] = Field(default_factory=dict)
+
+
+class DataFlowEdge(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    id: Optional[str] = None
+    source: Optional[str] = None
+    target: Optional[str] = None
+    properties: Dict[str, Any] = Field(default_factory=dict)
+
+
+class ProjectDataFlow(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    view_port: Optional[FlowViewPort] = Field(None, alias="viewPort")
+    nodes: List[DataFlowNode] = Field(default_factory=list)
+    edges: List[DataFlowEdge] = Field(default_factory=list)
+
 class Project(BaseModel):
     model_config = ConfigDict(
         populate_by_name=True,
@@ -2945,13 +3018,142 @@ class Project(BaseModel):
     owner: Optional[User] = None
     options: Optional[ProjectOptions] = Field(None, alias="options")
 
-
 class TaskStatusType(str, Enum):
     """Enum for task status types"""
     TODO = "TODO"
     IN_PROGRESS = "IN_PROGRESS"
     DONE = "DONE"
 
+class ProjectAttributeStatus(BaseModel):
+    """
+    Represents an attribute status for a project.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    color: Optional[str] = Field(None, max_length=25)
+    icon: Optional[str] = Field(None, max_length=25)
+    status: Optional[str] = Field(None, max_length=255)
+    status_type: Optional[StatusType2] = Field(None, alias="statusType")
+
+class ProjectDocumentStatus(BaseModel):
+    """
+    Represents a document status for a project.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    color: Optional[str] = Field(None, max_length=25)
+    icon: Optional[str] = Field(None, max_length=25)
+    status: str = Field(..., max_length=255)
+    status_type: Optional[StatusType2] = Field(None, alias="statusType")
+
+class ProjectTaskStatus(BaseModel):
+    """
+    Represents a task status for a project.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    color: Optional[str] = Field(None, max_length=25)
+    icon: Optional[str] = Field(None, max_length=25)
+    label: str = Field(..., max_length=255)
+    status_type: Optional[TaskStatusType] = Field(None, alias="statusType")
+
+class ProjectTemplateTag(BaseModel):
+    """
+    Represents a tag for a project template.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    label: Optional[str] = None
+    color: Optional[str] = None
+
+class ProjectTaskTemplate(BaseModel):
+    """
+    Represents a task template for a project.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    title: Optional[str] = None
+    description: Optional[str] = None
+
+class ProjectResource(BaseModel):
+    """
+    Represents a resource for a project.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    uri: Optional[str] = None
+    type: Optional[str] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    copy: Optional[bool] = False
+    slug: Optional[str] = None
+    original_uri: Optional[str] = Field(None, alias="originalUri")
+
+class WorkspaceResource(BaseModel):
+    """
+    Represents a workspace resource.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    name: Optional[str] = None
+    description: Optional[str] = None
+    storage: Optional[WorkspaceStorage] = None
+
+class ProjectTemplateRequest(BaseModel):
+    """
+    Represents a request to create a project template.
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    name: Optional[str] = None
+    description: Optional[str] = None
+    options: Optional[ProjectOptions] = None
+    memory: Optional[ProjectMemory] = None
+    image_url: Optional[str] = Field(None, alias="imageUrl")
+    icon: Optional[str] = None
+    overview_markdown: Optional[str] = Field(None, alias="overviewMarkdown")
+    provider: Optional[str] = None
+    provider_url: Optional[str] = Field(None, alias="providerUrl")
+    provider_image_url: Optional[str] = Field(None, alias="providerImageUrl")
+    public_access: Optional[bool] = Field(False, alias="publicAccess")
+    resources: List[ProjectResource] = Field(default_factory=list)
+    workspaces: List[ProjectWorkspace] = Field(default_factory=list)
+    assistants: List[ProjectAssistant] = Field(default_factory=list)
+    document_statuses: List[ProjectDocumentStatus] = Field(default_factory=list, alias="documentStatuses")
+    task_statuses: List[ProjectTaskStatus] = Field(default_factory=list, alias="taskStatuses")
+    tags: Set[str] = Field(default_factory=set)
 
 class TaskStatus(BaseModel):
     """Model representing a task status entity"""

kodexa/platform/client.py

@@ -85,7 +85,7 @@ from kodexa.model.objects import (
     PageOrganization,
     DocumentFamilyStatistics, MessageContext, PagePrompt, Prompt, GuidanceSet, PageGuidanceSet, DocumentEmbedding,
     DocumentExternalData, Task, PageTask, RetainedGuidance, PageRetainedGuidance, TaskTemplate, TaskStatus,
-    TaskActivity, TaskDocumentFamily, TaskTag,
+    TaskActivity, TaskDocumentFamily, TaskTag, ProjectTemplateRequest,
 )
 
 logger = logging.getLogger()
@@ -306,7 +306,7 @@ class ProjectResourceEndpoint(ClientEndpoint):
             page += 1
 
     def list(
-            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None, 
+            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None,
             filters: Optional[List[str]] = None
     ):
         """
@@ -502,7 +502,7 @@ class ComponentEndpoint(ClientEndpoint, OrganizationOwned):
             params["page"] += 1
 
     def list(
-            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None, 
+            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None,
             filters: Optional[List[str]] = None
     ):
         """
@@ -730,7 +730,7 @@ class EntitiesEndpoint:
             page += 1
 
     def list(
-            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None, 
+            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None,
             filters: Optional[List[str]] = None
     ):
         """List the resources.
@@ -1164,34 +1164,43 @@ class PageTaskEndpoint(PageTask, PageEndpoint):
     """
     Represents a page of tasks.
     """
+
     def get_type(self) -> Optional[str]:
         return "task"
 
+
 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"
 
@@ -1219,10 +1228,12 @@ class TaskEndpoint(EntityEndpoint, Task):
         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"
 
@@ -1232,28 +1243,34 @@ class TasksEndpoint(EntitiesEndpoint):
     def get_page_class(self, object_dict=None):
         return PageTaskEndpoint
 
-    def create_with_template(self, task: Task, task_template: Optional[TaskTemplate] = None, document_families: Optional[List[DocumentFamily]] = None) -> TaskEndpoint:
+    def create_with_template(self, task: Task, task_template: Optional[TaskTemplate] = None,
+                             document_families: Optional[List[DocumentFamily]] = None) -> TaskEndpoint:
         """Create a task with the given template."""
         url = "/api/tasks/createTaskWithRequest"
         create_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
+            "documentFamilies": [df.model_dump(mode="json", by_alias=True) for df in
+                                 document_families] if document_families else None
         }
         response = self.client.post(url, create_body)
         return TaskEndpoint.model_validate(response.json()).set_client(self.client)
 
+
 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"
 
@@ -1263,17 +1280,21 @@ class TaskTemplatesEndpoint(EntitiesEndpoint):
     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"
 
@@ -1283,17 +1304,21 @@ class TaskActivitiesEndpoint(EntitiesEndpoint):
     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"
 
@@ -1303,17 +1328,21 @@ class TaskDocumentFamiliesEndpoint(EntitiesEndpoint):
     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"
 
@@ -2857,6 +2886,16 @@ class ProjectEndpoint(EntityEndpoint, Project):
         )
         return [ProjectTag.model_validate(tag) for tag in response.json()]
 
+    def create_project_template_request(self) -> ProjectTemplateRequest:
+        """Create a project template request from this project.
+
+        Returns:
+            ProjectTemplateRequest: A project template request object.
+        """
+        response = self.client.get(f"/api/projects/{self.id}/createProjectTemplateRequest")
+        return ProjectTemplateRequest.model_validate(response.json())
+
+
 
 class MessagesEndpoint(EntitiesEndpoint):
     """Represents a message endpoint"""
@@ -3477,6 +3516,7 @@ class ProjectTemplatesEndpoint(ComponentEndpoint, ClientEndpoint, OrganizationOw
         """
         return ProjectTemplateEndpoint
 
+
 class DataFormsEndpoint(ComponentEndpoint, ClientEndpoint, OrganizationOwned):
     """
     A class used to represent the DataFormsEndpoint.
@@ -4637,7 +4677,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             project_id: Optional[str] = None,
             friendly_names=False,
             include_ids=True,
-            include_exceptions=False,          
+            include_exceptions=False,
     ) -> str:
         """Get the JSON export for the document family
 
@@ -5106,7 +5146,7 @@ class DataStoreExceptionsEndpoint(EntitiesEndpoint):
         super().__init__(client)
 
     def list(
-            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None, 
+            self, query: str = "*", page: int = 1, page_size: int = 10, sort: Optional[str] = None,
             filters: Optional[List[str]] = None
     ):
         """

{kodexa-7.4.413640242188.dist-info → kodexa-7.4.413698864785.dist-info}/METADATA

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

{kodexa-7.4.413640242188.dist-info → kodexa-7.4.413698864785.dist-info}/RECORD

@@ -13,13 +13,13 @@ kodexa/model/entities/product.py,sha256=StUhTEeLXmc05cj6XnZppQfeJsqCPbX1jdhsysHH
 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=q3zEm6pPOB-xPCKbOxmTMqLALzmQr2Ppam8knApoSEE,119645
-kodexa/model/objects.py,sha256=S1q3rneARkIVgHrPYUSi5exF1iNirCdZ57oKFc4EKPo,190116
+kodexa/model/objects.py,sha256=Y1aHbFbVNLhI1Sv9XddmKne4A8mYgVRpdWzc6avF-Uo,196684
 kodexa/model/persistence.py,sha256=jUgQ8xwsAFIoZ_bEynxCDEWhUII42eN0e0Mum0dkQPg,72043
 kodexa/model/utils.py,sha256=6R-3rFiW9irBwj0Mq5yhp7EDXkNUFaeFhr3bWmnlW4g,2961
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=zyNEpA7KlGhPs_l-vgV6m-OCb16dbxQhl8QezeylugA,25540
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=e-MZV4chLYVQj24EADsOdYXbRJ6dgdJJmZ0fqfujSQw,231445
+kodexa/platform/client.py,sha256=NK00OhqiGWWblXTF4g6i2P8ffdN0FHu8z2mXSepsM-k,231947
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
 kodexa/platform/kodexa.py,sha256=izvvUUkRUNYFZGMiL4DcJpZ4gZznHpxkfbexV0Vn_38,35041
 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.413640242188.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.4.413640242188.dist-info/METADATA,sha256=K5QlDwoeKLuBwKdkqAfABz5eOBmQeVtNGw_EtInI3Rs,2813
-kodexa-7.4.413640242188.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.4.413640242188.dist-info/RECORD,,
+kodexa-7.4.413698864785.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.4.413698864785.dist-info/METADATA,sha256=wcIJSD3dHPfQh70UUEOE8ycKT8m9Vo2KuhtM-Iu_3JQ,2813
+kodexa-7.4.413698864785.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.4.413698864785.dist-info/RECORD,,