kodexa 7.0.9774637276__tar.gz → 7.0.9957978617__tar.gz

{kodexa-7.0.9774637276 → kodexa-7.0.9957978617}/PKG-INFO

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

{kodexa-7.0.9774637276 → kodexa-7.0.9957978617}/kodexa/model/objects.py

@@ -3851,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):
     """
 

{kodexa-7.0.9774637276 → kodexa-7.0.9957978617}/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()
@@ -4456,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.

{kodexa-7.0.9774637276 → kodexa-7.0.9957978617}/pyproject.toml

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