flatmark 1.0.0__py3-none-any.whl

flatmark/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing flatmark"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

flatmark/api/__init__.py

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

flatmark/api/account/__init__.py

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

flatmark/api/account/get_me.py

@@ -0,0 +1,176 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.me_response import MeResponse
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/me",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MeResponse | None:
+    if response.status_code == 200:
+        response_200 = MeResponse.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: AuthenticatedClient | Client, response: httpx.Response) -> Response[MeResponse]:
+    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,
+) -> Response[MeResponse]:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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[MeResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> MeResponse | None:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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:
+        MeResponse
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[MeResponse]:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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[MeResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> MeResponse | None:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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:
+        MeResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

flatmark/api/convert/__init__.py

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

flatmark/api/convert/convert_document.py

@@ -0,0 +1,253 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.body_convert_document import BodyConvertDocument
+from ...models.problem import Problem
+from ...models.sync_convert_response import SyncConvertResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: BodyConvertDocument,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/convert",
+    }
+
+    _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
+) -> Problem | SyncConvertResponse | None:
+    if response.status_code == 200:
+        response_200 = SyncConvertResponse.from_dict(response.json())
+
+        return response_200
+
+    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 == 500:
+        response_500 = Problem.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = Problem.from_dict(response.json())
+
+        return response_503
+
+    if response.status_code == 504:
+        response_504 = Problem.from_dict(response.json())
+
+        return response_504
+
+    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[Problem | SyncConvertResponse]:
+    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: BodyConvertDocument,
+) -> Response[Problem | SyncConvertResponse]:
+    """Convert a document to Markdown in one call
+
+     Converts one document up to 8 MB and returns the Markdown in the response.
+
+    Accepted types: PDF (`application/pdf`), Word `.docx`, PowerPoint `.pptx`,
+    Excel `.xlsx`, HTML (`text/html`) and plain text (`text/plain`). The
+    Content-Type of the file part decides how it is read. Conversion uses
+    MarkItDown. PDFs come back as plain text without headings and without OCR.
+    For scans, tables and page numbers, use the queue (`POST /v1/convert/jobs`).
+
+    Works without an API key at the anonymous rate limit. With a key, a
+    rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (BodyConvertDocument):
+
+    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[Problem | SyncConvertResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: BodyConvertDocument,
+) -> Problem | SyncConvertResponse | None:
+    """Convert a document to Markdown in one call
+
+     Converts one document up to 8 MB and returns the Markdown in the response.
+
+    Accepted types: PDF (`application/pdf`), Word `.docx`, PowerPoint `.pptx`,
+    Excel `.xlsx`, HTML (`text/html`) and plain text (`text/plain`). The
+    Content-Type of the file part decides how it is read. Conversion uses
+    MarkItDown. PDFs come back as plain text without headings and without OCR.
+    For scans, tables and page numbers, use the queue (`POST /v1/convert/jobs`).
+
+    Works without an API key at the anonymous rate limit. With a key, a
+    rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (BodyConvertDocument):
+
+    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:
+        Problem | SyncConvertResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: BodyConvertDocument,
+) -> Response[Problem | SyncConvertResponse]:
+    """Convert a document to Markdown in one call
+
+     Converts one document up to 8 MB and returns the Markdown in the response.
+
+    Accepted types: PDF (`application/pdf`), Word `.docx`, PowerPoint `.pptx`,
+    Excel `.xlsx`, HTML (`text/html`) and plain text (`text/plain`). The
+    Content-Type of the file part decides how it is read. Conversion uses
+    MarkItDown. PDFs come back as plain text without headings and without OCR.
+    For scans, tables and page numbers, use the queue (`POST /v1/convert/jobs`).
+
+    Works without an API key at the anonymous rate limit. With a key, a
+    rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (BodyConvertDocument):
+
+    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[Problem | SyncConvertResponse]
+    """
+
+    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: BodyConvertDocument,
+) -> Problem | SyncConvertResponse | None:
+    """Convert a document to Markdown in one call
+
+     Converts one document up to 8 MB and returns the Markdown in the response.
+
+    Accepted types: PDF (`application/pdf`), Word `.docx`, PowerPoint `.pptx`,
+    Excel `.xlsx`, HTML (`text/html`) and plain text (`text/plain`). The
+    Content-Type of the file part decides how it is read. Conversion uses
+    MarkItDown. PDFs come back as plain text without headings and without OCR.
+    For scans, tables and page numbers, use the queue (`POST /v1/convert/jobs`).
+
+    Works without an API key at the anonymous rate limit. With a key, a
+    rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (BodyConvertDocument):
+
+    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:
+        Problem | SyncConvertResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

flatmark/api/convert/get_conversion_result.py

@@ -0,0 +1,237 @@
+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.get_conversion_result_format import GetConversionResultFormat
+from ...models.problem import Problem
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    job_id: str,
+    *,
+    format_: GetConversionResultFormat | Unset = GetConversionResultFormat.MARKDOWN,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_format_: str | Unset = UNSET
+    if not isinstance(format_, Unset):
+        json_format_ = format_.value
+
+    params["format"] = json_format_
+
+    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/convert/jobs/{job_id}/result".format(
+            job_id=quote(str(job_id), safe=""),
+        ),
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Problem | str | None:
+    if response.status_code == 200:
+        response_200 = response.text
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = Problem.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 409:
+        response_409 = Problem.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 410:
+        response_410 = Problem.from_dict(response.json())
+
+        return response_410
+
+    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[Problem | str]:
+    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,
+    format_: GetConversionResultFormat | Unset = GetConversionResultFormat.MARKDOWN,
+) -> Response[Problem | str]:
+    """Download a queued job's Markdown or JSON
+
+     Returns the output of one of your finished queued jobs.
+
+    Markdown (`text/markdown`) by default, or the DoclingDocument JSON
+    (`application/json`) with `?format=json`. The JSON carries page numbers for
+    PDF, slide numbers for PowerPoint and sheet names for Excel.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str):
+        format_ (GetConversionResultFormat | Unset): `markdown` (default) or `json` for the
+            DoclingDocument structure file. Default: GetConversionResultFormat.MARKDOWN.
+
+    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[Problem | str]
+    """
+
+    kwargs = _get_kwargs(
+        job_id=job_id,
+        format_=format_,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+    format_: GetConversionResultFormat | Unset = GetConversionResultFormat.MARKDOWN,
+) -> Problem | str | None:
+    """Download a queued job's Markdown or JSON
+
+     Returns the output of one of your finished queued jobs.
+
+    Markdown (`text/markdown`) by default, or the DoclingDocument JSON
+    (`application/json`) with `?format=json`. The JSON carries page numbers for
+    PDF, slide numbers for PowerPoint and sheet names for Excel.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str):
+        format_ (GetConversionResultFormat | Unset): `markdown` (default) or `json` for the
+            DoclingDocument structure file. Default: GetConversionResultFormat.MARKDOWN.
+
+    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:
+        Problem | str
+    """
+
+    return sync_detailed(
+        job_id=job_id,
+        client=client,
+        format_=format_,
+    ).parsed
+
+
+async def asyncio_detailed(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+    format_: GetConversionResultFormat | Unset = GetConversionResultFormat.MARKDOWN,
+) -> Response[Problem | str]:
+    """Download a queued job's Markdown or JSON
+
+     Returns the output of one of your finished queued jobs.
+
+    Markdown (`text/markdown`) by default, or the DoclingDocument JSON
+    (`application/json`) with `?format=json`. The JSON carries page numbers for
+    PDF, slide numbers for PowerPoint and sheet names for Excel.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str):
+        format_ (GetConversionResultFormat | Unset): `markdown` (default) or `json` for the
+            DoclingDocument structure file. Default: GetConversionResultFormat.MARKDOWN.
+
+    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[Problem | str]
+    """
+
+    kwargs = _get_kwargs(
+        job_id=job_id,
+        format_=format_,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    job_id: str,
+    *,
+    client: AuthenticatedClient,
+    format_: GetConversionResultFormat | Unset = GetConversionResultFormat.MARKDOWN,
+) -> Problem | str | None:
+    """Download a queued job's Markdown or JSON
+
+     Returns the output of one of your finished queued jobs.
+
+    Markdown (`text/markdown`) by default, or the DoclingDocument JSON
+    (`application/json`) with `?format=json`. The JSON carries page numbers for
+    PDF, slide numbers for PowerPoint and sheet names for Excel.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Args:
+        job_id (str):
+        format_ (GetConversionResultFormat | Unset): `markdown` (default) or `json` for the
+            DoclingDocument structure file. Default: GetConversionResultFormat.MARKDOWN.
+
+    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:
+        Problem | str
+    """
+
+    return (
+        await asyncio_detailed(
+            job_id=job_id,
+            client=client,
+            format_=format_,
+        )
+    ).parsed