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.annotation_position import AnnotationPosition
from ...types.annotation_ref import AnnotationRef
from ...types.doc_forms_delete_widget200response import DocFormsDeleteWidget200Response
from ...types.doc_forms_list200response import DocFormsList200Response
from ...types.doc_forms_reorder_calculations200response import DocFormsReorderCalculations200Response
from ...types.doc_forms_reorder_widgets200response import DocFormsReorderWidgets200Response
from ...types.doc_forms_reset200response import DocFormsReset200Response
from ...types.doc_forms_set_value200response import DocFormsSetValue200Response
from ...types.doc_forms_set_value_request import DocFormsSetValueRequest
from ...types.doc_forms_update_widget200response import DocFormsUpdateWidget200Response
from ...types.field_position import FieldPosition
from ...types.form_field_ref import FormFieldRef
from ...types.widget_patch import WidgetPatch
from .raw_client import AsyncRawFormsClient, RawFormsClient

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


class FormsClient:
    def __init__(self, *, client_wrapper: SyncClientWrapper):
        self._raw_client = RawFormsClient(client_wrapper=client_wrapper)

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

        Returns
        -------
        RawFormsClient
        """
        return self._raw_client

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

        layer_name : str

        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
        -------
        DocFormsList200Response
            OK

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

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.list(
            doc_id="docId",
            layer_name="layerName",
        )
        """
        _response = self._raw_client.list(
            doc_id, layer_name, document_password=document_password, request_options=request_options
        )
        return _response.data

    def reorder_calculations(
        self,
        doc_id: str,
        layer_name: str,
        *,
        fields: typing.Sequence[FormFieldRef],
        position: FieldPosition,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsReorderCalculations200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        fields : typing.Sequence[FormFieldRef]

        position : FieldPosition

        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
        -------
        DocFormsReorderCalculations200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient, FormFieldRef_ObjectNumber

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.reorder_calculations(
            doc_id="docId",
            layer_name="layerName",
            fields=[
                FormFieldRef_ObjectNumber(
                    object_number=1,
                )
            ],
            position="start",
        )
        """
        _response = self._raw_client.reorder_calculations(
            doc_id,
            layer_name,
            fields=fields,
            position=position,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    def set_value(
        self,
        doc_id: str,
        layer_name: str,
        field_key: str,
        *,
        request: DocFormsSetValueRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsSetValue200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        field_key : str

        request : DocFormsSetValueRequest

        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
        -------
        DocFormsSetValue200Response
            OK

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

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.set_value(
            doc_id="docId",
            layer_name="layerName",
            field_key="fieldKey",
            request={"key": "value"},
        )
        """
        _response = self._raw_client.set_value(
            doc_id,
            layer_name,
            field_key,
            request=request,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    def reset(
        self,
        doc_id: str,
        layer_name: str,
        *,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        refs: typing.Optional[typing.Sequence[FormFieldRef]] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsReset200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        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.

        refs : typing.Optional[typing.Sequence[FormFieldRef]]

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

        Returns
        -------
        DocFormsReset200Response
            OK

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

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.reset(
            doc_id="docId",
            layer_name="layerName",
        )
        """
        _response = self._raw_client.reset(
            doc_id,
            layer_name,
            document_password=document_password,
            idempotency_key=idempotency_key,
            refs=refs,
            request_options=request_options,
        )
        return _response.data

    def delete_widget(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        annot_key: str,
        *,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsDeleteWidget200Response:
        """
        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`.

        annot_key : str
            The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.

        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
        -------
        DocFormsDeleteWidget200Response
            OK

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

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.delete_widget(
            doc_id="docId",
            layer_name="layerName",
            page_key="pageKey",
            annot_key="annotKey",
        )
        """
        _response = self._raw_client.delete_widget(
            doc_id,
            layer_name,
            page_key,
            annot_key,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    def update_widget(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        annot_key: str,
        *,
        patch: WidgetPatch,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsUpdateWidget200Response:
        """
        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`.

        annot_key : str
            The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.

        patch : WidgetPatch

        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
        -------
        DocFormsUpdateWidget200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient, WidgetPatch

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.update_widget(
            doc_id="docId",
            layer_name="layerName",
            page_key="pageKey",
            annot_key="annotKey",
            patch=WidgetPatch(),
        )
        """
        _response = self._raw_client.update_widget(
            doc_id,
            layer_name,
            page_key,
            annot_key,
            patch=patch,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data

    def reorder_widgets(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        *,
        widgets: typing.Sequence[AnnotationRef],
        position: AnnotationPosition,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsReorderWidgets200Response:
        """
        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`.

        widgets : typing.Sequence[AnnotationRef]

        position : AnnotationPosition

        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
        -------
        DocFormsReorderWidgets200Response
            OK

        Examples
        --------
        from cloudpdf import AnnotationRef_ObjectNumber, CloudPDFClient, PageRef

        client = CloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )
        client.doc.forms.reorder_widgets(
            doc_id="docId",
            layer_name="layerName",
            page_key="pageKey",
            widgets=[
                AnnotationRef_ObjectNumber(
                    page=PageRef(
                        kind="objectNumber",
                        object_number=1,
                    ),
                    object_number=1,
                )
            ],
            position="start",
        )
        """
        _response = self._raw_client.reorder_widgets(
            doc_id,
            layer_name,
            page_key,
            widgets=widgets,
            position=position,
            document_password=document_password,
            idempotency_key=idempotency_key,
            request_options=request_options,
        )
        return _response.data


class AsyncFormsClient:
    def __init__(self, *, client_wrapper: AsyncClientWrapper):
        self._raw_client = AsyncRawFormsClient(client_wrapper=client_wrapper)

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

        Returns
        -------
        AsyncRawFormsClient
        """
        return self._raw_client

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

        layer_name : str

        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
        -------
        DocFormsList200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


        async def main() -> None:
            await client.doc.forms.list(
                doc_id="docId",
                layer_name="layerName",
            )


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

    async def reorder_calculations(
        self,
        doc_id: str,
        layer_name: str,
        *,
        fields: typing.Sequence[FormFieldRef],
        position: FieldPosition,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsReorderCalculations200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        fields : typing.Sequence[FormFieldRef]

        position : FieldPosition

        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
        -------
        DocFormsReorderCalculations200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient, FormFieldRef_ObjectNumber

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


        async def main() -> None:
            await client.doc.forms.reorder_calculations(
                doc_id="docId",
                layer_name="layerName",
                fields=[
                    FormFieldRef_ObjectNumber(
                        object_number=1,
                    )
                ],
                position="start",
            )


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

    async def set_value(
        self,
        doc_id: str,
        layer_name: str,
        field_key: str,
        *,
        request: DocFormsSetValueRequest,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsSetValue200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        field_key : str

        request : DocFormsSetValueRequest

        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
        -------
        DocFormsSetValue200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


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


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

    async def reset(
        self,
        doc_id: str,
        layer_name: str,
        *,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        refs: typing.Optional[typing.Sequence[FormFieldRef]] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsReset200Response:
        """
        Parameters
        ----------
        doc_id : str

        layer_name : str

        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.

        refs : typing.Optional[typing.Sequence[FormFieldRef]]

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

        Returns
        -------
        DocFormsReset200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


        async def main() -> None:
            await client.doc.forms.reset(
                doc_id="docId",
                layer_name="layerName",
            )


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

    async def delete_widget(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        annot_key: str,
        *,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsDeleteWidget200Response:
        """
        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`.

        annot_key : str
            The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.

        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
        -------
        DocFormsDeleteWidget200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


        async def main() -> None:
            await client.doc.forms.delete_widget(
                doc_id="docId",
                layer_name="layerName",
                page_key="pageKey",
                annot_key="annotKey",
            )


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

    async def update_widget(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        annot_key: str,
        *,
        patch: WidgetPatch,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsUpdateWidget200Response:
        """
        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`.

        annot_key : str
            The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.

        patch : WidgetPatch

        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
        -------
        DocFormsUpdateWidget200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient, WidgetPatch

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


        async def main() -> None:
            await client.doc.forms.update_widget(
                doc_id="docId",
                layer_name="layerName",
                page_key="pageKey",
                annot_key="annotKey",
                patch=WidgetPatch(),
            )


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

    async def reorder_widgets(
        self,
        doc_id: str,
        layer_name: str,
        page_key: str,
        *,
        widgets: typing.Sequence[AnnotationRef],
        position: AnnotationPosition,
        document_password: typing.Optional[str] = None,
        idempotency_key: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> DocFormsReorderWidgets200Response:
        """
        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`.

        widgets : typing.Sequence[AnnotationRef]

        position : AnnotationPosition

        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
        -------
        DocFormsReorderWidgets200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AnnotationRef_ObjectNumber, AsyncCloudPDFClient, PageRef

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
            base_url="https://yourhost.com/path/to/api",
        )


        async def main() -> None:
            await client.doc.forms.reorder_widgets(
                doc_id="docId",
                layer_name="layerName",
                page_key="pageKey",
                widgets=[
                    AnnotationRef_ObjectNumber(
                        page=PageRef(
                            kind="objectNumber",
                            object_number=1,
                        ),
                        object_number=1,
                    )
                ],
                position="start",
            )


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