kodexa 7.0.1a9196705380__tar.gz → 7.0.1a9956673208__tar.gz

{kodexa-7.0.1a9196705380 → kodexa-7.0.1a9956673208}/PKG-INFO

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

{kodexa-7.0.1a9196705380 → kodexa-7.0.1a9956673208}/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.1a9196705380 → kodexa-7.0.1a9956673208}/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.1a9196705380 → kodexa-7.0.1a9956673208}/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()
@@ -1550,6 +1551,20 @@ class OrganizationEndpoint(Organization, EntityEndpoint):
             .set_client(self.client)
         )
 
+    @property
+    def guidance_sets(self) -> "GuidanceSetsEndpoint":
+        """
+        Get the guidance sets endpoint of the organization.
+
+        Returns:
+            GuidanceSetsEndpoint: The guidance sets endpoint of the organization.
+        """
+        return (
+            GuidanceSetsEndpoint()
+            .set_organization(self)
+            .set_client(self.client)
+        )
+
     @property
     def credentials(self):
         """
@@ -2067,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:
@@ -2119,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.
 
@@ -2157,7 +2236,7 @@ class ProjectGuidanceSetsEndpoint(ProjectResourceEndpoint):
         return "guidance"
 
     def get_instance_class(self, object_dict=None):
-        return GuidanceSetsEndpoint
+        return GuidanceSetEndpoint
 
 
 class ProjectDataFormEndpoint(ProjectResourceEndpoint):
@@ -2459,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.
@@ -2503,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.
@@ -2540,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:
@@ -2582,7 +2679,6 @@ class ProjectEndpoint(EntityEndpoint, Project):
         return [ProjectTag.model_validate(tag) for tag in response.json()]
 
 
-
 class MessagesEndpoint(EntitiesEndpoint):
     """Represents a message endpoint"""
 
@@ -4361,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.
@@ -5337,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"
@@ -5361,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(
@@ -6229,7 +6354,6 @@ class KodexaClient:
         self.messages = MessagesEndpoint(self)
         from kodexa.model.entities.product import ProductsEndpoint
         self.products = ProductsEndpoint(self)
-        self.guidance_sets = GuidanceSetsEndpoint(self)
 
     @staticmethod
     def login(url, token):

{kodexa-7.0.1a9196705380 → kodexa-7.0.1a9956673208}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kodexa"
-version = "7.0.1a9196705380"
+version = "7.0.1a9956673208"
 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"