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

wavix/two_fa/sessions/raw_client.py

@@ -0,0 +1,200 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.jsonable_encoder import encode_path_param
+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 ...errors.not_found_error import NotFoundError
+from ...types.list_sessions_response_item import ListSessionsResponseItem
+from pydantic import ValidationError
+
+
+class RawSessionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self, service_id: str, *, from_: dt.date, to: dt.date, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.List[ListSessionsResponseItem]]:
+        """
+        Returns the 2FA verifications for the service identified by `service_id`, within the requested date range.
+
+        Parameters
+        ----------
+        service_id : str
+            The unique ID of the 2FA service.
+
+        from_ : dt.date
+            Start of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        to : dt.date
+            End of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[ListSessionsResponseItem]]
+            Returns the list of 2FA verifications.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/two-fa/service/{encode_path_param(service_id)}/sessions",
+            method="GET",
+            params={
+                "from": str(from_),
+                "to": str(to),
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[ListSessionsResponseItem],
+                    parse_obj_as(
+                        type_=typing.List[ListSessionsResponseItem],  # 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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    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 AsyncRawSessionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self, service_id: str, *, from_: dt.date, to: dt.date, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.List[ListSessionsResponseItem]]:
+        """
+        Returns the 2FA verifications for the service identified by `service_id`, within the requested date range.
+
+        Parameters
+        ----------
+        service_id : str
+            The unique ID of the 2FA service.
+
+        from_ : dt.date
+            Start of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        to : dt.date
+            End of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[ListSessionsResponseItem]]
+            Returns the list of 2FA verifications.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/two-fa/service/{encode_path_param(service_id)}/sessions",
+            method="GET",
+            params={
+                "from": str(from_),
+                "to": str(to),
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[ListSessionsResponseItem],
+                    parse_obj_as(
+                        type_=typing.List[ListSessionsResponseItem],  # 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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    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)

wavix/two_fa/verification/__init__.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        CheckVerificationResponse,
+        CreateVerificationResponse,
+        ResendVerificationResponse,
+        TwoFactorVerificationResendRequestChannel,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "CheckVerificationResponse": ".types",
+    "CreateVerificationResponse": ".types",
+    "ResendVerificationResponse": ".types",
+    "TwoFactorVerificationResendRequestChannel": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "CheckVerificationResponse",
+    "CreateVerificationResponse",
+    "ResendVerificationResponse",
+    "TwoFactorVerificationResendRequestChannel",
+]

wavix/two_fa/verification/client.py

@@ -0,0 +1,395 @@
+# 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.success_response import SuccessResponse
+from .raw_client import AsyncRawVerificationClient, RawVerificationClient
+from .types.check_verification_response import CheckVerificationResponse
+from .types.create_verification_response import CreateVerificationResponse
+from .types.resend_verification_response import ResendVerificationResponse
+from .types.two_factor_verification_resend_request_channel import TwoFactorVerificationResendRequestChannel
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class VerificationClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawVerificationClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawVerificationClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawVerificationClient
+        """
+        return self._raw_client
+
+    def create(
+        self, *, service_id: str, to: str, channel: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateVerificationResponse:
+        """
+        Creates a 2FA verification and sends a one-time password (OTP) to the destination phone number over the selected channel. Requires a 2FA service configured in the Wavix portal; the service is reused to generate and validate OTPs.
+
+        The verification proceeds through three steps:
+        1. Create a verification to generate and send an OTP.
+        2. Resend the OTP on the same verification if needed.
+        3. Validate the OTP through the check endpoint.
+
+        Parameters
+        ----------
+        service_id : str
+            Unique Wavix 2FA Service ID. Available on the Wavix portal.
+
+        to : str
+            End user's phone number to which the verification code will be sent. The phone number must be in E.164 format.
+
+        channel : str
+            Channel used to deliver the verification code. One of `sms` (sent as a text message) or `voice` (read aloud over a phone call).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateVerificationResponse
+            Returns the created 2FA verification.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.two_fa.verification.create(
+            service_id="7204a030201211ee9fb47d093f2f127c",
+            to="447919433768",
+            channel="sms",
+        )
+        """
+        _response = self._raw_client.create(
+            service_id=service_id, to=to, channel=channel, request_options=request_options
+        )
+        return _response.data
+
+    def resend(
+        self,
+        session_id: str,
+        *,
+        channel: TwoFactorVerificationResendRequestChannel,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ResendVerificationResponse:
+        """
+        Resends the OTP for the verification identified by `session_id` over the specified channel. Previously sent codes are invalidated.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique ID of the 2FA verification session.
+
+        channel : TwoFactorVerificationResendRequestChannel
+            Channel used to resend the verification code. One of `sms` (sent as a text message) or `voice` (read aloud over a phone call).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ResendVerificationResponse
+            Returns the resend result, including the channel used.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.two_fa.verification.resend(
+            session_id="2953d4308f2e11ecb75fcdafd6d2d687",
+            channel="sms",
+        )
+        """
+        _response = self._raw_client.resend(session_id, channel=channel, request_options=request_options)
+        return _response.data
+
+    def check(
+        self, session_id: str, *, code: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> CheckVerificationResponse:
+        """
+        Validates the OTP submitted by the end user against the verification identified by `session_id`.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique ID of the 2FA verification session.
+
+        code : str
+            The code entered by an end user
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CheckVerificationResponse
+            Returns the validation result in `is_valid`.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.two_fa.verification.check(
+            session_id="2953d4308f2e11ecb75fcdafd6d2d687",
+            code="123456",
+        )
+        """
+        _response = self._raw_client.check(session_id, code=code, request_options=request_options)
+        return _response.data
+
+    def cancel(self, session_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> SuccessResponse:
+        """
+        Cancels the 2FA verification identified by `session_id`. No further codes are sent, and previously sent codes can no longer be validated. A new verification is required to send another code.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique ID of the 2FA verification session.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The verification is canceled.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.two_fa.verification.cancel(
+            session_id="2953d4308f2e11ecb75fcdafd6d2d687",
+        )
+        """
+        _response = self._raw_client.cancel(session_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncVerificationClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawVerificationClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawVerificationClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawVerificationClient
+        """
+        return self._raw_client
+
+    async def create(
+        self, *, service_id: str, to: str, channel: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateVerificationResponse:
+        """
+        Creates a 2FA verification and sends a one-time password (OTP) to the destination phone number over the selected channel. Requires a 2FA service configured in the Wavix portal; the service is reused to generate and validate OTPs.
+
+        The verification proceeds through three steps:
+        1. Create a verification to generate and send an OTP.
+        2. Resend the OTP on the same verification if needed.
+        3. Validate the OTP through the check endpoint.
+
+        Parameters
+        ----------
+        service_id : str
+            Unique Wavix 2FA Service ID. Available on the Wavix portal.
+
+        to : str
+            End user's phone number to which the verification code will be sent. The phone number must be in E.164 format.
+
+        channel : str
+            Channel used to deliver the verification code. One of `sms` (sent as a text message) or `voice` (read aloud over a phone call).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateVerificationResponse
+            Returns the created 2FA verification.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.two_fa.verification.create(
+                service_id="7204a030201211ee9fb47d093f2f127c",
+                to="447919433768",
+                channel="sms",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            service_id=service_id, to=to, channel=channel, request_options=request_options
+        )
+        return _response.data
+
+    async def resend(
+        self,
+        session_id: str,
+        *,
+        channel: TwoFactorVerificationResendRequestChannel,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ResendVerificationResponse:
+        """
+        Resends the OTP for the verification identified by `session_id` over the specified channel. Previously sent codes are invalidated.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique ID of the 2FA verification session.
+
+        channel : TwoFactorVerificationResendRequestChannel
+            Channel used to resend the verification code. One of `sms` (sent as a text message) or `voice` (read aloud over a phone call).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ResendVerificationResponse
+            Returns the resend result, including the channel used.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.two_fa.verification.resend(
+                session_id="2953d4308f2e11ecb75fcdafd6d2d687",
+                channel="sms",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.resend(session_id, channel=channel, request_options=request_options)
+        return _response.data
+
+    async def check(
+        self, session_id: str, *, code: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> CheckVerificationResponse:
+        """
+        Validates the OTP submitted by the end user against the verification identified by `session_id`.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique ID of the 2FA verification session.
+
+        code : str
+            The code entered by an end user
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CheckVerificationResponse
+            Returns the validation result in `is_valid`.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.two_fa.verification.check(
+                session_id="2953d4308f2e11ecb75fcdafd6d2d687",
+                code="123456",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.check(session_id, code=code, request_options=request_options)
+        return _response.data
+
+    async def cancel(
+        self, session_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> SuccessResponse:
+        """
+        Cancels the 2FA verification identified by `session_id`. No further codes are sent, and previously sent codes can no longer be validated. A new verification is required to send another code.
+
+        Parameters
+        ----------
+        session_id : str
+            The unique ID of the 2FA verification session.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The verification is canceled.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.two_fa.verification.cancel(
+                session_id="2953d4308f2e11ecb75fcdafd6d2d687",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel(session_id, request_options=request_options)
+        return _response.data