docu-devs-api-client 1.10.1__tar.gz → 1.10.2__tar.gz

{docu_devs_api_client-1.10.1 → docu_devs_api_client-1.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docu-devs-api-client
-Version: 1.10.1
+Version: 1.10.2
 Summary: A client library for accessing DocuDevs API
 Project-URL: Homepage, https://www.docudevs.ai/
 Project-URL: Repository, https://github.com/piizei/docudevs.git

docu_devs_api_client-1.10.2/docudevs/api/job/apply_pdf_acro_form_field_definitions.py

@@ -0,0 +1,169 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.pdf_acro_form_apply_request import PdfAcroFormApplyRequest
+from ...models.submit_operation_response import SubmitOperationResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    parent_guid: str,
+    *,
+    body: PdfAcroFormApplyRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": f"/job/{parent_guid}/pdf-acroform/apply",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[SubmitOperationResponse]:
+    if response.status_code == 200:
+        response_200 = SubmitOperationResponse.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[SubmitOperationResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    parent_guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: PdfAcroFormApplyRequest,
+) -> Response[SubmitOperationResponse]:
+    """
+    Args:
+        parent_guid (str):
+        body (PdfAcroFormApplyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[SubmitOperationResponse]
+    """
+
+    kwargs = _get_kwargs(
+        parent_guid=parent_guid,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    parent_guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: PdfAcroFormApplyRequest,
+) -> Optional[SubmitOperationResponse]:
+    """
+    Args:
+        parent_guid (str):
+        body (PdfAcroFormApplyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        SubmitOperationResponse
+    """
+
+    return sync_detailed(
+        parent_guid=parent_guid,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    parent_guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: PdfAcroFormApplyRequest,
+) -> Response[SubmitOperationResponse]:
+    """
+    Args:
+        parent_guid (str):
+        body (PdfAcroFormApplyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[SubmitOperationResponse]
+    """
+
+    kwargs = _get_kwargs(
+        parent_guid=parent_guid,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    parent_guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: PdfAcroFormApplyRequest,
+) -> Optional[SubmitOperationResponse]:
+    """
+    Args:
+        parent_guid (str):
+        body (PdfAcroFormApplyRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        SubmitOperationResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            parent_guid=parent_guid,
+            client=client,
+            body=body,
+        )
+    ).parsed

docu_devs_api_client-1.10.2/docudevs/api/job/get_pdf_acro_form_field_definitions.py

@@ -0,0 +1,92 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    guid: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/job/result/{guid}/pdf-acroform-field-definitions",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if response.status_code == 200:
+        return None
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """
+    Args:
+        guid (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        guid=guid,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """
+    Args:
+        guid (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        guid=guid,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

{docu_devs_api_client-1.10.1 → docu_devs_api_client-1.10.2}/docudevs/docudevs_client.py

@@ -2301,6 +2301,10 @@ class DocuDevsClient:
         min_confidence: Optional[float] = None,
         max_fields_per_page: Optional[int] = None,
         force_ocr: Optional[bool] = None,
+        use_commonforms: Optional[bool] = None,
+        commonforms_model: Optional[str] = None,
+        commonforms_fast: Optional[bool] = None,
+        commonforms_confidence: Optional[float] = None,
     ):
         """Submit a pdf-acroform operation for an existing PDF job."""
         if page_range is not None:
@@ -2309,6 +2313,8 @@ class DocuDevsClient:
             page_range = [int(page) for page in page_range]
         if min_confidence is not None and not 0 <= min_confidence <= 1:
             raise ValueError("min_confidence must be between 0 and 1")
+        if commonforms_confidence is not None and not 0 <= commonforms_confidence <= 1:
+            raise ValueError("commonforms_confidence must be between 0 and 1")
         if max_fields_per_page is not None and max_fields_per_page < 1:
             raise ValueError("max_fields_per_page must be >= 1")
 
@@ -2324,6 +2330,14 @@ class DocuDevsClient:
             custom_parameters["maxFieldsPerPage"] = max_fields_per_page
         if force_ocr is not None:
             custom_parameters["forceOcr"] = force_ocr
+        if use_commonforms is not None:
+            custom_parameters["useCommonForms"] = use_commonforms
+        if commonforms_model is not None:
+            custom_parameters["commonFormsModel"] = commonforms_model
+        if commonforms_fast is not None:
+            custom_parameters["commonFormsFast"] = commonforms_fast
+        if commonforms_confidence is not None:
+            custom_parameters["commonFormsConfidence"] = commonforms_confidence
 
         return await self.submit_operation_with_parameters(
             job_guid=job_guid,
@@ -2349,6 +2363,107 @@ class DocuDevsClient:
             )
         raise Exception(f"Error downloading pdf-acroform result: {response.status_code} - {response.text}")
 
+    async def get_pdf_acroform_field_definitions(
+        self, operation_job_guid: str
+    ) -> dict | None:
+        """Get normalized field definitions used to generate a pdf-acroform operation."""
+        response = await self._get_async_client().get(
+            f"/job/result/{quote(operation_job_guid, safe='')}/pdf-acroform-field-definitions"
+        )
+        if response.status_code == HTTPStatus.OK:
+            try:
+                return response.json()
+            except Exception:
+                try:
+                    import json
+
+                    return json.loads(response.text)
+                except Exception:
+                    return None
+        if response.status_code == HTTPStatus.NOT_FOUND:
+            return None
+        raise Exception(
+            f"Failed to get pdf-acroform field definitions: {response.status_code}"
+        )
+
+    async def submit_pdf_acroform_apply_operation(
+        self,
+        parent_job_guid: str,
+        *,
+        field_definitions: Sequence[Mapping[str, Any]],
+        source_operation_guid: Optional[str] = None,
+        min_confidence: Optional[float] = 0.0,
+        max_fields_per_page: Optional[int] = 300,
+    ):
+        """Submit edited field definitions to generate a new AcroForm PDF."""
+        if field_definitions is None:
+            raise ValueError("field_definitions is required")
+        normalized_definitions = [dict(field) for field in field_definitions]
+        if min_confidence is not None and not 0 <= min_confidence <= 1:
+            raise ValueError("min_confidence must be between 0 and 1")
+        if max_fields_per_page is not None and max_fields_per_page < 1:
+            raise ValueError("max_fields_per_page must be >= 1")
+
+        payload: dict[str, Any] = {"fieldDefinitions": normalized_definitions}
+        if source_operation_guid is not None:
+            payload["sourceOperationGuid"] = source_operation_guid
+        if min_confidence is not None:
+            payload["minConfidence"] = min_confidence
+        if max_fields_per_page is not None:
+            payload["maxFieldsPerPage"] = max_fields_per_page
+
+        response = await self._get_async_client().post(
+            f"/job/{quote(parent_job_guid, safe='')}/pdf-acroform/apply",
+            json=payload,
+        )
+        if response.status_code == HTTPStatus.OK:
+            return self._wrap_response(response)
+        raise Exception(
+            "Error submitting pdf-acroform apply operation: "
+            f"{response.status_code} - {response.text}"
+        )
+
+    async def submit_and_wait_for_pdf_acroform_apply_operation(
+        self,
+        parent_job_guid: str,
+        *,
+        field_definitions: Sequence[Mapping[str, Any]],
+        source_operation_guid: Optional[str] = None,
+        min_confidence: Optional[float] = 0.0,
+        max_fields_per_page: Optional[int] = 300,
+        timeout: int = 180,
+        poll_interval: float = 5.0,
+        save_to: str | None = None,
+    ) -> PdfAcroFormOperationResult:
+        """Submit edited field definitions, wait for completion, then download the PDF."""
+        operation_response = await self.submit_pdf_acroform_apply_operation(
+            parent_job_guid,
+            field_definitions=field_definitions,
+            source_operation_guid=source_operation_guid,
+            min_confidence=min_confidence,
+            max_fields_per_page=max_fields_per_page,
+        )
+        parsed = getattr(operation_response, "parsed", None)
+        operation_guid = getattr(operation_response, "job_guid", None)
+        if not operation_guid and isinstance(parsed, Mapping):
+            operation_guid = parsed.get("jobGuid") or parsed.get("job_guid")
+        if not operation_guid:
+            raise Exception("No operation job GUID returned from pdf-acroform apply operation")
+        result = await self._wait_for_operation_job_result(
+            operation_guid,
+            parent_job_guid=parent_job_guid,
+            operation_type="pdf-acroform-apply",
+            timeout=timeout,
+            poll_interval=poll_interval,
+        )
+        pdf = await self.get_pdf_acroform(operation_guid, save_to=save_to)
+        return PdfAcroFormOperationResult(
+            result=result,
+            pdf=pdf,
+            operation_job_guid=operation_guid,
+            parent_job_guid=parent_job_guid,
+        )
+
     async def submit_and_wait_for_pdf_acroform_operation(
         self,
         job_guid: str,
@@ -2359,6 +2474,10 @@ class DocuDevsClient:
         min_confidence: Optional[float] = None,
         max_fields_per_page: Optional[int] = None,
         force_ocr: Optional[bool] = None,
+        use_commonforms: Optional[bool] = None,
+        commonforms_model: Optional[str] = None,
+        commonforms_fast: Optional[bool] = None,
+        commonforms_confidence: Optional[float] = None,
         timeout: int = 180,
         poll_interval: float = 5.0,
         save_to: str | None = None,
@@ -2372,6 +2491,10 @@ class DocuDevsClient:
             min_confidence=min_confidence,
             max_fields_per_page=max_fields_per_page,
             force_ocr=force_ocr,
+            use_commonforms=use_commonforms,
+            commonforms_model=commonforms_model,
+            commonforms_fast=commonforms_fast,
+            commonforms_confidence=commonforms_confidence,
         )
         operation_guid = getattr(operation_response, "job_guid", None)
         if not operation_guid:

{docu_devs_api_client-1.10.1 → docu_devs_api_client-1.10.2}/docudevs/models/__init__.py

@@ -77,6 +77,7 @@ from .page_case_document import PageCaseDocument
 from .page_processing_job import PageProcessingJob
 from .pageable import Pageable
 from .pageable_mode import PageableMode
+from .pdf_acro_form_apply_request import PdfAcroFormApplyRequest
 from .pdf_field import PDFField
 from .pipeline_node_status_summary import PipelineNodeStatusSummary
 from .pipeline_ocr_status_summary import PipelineOcrStatusSummary
@@ -216,6 +217,7 @@ __all__ = (
     "PageableMode",
     "PageCaseDocument",
     "PageProcessingJob",
+    "PdfAcroFormApplyRequest",
     "PDFField",
     "PipelineNodeStatusSummary",
     "PipelineOcrStatusSummary",

docu_devs_api_client-1.10.2/docudevs/models/pdf_acro_form_apply_request.py

@@ -0,0 +1,121 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, Union, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="PdfAcroFormApplyRequest")
+
+
+@_attrs_define
+class PdfAcroFormApplyRequest:
+    """
+    Attributes:
+        field_definitions (list[Any]):
+        source_operation_guid (Union[None, Unset, str]):
+        min_confidence (Union[None, Unset, float]):
+        max_fields_per_page (Union[None, Unset, int]):
+    """
+
+    field_definitions: list[Any]
+    source_operation_guid: Union[None, Unset, str] = UNSET
+    min_confidence: Union[None, Unset, float] = UNSET
+    max_fields_per_page: Union[None, Unset, int] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        field_definitions = self.field_definitions
+
+        source_operation_guid: Union[None, Unset, str]
+        if isinstance(self.source_operation_guid, Unset):
+            source_operation_guid = UNSET
+        else:
+            source_operation_guid = self.source_operation_guid
+
+        min_confidence: Union[None, Unset, float]
+        if isinstance(self.min_confidence, Unset):
+            min_confidence = UNSET
+        else:
+            min_confidence = self.min_confidence
+
+        max_fields_per_page: Union[None, Unset, int]
+        if isinstance(self.max_fields_per_page, Unset):
+            max_fields_per_page = UNSET
+        else:
+            max_fields_per_page = self.max_fields_per_page
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "fieldDefinitions": field_definitions,
+            }
+        )
+        if source_operation_guid is not UNSET:
+            field_dict["sourceOperationGuid"] = source_operation_guid
+        if min_confidence is not UNSET:
+            field_dict["minConfidence"] = min_confidence
+        if max_fields_per_page is not UNSET:
+            field_dict["maxFieldsPerPage"] = max_fields_per_page
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        field_definitions = cast(list[Any], d.pop("fieldDefinitions"))
+
+        def _parse_source_operation_guid(data: object) -> Union[None, Unset, str]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, str], data)
+
+        source_operation_guid = _parse_source_operation_guid(d.pop("sourceOperationGuid", UNSET))
+
+        def _parse_min_confidence(data: object) -> Union[None, Unset, float]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, float], data)
+
+        min_confidence = _parse_min_confidence(d.pop("minConfidence", UNSET))
+
+        def _parse_max_fields_per_page(data: object) -> Union[None, Unset, int]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, int], data)
+
+        max_fields_per_page = _parse_max_fields_per_page(d.pop("maxFieldsPerPage", UNSET))
+
+        pdf_acro_form_apply_request = cls(
+            field_definitions=field_definitions,
+            source_operation_guid=source_operation_guid,
+            min_confidence=min_confidence,
+            max_fields_per_page=max_fields_per_page,
+        )
+
+        pdf_acro_form_apply_request.additional_properties = d
+        return pdf_acro_form_apply_request
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties