client.py

# This file was auto-generated by Fern from our API Definition.

import typing

from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.doc_pages_extract_request import DocPagesExtractRequest
from ...types.doc_pages_flatten200response import DocPagesFlatten200Response
from ...types.doc_pages_flatten_request import DocPagesFlattenRequest
from ...types.doc_pages_remove_name200response import DocPagesRemoveName200Response
from ...types.doc_pages_remove_name_request import DocPagesRemoveNameRequest
from ...types.doc_pages_set_name200response import DocPagesSetName200Response
from ...types.doc_pages_set_name_request import DocPagesSetNameRequest
from ...types.doc_pages_set_scale200response import DocPagesSetScale200Response
from ...types.doc_pages_viewports200response import DocPagesViewports200Response
from .raw_client import AsyncRawPagesClient, RawPagesClient
from .types.doc_pages_set_scale_request_measure import DocPagesSetScaleRequestMeasure

# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)


class PagesClient:
    def __init__(self, *, client_wrapper: SyncClientWrapper):
        self._raw_client = RawPagesClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> RawPagesClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        RawPagesClient
        """
        return self._raw_client

    def set_scale(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        *,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        measure: typing.Optional[DocPagesSetScaleRequestMeasure] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesSetScale200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        page_key : str
            The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        measure : typing.Optional[DocPagesSetScaleRequestMeasure]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesSetScale200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.doc.pages.set_scale(
            doc_id="docId",
            layer_name="layerName",
            page_key="pageKey",
        )
        """
        _response = self._raw_client.set_scale(
            doc_id,
            layer_name,
            page_key,
            document_password=document_password,
            idempotency_key=idempotency_key,
            measure=measure,
            request_options=request_options,
        )
        return _response.data

    def viewports(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        *,
        document_password: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesViewports200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        page_key : str
            The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesViewports200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.doc.pages.viewports(
            doc_id="docId",
            layer_name="layerName",
            page_key="pageKey",
        )
        """
        _response = self._raw_client.viewports(
            doc_id, layer_name, page_key, document_password=document_password, request_options=request_options
        )
        return _response.data

    def extract(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesExtractRequest,
        document_password: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> typing.Iterator[bytes]:
        """
        A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?: boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage` (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused without `flatten`.

        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesExtractRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.

        Returns
        -------
        typing.Iterator[bytes]
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.doc.pages.extract(
            doc_id="docId",
            layer_name="layerName",
            request={"string": {"key": "value"}},
        )
        """
        with self._raw_client.extract(
            doc_id, layer_name, request=request, document_password=document_password, request_options=request_options
        ) as r:
            yield from r.data

    def flatten(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesFlattenRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesFlatten200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesFlattenRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesFlatten200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.doc.pages.flatten(
            doc_id="docId",
            layer_name="layerName",
            request={"key": "value"},
        )
        """
        _response = self._raw_client.flatten(
            doc_id,
            layer_name,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    def set_name(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesSetNameRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesSetName200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesSetNameRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesSetName200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.doc.pages.set_name(
            doc_id="docId",
            layer_name="layerName",
            request={"key": "value"},
        )
        """
        _response = self._raw_client.set_name(
            doc_id,
            layer_name,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    def remove_name(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesRemoveNameRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesRemoveName200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesRemoveNameRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesRemoveName200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.doc.pages.remove_name(
            doc_id="docId",
            layer_name="layerName",
            request={"key": "value"},
        )
        """
        _response = self._raw_client.remove_name(
            doc_id,
            layer_name,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data


class AsyncPagesClient:
    def __init__(self, *, client_wrapper: AsyncClientWrapper):
        self._raw_client = AsyncRawPagesClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> AsyncRawPagesClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        AsyncRawPagesClient
        """
        return self._raw_client

    async def set_scale(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        *,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        measure: typing.Optional[DocPagesSetScaleRequestMeasure] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesSetScale200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        page_key : str
            The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        measure : typing.Optional[DocPagesSetScaleRequestMeasure]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesSetScale200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.doc.pages.set_scale(
                doc_id="docId",
                layer_name="layerName",
                page_key="pageKey",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.set_scale(
            doc_id,
            layer_name,
            page_key,
            document_password=document_password,
            idempotency_key=idempotency_key,
            measure=measure,
            request_options=request_options,
        )
        return _response.data

    async def viewports(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        *,
        document_password: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesViewports200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        page_key : str
            The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesViewports200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.doc.pages.viewports(
                doc_id="docId",
                layer_name="layerName",
                page_key="pageKey",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.viewports(
            doc_id, layer_name, page_key, document_password=document_password, request_options=request_options
        )
        return _response.data

    async def extract(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesExtractRequest,
        document_password: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> typing.AsyncIterator[bytes]:
        """
        A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?: boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage` (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused without `flatten`.

        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesExtractRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.

        Returns
        -------
        typing.AsyncIterator[bytes]
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.doc.pages.extract(
                doc_id="docId",
                layer_name="layerName",
                request={"string": {"key": "value"}},
            )


        asyncio.run(main())
        """
        async with self._raw_client.extract(
            doc_id, layer_name, request=request, document_password=document_password, request_options=request_options
        ) as r:
            async for _chunk in r.data:
                yield _chunk

    async def flatten(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesFlattenRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesFlatten200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesFlattenRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesFlatten200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.doc.pages.flatten(
                doc_id="docId",
                layer_name="layerName",
                request={"key": "value"},
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.flatten(
            doc_id,
            layer_name,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    async def set_name(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesSetNameRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesSetName200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesSetNameRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesSetName200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.doc.pages.set_name(
                doc_id="docId",
                layer_name="layerName",
                request={"key": "value"},
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.set_name(
            doc_id,
            layer_name,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    async def remove_name(
        self,
        doc_id: str,
        layer_name: str,
        *,
        request: DocPagesRemoveNameRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocPagesRemoveName200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        request : DocPagesRemoveNameRequest

        document_password : typing.Optional[str]
            Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

        idempotency_key : typing.Optional[str]
            Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        DocPagesRemoveName200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.doc.pages.remove_name(
                doc_id="docId",
                layer_name="layerName",
                request={"key": "value"},
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.remove_name(
            doc_id,
            layer_name,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data