kodexa 7.0.1a9196805101__tar.gz → 7.0.1a9971685034__tar.gz

{kodexa-7.0.1a9196805101 → kodexa-7.0.1a9971685034}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 7.0.1a9196805101
+Version: 7.0.1a9971685034
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com
@@ -16,6 +16,7 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: addict (>=2.4.0,<3.0.0)
 Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: better-exceptions (>=0.3.3,<0.4.0)
+Requires-Dist: certifi (>=2024.7.4,<2025.0.0)
 Requires-Dist: chevron (>=0.14.0,<0.15.0)
 Requires-Dist: deepdiff (>=7.0.1,<8.0.0)
 Requires-Dist: msgpack (>=1.0.6,<2.0.0)

kodexa-7.0.1a9971685034/kodexa/model/entities/check_response.py

@@ -0,0 +1,133 @@
+from typing import Optional, List
+
+from pydantic import BaseModel, ConfigDict, Field
+from kodexa.model.base import StandardDateTime
+from kodexa.model.objects import User
+from kodexa.platform.client import EntityEndpoint, PageEndpoint, EntitiesEndpoint
+
+from enum import Enum
+
+
+class CheckStatus(Enum):
+    """ Check Status ENUM: OPEN, CLOSED, IN_PROGRESS """
+    open = "OPEN"
+    closed = "CLOSED"
+    in_progress = "IN_PROGRESS"
+
+
+class CheckResponse(BaseModel):
+    """
+    Entity of check response
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+
+    id: Optional[str] = Field(None)
+    uuid: Optional[str] = None
+    change_sequence: Optional[int] = Field(None, alias="changeSequence")
+    created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
+    updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
+    title: Optional[str] = None
+    description: Optional[str] = None
+    status: Optional[CheckStatus] = None
+    confidence: Optional[float] = None
+    approver: Optional[User] = None
+    data_object_id: Optional[str] = Field(None, alias="dataObjectId")
+
+
+class PageCheckResponse(BaseModel):
+    """
+        A page pydantic for check response
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    total_pages: Optional[int] = Field(None, alias="totalPages")
+    total_elements: Optional[int] = Field(None, alias="totalElements")
+    size: Optional[int] = None
+    content: Optional[List[CheckResponse]] = None
+    number: Optional[int] = None
+    number_of_elements: Optional[int] = Field(None, alias="numberOfElements")
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
+class PageCheckResponseEndpoint(PageCheckResponse, PageEndpoint):
+    """
+        Represents a page check response endpoint
+
+        This class is used to represent the endpoints of a page check response. It inherits from
+        the PageCheckResponse and PageEndpoint classes.
+
+        Methods:
+            get_type: Returns the type of the endpoint.
+    """
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint
+
+        This method is used to get the type of the endpoint. In this case, it will always
+        return "workspace".
+
+        Returns:
+            str: The type of the endpoint, "workspace".
+        """
+        return "checkResponse"
+
+
+class CheckResponseEndpoint(CheckResponse, EntityEndpoint):
+    """Represents a Check Response endpoint"""
+
+    def get_type(self) -> str:
+        """
+        Get the type of endpoint
+
+        :return: The type of endpoint
+        """
+        return "checkResponses"
+
+
+class CheckResponsesEndpoint(EntitiesEndpoint):
+    """ Represents check responses endpoint """
+
+    def get_type(self) -> str:
+        """
+            Get the type of endpoint
+        :return: The type of endpoint
+        """
+        return "checkResponses"
+
+    def get_instance_class(self, object_dict=None) -> CheckResponseEndpoint:
+        """Get the instance class of the endpoint
+
+        This method is used to get the instance class of the endpoint.
+
+        Args:
+            object_dict (dict, optional): A dictionary containing the object data.
+
+        Returns:
+            CheckResponseEndpoint: The instance class of the endpoint.
+        """
+        return CheckResponseEndpoint
+
+    def get_page_class(self, object_dict=None) -> PageCheckResponseEndpoint:
+        """Get the page class of the endpoint
+
+        This method is used to get the page class of the endpoint.
+
+        Args:
+            object_dict (dict, optional): A dictionary containing the object data.
+
+        Returns:
+            PageCheckResponseEndpoint: The page class of the endpoint.
+        """
+        return PageCheckResponseEndpoint

{kodexa-7.0.1a9196805101 → kodexa-7.0.1a9971685034}/kodexa/model/model.py

@@ -559,9 +559,13 @@ class ContentNode(object):
            >>> new_page.add_feature('pagination','pageNum',1)
         """
         if self.has_feature(feature_type, name):
-            raise Exception(
-                f"Feature {feature_type}:{name} already exists on this node, use set_feature to update"
-            )
+            existing_feature = self.get_feature(feature_type, name)
+            if isinstance(existing_feature.value, list):
+                existing_feature.value.append(value)
+            else:
+                existing_feature.value = [existing_feature.value, value]
+            self.update_feature(existing_feature)
+            return existing_feature
 
         # Make sure that we treat the value as list all the time
         new_feature = ContentFeature(

{kodexa-7.0.1a9196805101 → kodexa-7.0.1a9971685034}/kodexa/model/objects.py

@@ -1732,6 +1732,7 @@ class ProjectResourcesUpdate(BaseModel):
     store_refs: Optional[List[str]] = Field(None, alias="storeRefs")
     dashboard_refs: Optional[List[str]] = Field(None, alias="dashboardRefs")
     data_form_refs: Optional[List[str]] = Field(None, alias="dataFormRefs")
+    guidance_set_refs: Optional[List[str]] = Field(None, alias="guidanceRefs")
 
 
 class Role1(Enum):
@@ -3850,6 +3851,18 @@ class DocumentEmbedding(BaseModel):
     node_uuid: Optional[str] = Field(None, alias="nodeUuid")
 
 
+class DocumentExternalData(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+
+    external_data: Optional[Dict[str, Any]] = Field(None, alias="externalData")
+    document_family: Optional[DocumentFamily] = Field(None, alias="documentFamily")
+
+
 class DocumentFamily(BaseModel):
     """
 
@@ -5071,6 +5084,13 @@ class ModelContentMetadata(BaseModel):
         alias="additionalTaxonOptions",
         description="This are additional properties that can be set on a label when the model is part of the project",
     )
+
+    taxon_features: Optional[List[TaxonFeatures]] = Field(
+        None,
+        alias="taxonFeatures",
+        description="This are additional properties that can be set as part of the taxon in the taxonomy (not a label but at the taxon level) they will be stored under the type_features",
+    )
+
     contents: Optional[List[str]] = Field(
         None,
         description="A list of the paths (with wildcards) that hold the content of this model",
@@ -5101,6 +5121,33 @@ class Action(ExtensionPackProvided):
     metadata: Optional[ObjectMetadata] = None
 
 
+class TaxonFeatures(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    """
+    A Custom Event allows you to define an subtype of assistant event with options
+    """
+
+    taxonPath: Optional[str] = Field(
+        None, description="The path of the taxon to add the features to", pattern=r"^[a-zA-Z0-9\-_]{0,40}$"
+    )
+    options: Optional[List[Option]] = Field(
+        None, description="The options to add as type features to the taxon"
+    )
+    group_only: Optional[bool] = Field(
+        None,
+        alias="groupOnly",
+        description="If true, the features will only be added to the group taxon",
+    )
+
+
 class AssistantDefinition(ExtensionPackProvided):
     """
 
@@ -5136,6 +5183,11 @@ class AssistantDefinition(ExtensionPackProvided):
         alias="additionalTaxonOptions",
         description="This are additional properties that can be set on a label when the assistant is part of the project",
     )
+    taxon_features: Optional[List[TaxonFeatures]] = Field(
+        None,
+        alias="taxonFeatures",
+        description="This are additional properties that can be set as part of the taxon in the taxonomy (not a label but at the taxon level) they will be stored under the type_features",
+    )
     event_types: Optional[List[CustomEvent]] = Field(
         None,
         alias="eventTypes",

{kodexa-7.0.1a9196805101 → kodexa-7.0.1a9971685034}/kodexa/platform/client.py

@@ -86,6 +86,7 @@ from kodexa.model.objects import (
     PageExtensionPack,
     PageOrganization,
     DocumentFamilyStatistics, MessageContext, PagePrompt, Prompt, GuidanceSet, PageGuidanceSet, DocumentEmbedding,
+    DocumentExternalData,
 )
 
 logger = logging.getLogger()
@@ -2081,6 +2082,38 @@ class ProjectDocumentStoresEndpoint(ProjectResourceEndpoint):
         return DocumentStoreEndpoint
 
 
+class ProjectDashboardsEndpoint(ProjectResourceEndpoint):
+    """Represents a project dashboards endpoint.
+
+    This class is used to represent a project document stores endpoint in the system.
+    """
+
+    """Represents a project document stores endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint.
+
+        This method is used to get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "dashboards"
+
+    def get_instance_class(self, object_dict=None):
+        """Get the instance class of the project document stores endpoint.
+
+        This method is used to get the instance class of the project document stores endpoint.
+
+        Args:
+            object_dict (dict, optional): The object dictionary. Defaults to None.
+
+        Returns:
+            DocumentStoreEndpoint: The instance class of the project document stores endpoint.
+        """
+        return DashboardEndpoint
+
+
 class GuidanceSetEndpoint(ComponentInstanceEndpoint, GuidanceSet):
 
     def get_type(self) -> str:
@@ -2133,6 +2166,38 @@ class PagePromptEndpoint(PagePrompt, PageEndpoint):
     pass
 
 
+class ProjectDataFormsEndpoint(ProjectResourceEndpoint):
+    """Represents a project data forms endpoint.
+
+    This class is used to represent a project taxonomies endpoint in the system.
+    """
+
+    """Represents a project taxonomies endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint.
+
+        This method is used to get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "dataForms"
+
+    def get_instance_class(self, object_dict=None):
+        """Get the instance class of the project data form endpoint.
+
+        This method is used to get the instance class of the project dataform endpoint.
+
+        Args:
+            object_dict (dict, optional): The object dictionary. Defaults to None.
+
+        Returns:
+            TaxonomyEndpoint: The instance class of the project taxonomies endpoint.
+        """
+        return DataFormEndpoint
+
+
 class ProjectTaxonomiesEndpoint(ProjectResourceEndpoint):
     """Represents a project taxonomies endpoint.
 
@@ -2171,7 +2236,7 @@ class ProjectGuidanceSetsEndpoint(ProjectResourceEndpoint):
         return "guidance"
 
     def get_instance_class(self, object_dict=None):
-        return GuidanceSetsEndpoint
+        return GuidanceSetEndpoint
 
 
 class ProjectDataFormEndpoint(ProjectResourceEndpoint):
@@ -2473,7 +2538,7 @@ class ProjectEndpoint(EntityEndpoint, Project):
             stores: List["StoreEndpoint"] = None,
             taxonomies: List["TaxonomyEndpoint"] = None,
             data_forms: List["DataFormEndpoint"] = None,
-            guidance: List["GuidanceSetsEndpoint"] = None,
+            guidance: List["GuidanceSetEndpoint"] = None,
             dashboards: List["DashboardEndpoint"] = None,
     ):
         """Update the resources of the project.
@@ -2517,6 +2582,15 @@ class ProjectEndpoint(EntityEndpoint, Project):
             body=json.loads(project_resources_update.json(by_alias=True)),
         )
 
+    @property
+    def dashboards(self) -> ProjectDashboardsEndpoint:
+        """Get the document stores endpoint of the project.
+
+        Returns:
+            ProjectDocumentStoresEndpoint: The document stores endpoint of the project.
+        """
+        return ProjectDashboardsEndpoint().set_client(self.client).set_project(self)
+
     @property
     def document_stores(self) -> ProjectDocumentStoresEndpoint:
         """Get the document stores endpoint of the project.
@@ -2554,13 +2628,22 @@ class ProjectEndpoint(EntityEndpoint, Project):
         return ProjectTaxonomiesEndpoint().set_client(self.client).set_project(self)
 
     @property
-    def guidance(self) -> "ProjectGuidanceEndpoint":
+    def guidance(self) -> "ProjectGuidanceSetsEndpoint":
         """Get the guidance sets endpoint of the project.
 
         Returns:
             GuidanceSetsEndpoint: The guidance sets endpoint of the project.
         """
-        return ProjectGuidanceSetEndpoint().set_client(self.client).set_project(self)
+        return ProjectGuidanceSetsEndpoint().set_client(self.client).set_project(self)
+
+    @property
+    def data_forms(self) -> "ProjectDataFormsEndpoint":
+        """Get the guidance sets endpoint of the project.
+
+        Returns:
+            GuidanceSetsEndpoint: The guidance sets endpoint of the project.
+        """
+        return ProjectDataFormsEndpoint().set_client(self.client).set_project(self)
 
     @property
     def assistants(self) -> ProjectAssistantsEndpoint:
@@ -2596,7 +2679,6 @@ class ProjectEndpoint(EntityEndpoint, Project):
         return [ProjectTag.model_validate(tag) for tag in response.json()]
 
 
-
 class MessagesEndpoint(EntitiesEndpoint):
     """Represents a message endpoint"""
 
@@ -4375,6 +4457,28 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
         response = self.client.get(url)
         process_response(response)
 
+    def get_external_data(self) -> DocumentExternalData:
+        """
+        Get the external data of the document family.
+
+        Returns:
+            DocumentExternalData: The external data of the document family.
+        """
+        url = f"/api/documentFamilies/{self.id}/externalData"
+        response = self.client.get(url)
+        return DocumentExternalData.model_validate(response.json())
+
+    def update_external_data(self, external_data: DocumentExternalData):
+        """
+        Update the external data of the document family.
+
+        Args:
+            external_data (DocumentExternalData): The external data to update.
+        """
+        url = f"/api/documentFamilies/{self.id}/externalData"
+        response = self.client.put(url, body=external_data.model_dump(mode="json", by_alias=True))
+        process_response(response)
+
     def export(self) -> bytes:
         """
         Export the document family as bytes.
@@ -5351,19 +5455,21 @@ class DocumentStoreEndpoint(StoreEndpoint):
             document_family_response.json()
         ).set_client(self.client)
 
-    def stream_query(self, query: str = "*", sort=None):
+    def stream_query(self, query: str = "*", sort=None, limit=None):
         """
         Stream the query for the document family.
 
         Args:
             query (str, optional): The query to run. Defaults to "*".
             sort (str, optional): Sorting order of the query. Defaults to None.
+            limit (int, optional): The maximum number of items to return. Defaults to None.
 
         Returns:
             generator: A generator of the document families.
         """
         page_size = 5
         page = 1
+        number_of_items = 0
 
         if not sort:
             sort = "id"
@@ -5375,7 +5481,12 @@ class DocumentStoreEndpoint(StoreEndpoint):
             if not page_response.content:
                 break
             for document_family in page_response.content:
+                number_of_items += 1
+                if limit and number_of_items > limit:
+                    break
+
                 yield document_family
+
             page += 1
 
     def query(
@@ -6813,6 +6924,7 @@ class KodexaClient:
 
             from kodexa.model.entities.product import ProductEndpoint
             from kodexa.model.entities.product_subscription import ProductSubscriptionEndpoint
+            from kodexa.model.entities.check_response import CheckResponseEndpoint
             known_components = {
                 "taxonomy": TaxonomyEndpoint,
                 "pipeline": PipelineEndpoint,
@@ -6838,6 +6950,7 @@ class KodexaClient:
                 "channel": ChannelEndpoint,
                 "product": ProductEndpoint,
                 "productSubscription": ProductSubscriptionEndpoint,
+                "checkResponse": CheckResponseEndpoint
             }
 
             if component_type in known_components:

{kodexa-7.0.1a9196805101 → kodexa-7.0.1a9971685034}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kodexa"
-version = "7.0.1a9196805101"
+version = "7.0.1a9971685034"
 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"
@@ -35,6 +35,7 @@ semver = "^3.0.1"
 chevron = "^0.14.0"
 addict = "^2.4.0"
 simpleeval = "^0.9.13"
+certifi = "^2024.7.4"
 
 [tool.poetry.group.dev.dependencies]
 mkdocs-material = "^9.0.3"
@@ -43,7 +44,7 @@ pytest-runner = "^6.0.0"
 mypy = "^1.10.0"
 flake8 = "^7.0.0"
 pandas = "2.2.2"
-setuptools = "^65.5.1"
+setuptools = "^70"
 black = ">=23.7,<25.0"
 mkdocstrings = "^0.22.0"
 mkdocstrings-python = "^1.5.1"