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

wavix/link_shortener/raw_client.py

@@ -0,0 +1,265 @@
+# 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.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 ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.short_link_response import ShortLinkResponse
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawLinkShortenerClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self,
+        *,
+        link: str,
+        expiration_time: typing.Optional[dt.datetime] = OMIT,
+        fallback_url: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        utm_campaign: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[ShortLinkResponse]:
+        """
+        Creates a short link that redirects to the target URL and tracks click metrics.
+
+        Parameters
+        ----------
+        link : str
+            Target URL to shorten.
+
+        expiration_time : typing.Optional[dt.datetime]
+            Expiration date and time in ISO 8601 format.
+
+        fallback_url : typing.Optional[str]
+            Fallback URL for expired or invalid links.
+
+        phone : typing.Optional[str]
+            Phone number for the short link.
+
+        utm_campaign : typing.Optional[str]
+            UTM campaign name for tracking insights.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ShortLinkResponse]
+            Returns the created short link.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/short-links",
+            method="POST",
+            json={
+                "link": link,
+                "expiration_time": expiration_time,
+                "fallback_url": fallback_url,
+                "phone": phone,
+                "utm_campaign": utm_campaign,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ShortLinkResponse,
+                    parse_obj_as(
+                        type_=ShortLinkResponse,  # 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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    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 AsyncRawLinkShortenerClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self,
+        *,
+        link: str,
+        expiration_time: typing.Optional[dt.datetime] = OMIT,
+        fallback_url: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        utm_campaign: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[ShortLinkResponse]:
+        """
+        Creates a short link that redirects to the target URL and tracks click metrics.
+
+        Parameters
+        ----------
+        link : str
+            Target URL to shorten.
+
+        expiration_time : typing.Optional[dt.datetime]
+            Expiration date and time in ISO 8601 format.
+
+        fallback_url : typing.Optional[str]
+            Fallback URL for expired or invalid links.
+
+        phone : typing.Optional[str]
+            Phone number for the short link.
+
+        utm_campaign : typing.Optional[str]
+            UTM campaign name for tracking insights.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ShortLinkResponse]
+            Returns the created short link.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/short-links",
+            method="POST",
+            json={
+                "link": link,
+                "expiration_time": expiration_time,
+                "fallback_url": fallback_url,
+                "phone": phone,
+                "utm_campaign": utm_campaign,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ShortLinkResponse,
+                    parse_obj_as(
+                        type_=ShortLinkResponse,  # 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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    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/number_validator/__init__.py

@@ -0,0 +1,35 @@
+# 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 GetNumberValidatorResponse
+    from . import results
+_dynamic_imports: typing.Dict[str, str] = {"GetNumberValidatorResponse": ".types", "results": ".results"}
+
+
+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__ = ["GetNumberValidatorResponse", "results"]

wavix/number_validator/client.py

@@ -0,0 +1,271 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.number_validator_create_bulk_response import NumberValidatorCreateBulkResponse
+from ..types.phone_number_validation_type import PhoneNumberValidationType
+from .raw_client import AsyncRawNumberValidatorClient, RawNumberValidatorClient
+from .types.get_number_validator_response import GetNumberValidatorResponse
+
+if typing.TYPE_CHECKING:
+    from .results.client import AsyncResultsClient, ResultsClient
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class NumberValidatorClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawNumberValidatorClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._results: typing.Optional[ResultsClient] = None
+
+    @property
+    def with_raw_response(self) -> RawNumberValidatorClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawNumberValidatorClient
+        """
+        return self._raw_client
+
+    def get(
+        self,
+        *,
+        phone_number: str,
+        type: PhoneNumberValidationType,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetNumberValidatorResponse:
+        """
+        Validates a single phone number and returns line type, carrier, portability, and reachability details.
+
+        Parameters
+        ----------
+        phone_number : str
+            The phone number to validate, in E.164 format with or without the leading `+`.
+
+        type : PhoneNumberValidationType
+            Depth of validation to perform. Accepts a `PhoneNumberValidationType` value.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetNumberValidatorResponse
+            Returns the phone number validation details.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.number_validator.get(
+            phone_number="971569483322",
+            type="format",
+        )
+        """
+        _response = self._raw_client.get(phone_number=phone_number, type=type, request_options=request_options)
+        return _response.data
+
+    def create_bulk(
+        self,
+        *,
+        phone_numbers: typing.Sequence[str],
+        type: PhoneNumberValidationType,
+        async_: bool,
+        force: bool,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NumberValidatorCreateBulkResponse:
+        """
+        Validates a batch of phone numbers. When `async` is `true`, returns a `request_id` to poll for results instead of the validation details.
+
+        Parameters
+        ----------
+        phone_numbers : typing.Sequence[str]
+            List of phone numbers to get detailed information about.
+
+        type : PhoneNumberValidationType
+
+        async_ : bool
+            Indicates whether the request should be executed asynchronously. If `true`, the response will include a `request_uuid` that can be used to poll for results. If `false`, the response will include validation results directly.
+
+        force : bool
+            Indicates whether to force a fresh validation instead of returning a previously cached result.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NumberValidatorCreateBulkResponse
+            Returns the validation results, or a `request_id` when validation is asynchronous.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.number_validator.create_bulk(
+            phone_numbers=["971501390098", "971504359195"],
+            type="format",
+            async_=True,
+            force=True,
+        )
+        """
+        _response = self._raw_client.create_bulk(
+            phone_numbers=phone_numbers, type=type, async_=async_, force=force, request_options=request_options
+        )
+        return _response.data
+
+    @property
+    def results(self):
+        if self._results is None:
+            from .results.client import ResultsClient  # noqa: E402
+
+            self._results = ResultsClient(client_wrapper=self._client_wrapper)
+        return self._results
+
+
+class AsyncNumberValidatorClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawNumberValidatorClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._results: typing.Optional[AsyncResultsClient] = None
+
+    @property
+    def with_raw_response(self) -> AsyncRawNumberValidatorClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawNumberValidatorClient
+        """
+        return self._raw_client
+
+    async def get(
+        self,
+        *,
+        phone_number: str,
+        type: PhoneNumberValidationType,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetNumberValidatorResponse:
+        """
+        Validates a single phone number and returns line type, carrier, portability, and reachability details.
+
+        Parameters
+        ----------
+        phone_number : str
+            The phone number to validate, in E.164 format with or without the leading `+`.
+
+        type : PhoneNumberValidationType
+            Depth of validation to perform. Accepts a `PhoneNumberValidationType` value.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetNumberValidatorResponse
+            Returns the phone number validation details.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.number_validator.get(
+                phone_number="971569483322",
+                type="format",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(phone_number=phone_number, type=type, request_options=request_options)
+        return _response.data
+
+    async def create_bulk(
+        self,
+        *,
+        phone_numbers: typing.Sequence[str],
+        type: PhoneNumberValidationType,
+        async_: bool,
+        force: bool,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NumberValidatorCreateBulkResponse:
+        """
+        Validates a batch of phone numbers. When `async` is `true`, returns a `request_id` to poll for results instead of the validation details.
+
+        Parameters
+        ----------
+        phone_numbers : typing.Sequence[str]
+            List of phone numbers to get detailed information about.
+
+        type : PhoneNumberValidationType
+
+        async_ : bool
+            Indicates whether the request should be executed asynchronously. If `true`, the response will include a `request_uuid` that can be used to poll for results. If `false`, the response will include validation results directly.
+
+        force : bool
+            Indicates whether to force a fresh validation instead of returning a previously cached result.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NumberValidatorCreateBulkResponse
+            Returns the validation results, or a `request_id` when validation is asynchronous.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.number_validator.create_bulk(
+                phone_numbers=["971501390098", "971504359195"],
+                type="format",
+                async_=True,
+                force=True,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_bulk(
+            phone_numbers=phone_numbers, type=type, async_=async_, force=force, request_options=request_options
+        )
+        return _response.data
+
+    @property
+    def results(self):
+        if self._results is None:
+            from .results.client import AsyncResultsClient  # noqa: E402
+
+            self._results = AsyncResultsClient(client_wrapper=self._client_wrapper)
+        return self._results