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

wavix/sms_and_mms/sender_ids/client.py

@@ -0,0 +1,391 @@
+# 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.sender_id_details import SenderIdDetails
+from ...types.sender_id_list_response import SenderIdListResponse
+from ...types.sender_id_response import SenderIdResponse
+from ...types.sender_id_type import SenderIdType
+from .raw_client import AsyncRawSenderIdsClient, RawSenderIdsClient
+from .types.delete_sender_ids_response import DeleteSenderIdsResponse
+from .types.sender_id_create_request_monthly_volume import SenderIdCreateRequestMonthlyVolume
+from .types.sender_id_create_request_usecase import SenderIdCreateRequestUsecase
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SenderIdsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSenderIdsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSenderIdsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSenderIdsClient
+        """
+        return self._raw_client
+
+    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> SenderIdListResponse:
+        """
+        Returns the Sender IDs registered for the authenticated account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SenderIdListResponse
+            Returns the list of Sender IDs.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.sender_ids.list()
+        """
+        _response = self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    def create(
+        self,
+        *,
+        sender_id: str,
+        type: SenderIdType,
+        countries: typing.Sequence[str],
+        usecase: SenderIdCreateRequestUsecase,
+        monthly_volume: typing.Optional[SenderIdCreateRequestMonthlyVolume] = OMIT,
+        samples: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SenderIdDetails:
+        """
+        Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
+
+        Parameters
+        ----------
+        sender_id : str
+            Sender ID name. Can be either an alphanumeric string or a  phone number.
+
+        type : SenderIdType
+
+        countries : typing.Sequence[str]
+            Two-letter ISO country codes where the Sender ID is allowlisted.
+
+        usecase : SenderIdCreateRequestUsecase
+            Primary use case for the Sender ID. One of `transactional` (account or order notifications), `promo` (marketing and promotional messages), or `authentication` (one-time passcodes and verification codes).
+
+        monthly_volume : typing.Optional[SenderIdCreateRequestMonthlyVolume]
+            Expected number of messages sent per month from the Sender ID. One of `1-1000`, `1001-20000`, `20001-50000`, `50001-100000`, or `More than 100000`. Each value is the message-count band for the month.
+
+        samples : typing.Optional[typing.Sequence[str]]
+            Message samples.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SenderIdDetails
+            Returns the created Sender ID.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.sender_ids.create(
+            sender_id="Wavix",
+            type="numeric",
+            countries=["countries"],
+            usecase="transactional",
+        )
+        """
+        _response = self._raw_client.create(
+            sender_id=sender_id,
+            type=type,
+            countries=countries,
+            usecase=usecase,
+            monthly_volume=monthly_volume,
+            samples=samples,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> SenderIdResponse:
+        """
+        Returns the Sender ID identified by `id`.
+
+        Parameters
+        ----------
+        id : str
+            The unique ID of the Sender ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SenderIdResponse
+            Returns the Sender ID.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.sender_ids.get(
+            id="id",
+        )
+        """
+        _response = self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteSenderIdsResponse:
+        """
+        Deletes the Sender ID identified by `id`. Deletion is permanent.
+
+        Parameters
+        ----------
+        id : str
+            The unique ID of the Sender ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteSenderIdsResponse
+            Returns a success confirmation. The Sender ID is deleted.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.sender_ids.delete(
+            id="fc34ba88-1eee-476e-b09e-dae63dc441e0",
+        )
+        """
+        _response = self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+
+class AsyncSenderIdsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSenderIdsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSenderIdsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSenderIdsClient
+        """
+        return self._raw_client
+
+    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> SenderIdListResponse:
+        """
+        Returns the Sender IDs registered for the authenticated account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SenderIdListResponse
+            Returns the list of Sender IDs.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.sender_ids.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        sender_id: str,
+        type: SenderIdType,
+        countries: typing.Sequence[str],
+        usecase: SenderIdCreateRequestUsecase,
+        monthly_volume: typing.Optional[SenderIdCreateRequestMonthlyVolume] = OMIT,
+        samples: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SenderIdDetails:
+        """
+        Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
+
+        Parameters
+        ----------
+        sender_id : str
+            Sender ID name. Can be either an alphanumeric string or a  phone number.
+
+        type : SenderIdType
+
+        countries : typing.Sequence[str]
+            Two-letter ISO country codes where the Sender ID is allowlisted.
+
+        usecase : SenderIdCreateRequestUsecase
+            Primary use case for the Sender ID. One of `transactional` (account or order notifications), `promo` (marketing and promotional messages), or `authentication` (one-time passcodes and verification codes).
+
+        monthly_volume : typing.Optional[SenderIdCreateRequestMonthlyVolume]
+            Expected number of messages sent per month from the Sender ID. One of `1-1000`, `1001-20000`, `20001-50000`, `50001-100000`, or `More than 100000`. Each value is the message-count band for the month.
+
+        samples : typing.Optional[typing.Sequence[str]]
+            Message samples.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SenderIdDetails
+            Returns the created Sender ID.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.sender_ids.create(
+                sender_id="Wavix",
+                type="numeric",
+                countries=["countries"],
+                usecase="transactional",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            sender_id=sender_id,
+            type=type,
+            countries=countries,
+            usecase=usecase,
+            monthly_volume=monthly_volume,
+            samples=samples,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> SenderIdResponse:
+        """
+        Returns the Sender ID identified by `id`.
+
+        Parameters
+        ----------
+        id : str
+            The unique ID of the Sender ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SenderIdResponse
+            Returns the Sender ID.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.sender_ids.get(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    async def delete(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteSenderIdsResponse:
+        """
+        Deletes the Sender ID identified by `id`. Deletion is permanent.
+
+        Parameters
+        ----------
+        id : str
+            The unique ID of the Sender ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteSenderIdsResponse
+            Returns a success confirmation. The Sender ID is deleted.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.sender_ids.delete(
+                id="fc34ba88-1eee-476e-b09e-dae63dc441e0",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(id, request_options=request_options)
+        return _response.data