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

wavix/sms_and_mms/messages/client.py

@@ -0,0 +1,625 @@
+# 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.message_body import MessageBody
+from ...types.message_delivery_status import MessageDeliveryStatus
+from ...types.send_messages_response import SendMessagesResponse
+from .raw_client import AsyncRawMessagesClient, RawMessagesClient
+from .types.get_messages_response import GetMessagesResponse
+from .types.list_all_messages_request_message_type import ListAllMessagesRequestMessageType
+from .types.list_messages_request_message_type import ListMessagesRequestMessageType
+from .types.list_messages_response import ListMessagesResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class MessagesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawMessagesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawMessagesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawMessagesClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        type: str,
+        sent_after: typing.Optional[str] = None,
+        sent_before: typing.Optional[str] = None,
+        from_: typing.Optional[str] = None,
+        to: typing.Optional[str] = None,
+        status: typing.Optional[MessageDeliveryStatus] = None,
+        tag: typing.Optional[str] = None,
+        message_type: typing.Optional[ListMessagesRequestMessageType] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListMessagesResponse:
+        """
+        Returns a paginated list of SMS and MMS messages for the authenticated account, filtered by direction, date, and other criteria.
+
+        Parameters
+        ----------
+        type : str
+            Filters messages by direction. One of `inbound` (messages received by the account) or `outbound` (messages sent by the account).
+
+        sent_after : typing.Optional[str]
+            Returns messages sent on or after this date, in `YYYY-MM-DD` format.
+
+        sent_before : typing.Optional[str]
+            Returns messages sent on or before this date, in `YYYY-MM-DD` format.
+
+        from_ : typing.Optional[str]
+            Filters by message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number.
+
+        to : typing.Optional[str]
+            Filters by message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, an SMS-enabled number on the Wavix platform.
+
+        status : typing.Optional[MessageDeliveryStatus]
+            Filters messages by delivery status. Accepts a `MessageDeliveryStatus` value.
+
+        tag : typing.Optional[str]
+            Filters messages by `tag`. Supported for outbound messages only.
+
+        message_type : typing.Optional[ListMessagesRequestMessageType]
+            Filters messages by type. One of `sms` (text message) or `mms` (multimedia message).
+
+        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
+        -------
+        ListMessagesResponse
+            Returns a paginated list of messages.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.messages.list(
+            sent_after="2023-04-10",
+            sent_before="2023-04-13",
+            type="outbound",
+            from_="15072429497",
+            to="16419252149",
+            tag="campaignX",
+            page=2,
+            per_page=50,
+        )
+        """
+        _response = self._raw_client.list(
+            type=type,
+            sent_after=sent_after,
+            sent_before=sent_before,
+            from_=from_,
+            to=to,
+            status=status,
+            tag=tag,
+            message_type=message_type,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def send(
+        self,
+        *,
+        from_: str,
+        to: str,
+        message_body: MessageBody,
+        callback_url: typing.Optional[str] = OMIT,
+        validity: typing.Optional[int] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SendMessagesResponse:
+        """
+        Sends an SMS or MMS message. MMS is supported for U.S. numbers only. Track delivery using the returned `message_id` and the message status callback.
+        **Rate limit**: 20 messages per phone number in 24 hours.
+
+        Parameters
+        ----------
+        from_ : str
+            Sender ID. Numeric or alphanumeric.
+
+        to : str
+            Recipient phone number.
+
+        message_body : MessageBody
+
+        callback_url : typing.Optional[str]
+            Callback URL for delivery reports.
+
+        validity : typing.Optional[int]
+            Message validity period in seconds. Delivery attempts stop after this period expires.
+
+        tag : typing.Optional[str]
+            Tag to group messages, such as for a specific campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SendMessagesResponse
+            Returns the submitted message with its `message_id` and initial status.
+
+        Examples
+        --------
+        from wavix import MessageBody, Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.messages.send(
+            from_="Wavix",
+            to="+447537151866",
+            message_body=MessageBody(
+                text="Hi there, this is a message from Wavix",
+            ),
+            callback_url="https://you-site.com/webhook",
+            validity=3600,
+            tag="Fall sale",
+        )
+        """
+        _response = self._raw_client.send(
+            from_=from_,
+            to=to,
+            message_body=message_body,
+            callback_url=callback_url,
+            validity=validity,
+            tag=tag,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetMessagesResponse:
+        """
+        Returns the SMS or MMS message identified by `id`, including its delivery status and content.
+
+        Parameters
+        ----------
+        id : str
+            The unique ID of the message.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetMessagesResponse
+            Returns the message.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.messages.get(
+            id="3a525ca2-6909-4c72-9399-905adf7f3a74",
+        )
+        """
+        _response = self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    def list_all(
+        self,
+        *,
+        type: str,
+        sent_after: typing.Optional[str] = None,
+        sent_before: typing.Optional[str] = None,
+        from_: typing.Optional[str] = None,
+        to: typing.Optional[str] = None,
+        status: typing.Optional[MessageDeliveryStatus] = None,
+        tag: typing.Optional[str] = None,
+        message_type: typing.Optional[ListAllMessagesRequestMessageType] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> str:
+        """
+        Streams matching SMS and MMS messages as newline-delimited JSON (NDJSON), one message per line, for bulk export.
+
+        Parameters
+        ----------
+        type : str
+            Filters messages by direction. One of `inbound` (messages received by the account) or `outbound` (messages sent by the account).
+
+        sent_after : typing.Optional[str]
+            Returns messages sent on or after this timestamp, in `YYYY-MM-DDTHH:MM:SS` format.
+
+        sent_before : typing.Optional[str]
+            Returns messages sent on or before this timestamp, in `YYYY-MM-DDTHH:MM:SS` format.
+
+        from_ : typing.Optional[str]
+            Filters by message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number.
+
+        to : typing.Optional[str]
+            Filters by message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, the SMS-enabled number that received the message.
+
+        status : typing.Optional[MessageDeliveryStatus]
+            Filters messages by delivery status. Accepts a `MessageDeliveryStatus` value.
+
+        tag : typing.Optional[str]
+            Filters messages by `tag`. Supported for outbound messages only.
+
+        message_type : typing.Optional[ListAllMessagesRequestMessageType]
+            Filters messages by type. One of `sms` (text message) or `mms` (multimedia message).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        str
+            Returns an NDJSON stream of messages, one per line.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.messages.list_all(
+            sent_after="2023-04-10T00:00:00",
+            sent_before="2023-04-13T23:59:59",
+            type="outbound",
+            from_="15072429497",
+            to="16419252149",
+            tag="campaignX",
+        )
+        """
+        _response = self._raw_client.list_all(
+            type=type,
+            sent_after=sent_after,
+            sent_before=sent_before,
+            from_=from_,
+            to=to,
+            status=status,
+            tag=tag,
+            message_type=message_type,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncMessagesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawMessagesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawMessagesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawMessagesClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        type: str,
+        sent_after: typing.Optional[str] = None,
+        sent_before: typing.Optional[str] = None,
+        from_: typing.Optional[str] = None,
+        to: typing.Optional[str] = None,
+        status: typing.Optional[MessageDeliveryStatus] = None,
+        tag: typing.Optional[str] = None,
+        message_type: typing.Optional[ListMessagesRequestMessageType] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListMessagesResponse:
+        """
+        Returns a paginated list of SMS and MMS messages for the authenticated account, filtered by direction, date, and other criteria.
+
+        Parameters
+        ----------
+        type : str
+            Filters messages by direction. One of `inbound` (messages received by the account) or `outbound` (messages sent by the account).
+
+        sent_after : typing.Optional[str]
+            Returns messages sent on or after this date, in `YYYY-MM-DD` format.
+
+        sent_before : typing.Optional[str]
+            Returns messages sent on or before this date, in `YYYY-MM-DD` format.
+
+        from_ : typing.Optional[str]
+            Filters by message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number.
+
+        to : typing.Optional[str]
+            Filters by message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, an SMS-enabled number on the Wavix platform.
+
+        status : typing.Optional[MessageDeliveryStatus]
+            Filters messages by delivery status. Accepts a `MessageDeliveryStatus` value.
+
+        tag : typing.Optional[str]
+            Filters messages by `tag`. Supported for outbound messages only.
+
+        message_type : typing.Optional[ListMessagesRequestMessageType]
+            Filters messages by type. One of `sms` (text message) or `mms` (multimedia message).
+
+        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
+        -------
+        ListMessagesResponse
+            Returns a paginated list of messages.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.messages.list(
+                sent_after="2023-04-10",
+                sent_before="2023-04-13",
+                type="outbound",
+                from_="15072429497",
+                to="16419252149",
+                tag="campaignX",
+                page=2,
+                per_page=50,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            type=type,
+            sent_after=sent_after,
+            sent_before=sent_before,
+            from_=from_,
+            to=to,
+            status=status,
+            tag=tag,
+            message_type=message_type,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def send(
+        self,
+        *,
+        from_: str,
+        to: str,
+        message_body: MessageBody,
+        callback_url: typing.Optional[str] = OMIT,
+        validity: typing.Optional[int] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SendMessagesResponse:
+        """
+        Sends an SMS or MMS message. MMS is supported for U.S. numbers only. Track delivery using the returned `message_id` and the message status callback.
+        **Rate limit**: 20 messages per phone number in 24 hours.
+
+        Parameters
+        ----------
+        from_ : str
+            Sender ID. Numeric or alphanumeric.
+
+        to : str
+            Recipient phone number.
+
+        message_body : MessageBody
+
+        callback_url : typing.Optional[str]
+            Callback URL for delivery reports.
+
+        validity : typing.Optional[int]
+            Message validity period in seconds. Delivery attempts stop after this period expires.
+
+        tag : typing.Optional[str]
+            Tag to group messages, such as for a specific campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SendMessagesResponse
+            Returns the submitted message with its `message_id` and initial status.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix, MessageBody
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.messages.send(
+                from_="Wavix",
+                to="+447537151866",
+                message_body=MessageBody(
+                    text="Hi there, this is a message from Wavix",
+                ),
+                callback_url="https://you-site.com/webhook",
+                validity=3600,
+                tag="Fall sale",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.send(
+            from_=from_,
+            to=to,
+            message_body=message_body,
+            callback_url=callback_url,
+            validity=validity,
+            tag=tag,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetMessagesResponse:
+        """
+        Returns the SMS or MMS message identified by `id`, including its delivery status and content.
+
+        Parameters
+        ----------
+        id : str
+            The unique ID of the message.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetMessagesResponse
+            Returns the message.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.messages.get(
+                id="3a525ca2-6909-4c72-9399-905adf7f3a74",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    async def list_all(
+        self,
+        *,
+        type: str,
+        sent_after: typing.Optional[str] = None,
+        sent_before: typing.Optional[str] = None,
+        from_: typing.Optional[str] = None,
+        to: typing.Optional[str] = None,
+        status: typing.Optional[MessageDeliveryStatus] = None,
+        tag: typing.Optional[str] = None,
+        message_type: typing.Optional[ListAllMessagesRequestMessageType] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> str:
+        """
+        Streams matching SMS and MMS messages as newline-delimited JSON (NDJSON), one message per line, for bulk export.
+
+        Parameters
+        ----------
+        type : str
+            Filters messages by direction. One of `inbound` (messages received by the account) or `outbound` (messages sent by the account).
+
+        sent_after : typing.Optional[str]
+            Returns messages sent on or after this timestamp, in `YYYY-MM-DDTHH:MM:SS` format.
+
+        sent_before : typing.Optional[str]
+            Returns messages sent on or before this timestamp, in `YYYY-MM-DDTHH:MM:SS` format.
+
+        from_ : typing.Optional[str]
+            Filters by message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number.
+
+        to : typing.Optional[str]
+            Filters by message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, the SMS-enabled number that received the message.
+
+        status : typing.Optional[MessageDeliveryStatus]
+            Filters messages by delivery status. Accepts a `MessageDeliveryStatus` value.
+
+        tag : typing.Optional[str]
+            Filters messages by `tag`. Supported for outbound messages only.
+
+        message_type : typing.Optional[ListAllMessagesRequestMessageType]
+            Filters messages by type. One of `sms` (text message) or `mms` (multimedia message).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        str
+            Returns an NDJSON stream of messages, one per line.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.messages.list_all(
+                sent_after="2023-04-10T00:00:00",
+                sent_before="2023-04-13T23:59:59",
+                type="outbound",
+                from_="15072429497",
+                to="16419252149",
+                tag="campaignX",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_all(
+            type=type,
+            sent_after=sent_after,
+            sent_before=sent_before,
+            from_=from_,
+            to=to,
+            status=status,
+            tag=tag,
+            message_type=message_type,
+            request_options=request_options,
+        )
+        return _response.data