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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docu-devs-api-client
-Version: 1.9.2
+Version: 1.10.1
 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.9.2 → docu_devs_api_client-1.10.1}/cli.py

@@ -1064,6 +1064,74 @@ async def operations_error_analysis(
         _echo_response(response)
 
 
+@operations.command("pdf-acroform")
+@click.argument("job_guid")
+@click.option("--llm-type", default="DEFAULT", type=click.Choice(["DEFAULT", "MINI", "HIGH"]), help="LLM type for visual field detection")
+@click.option("--ocr", default="PREMIUM", type=click.Choice(["PREMIUM", "DEFAULT", "AUTO"]), help="OCR mode used when page images are missing")
+@click.option("--page", "pages", multiple=True, type=int, help="1-based page number to inspect")
+@click.option("--min-confidence", type=float, help="Minimum accepted field detection confidence")
+@click.option("--max-fields-per-page", type=int, help="Maximum generated fields per page")
+@click.option("--force-ocr/--no-force-ocr", default=None, help="Force OCR image generation even if thumbnails exist")
+@click.option("--wait/--no-wait", default=True, help="Wait for completion")
+@click.option("--timeout", default=180, show_default=True, help="Wait timeout in seconds")
+@click.option("--poll-interval", default=5.0, show_default=True, help="Polling interval in seconds")
+@click.option("--output", type=click.Path(), help="Save the generated AcroForm PDF to this path")
+@click.pass_context
+@async_command
+async def operations_pdf_acroform(
+    ctx,
+    job_guid: str,
+    llm_type: str,
+    ocr: str,
+    pages: tuple[int, ...],
+    min_confidence: Optional[float],
+    max_fields_per_page: Optional[int],
+    force_ocr: Optional[bool],
+    wait: bool,
+    timeout: int,
+    poll_interval: float,
+    output: Optional[str],
+):
+    """Convert a completed PDF job into a fillable AcroForm PDF."""
+    if output and not wait:
+        raise click.BadParameter("--output requires --wait", param_hint="--output")
+
+    page_range = list(pages) or None
+    client: DocuDevsClient = ctx.obj["client"]
+    if wait:
+        result = await client.submit_and_wait_for_pdf_acroform_operation(
+            job_guid=job_guid,
+            llm_type=llm_type,
+            ocr=ocr,
+            page_range=page_range,
+            min_confidence=min_confidence,
+            max_fields_per_page=max_fields_per_page,
+            force_ocr=force_ocr,
+            timeout=timeout,
+            poll_interval=poll_interval,
+            save_to=output,
+        )
+        _echo_response(
+            {
+                "operationJobGuid": result.operation_job_guid,
+                "parentJobGuid": result.parent_job_guid,
+                "result": result.result,
+                "output": output,
+            }
+        )
+    else:
+        response = await client.submit_pdf_acroform_operation(
+            job_guid=job_guid,
+            llm_type=llm_type,
+            ocr=ocr,
+            page_range=page_range,
+            min_confidence=min_confidence,
+            max_fields_per_page=max_fields_per_page,
+            force_ocr=force_ocr,
+        )
+        _echo_response(response)
+
+
 @operations.command("generative-task")
 @click.argument("parent_job_id")
 @click.option("--prompt", required=True, help="Prompt for the generative task")

{docu_devs_api_client-1.9.2 → docu_devs_api_client-1.10.1}/docudevs/__init__.py

@@ -1,7 +1,15 @@
 """A client library for accessing DocuDevs API"""
 
 from .client import AuthenticatedClient, Client
-from .docudevs_client import DocuDevsClient, UploadDocumentBody, UploadCommand, File, UploadFilesBody, TemplateFillRequest
+from .docudevs_client import (
+    DocuDevsClient,
+    File,
+    TemplateFillRequest,
+    UploadCommand,
+    UploadDocumentBody,
+    UploadFilesBody,
+)
+from .pipeline import NodeRef, P, Pipeline, PipelinePath, and_, eq, exists, ne, not_, or_
 from .schema import array_schema, json_schema
 
 __all__ = (
@@ -13,6 +21,16 @@ __all__ = (
     "File",
     "UploadFilesBody",
     "TemplateFillRequest",
+    "P",
+    "NodeRef",
+    "Pipeline",
+    "PipelinePath",
+    "and_",
+    "eq",
+    "exists",
+    "ne",
+    "not_",
+    "or_",
     "array_schema",
     "json_schema",
 )

docu_devs_api_client-1.10.1/docudevs/api/document/extract_acro_form_metadata.py

@@ -0,0 +1,99 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.extract_acro_form_metadata_body import ExtractAcroFormMetadataBody
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ExtractAcroFormMetadataBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/document/acroform-metadata",
+    }
+
+    _kwargs["files"] = body.to_multipart()
+
+    _kwargs["headers"] = headers
+    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(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ExtractAcroFormMetadataBody,
+) -> Response[Any]:
+    """
+    Args:
+        body (ExtractAcroFormMetadataBody):
+
+    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(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ExtractAcroFormMetadataBody,
+) -> Response[Any]:
+    """
+    Args:
+        body (ExtractAcroFormMetadataBody):
+
+    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(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

docu_devs_api_client-1.10.1/docudevs/api/job/get_acro_form_metadata.py

@@ -0,0 +1,112 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    guid: str,
+    *,
+    batch_index: Union[None, Unset, int] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    json_batch_index: Union[None, Unset, int]
+    if isinstance(batch_index, Unset):
+        json_batch_index = UNSET
+    else:
+        json_batch_index = batch_index
+    params["batchIndex"] = json_batch_index
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/job/result/{guid}/acroform-metadata",
+        "params": params,
+    }
+
+    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],
+    batch_index: Union[None, Unset, int] = UNSET,
+) -> Response[Any]:
+    """
+    Args:
+        guid (str):
+        batch_index (Union[None, Unset, int]):
+
+    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,
+        batch_index=batch_index,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    guid: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    batch_index: Union[None, Unset, int] = UNSET,
+) -> Response[Any]:
+    """
+    Args:
+        guid (str):
+        batch_index (Union[None, Unset, int]):
+
+    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,
+        batch_index=batch_index,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

docu_devs_api_client-1.10.1/docudevs/api/job/get_pdf_acro_form_result.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",
+    }
+
+    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/docudevs/api/submission_portals/create_portal.py

@@ -0,0 +1,156 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_submission_portal_request import CreateSubmissionPortalRequest
+from ...models.submission_portal_response import SubmissionPortalResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: CreateSubmissionPortalRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/submission-portals",
+    }
+
+    _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[SubmissionPortalResponse]:
+    if response.status_code == 200:
+        response_200 = SubmissionPortalResponse.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[SubmissionPortalResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateSubmissionPortalRequest,
+) -> Response[SubmissionPortalResponse]:
+    """
+    Args:
+        body (CreateSubmissionPortalRequest):
+
+    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[SubmissionPortalResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateSubmissionPortalRequest,
+) -> Optional[SubmissionPortalResponse]:
+    """
+    Args:
+        body (CreateSubmissionPortalRequest):
+
+    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:
+        SubmissionPortalResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateSubmissionPortalRequest,
+) -> Response[SubmissionPortalResponse]:
+    """
+    Args:
+        body (CreateSubmissionPortalRequest):
+
+    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[SubmissionPortalResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateSubmissionPortalRequest,
+) -> Optional[SubmissionPortalResponse]:
+    """
+    Args:
+        body (CreateSubmissionPortalRequest):
+
+    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:
+        SubmissionPortalResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

docu_devs_api_client-1.10.1/docudevs/api/submission_portals/delete_portal.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(
+    id: int,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": f"/submission-portals/{id}",
+    }
+
+    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(
+    id: int,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """
+    Args:
+        id (int):
+
+    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(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Any]:
+    """
+    Args:
+        id (int):
+
+    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(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)