wavix-python-sdk 1.0.0__py3-none-any.whl

wavix/numbers/papers/client.py

@@ -0,0 +1,155 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ... import core
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.document_type_id import DocumentTypeId
+from ...types.number_document import NumberDocument
+from .raw_client import AsyncRawPapersClient, RawPapersClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class PapersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawPapersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawPapersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawPapersClient
+        """
+        return self._raw_client
+
+    def upload(
+        self,
+        *,
+        did_ids: str,
+        doc_attachment: core.File,
+        doc_id: DocumentTypeId,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[NumberDocument]:
+        """
+        Uploads a verification document for one or more phone numbers.
+        Uploaded files must meet the following requirements:
+        - Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF
+        - Maximum file size: 10 MB
+        - Files can't be password protected
+        - PDF files must not contain digital signatures
+
+        Parameters
+        ----------
+        did_ids : str
+            Comma-separated record IDs of the phone numbers the document applies to.
+
+        doc_attachment : core.File
+            See core.File for more documentation
+
+        doc_id : DocumentTypeId
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[NumberDocument]
+            Returns the uploaded documents and their review status.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.numbers.papers.upload(
+            did_ids="did_ids",
+            doc_id=1,
+        )
+        """
+        _response = self._raw_client.upload(
+            did_ids=did_ids, doc_attachment=doc_attachment, doc_id=doc_id, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncPapersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawPapersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawPapersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawPapersClient
+        """
+        return self._raw_client
+
+    async def upload(
+        self,
+        *,
+        did_ids: str,
+        doc_attachment: core.File,
+        doc_id: DocumentTypeId,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[NumberDocument]:
+        """
+        Uploads a verification document for one or more phone numbers.
+        Uploaded files must meet the following requirements:
+        - Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF
+        - Maximum file size: 10 MB
+        - Files can't be password protected
+        - PDF files must not contain digital signatures
+
+        Parameters
+        ----------
+        did_ids : str
+            Comma-separated record IDs of the phone numbers the document applies to.
+
+        doc_attachment : core.File
+            See core.File for more documentation
+
+        doc_id : DocumentTypeId
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[NumberDocument]
+            Returns the uploaded documents and their review status.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.numbers.papers.upload(
+                did_ids="did_ids",
+                doc_id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.upload(
+            did_ids=did_ids, doc_attachment=doc_attachment, doc_id=doc_id, request_options=request_options
+        )
+        return _response.data

wavix/numbers/papers/raw_client.py

@@ -0,0 +1,208 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ... import core
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.parse_error import ParsingError
+from ...core.pydantic_utilities import parse_obj_as
+from ...core.request_options import RequestOptions
+from ...errors.bad_request_error import BadRequestError
+from ...errors.forbidden_error import ForbiddenError
+from ...types.document_type_id import DocumentTypeId
+from ...types.number_document import NumberDocument
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawPapersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def upload(
+        self,
+        *,
+        did_ids: str,
+        doc_attachment: core.File,
+        doc_id: DocumentTypeId,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[typing.List[NumberDocument]]:
+        """
+        Uploads a verification document for one or more phone numbers.
+        Uploaded files must meet the following requirements:
+        - Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF
+        - Maximum file size: 10 MB
+        - Files can't be password protected
+        - PDF files must not contain digital signatures
+
+        Parameters
+        ----------
+        did_ids : str
+            Comma-separated record IDs of the phone numbers the document applies to.
+
+        doc_attachment : core.File
+            See core.File for more documentation
+
+        doc_id : DocumentTypeId
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[NumberDocument]]
+            Returns the uploaded documents and their review status.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/numbers/papers",
+            method="POST",
+            data={
+                "did_ids": did_ids,
+                "doc_id": doc_id,
+            },
+            files={
+                "doc_attachment": doc_attachment,
+            },
+            request_options=request_options,
+            omit=OMIT,
+            force_multipart=True,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[NumberDocument],
+                    parse_obj_as(
+                        type_=typing.List[NumberDocument],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawPapersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def upload(
+        self,
+        *,
+        did_ids: str,
+        doc_attachment: core.File,
+        doc_id: DocumentTypeId,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[typing.List[NumberDocument]]:
+        """
+        Uploads a verification document for one or more phone numbers.
+        Uploaded files must meet the following requirements:
+        - Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF
+        - Maximum file size: 10 MB
+        - Files can't be password protected
+        - PDF files must not contain digital signatures
+
+        Parameters
+        ----------
+        did_ids : str
+            Comma-separated record IDs of the phone numbers the document applies to.
+
+        doc_attachment : core.File
+            See core.File for more documentation
+
+        doc_id : DocumentTypeId
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[NumberDocument]]
+            Returns the uploaded documents and their review status.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/numbers/papers",
+            method="POST",
+            data={
+                "did_ids": did_ids,
+                "doc_id": doc_id,
+            },
+            files={
+                "doc_attachment": doc_attachment,
+            },
+            request_options=request_options,
+            omit=OMIT,
+            force_multipart=True,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[NumberDocument],
+                    parse_obj_as(
+                        type_=typing.List[NumberDocument],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)