clerk-sdk 0.4.1__py3-none-any.whl → 0.4.3__py3-none-any.whl

clerk/client.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Literal
 
 from clerk.base import BaseClerk
-from clerk.models.document import Document, UploadDocumentRequest
+from clerk.models.document import Document, GetDocumentsRequest, UploadDocumentRequest
 from .models.file import ParsedFile, UploadFile
 
 
@@ -28,6 +28,27 @@ class Clerk(BaseClerk):
         res = self.get_request(endpoint=endpoint)
         return Document(**res.data[0])
 
+    def get_documents(self, request: GetDocumentsRequest) -> List[Document]:
+        if not any(
+            [
+                request.organization_id,
+                request.project_id,
+                request.start_date,
+                request.end_date,
+                request.query,
+                request.include_statuses,
+            ]
+        ):
+            raise ValueError(
+                "At least one query parameter (organization_id, project_id, start_date, end_date, query, or include_statuses) must be provided."
+            )
+
+        endpoint = f"/documents"
+        params = request.model_dump(mode="json")
+        res = self.get_request(endpoint, params=params)
+
+        return [Document(**d) for d in res.data]
+
     def get_files_document(self, document_id: str) -> List[ParsedFile]:
         endpoint = f"/document/{document_id}/files"
         res = self.get_request(endpoint=endpoint)

clerk/models/document.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+import json
 import mimetypes
 import os
 from typing import Any, Dict, List, Optional
@@ -28,6 +29,7 @@ class UploadDocumentRequest(BaseModel):
     message_subject: Optional[str] = None
     message_content: Optional[str] = None
     files: List[str | ParsedFile] = []
+    input_structured_data: Dict[str, Any] | None = None
 
     def _define_files(self):
         formatted_files: List[
@@ -70,12 +72,35 @@ class UploadDocumentRequest(BaseModel):
 
     @property
     def data(self) -> Dict[str, Any]:
+
+        serialized_input_structured_data: str | None = None
+        if self.input_structured_data:
+            try:
+                serialized_input_structured_data = json.dumps(
+                    self.input_structured_data
+                )
+            except Exception as e:
+                raise ValueError(
+                    f"`input_structured_data` is not JSON serializable: {e}"
+                )
+
         return dict(
             project_id=self.project_id,
             message_subject=self.message_subject,
             mesasge_content=self.message_content,
+            input_structured_data=serialized_input_structured_data,
         )
 
     @property
     def files_(self):
         return self._define_files()
+
+
+class GetDocumentsRequest(BaseModel):
+    organization_id: str | None = None
+    project_id: str | None = None
+    start_date: datetime | None = None
+    end_date: datetime | None = None
+    query: str | None = None
+    include_statuses: List[DocumentStatuses] | None = None
+    limit: int = 50

clerk/models/document_statuses.py

@@ -9,3 +9,4 @@ class DocumentStatuses(str, Enum):
     REVIEWED_NEGATIVE = "reviewed_negative"
     EXAMPLE = "example"
     SUPERSEDED = "superseded"
+    REQUIRES_REVIEW = "requires_review"

{clerk_sdk-0.4.1.dist-info → clerk_sdk-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.1
+Version: 0.4.3
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group

{clerk_sdk-0.4.1.dist-info → clerk_sdk-0.4.3.dist-info}/RECORD

@@ -1,6 +1,6 @@
 clerk/__init__.py,sha256=LWpbImG7352mUJYC1tRm_zsn5rnt4sFl5ldoq5f0dlo,26
 clerk/base.py,sha256=S1RKc2pBw2FPlVjefJzsNtyTDPB0UG46C2K_QVV1opA,4008
-clerk/client.py,sha256=cgDOO9fRfJAoV5_r6PCoPWoAY0OwoeEMT3cEkzUSZOI,1612
+clerk/client.py,sha256=Ma6nCICRBjgdcntPaEJv8baMBr7zftKeLcEzfD634eA,2368
 clerk/decorator/__init__.py,sha256=yGGcS17VsZ7cZ-hVGCm3I3vGDJMiJIAqmDGzriIi0DI,65
 clerk/decorator/models.py,sha256=PiAugPvX1c6BQBWtfhyh5k9Uau2OJNDIx7T1TLz7ZFY,409
 clerk/decorator/task_decorator.py,sha256=H8caRvNvvl-IRwyREP66gBGVM-SpQJ1W7oAFImO-6Jw,3769
@@ -37,8 +37,8 @@ clerk/gui_automation/ui_state_machine/exceptions.py,sha256=9KWg20dnCssMdMu632E0n
 clerk/gui_automation/ui_state_machine/models.py,sha256=oNmfHtjqgRkUAxPnQ8R5-IR-K_FCeg3NU6aqjVSnThI,1407
 clerk/gui_automation/ui_state_machine/state_machine.py,sha256=u2wJqu5WxmZHkzlIHTgK_icZUw3yv9nNuZkh9IaqmXI,35622
 clerk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/models/document.py,sha256=m9ccAQdy1G-ZgUT-a44TMgIVAp4he-90uYjVPqwgO98,2193
-clerk/models/document_statuses.py,sha256=ytTQhgACs2m22qz51_7Ti0IxzbVyl-fl7uF7CnDEyLA,279
+clerk/models/document.py,sha256=SdHLuX01yQ1std-o25Wso5sq7HQznV7-SN8azVzyczQ,3036
+clerk/models/document_statuses.py,sha256=7C9tTmbeEOahNbT45Mdr9a-yPOk_rQpM12_leHoPjsc,319
 clerk/models/file.py,sha256=wfMGoNTsIBFxpPUzOTOkUYZ-FGxXg6n2mZhDCBt6Jbc,733
 clerk/models/remote_device.py,sha256=2jijS-9WWq7y6xIbAaDaPnzZo3-tjp2-dCQvNKP8YSU,109
 clerk/models/response_model.py,sha256=R62daUN1YVOwgnrh_epvFRsQcOwT7R4u97l73egvm-c,232
@@ -46,8 +46,8 @@ clerk/models/ui_operator.py,sha256=mKTJUFZgv7PeEt5oys28HVZxHOJsofmRQOcRpqj0dbU,2
 clerk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/utils/logger.py,sha256=vHbp-lUK3W3c5fhyPsp05p9LGyDHj95v8XM_XQ_FlLc,3691
 clerk/utils/save_artifact.py,sha256=94aYkYNVGcSUaSWZmdjiY6Oc-3yCKb2XWCZ56IAXQqk,1158
-clerk_sdk-0.4.1.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.4.1.dist-info/METADATA,sha256=50SHt0qwDSsCh5X8ew-k-NBccXZdCyrJ75EuNK7Cm5o,3508
-clerk_sdk-0.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.4.1.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.4.1.dist-info/RECORD,,
+clerk_sdk-0.4.3.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.4.3.dist-info/METADATA,sha256=aEw-kitMM4mBj-R4Jc9JEs8wBQ6et6I9_hGHjP70taw,3508
+clerk_sdk-0.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.4.3.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.4.3.dist-info/RECORD,,