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

wavix/link_shortener/client.py

@@ -0,0 +1,194 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.short_link_response import ShortLinkResponse
+from .raw_client import AsyncRawLinkShortenerClient, RawLinkShortenerClient
+
+if typing.TYPE_CHECKING:
+    from .metrics.client import AsyncMetricsClient, MetricsClient
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class LinkShortenerClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawLinkShortenerClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._metrics: typing.Optional[MetricsClient] = None
+
+    @property
+    def with_raw_response(self) -> RawLinkShortenerClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawLinkShortenerClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        ShortLinkResponse
+            Returns the created short link.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.link_shortener.create(
+            link="https://your-site.com/long-url",
+        )
+        """
+        _response = self._raw_client.create(
+            link=link,
+            expiration_time=expiration_time,
+            fallback_url=fallback_url,
+            phone=phone,
+            utm_campaign=utm_campaign,
+            request_options=request_options,
+        )
+        return _response.data
+
+    @property
+    def metrics(self):
+        if self._metrics is None:
+            from .metrics.client import MetricsClient  # noqa: E402
+
+            self._metrics = MetricsClient(client_wrapper=self._client_wrapper)
+        return self._metrics
+
+
+class AsyncLinkShortenerClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawLinkShortenerClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._metrics: typing.Optional[AsyncMetricsClient] = None
+
+    @property
+    def with_raw_response(self) -> AsyncRawLinkShortenerClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawLinkShortenerClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        ShortLinkResponse
+            Returns the created short link.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.link_shortener.create(
+                link="https://your-site.com/long-url",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            link=link,
+            expiration_time=expiration_time,
+            fallback_url=fallback_url,
+            phone=phone,
+            utm_campaign=utm_campaign,
+            request_options=request_options,
+        )
+        return _response.data
+
+    @property
+    def metrics(self):
+        if self._metrics is None:
+            from .metrics.client import AsyncMetricsClient  # noqa: E402
+
+            self._metrics = AsyncMetricsClient(client_wrapper=self._client_wrapper)
+        return self._metrics

wavix/link_shortener/metrics/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

wavix/link_shortener/metrics/client.py

@@ -0,0 +1,198 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.short_link_metrics_response import ShortLinkMetricsResponse
+from .raw_client import AsyncRawMetricsClient, RawMetricsClient
+
+
+class MetricsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawMetricsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawMetricsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawMetricsClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        from_: dt.date,
+        to: dt.date,
+        phone: typing.Optional[str] = None,
+        utm_campaign: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ShortLinkMetricsResponse:
+        """
+        Returns per-click metrics for short links, including device, location, and campaign attribution, within the requested date range.
+
+        Parameters
+        ----------
+        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.
+
+        phone : typing.Optional[str]
+            Filters metrics by the phone number associated with the click, in E.164 format.
+
+        utm_campaign : typing.Optional[str]
+            Filters metrics by `utm_campaign` name.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ShortLinkMetricsResponse
+            Returns a paginated list of short link metrics.
+
+        Examples
+        --------
+        import datetime
+
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.link_shortener.metrics.list(
+            from_=datetime.date.fromisoformat(
+                "2023-05-01",
+            ),
+            to=datetime.date.fromisoformat(
+                "2023-05-31",
+            ),
+            phone="1872025555",
+            utm_campaign="summer",
+            page=1,
+            per_page=25,
+        )
+        """
+        _response = self._raw_client.list(
+            from_=from_,
+            to=to,
+            phone=phone,
+            utm_campaign=utm_campaign,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncMetricsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawMetricsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawMetricsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawMetricsClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        from_: dt.date,
+        to: dt.date,
+        phone: typing.Optional[str] = None,
+        utm_campaign: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ShortLinkMetricsResponse:
+        """
+        Returns per-click metrics for short links, including device, location, and campaign attribution, within the requested date range.
+
+        Parameters
+        ----------
+        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.
+
+        phone : typing.Optional[str]
+            Filters metrics by the phone number associated with the click, in E.164 format.
+
+        utm_campaign : typing.Optional[str]
+            Filters metrics by `utm_campaign` name.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ShortLinkMetricsResponse
+            Returns a paginated list of short link metrics.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.link_shortener.metrics.list(
+                from_=datetime.date.fromisoformat(
+                    "2023-05-01",
+                ),
+                to=datetime.date.fromisoformat(
+                    "2023-05-31",
+                ),
+                phone="1872025555",
+                utm_campaign="summer",
+                page=1,
+                per_page=25,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            from_=from_,
+            to=to,
+            phone=phone,
+            utm_campaign=utm_campaign,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data

wavix/link_shortener/metrics/raw_client.py

@@ -0,0 +1,218 @@
+# 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 ...types.short_link_metrics_response import ShortLinkMetricsResponse
+from pydantic import ValidationError
+
+
+class RawMetricsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        from_: dt.date,
+        to: dt.date,
+        phone: typing.Optional[str] = None,
+        utm_campaign: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[ShortLinkMetricsResponse]:
+        """
+        Returns per-click metrics for short links, including device, location, and campaign attribution, within the requested date range.
+
+        Parameters
+        ----------
+        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.
+
+        phone : typing.Optional[str]
+            Filters metrics by the phone number associated with the click, in E.164 format.
+
+        utm_campaign : typing.Optional[str]
+            Filters metrics by `utm_campaign` name.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ShortLinkMetricsResponse]
+            Returns a paginated list of short link metrics.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/short-links/metrics",
+            method="GET",
+            params={
+                "from": str(from_),
+                "to": str(to),
+                "phone": phone,
+                "utm_campaign": utm_campaign,
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ShortLinkMetricsResponse,
+                    parse_obj_as(
+                        type_=ShortLinkMetricsResponse,  # 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 AsyncRawMetricsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        from_: dt.date,
+        to: dt.date,
+        phone: typing.Optional[str] = None,
+        utm_campaign: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[ShortLinkMetricsResponse]:
+        """
+        Returns per-click metrics for short links, including device, location, and campaign attribution, within the requested date range.
+
+        Parameters
+        ----------
+        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.
+
+        phone : typing.Optional[str]
+            Filters metrics by the phone number associated with the click, in E.164 format.
+
+        utm_campaign : typing.Optional[str]
+            Filters metrics by `utm_campaign` name.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ShortLinkMetricsResponse]
+            Returns a paginated list of short link metrics.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/short-links/metrics",
+            method="GET",
+            params={
+                "from": str(from_),
+                "to": str(to),
+                "phone": phone,
+                "utm_campaign": utm_campaign,
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ShortLinkMetricsResponse,
+                    parse_obj_as(
+                        type_=ShortLinkMetricsResponse,  # 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)