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

clerk/base.py

@@ -2,7 +2,7 @@ import os
 
 import requests
 import backoff
-from typing import Dict, Optional, Self
+from typing import Any, Dict, List, Optional, Self, Tuple
 
 
 from pydantic import BaseModel, model_validator, Field
@@ -10,7 +10,7 @@ from pydantic import BaseModel, model_validator, Field
 from .models.response_model import StandardResponse
 
 
-def giveup_handler(e):
+def giveup_handler(e: Any):
     return (
         isinstance(e, requests.exceptions.HTTPError)
         and e.response is not None
@@ -42,16 +42,15 @@ class BaseClerk(BaseModel):
         (requests.exceptions.RequestException,),
         max_tries=3,
         jitter=None,
-        # on_backoff=backoff_handler,
         giveup=giveup_handler,
     )
     def get_request(
         self,
         endpoint: str,
         headers: Dict[str, str] = {},
-        json: Dict = {},
-        params: Dict = {},
-    ) -> StandardResponse:
+        json: Dict[str, Any] = {},
+        params: Dict[str, Any] = {},
+    ) -> StandardResponse[Dict[str, Any]]:
 
         merged_headers = {**self.headers, **headers}
         url = f"{self.base_url}{endpoint}"
@@ -70,18 +69,17 @@ class BaseClerk(BaseModel):
         (requests.exceptions.RequestException,),
         max_tries=3,
         jitter=None,
-        # on_backoff=backoff_handler,
         giveup=giveup_handler,
     )
     def post_request(
         self,
         endpoint: str,
         headers: Dict[str, str] = {},
-        json: Dict = {},
-        params: Dict = {},
-        data: Dict = None,
-        files: Dict = {},
-    ) -> StandardResponse:
+        json: Dict[str, Any] = {},
+        params: Dict[str, Any] = {},
+        data: Dict[str, Any] | None = None,
+        files: List[Tuple[str, Tuple[str, bytes, str | None]]] | None = None,
+    ) -> StandardResponse[Dict[str, Any]]:
 
         merged_headers = {**self.headers, **headers}
         url = f"{self.base_url}{endpoint}"
@@ -96,7 +94,43 @@ class BaseClerk(BaseModel):
             json=json,
             params=params,
             data=data,
-            files=files,
+            files=files,  # type: ignore
+        )
+        response.raise_for_status()
+
+        return StandardResponse(**response.json())
+
+    @backoff.on_exception(
+        backoff.expo,
+        (requests.exceptions.RequestException,),
+        max_tries=3,
+        jitter=None,
+        giveup=giveup_handler,
+    )
+    def put_request(
+        self,
+        endpoint: str,
+        headers: Dict[str, str] = {},
+        json: Dict[str, Any] = {},
+        params: Dict[str, Any] = {},
+        data: Dict[str, Any] | None = None,
+        files: List[Tuple[str, Tuple[str, bytes, str | None]]] | None = None,
+    ) -> StandardResponse[Dict[str, Any]]:
+
+        merged_headers = {**self.headers, **headers}
+        url = f"{self.base_url}{endpoint}"
+        if self.root_endpoint:
+            url = f"{self.base_url}{self.root_endpoint}{endpoint}"
+
+        # logger.info(f"POST {url} | body={json} | params={params}")
+
+        response = requests.put(
+            url,
+            headers=merged_headers,
+            json=json,
+            params=params,
+            data=data,
+            files=files,  # type: ignore
         )
         response.raise_for_status()
 

clerk/client.py

@@ -1,11 +1,28 @@
-from typing import List, Literal
-from xml.dom.minidom import Document
+from typing import Any, Dict, List, Literal
 
 from clerk.base import BaseClerk
+from clerk.models.document import Document, UploadDocumentRequest
 from .models.file import ParsedFile, UploadFile
 
 
 class Clerk(BaseClerk):
+
+    def upload_document(self, request: UploadDocumentRequest) -> Document:
+        endpoint = "/document"
+        res = self.post_request(
+            endpoint=endpoint, data=request.data, files=request.files_
+        )
+        return Document(**res.data[0])
+
+    def update_document_structured_data(
+        self, document_id: str, updated_structured_data: Dict[str, Any]
+    ) -> Document:
+        endpoint = f"/document/{document_id}"
+        payload = dict(structured_data=updated_structured_data)
+        res = self.put_request(endpoint, json=payload)
+
+        return Document(**res.data[0])
+
     def get_document(self, document_id: str) -> Document:
         endpoint = f"/document/{document_id}"
         res = self.get_request(endpoint=endpoint)

clerk/decorator/__init__.py

@@ -1 +1,3 @@
 from .task_decorator import clerk_code
+
+__all__ = ["clerk_code"]

clerk/decorator/models.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 from pydantic import BaseModel
 
 
@@ -16,5 +16,5 @@ class Document(BaseModel):
 
 class ClerkCodePayload(BaseModel):
     document: Document
-    structured_data: Dict
+    structured_data: Dict[str, Any]
     run_id: Optional[str] = None

clerk/decorator/task_decorator.py

@@ -13,17 +13,19 @@ output_pkl: str = "/app/data/output/output.pkl"
 def clerk_code():
     def decorator(func: Callable[[ClerkCodePayload], ClerkCodePayload]):
         @wraps(func)
-        def wrapper(payload: Optional[ClerkCodePayload] = None) -> ClerkCodePayload:
+        def wrapper(
+            payload: Optional[ClerkCodePayload] = None,
+        ) -> ClerkCodePayload | None:
             # 1. Load payload from file if not provided
             use_pickle = False
-            output = None
+            output: ClerkCodePayload | BaseException | None = None
             error_occurred = False
             error_info = None
             if payload is None:
                 use_pickle = True
-                # Write a placeholder output file in case of early failure                
+                # Write a placeholder output file in case of early failure
                 with open(output_pkl, "wb") as f:
-                    pickle.dump({"error": "Early failure"}, f)                
+                    pickle.dump({"error": "Early failure"}, f)
                 try:
                     with open(input_pkl, "rb") as f:
                         raw_data = pickle.load(f)
@@ -40,11 +42,13 @@ def clerk_code():
                         traceback=traceback.format_exc(),
                     )
 
+            assert payload is not None
+
             # 2. Execute function
             if not error_occurred:
                 try:
                     output = func(payload)
-                    if not isinstance(output, ClerkCodePayload):
+                    if not isinstance(output, ClerkCodePayload):  # type: ignore
                         raise TypeError(
                             "Function must return a ClerkCodePayload instance."
                         )
@@ -55,10 +59,11 @@ def clerk_code():
                         message=str(e),
                         traceback=traceback.format_exc(),
                     )
+                    output = error_info
 
             # 3. write to output.pkl
             try:
-                if use_pickle:
+                if use_pickle and output is not None:
                     with open(output_pkl, "wb") as f:
                         if error_occurred:
                             pickle.dump(error_info, f)
@@ -66,6 +71,7 @@ def clerk_code():
                             pickle.dump(output, f)
                         else:
                             pickle.dump(output.model_dump(mode="json"), f)
+
             except Exception as e:
                 # If writing output.pkl fails, try to write a minimal error
                 try:

clerk/exceptions/exceptions.py

@@ -1,10 +1,10 @@
-from typing import Optional
+from typing import Any, Optional
 
 
 class AppBaseException(Exception):
     def __init__(
         self,
-        *args,
+        *args: Any,
         type_: Optional[str] = None,
         message: Optional[str] = None,
         traceback: Optional[str] = None,
@@ -23,17 +23,17 @@ class AppBaseException(Exception):
         self.traceback = traceback
 
     # (Optional) make pickling round-trip the extra fields explicitly
-    def __reduce__(self):
+    def __reduce__(self):  # type: ignore
         # Reconstruct with message-only (what Exception expects) and restore extras via state
         return (
             self.__class__,
             (self.message,),
             {"type": self.type, "traceback": self.traceback},
-        )
+        )  # type: ignore
 
-    def __setstate__(self, state):
-        for k, v in state.items():
-            setattr(self, k, v)
+    def __setstate__(self, state):  # type: ignore
+        for k, v in state.items():  # type: ignore
+            setattr(self, k, v)  # type: ignore
 
 
 class ApplicationException(AppBaseException):

clerk/gui_automation/action_model/model.py

@@ -1,7 +1,7 @@
 import base64
 import os
 from typing import List, Literal, Optional, Union
-from pydantic import BaseModel, Field, validator
+from pydantic import BaseModel
 
 CoordsType = Union[List[float], List[int]]
 

clerk/gui_automation/client.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional, Type
 
 from pydantic import BaseModel
 from clerk.base import BaseClerk
@@ -16,7 +16,7 @@ from clerk.models.ui_operator import UiOperatorTask
 
 class RPAClerk(BaseClerk):
 
-    root_endpoint: str = "/gui_automation"
+    root_endpoint = "/gui_automation"
 
     def allocate_remote_device(self, group_name: str, run_id: str):
         endpoint = "/remote_device/allocate"
@@ -24,7 +24,7 @@ class RPAClerk(BaseClerk):
             endpoint=endpoint, json={"group_name": group_name, "run_id": run_id}
         )
 
-        if res.data[0] is None:
+        if res.data[0] is None:  # type: ignore
             raise NoClientsAvailable()
 
         return RemoteDevice(**res.data[0])
@@ -40,14 +40,14 @@ class RPAClerk(BaseClerk):
             json={"id": remote_device.id, "name": remote_device.name, "run_id": run_id},
         )
 
-    def get_coordinates(self, payload: Dict) -> Coords:
+    def get_coordinates(self, payload: Dict[str, Any]) -> Coords:
         endpoint = "/action_model/get_coordinates"
         res = self.post_request(endpoint=endpoint, json=payload)
-        if res.data[0] is None:
+        if res.data[0] is None:  # type: ignore
             raise RuntimeError("No coordinates found in the response.")
         return Coords(**res.data[0])
 
-    def create_ui_operator_task(self, payload: Dict) -> UiOperatorTask:
+    def create_ui_operator_task(self, payload: Dict[str, Any]) -> UiOperatorTask:
         endpoint = "/ui_operator"
         res = self.post_request(endpoint=endpoint, json=payload)
         return UiOperatorTask(**res.data[0])
@@ -59,7 +59,7 @@ class RPAClerk(BaseClerk):
 
 
 class GUIVisionClerk(BaseClerk):
-    root_endpoint: str = "/gui_automation/vision"
+    root_endpoint = "/gui_automation/vision"
 
     def find_target(self, screen_b64: str, use_ocr: bool, target_prompt: str):
         endpoint = "/find_target"
@@ -89,8 +89,12 @@ class GUIVisionClerk(BaseClerk):
         return BaseState(**res.data[0])
 
     def answer(
-        self, screen_b64: str, use_ocr: bool, question: str, output_model: BaseModel
-    ) -> Dict:
+        self,
+        screen_b64: str,
+        use_ocr: bool,
+        question: str,
+        output_model: Type[BaseModel],
+    ) -> BaseModel:
         endpoint = "/answer"
         res = self.post_request(
             endpoint=endpoint,
@@ -102,7 +106,7 @@ class GUIVisionClerk(BaseClerk):
             },
         )
 
-        return output_model(**res.data[0])
+        return output_model.model_validate(**res.data[0])
 
     def classify_state(
         self, screen_b64: str, use_ocr: bool, possible_states: List[Dict[str, str]]
@@ -136,12 +140,12 @@ class GUIVisionClerk(BaseClerk):
 
 
 class CourseCorrectorClerk(BaseClerk):
-    root_endpoint: str = "/gui_automation/course_corrector"
+    root_endpoint = "/gui_automation/course_correction"
 
     def get_corrective_actions(
         self,
         screen_b64: str,
-        use_ocr: str,
+        use_ocr: bool,
         goal: str,
         custom_instructions: Optional[str] = None,
     ) -> ActionString:

clerk/gui_automation/client_actor/client_actor.py

@@ -21,7 +21,7 @@ from .model import PerformActionResponse, ActionStates
 from .exception import PerformActionException, GetScreenError
 
 
-async def _perform_action_ws(payload: Dict) -> PerformActionResponse:
+async def _perform_action_ws(payload: Dict[str, Any]) -> PerformActionResponse:
     """Perform an action over a WebSocket connection.
 
     Args:
@@ -65,7 +65,7 @@ async def _get_screen_async() -> str:
         This function sends a request to perform a screenshot action over a WebSocket connection
         and returns the base64 encoded image of the screen captured.
     """
-    payload = {
+    payload: Dict[str, Any] = {
         "proc_inst_id": os.getenv("_run_id"),
         "client_name": os.getenv("REMOTE_DEVICE_NAME"),
         "headless": True,
@@ -131,7 +131,7 @@ async def _perform_action_async(
     Raises:
         PerformActionException: If the action fails with an error message.
     """
-    req_payload: Dict = {
+    req_payload: Dict[str, Any] = {
         "proc_inst_id": os.getenv("_run_id"),
         "client_name": os.getenv("REMOTE_DEVICE_NAME"),
         "headless": (

clerk/gui_automation/client_actor/model.py

@@ -1,20 +1,22 @@
-from typing import Any, List, Literal, Optional, Union
+from typing import Any, List, Literal, Optional, TypeAlias, Union
 from pydantic import BaseModel, Field
 from enum import Enum
 
+from clerk.gui_automation.ui_actions.base import ActionTypes
 
-ActionTypes = Literal[
-    "left_click",
-    "right_click",
-    "middle_click",
-    "double_click",
-    "send_keys",
-    "press_keys",
-    "hot_keys",
-    "paste_text",
-    "get_text",
-    "scroll",
-]
+
+# ActionTypes = Literal[
+#     "left_click",
+#     "right_click",
+#     "middle_click",
+#     "double_click",
+#     "send_keys",
+#     "press_keys",
+#     "hot_keys",
+#     "paste_text",
+#     "get_text",
+#     "scroll",
+# ]
 
 
 class ActionStates(Enum):
@@ -77,6 +79,7 @@ class WindowExecutePayload(BaseModel):
         "close_window",
         "activate_window",
     ]
+
     window_name: str
     timeout: int = Field(default=10)
 

clerk/gui_automation/decorators/gui_automation.py

@@ -79,7 +79,7 @@ def gui_automation(
       • Passes control to the wrapped function,
       • Cleans everything up afterwards.
     """
-    group_name: str = os.getenv("REMOTE_DEVICE_GROUP")
+    group_name: str | None = os.getenv("REMOTE_DEVICE_GROUP")
     if not group_name:
         raise ValueError("REMOTE_DEVICE_GROUP environmental variable is required.")
 

clerk/gui_automation/ui_actions/actions.py

@@ -45,7 +45,7 @@ class File(BaseModel):
 
     @field_validator("content", mode="before")
     @classmethod
-    def convert_to_bytes(cls, v) -> bytes:
+    def convert_to_bytes(cls, v: str | bytes) -> bytes:
         if isinstance(v, str):
             from base64 import b64decode
 
@@ -75,7 +75,7 @@ class LeftClick(BaseAction):
         LeftClick(target="Suche").above("Kalender").do()
     """
 
-    action_type: Literal["left_click"] = "left_click"
+    action_type = "left_click"
 
     @backoff.on_exception(
         backoff.expo,
@@ -100,7 +100,7 @@ class LeftClick(BaseAction):
 
     @property
     def actionable_string(self):
-        return f"LeftClick(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchor}', relation='{self.relation}').do()"
+        return f"LeftClick(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchors}').do()"
 
 
 class RightClick(BaseAction):
@@ -118,7 +118,7 @@ class RightClick(BaseAction):
         RightClick(target="Suche").above("Kalender").do()
     """
 
-    action_type: Literal["right_click"] = "right_click"
+    action_type = "right_click"
 
     @backoff.on_exception(
         backoff.expo,
@@ -143,7 +143,7 @@ class RightClick(BaseAction):
 
     @property
     def actionable_string(self):
-        return f"RightClick(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchor}', relation='{self.relation}').do()"
+        return f"RightClick(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchors}').do()"
 
 
 class MiddleClickAction(BaseAction):
@@ -161,7 +161,7 @@ class MiddleClickAction(BaseAction):
         MiddleClickAction(target="Suche").above("Kalender").do()
     """
 
-    action_type: Literal["middle_click"] = "middle_click"
+    action_type = "middle_click"
 
     @backoff.on_exception(
         backoff.expo,
@@ -186,7 +186,7 @@ class MiddleClickAction(BaseAction):
 
     @property
     def actionable_string(self):
-        return f"MiddleClickAction(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchor}', relation='{self.relation}').do()"
+        return f"MiddleClickAction(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchors}').do()"
 
 
 class DoubleClick(BaseAction):
@@ -204,7 +204,7 @@ class DoubleClick(BaseAction):
         DoubleClick(target="Suche").above("Kalender").do()
     """
 
-    action_type: Literal["double_click"] = "double_click"
+    action_type = "double_click"
 
     @backoff.on_exception(
         backoff.expo,
@@ -229,7 +229,7 @@ class DoubleClick(BaseAction):
 
     @property
     def actionable_string(self):
-        return f"DoubleClick(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchor}', relation='{self.relation}').do()"
+        return f"DoubleClick(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchors}').do()"
 
 
 class Scroll(BaseAction):
@@ -249,7 +249,7 @@ class Scroll(BaseAction):
         DoubleClick(target="Suche").above("Kalender").do()
     """
 
-    action_type: Literal["scroll"] = "scroll"
+    action_type = "scroll"
     clicks: int
     click_coords: List[int] = Field(default=[])
 
@@ -333,7 +333,7 @@ class SendKeys(BaseAction):
 
     @property
     def actionable_string(self):
-        return f"SendKeys(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchor}', relation='{self.relation}', keys='{self.keys}').do()"
+        return f"SendKeys(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchors}', keys='{self.keys}').do()"
 
 
 class PressKeys(BaseAction):
@@ -353,7 +353,7 @@ class PressKeys(BaseAction):
         PressKeys(keys='ctrl+shift+esc').do()
     """
 
-    action_type: ActionTypes = "press_keys"
+    action_type = "press_keys"
     keys: str
 
     def do(self):
@@ -366,7 +366,7 @@ class PressKeys(BaseAction):
 
     @property
     def actionable_string(self):
-        return f"PressKeys(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchor}', relation='{self.relation}', keys='{self.keys}').do()"
+        return f"PressKeys(action_type='{self.action_type}', target='{self.target}', anchor='{self.anchors}', keys='{self.keys}').do()"
 
 
 class WaitFor(BaseAction):
@@ -385,7 +385,7 @@ class WaitFor(BaseAction):
         WaitFor("element").do(timeout=60)
     """
 
-    action_type: Literal["wait_for"] = "wait_for"
+    action_type = "wait_for"
     retry_timeout: float = 0.5
     is_awaited: bool = True
 
@@ -450,7 +450,7 @@ class OpenApplication(BaseAction):
         OpenApplication(app_path="/path/to/application.exe", app_window_name="Application Window").do()
     """
 
-    action_type: Literal["open_app"] = "open_app"
+    action_type = "open_app"
     app_path: str = Field(description="Absolute path of the application")
     app_window_name: str = Field(
         description="Name of the application window once open. Wildcard logic enabled."
@@ -479,7 +479,7 @@ class ForceCloseApplication(BaseAction):
             Executes the action to force close the application by creating and performing an ApplicationExecutePayload with the specified process name.
     """
 
-    action_type: Literal["force_close_app"] = "force_close_app"
+    action_type = "force_close_app"
     process_name: str = Field(
         description="Process name from task manager. Example: process.exe"
     )
@@ -509,7 +509,7 @@ class SaveFiles(BaseAction):
         SaveFiles(save_location="/path/to/", files=["/path/to/file_1", "/path/to/file_2"]).do()
     """
 
-    action_type: ActionTypes = "save_files"
+    action_type = "save_files"
     save_location: str
     files: Union[List[str], List[FileDetails]]
 
@@ -580,7 +580,7 @@ class GetFile(BaseAction):
         GetFile(file_location="/path/to/file_1").do()
     """
 
-    action_type: Literal["get_file"] = "get_file"
+    action_type = "get_file"
     file_location: str
 
     def do(self) -> File:
@@ -605,7 +605,7 @@ class MaximizeWindow(BaseAction):
         MaximizeWindow(window_name="MyWindow").do()
     """
 
-    action_type: Literal["maximize_window"] = "maximize_window"
+    action_type = "maximize_window"
     window_name: str
 
     def do(self, timeout: int = 10):
@@ -630,7 +630,7 @@ class MinimizeWindow(BaseAction):
         MinimizeWindow(window_name="MyWindow").do()
     """
 
-    action_type: Literal["minimize_window"] = "minimize_window"
+    action_type = "minimize_window"
     window_name: str
 
     def do(self, timeout: int = 10):
@@ -655,7 +655,7 @@ class CloseWindow(BaseAction):
         CloseWindow(window_name="MyWindow").do()
     """
 
-    action_type: Literal["close_window"] = "close_window"
+    action_type = "close_window"
     window_name: str
 
     def do(self, timeout: int = 10):
@@ -680,7 +680,7 @@ class ActivateWindow(BaseAction):
         ActivateWindow(window_name="MyWindow").do()
     """
 
-    action_type: Literal["activate_window"] = "activate_window"
+    action_type = "activate_window"
     window_name: str
 
     def do(self, timeout: int = 10):
@@ -709,7 +709,7 @@ class GetText(BaseAction):
 
     """
 
-    action_type: Literal["get_text"] = "get_text"
+    action_type = "get_text"
 
     @backoff.on_exception(
         backoff.expo,
@@ -752,7 +752,7 @@ class PasteText(BaseAction):
 
     """
 
-    action_type: Literal["paste_text"] = "paste_text"
+    action_type = "paste_text"
     keys: Union[str, List[str]]
     followed_by: Optional[str] = Field(default=None)
 

clerk/gui_automation/ui_actions/base.py

@@ -1,4 +1,4 @@
-from typing import Literal, Self, Union, List, Optional
+from typing import Literal, Self, TypeAlias, Union, List, Optional
 from pydantic import BaseModel, Field, model_validator
 from ..client_actor import get_screen
 from ..exceptions.modality.exc import TargetModalityError
@@ -24,12 +24,13 @@ def to_full_img_path(img: Union[str, ImageB64]) -> str:
     return os.path.join(TARGET_IMAGES_PATH, img)
 
 
-ActionTypes = Literal[
+ActionTypes: TypeAlias = Literal[
     "left_click",
     "right_click",
     "middle_click",
     "double_click",
     "send_keys",
+    "hot_keys",
     "press_keys",
     "wait_for",
     "open_app",
@@ -130,6 +131,8 @@ class BaseAction(BaseModel):
         return [xcenter, ycenter]
 
     def _prepare_payload(self):
+        if not self.target:
+            raise ValueError("target cannot be None.")
         payload: Screenshot = Screenshot(
             screen_b64=ImageB64(value=get_screen()),
             target=self.target,

clerk/gui_automation/ui_state_inspector/gui_vision.py

@@ -115,7 +115,7 @@ class Vision(BaseModel):
             The current state of the GUI (BaseState or a subclass of BaseState)
         """
         screen_b64 = get_screen()
-        state = self.verify_state(
+        state = self.clerk_client.verify_state(
             screen_b64,
             self.use_ocr,
             possible_states,
@@ -160,7 +160,7 @@ class Vision(BaseModel):
             screen_b64, self.use_ocr, possible_states
         )
         # if output_model is provided, return the model, otherwise return the id and description of the default model
-        if output_model is not None:
+        if output_model is not None:  # type: ignore
             return state
         assert isinstance(state, BaseState)
         return state.id, state.description

clerk/gui_automation/ui_state_inspector/models.py

@@ -1,5 +1,5 @@
-from pydantic import BaseModel, field_validator, model_validator
-from typing import List, Dict, Optional
+from pydantic import BaseModel, field_validator
+from typing import Any, List, Dict, Optional
 
 
 class BaseState(BaseModel):
@@ -21,7 +21,7 @@ class BaseState(BaseModel):
 
     id: str
     description: str
-    screenshots: List = []
+    screenshots: List[Dict[str, str]] = []
 
     def add_screenshot(self, bucket_name: str, file_name: str):
         self.screenshots.append({"bucket_name": bucket_name, "file_name": file_name})
@@ -137,7 +137,7 @@ class TargetWithAnchor(BaseModel):
 
     @field_validator("target", mode="before")
     @classmethod
-    def retain_one_word(cls, v):
+    def retain_one_word(cls, v: str):
         return v.split(" ")[-1]
 
 
@@ -174,7 +174,7 @@ class ActionString(BaseModel):
 
     @field_validator("action_string", mode="before")
     @classmethod
-    def ensure_format(cls, v):
+    def ensure_format(cls, v: Any):
         if not isinstance(v, str):
             raise ValueError("Action string must be a string")
         if not v.startswith("LeftClick") and not v.startswith("NoAction"):

clerk/gui_automation/ui_state_machine/models.py

@@ -1,5 +1,5 @@
-from typing import Optional
-from pydantic import BaseModel, field_validator, model_validator
+from typing import Any, Optional
+from pydantic import BaseModel, field_validator
 
 
 class ActionString(BaseModel):
@@ -24,7 +24,7 @@ class ActionString(BaseModel):
 
     @field_validator("action_string", mode="before")
     @classmethod
-    def ensure_format(cls, v):
+    def ensure_format(cls, v: Any):
         if not isinstance(v, str):
             raise ValueError("Action string must be a string")
         if not v.endswith(".do()") and not v.startswith("NoAction"):
@@ -32,7 +32,7 @@ class ActionString(BaseModel):
         return v
 
     @field_validator("interrupt_process", mode="before")
-    def convert_to_bool(cls, v):
+    def convert_to_bool(cls, v: str | bool | None):
         if v is None:
             return False
         elif isinstance(v, str):

clerk/models/document.py

@@ -1,8 +1,11 @@
-import datetime
-from typing import Dict, Optional
+from datetime import datetime
+import mimetypes
+import os
+from typing import Any, Dict, List, Optional
 from pydantic import BaseModel
 
 from clerk.models.document_statuses import DocumentStatuses
+from clerk.models.file import ParsedFile
 
 
 class Document(BaseModel):
@@ -14,7 +17,65 @@ class Document(BaseModel):
     message_subject: Optional[str] = None
     message_content: Optional[str] = None
     message_html: Optional[str] = None
-    structured_data: Optional[Dict] = None
+    structured_data: Optional[Dict[str, Any]] = None
     status: DocumentStatuses
     created_at: datetime
     updated_at: datetime
+
+
+class UploadDocumentRequest(BaseModel):
+    project_id: str
+    message_subject: Optional[str] = None
+    message_content: Optional[str] = None
+    files: List[str | ParsedFile] = []
+
+    def _define_files(self):
+        formatted_files: List[
+            tuple[
+                str,
+                tuple[
+                    str,
+                    bytes,
+                    str | None,
+                ],
+            ]
+        ] = []
+
+        for file in self.files:
+            if isinstance(file, str):
+                if os.path.exists(file):
+                    tmp = (
+                        "files",
+                        (
+                            os.path.basename(file).replace(" ", "_"),
+                            open(file, "rb").read(),
+                            mimetypes.guess_type(file)[0],
+                        ),
+                    )
+
+                else:
+                    raise FileExistsError(file)
+            else:
+                tmp = (
+                    "files",
+                    (
+                        file.name,
+                        file.decoded_content,
+                        file.mimetype,
+                    ),
+                )
+            formatted_files.append(tmp)
+
+        return formatted_files
+
+    @property
+    def data(self) -> Dict[str, Any]:
+        return dict(
+            project_id=self.project_id,
+            message_subject=self.message_subject,
+            mesasge_content=self.message_content,
+        )
+
+    @property
+    def files_(self):
+        return self._define_files()

clerk/models/file.py

@@ -18,8 +18,10 @@ class ParsedFile(BaseModel):
 
 class UploadFile(BaseModel):
     name: str
-    mimetype: str
+    mimetype: str | None
     content: bytes
 
-    def to_multipart_format(self, key: str = "files") -> Tuple:
+    def to_multipart_format(
+        self, key: str = "files"
+    ) -> Tuple[str, Tuple[str, bytes, str | None]]:
         return (key, (self.name, self.content, self.mimetype))

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

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

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

@@ -1,53 +1,53 @@
 clerk/__init__.py,sha256=LWpbImG7352mUJYC1tRm_zsn5rnt4sFl5ldoq5f0dlo,26
-clerk/base.py,sha256=QpneNQlMms_uUOIMnQ_8KMz8U2hhu7rhUz5xWfa9CCs,2829
-clerk/client.py,sha256=TAtn0jwzzfc1WGhiZBFpGRQoNBaLHIMspXmyOdM-abI,973
-clerk/decorator/__init__.py,sha256=4VCGOFNq7pA7iJS410V_R9eWfjxP7mwxwa4thwaUTf8,39
-clerk/decorator/models.py,sha256=JWFOJuUh3F40iOL0aoNgUC9GRHU3Fcq3GOjSXA7Gwng,394
-clerk/decorator/task_decorator.py,sha256=RarLfGR0uDtIBWlaPSIvGhIi2gmHPa4_825RBAL3DgI,3610
+clerk/base.py,sha256=S1RKc2pBw2FPlVjefJzsNtyTDPB0UG46C2K_QVV1opA,4008
+clerk/client.py,sha256=cgDOO9fRfJAoV5_r6PCoPWoAY0OwoeEMT3cEkzUSZOI,1612
+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
 clerk/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/exceptions/exceptions.py,sha256=aIrmID62HoQo0pLErfX9NR2nopTyf53BpOu4gtqAy-A,1201
+clerk/exceptions/exceptions.py,sha256=gSCma06b6W6c0NrA2rhzd5YjFhZGa6caShX07lo-_3E,1291
 clerk/exceptions/remote_device.py,sha256=R0Vfmk8ejibEFeV29A8Vqst2YA6yxdqEX9lP5wWubgM,134
 clerk/gui_automation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/gui_automation/client.py,sha256=LqrUQtC-4pjUJYDDn_s3t073K066j_p0vf4kXLChBc0,4891
+clerk/gui_automation/client.py,sha256=zxZ2QgxXvOEenXz2LpZv9vySJRbVnqY5f1lYr4bTQ9E,5000
 clerk/gui_automation/action_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/gui_automation/action_model/model.py,sha256=sbTySgOq4Xv_r2p7q_ji1bGCHgRS1HXC9Z39thwCQ9c,3829
+clerk/gui_automation/action_model/model.py,sha256=yzaCyEMOH3YMkPBf6IwUMuu69-xyf78HzmthiewgWQY,3811
 clerk/gui_automation/action_model/utils.py,sha256=xzFxgN-bTK6HKGS7J-esQZ-ePj_yG72T-2ZVhcWvKjw,798
 clerk/gui_automation/client_actor/__init__.py,sha256=SVuL6-oo1Xc0oJkjMKrO6mJwpPGjrCLKhDV6r2Abtf8,66
-clerk/gui_automation/client_actor/client_actor.py,sha256=YVYBgDQ89NkgdlWSk_AvDtEO_BJe5YIHU5OJK4cUs28,5081
+clerk/gui_automation/client_actor/client_actor.py,sha256=RT5WnvrM37pLpoDd_WZg8sSjBuugqMW_eDLTEkL7kWc,5117
 clerk/gui_automation/client_actor/exception.py,sha256=zdnImHZ88yf52Xq3aMHivEU3aJg-r2c-r8x8XZnI3ic,407
-clerk/gui_automation/client_actor/model.py,sha256=wVpFCi1w2kh4kAV8oNx489vf_SLUQnqhc02rFD5NIJA,6335
+clerk/gui_automation/client_actor/model.py,sha256=B6tYQB0ngY3oM6pWIoJLTi_H9U-hTgQqal7b7rSWkd8,6433
 clerk/gui_automation/decorators/__init__.py,sha256=OCgXStEumscgT-RyVy5OKS7ml1w9y-lEnjCVnxuRnQs,43
-clerk/gui_automation/decorators/gui_automation.py,sha256=7p3xU2biyHN43hgEAGj34QJjHF2SeBDM6FRCx_eqewM,5350
+clerk/gui_automation/decorators/gui_automation.py,sha256=jqzN_iqIq2KvjUU-JoYnUSOf-mst31EKCk8zdMFzGQM,5357
 clerk/gui_automation/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/exceptions/agent_manager.py,sha256=KFWFWQ7X_8Z9XG__SMzb1jKI3yNoVTPJAXzW5O-fSXc,101
 clerk/gui_automation/exceptions/websocket.py,sha256=-MdwSwlf1hbnu55aDgk3L1znkTZ6xJS6po5VpEGD9ck,117
 clerk/gui_automation/exceptions/modality/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/exceptions/modality/exc.py,sha256=P-dMuCTyVZYD3pbGpCf_1SYEgaETn13c51pmfbsXr5k,1436
 clerk/gui_automation/ui_actions/__init__.py,sha256=-EDQ5375HXrvG3sfFY7zOPC405YcBL6xXRACm2p-YyI,23
-clerk/gui_automation/ui_actions/actions.py,sha256=hhxl5VMDNSXdqm2L0tZqs6IhJHVXtlSVSdwsiz2BbDI,27449
-clerk/gui_automation/ui_actions/base.py,sha256=4CjOkMZNLt8W0tLO91tOkz8CCea0m2IRBIOpWNMOZUA,7230
+clerk/gui_automation/ui_actions/actions.py,sha256=qFustr0Wr81Bq6tS9sPqqFMC5zwG5-XmjKy1kFwjSKc,26914
+clerk/gui_automation/ui_actions/base.py,sha256=ymYWZnleywyI2DeaAb_HuDxgoSgfgw0zjXyQGp4Nvqo,7351
 clerk/gui_automation/ui_actions/support.py,sha256=Ulb8DBfwnrBMaYoMLDgldEy9V--NDUSdhIYXpuODZoU,5772
 clerk/gui_automation/ui_state_inspector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/gui_automation/ui_state_inspector/gui_vision.py,sha256=lRnF3IMLViOB-UE447A4kc8BO7NKqqLV1NZKRswRKWg,7707
-clerk/gui_automation/ui_state_inspector/models.py,sha256=uuzYhE9is4Z-TmsVMA1mwf0mQGs_PDLqdSZKbe8dHSs,5691
+clerk/gui_automation/ui_state_inspector/gui_vision.py,sha256=Pk5nuFZnp_zNbqSOtndSmgqb6PLeADJfnC-eRIJMDZk,7736
+clerk/gui_automation/ui_state_inspector/models.py,sha256=ieri9ht2X694V5snYShj_9LHX8AtdCzSw5mCsCSLbj0,5705
 clerk/gui_automation/ui_state_machine/__init__.py,sha256=bTPZsPJkDLCwP2mdtBj4fU7C7ekOh0b-VPRKFEV3bPo,301
 clerk/gui_automation/ui_state_machine/ai_recovery.py,sha256=3_Gu_RPxta4eXmXWH3WA31c15sJL-dk1m1H2bOFV7so,3772
 clerk/gui_automation/ui_state_machine/decorators.py,sha256=gBOpIusjsXlA7FEiszDCFKTS6vXx3LBNMz_SQJNkMWg,2134
 clerk/gui_automation/ui_state_machine/exceptions.py,sha256=9KWg20dnCssMdMu632E0nP5vkndgYNI4cDCDW-vMkQA,1436
-clerk/gui_automation/ui_state_machine/models.py,sha256=1fpNYPsff0dyLg1wNJl-xQyMYvy4cSDy4OLxa0ej-0U,1395
+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=Bbt3YSvGcOrJJjJBYjbDGXpZIaQAYdq_-uIr2urwy5s,525
+clerk/models/document.py,sha256=m9ccAQdy1G-ZgUT-a44TMgIVAp4he-90uYjVPqwgO98,2193
 clerk/models/document_statuses.py,sha256=ytTQhgACs2m22qz51_7Ti0IxzbVyl-fl7uF7CnDEyLA,279
-clerk/models/file.py,sha256=BSLzcsLugG_F_VxN_OFcKtG20JkZyoGMv_1CAwdNkDM,676
+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
 clerk/models/ui_operator.py,sha256=mKTJUFZgv7PeEt5oys28HVZxHOJsofmRQOcRpqj0dbU,293
 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.3.7.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.3.7.dist-info/METADATA,sha256=TncEzZuTZ1MufOOlqTAt-B-trTwlZ9BB-ieZvgC2-Go,3508
-clerk_sdk-0.3.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.3.7.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.3.7.dist-info/RECORD,,
+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,,