flatmark 1.0.0__py3-none-any.whl

flatmark/api/convert/submit_conversion_job.py

@@ -0,0 +1,284 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.body_submit_conversion_job import BodySubmitConversionJob
+from ...models.job_submit_response import JobSubmitResponse
+from ...models.problem import Problem
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: BodySubmitConversionJob,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/convert/jobs",
+    }
+
+    _kwargs["files"] = body.to_multipart()
+
+    headers["Content-Type"] = "multipart/form-data; boundary=+++"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> JobSubmitResponse | Problem | None:
+    if response.status_code == 200:
+        response_200 = JobSubmitResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = Problem.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 402:
+        response_402 = Problem.from_dict(response.json())
+
+        return response_402
+
+    if response.status_code == 413:
+        response_413 = Problem.from_dict(response.json())
+
+        return response_413
+
+    if response.status_code == 415:
+        response_415 = Problem.from_dict(response.json())
+
+        return response_415
+
+    if response.status_code == 422:
+        response_422 = Problem.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 429:
+        response_429 = Problem.from_dict(response.json())
+
+        return response_429
+
+    if response.status_code == 503:
+        response_503 = Problem.from_dict(response.json())
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[JobSubmitResponse | Problem]:
+    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: AuthenticatedClient,
+    body: BodySubmitConversionJob,
+) -> Response[JobSubmitResponse | Problem]:
+    """Queue a document for conversion with OCR and tables
+
+     Queues one document up to 25 MB and 200 pages for conversion with Docling.
+
+    Accepted types are the same as for `POST /v1/convert`. The queue runs OCR
+    (text recognition) and recognizes tables, headings and reading order. A
+    conversion may take up to about 2 minutes; longer ones are stopped and fail.
+
+    Poll `GET /v1/jobs/{id}` (free) until `status` is `succeeded` or `failed`,
+    then download the result from `result_url` (free). The result is Markdown, or
+    the DoclingDocument JSON with `?format=json`.
+
+    With `webhook_url`, the job's final state is POSTed there as JSON
+    (`job_id`, `status`, `result`, `error`). The request carries
+    `X-Appkit-Signature: sha256=<hex>`, an HMAC-SHA256 of the raw request body
+    keyed with the `webhook_secret` from this response. `webhook_secret` is shown
+    only once. A delivery that fails is retried, 3 attempts in total.
+
+    Requires an API key. The credits are charged at submission and refunded if
+    the job fails. The uploaded file is deleted when the job finishes. Results
+    are kept for 7 days after submission.
+
+    **Credits:** 10 per call.
+
+    Args:
+        body (BodySubmitConversionJob):
+
+    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[JobSubmitResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: BodySubmitConversionJob,
+) -> JobSubmitResponse | Problem | None:
+    """Queue a document for conversion with OCR and tables
+
+     Queues one document up to 25 MB and 200 pages for conversion with Docling.
+
+    Accepted types are the same as for `POST /v1/convert`. The queue runs OCR
+    (text recognition) and recognizes tables, headings and reading order. A
+    conversion may take up to about 2 minutes; longer ones are stopped and fail.
+
+    Poll `GET /v1/jobs/{id}` (free) until `status` is `succeeded` or `failed`,
+    then download the result from `result_url` (free). The result is Markdown, or
+    the DoclingDocument JSON with `?format=json`.
+
+    With `webhook_url`, the job's final state is POSTed there as JSON
+    (`job_id`, `status`, `result`, `error`). The request carries
+    `X-Appkit-Signature: sha256=<hex>`, an HMAC-SHA256 of the raw request body
+    keyed with the `webhook_secret` from this response. `webhook_secret` is shown
+    only once. A delivery that fails is retried, 3 attempts in total.
+
+    Requires an API key. The credits are charged at submission and refunded if
+    the job fails. The uploaded file is deleted when the job finishes. Results
+    are kept for 7 days after submission.
+
+    **Credits:** 10 per call.
+
+    Args:
+        body (BodySubmitConversionJob):
+
+    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:
+        JobSubmitResponse | Problem
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: BodySubmitConversionJob,
+) -> Response[JobSubmitResponse | Problem]:
+    """Queue a document for conversion with OCR and tables
+
+     Queues one document up to 25 MB and 200 pages for conversion with Docling.
+
+    Accepted types are the same as for `POST /v1/convert`. The queue runs OCR
+    (text recognition) and recognizes tables, headings and reading order. A
+    conversion may take up to about 2 minutes; longer ones are stopped and fail.
+
+    Poll `GET /v1/jobs/{id}` (free) until `status` is `succeeded` or `failed`,
+    then download the result from `result_url` (free). The result is Markdown, or
+    the DoclingDocument JSON with `?format=json`.
+
+    With `webhook_url`, the job's final state is POSTed there as JSON
+    (`job_id`, `status`, `result`, `error`). The request carries
+    `X-Appkit-Signature: sha256=<hex>`, an HMAC-SHA256 of the raw request body
+    keyed with the `webhook_secret` from this response. `webhook_secret` is shown
+    only once. A delivery that fails is retried, 3 attempts in total.
+
+    Requires an API key. The credits are charged at submission and refunded if
+    the job fails. The uploaded file is deleted when the job finishes. Results
+    are kept for 7 days after submission.
+
+    **Credits:** 10 per call.
+
+    Args:
+        body (BodySubmitConversionJob):
+
+    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[JobSubmitResponse | Problem]
+    """
+
+    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: AuthenticatedClient,
+    body: BodySubmitConversionJob,
+) -> JobSubmitResponse | Problem | None:
+    """Queue a document for conversion with OCR and tables
+
+     Queues one document up to 25 MB and 200 pages for conversion with Docling.
+
+    Accepted types are the same as for `POST /v1/convert`. The queue runs OCR
+    (text recognition) and recognizes tables, headings and reading order. A
+    conversion may take up to about 2 minutes; longer ones are stopped and fail.
+
+    Poll `GET /v1/jobs/{id}` (free) until `status` is `succeeded` or `failed`,
+    then download the result from `result_url` (free). The result is Markdown, or
+    the DoclingDocument JSON with `?format=json`.
+
+    With `webhook_url`, the job's final state is POSTed there as JSON
+    (`job_id`, `status`, `result`, `error`). The request carries
+    `X-Appkit-Signature: sha256=<hex>`, an HMAC-SHA256 of the raw request body
+    keyed with the `webhook_secret` from this response. `webhook_secret` is shown
+    only once. A delivery that fails is retried, 3 attempts in total.
+
+    Requires an API key. The credits are charged at submission and refunded if
+    the job fails. The uploaded file is deleted when the job finishes. Results
+    are kept for 7 days after submission.
+
+    **Credits:** 10 per call.
+
+    Args:
+        body (BodySubmitConversionJob):
+
+    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:
+        JobSubmitResponse | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

flatmark/api/jobs/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

flatmark/api/jobs/get_job.py

@@ -0,0 +1,189 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.job_response import JobResponse
+from ...models.problem import Problem
+from ...types import Response
+
+
+def _get_kwargs(
+    job_id: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/jobs/{job_id}".format(
+            job_id=quote(str(job_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> JobResponse | Problem | None:
+    if response.status_code == 200:
+        response_200 = JobResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = Problem.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 422:
+        response_422 = Problem.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 429:
+        response_429 = Problem.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[JobResponse | Problem]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[JobResponse | Problem]:
+    """Get one queued job by ID
+
+     Returns one of your jobs. An unknown ID, or a job owned by someone else,
+    returns 404.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str): The `job_id` from the submit response.
+
+    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[JobResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        job_id=job_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> JobResponse | Problem | None:
+    """Get one queued job by ID
+
+     Returns one of your jobs. An unknown ID, or a job owned by someone else,
+    returns 404.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str): The `job_id` from the submit response.
+
+    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:
+        JobResponse | Problem
+    """
+
+    return sync_detailed(
+        job_id=job_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[JobResponse | Problem]:
+    """Get one queued job by ID
+
+     Returns one of your jobs. An unknown ID, or a job owned by someone else,
+    returns 404.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str): The `job_id` from the submit response.
+
+    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[JobResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        job_id=job_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> JobResponse | Problem | None:
+    """Get one queued job by ID
+
+     Returns one of your jobs. An unknown ID, or a job owned by someone else,
+    returns 404.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str): The `job_id` from the submit response.
+
+    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:
+        JobResponse | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            job_id=job_id,
+            client=client,
+        )
+    ).parsed

flatmark/api/jobs/list_jobs.py

@@ -0,0 +1,211 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.job_response_page import JobResponsePage
+from ...models.problem import Problem
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    limit: int | Unset = 50,
+    cursor: None | str | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["limit"] = limit
+
+    json_cursor: None | str | Unset
+    if isinstance(cursor, Unset):
+        json_cursor = UNSET
+    else:
+        json_cursor = cursor
+    params["cursor"] = json_cursor
+
+    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": "/v1/jobs",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> JobResponsePage | Problem | None:
+    if response.status_code == 200:
+        response_200 = JobResponsePage.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = Problem.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 429:
+        response_429 = Problem.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[JobResponsePage | Problem]:
+    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: AuthenticatedClient,
+    limit: int | Unset = 50,
+    cursor: None | str | Unset = UNSET,
+) -> Response[JobResponsePage | Problem]:
+    """List your queued jobs, newest first
+
+     Lists your jobs, newest first. Pass `next_cursor` back as `cursor` to get
+    the next page.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        limit (int | Unset): Items per page. Default: 50.
+        cursor (None | str | Unset): The `next_cursor` from the previous page.
+
+    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[JobResponsePage | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        limit=limit,
+        cursor=cursor,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    limit: int | Unset = 50,
+    cursor: None | str | Unset = UNSET,
+) -> JobResponsePage | Problem | None:
+    """List your queued jobs, newest first
+
+     Lists your jobs, newest first. Pass `next_cursor` back as `cursor` to get
+    the next page.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        limit (int | Unset): Items per page. Default: 50.
+        cursor (None | str | Unset): The `next_cursor` from the previous page.
+
+    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:
+        JobResponsePage | Problem
+    """
+
+    return sync_detailed(
+        client=client,
+        limit=limit,
+        cursor=cursor,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    limit: int | Unset = 50,
+    cursor: None | str | Unset = UNSET,
+) -> Response[JobResponsePage | Problem]:
+    """List your queued jobs, newest first
+
+     Lists your jobs, newest first. Pass `next_cursor` back as `cursor` to get
+    the next page.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        limit (int | Unset): Items per page. Default: 50.
+        cursor (None | str | Unset): The `next_cursor` from the previous page.
+
+    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[JobResponsePage | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        limit=limit,
+        cursor=cursor,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    limit: int | Unset = 50,
+    cursor: None | str | Unset = UNSET,
+) -> JobResponsePage | Problem | None:
+    """List your queued jobs, newest first
+
+     Lists your jobs, newest first. Pass `next_cursor` back as `cursor` to get
+    the next page.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        limit (int | Unset): Items per page. Default: 50.
+        cursor (None | str | Unset): The `next_cursor` from the previous page.
+
+    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:
+        JobResponsePage | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            limit=limit,
+            cursor=cursor,
+        )
+    ).parsed