clerk-sdk 0.4.1__tar.gz → 0.4.2__tar.gz

{clerk_sdk-0.4.1/clerk_sdk.egg-info → clerk_sdk-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.1
+Version: 0.4.2
 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 → clerk_sdk-0.4.2}/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_sdk-0.4.1 → clerk_sdk-0.4.2}/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_sdk-0.4.1 → clerk_sdk-0.4.2/clerk_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.1
+Version: 0.4.2
 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 → clerk_sdk-0.4.2}/setup.py

@@ -13,7 +13,7 @@ gui_requirements = get_requirements("./clerk/gui_automation")
 
 setup(
     name="clerk-sdk",
-    version="0.4.1",
+    version="0.4.2",
     description="Library for interacting with Clerk",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",