kodexa 6.0.193__py3-none-any.whl → 6.0.195__py3-none-any.whl

kodexa/model/objects.py

@@ -1649,6 +1649,38 @@ class FeatureSet(KodexaBaseModel):
     node_features: Optional[List[NodeFeatures]] = Field(None, alias='nodeFeatures')
 
 
+class DocumentViewState(KodexaBaseModel):
+    id: Optional[str] = Field(None, description='The ID of the document view')
+    index: Optional[int] = None
+    document_family_id: Optional[str] = Field(None, alias='documentFamilyId')
+    properties: Optional[Dict[str, Any]] = None
+
+
+class DataFormState(KodexaBaseModel):
+    id: Optional[str] = Field(None, description='The ID of the document view')
+    index: Optional[int] = None
+    properties: Optional[Dict[str, Any]] = None
+
+    data_form_ref: Optional[str] = Field(None, alias='dataFormRef')
+    document_family_ids: Optional[List[str]] = Field(None, alias='documentFamilyIds')
+    data_object_ids: Optional[List[str]] = Field(None, alias='dataObjectIds')
+
+
+class WorkspaceStorage(KodexaBaseModel):
+    document_view_states: Optional[List[DocumentViewState]] = Field(None, alias='documentViewStates')
+    data_form_states: Optional[List[DataFormState]] = Field(None, alias='dataFormStates')
+
+
+class Workspace(KodexaBaseModel):
+    id: Optional[str] = Field(None, description='The ID of the workspace')
+    uuid: Optional[str] = None
+    created_on: Optional[datetime] = Field(None, alias='createdOn')
+    updated_on: Optional[datetime] = Field(None, alias='updatedOn')
+    project: Optional[Project] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+
+
 class DataAttribute(KodexaBaseModel):
     id: Optional[str] = Field(None, description='The ID of the object')
     uuid: Optional[str] = None
@@ -1835,6 +1867,19 @@ class PageProject(KodexaBaseModel):
     empty: Optional[bool] = None
 
 
+class PageWorkspace(KodexaBaseModel):
+    total_pages: Optional[int] = Field(None, alias='totalPages')
+    total_elements: Optional[int] = Field(None, alias='totalElements')
+    size: Optional[int] = None
+    content: Optional[List[Workspace]] = None
+    number: Optional[int] = None
+    pageable: Optional[PageableObject] = None
+    number_of_elements: Optional[int] = Field(None, alias='numberOfElements')
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
 class PageOrganization(KodexaBaseModel):
     total_pages: Optional[int] = Field(None, alias='totalPages')
     total_elements: Optional[int] = Field(None, alias='totalElements')

kodexa/platform/client.py

@@ -32,7 +32,7 @@ from kodexa.model.objects import PageStore, PageTaxonomy, PageProject, PageOrgan
     PageDataObject, Assistant, ProjectTemplate, PageExtensionPack, DeploymentOptions, PageMembership, Membership, \
     PageDocumentFamily, ProjectResourcesUpdate, DataAttribute, PageNote, PageDataForm, DataForm, Store, PageExecution, \
     Dashboard, PageAction, PagePipeline, DocumentStatus, ModelTraining, PageModelTraining, ContentException, Option, \
-    CustomEvent, ProjectTag, PageDataException, DataException, ReprocessRequest
+    CustomEvent, ProjectTag, PageDataException, DataException, ReprocessRequest, PageWorkspace, Workspace
 
 logger = logging.getLogger()
 
@@ -587,6 +587,14 @@ class PageProjectEndpoint(PageProject, PageEndpoint):
         return "project"
 
 
+class PageWorkspaceEndpoint(PageWorkspace, PageEndpoint):
+    """Represents a page workspace endpoints"""
+
+    def get_type(self) -> Optional[str]:
+        """Get the type of the endpoint"""
+        return "workspace"
+
+
 class PageProjectTemplateEndpoint(PageProjectTemplate, PageEndpoint):
     pass
 
@@ -929,6 +937,30 @@ class ProjectModelStoresEndpoint(ProjectResourceEndpoint):
         return ModelStoreEndpoint
 
 
+class WorkspaceEndpoint(EntityEndpoint, Workspace):
+    """Represents a workspace endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint"""
+        return "workspaces"
+
+    def add_document_family(self, document_family: DocumentFamily):
+        url = f"/api/workspaces/{self.id}/documentFamilies"
+        response = self.client.post(url, body=document_family.to_dict())
+        process_response(response)
+
+    def remove_document_family(self, document_family: DocumentFamily):
+        url = f"/api/workspaces/{self.id}/documentFamilies/{document_family.id}"
+        response = self.client.delete(url)
+        process_response(response)
+
+    def list_document_families(self, page_size=10, page=1) -> PageDocumentFamilyEndpoint:
+        url = f"/api/workspaces/{self.id}/documentFamilies"
+        response = self.client.get(url, {"pageSize": page_size, "page": page})
+        process_response(response)
+        return PageDocumentFamilyEndpoint.parse_obj(response.json()).set_client(self.client)
+
+
 class ProjectEndpoint(EntityEndpoint, Project):
     """Represents a project endpoint"""
 
@@ -990,6 +1022,22 @@ class ProjectEndpoint(EntityEndpoint, Project):
         return [ProjectTag.parse_obj(tag) for tag in response.json()]
 
 
+class WorkspacesEndpoint(EntitiesEndpoint):
+    """Represents a workspaces endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint"""
+        return f"workspaces"
+
+    def get_instance_class(self, object_dict=None) -> Type[BaseModel]:
+        """Get the instance class of the endpoint"""
+        return WorkspaceEndpoint
+
+    def get_page_class(self, object_dict=None) -> Type[BaseModel]:
+        """Get the page class of the endpoint"""
+        return PageWorkspaceEndpoint
+
+
 class ProjectsEndpoint(EntitiesEndpoint):
     """Represents a projects endpoint"""
 
@@ -2418,6 +2466,13 @@ OBJECT_TYPES = {
         "endpoint": ProjectsEndpoint,
         "global": True
     },
+    "workspaces": {
+        "name": "workspace",
+        "plural": "workspaces",
+        "type": WorkspaceEndpoint,
+        "endpoint": WorkspacesEndpoint,
+        "global": True
+    },
     "projectTemplates": {
         "name": "projectTemplate",
         "plural": "projectTemplates",
@@ -2511,6 +2566,7 @@ class KodexaClient:
         self.access_token = access_token if access_token is not None else KodexaPlatform.get_access_token()
         self.organizations = OrganizationsEndpoint(self)
         self.projects = ProjectsEndpoint(self)
+        self.workspaces = WorkspacesEndpoint(self)
         self.users = UsersEndpoint(self)
         self.memberships = MembershipsEndpoint(self)
         self.executions = ExecutionsEndpoint(self)
@@ -2778,7 +2834,8 @@ class KodexaClient:
                 "dashboard": DashboardEndpoint,
                 "execution": ExecutionEndpoint,
                 "assistant": AssistantDefinitionEndpoint,
-                "exception": DataExceptionEndpoint
+                "exception": DataExceptionEndpoint,
+                "workspace": WorkspaceEndpoint,
             }
 
             if component_type in known_components:

{kodexa-6.0.193.dist-info → kodexa-6.0.195.dist-info}/METADATA

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

{kodexa-6.0.193.dist-info → kodexa-6.0.195.dist-info}/RECORD

@@ -6,12 +6,12 @@ kodexa/connectors/connectors.py,sha256=25-TffyGDjxHyp9ITug0qgr1nhqMAekmV5NVvbPGs
 kodexa/model/__init__.py,sha256=DyCgkJU7rOfd4SMvPRLaPdklCNlkqCRRWiVPwjYn2GE,720
 kodexa/model/base.py,sha256=6IraEK3RomjPgFpPYkxjuLUriF958AusgJO21Dcopeg,753
 kodexa/model/model.py,sha256=A9v5CRLe-Y28tj0C-oe8L1Gvu3m6bYfPvQQK89tCFzw,88524
-kodexa/model/objects.py,sha256=c58_U0k5wQdha7zcV3oEO_aHlq1Jfh72kzK_6EapZZE,114121
+kodexa/model/objects.py,sha256=jnFIsHUH2GVISwF3zjjekxK8FbXkGVfhRxLl1PU0-P8,115962
 kodexa/model/persistence.py,sha256=rRBY_onLcSTFlZZmitU8_FLffP7elDHhcmF8yYT94HE,37655
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=uzxe7HuSW1CKDZOrnV_LRHj3SHhbs14lvmMGJ_DIVdw,19763
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=CQp-xr199jYYkXzdI-AM44lzvC0z6e6klWpMwX-dVKg,106414
+kodexa/platform/client.py,sha256=FQmxDxrS0wobQ1hLQjS9tCzXbwFftOS0SRvVpA132wA,108476
 kodexa/platform/kodexa.py,sha256=HcwQh1NKkwSzkngKLp_kEsLW0N_JlzORszoknSDFLT0,27604
 kodexa/selectors/__init__.py,sha256=xA9-4vpyaAZWPSk3bh2kvDLkdv6XEmm7PjFbpziiTIk,100
 kodexa/selectors/ast.py,sha256=mTAcX_pjDiDy99ELxbMMwAAkzezOqz5uCyui9qz7Q4A,13499
@@ -34,7 +34,7 @@ kodexa/testing/test_components.py,sha256=i_9M6-bfUBdR1uYAzZZzWiW0M1DGKzE5mkNuHq4
 kodexa/testing/test_utils.py,sha256=HXM3S5FDzarzS6R7jkOHps6d6Ox2UtNqymoK6VCw8Zg,13596
 kodexa/training/__init__.py,sha256=xs2L62YpRkIRfslQwtQZ5Yxjhm7sLzX2TrVX6EuBnZQ,52
 kodexa/training/train_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kodexa-6.0.193.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-6.0.193.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-kodexa-6.0.193.dist-info/METADATA,sha256=fDfXmN62roEs76Dmc-UiLvkwin-EurfCWU_qMiL975U,3602
-kodexa-6.0.193.dist-info/RECORD,,
+kodexa-6.0.195.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-6.0.195.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+kodexa-6.0.195.dist-info/METADATA,sha256=THs9Jglsjh0wKYTL1q1SRIxKzGLCRfB31pYz6KIKMUQ,3602
+kodexa-6.0.195.dist-info/RECORD,,