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

wavix/call_control/client.py

@@ -0,0 +1,796 @@
+# 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.call_create_response import CallCreateResponse
+from ..types.call_list_response import CallListResponse
+from ..types.call_response import CallResponse
+from ..types.call_stream_channel import CallStreamChannel
+from ..types.call_stream_type import CallStreamType
+from ..types.success_response import SuccessResponse
+from .raw_client import AsyncRawCallControlClient, RawCallControlClient
+from .types.call_dtmf_collect_request_prompt import CallDtmfCollectRequestPrompt
+
+if typing.TYPE_CHECKING:
+    from .audio.client import AsyncAudioClient, AudioClient
+    from .streams.client import AsyncStreamsClient, StreamsClient
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CallControlClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCallControlClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._streams: typing.Optional[StreamsClient] = None
+        self._audio: typing.Optional[AudioClient] = None
+
+    @property
+    def with_raw_response(self) -> RawCallControlClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCallControlClient
+        """
+        return self._raw_client
+
+    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> CallListResponse:
+        """
+        Returns the calls currently in progress for the authenticated account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CallListResponse
+            Returns the list of active calls.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.list()
+        """
+        _response = self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    def create(
+        self,
+        *,
+        from_: str,
+        to: str,
+        callback_url: str,
+        recording: typing.Optional[bool] = OMIT,
+        voicemail_detection: typing.Optional[bool] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        timeout: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CallCreateResponse:
+        """
+        Places an outbound call. Returns the call with its `uuid` for tracking and control.
+
+        Parameters
+        ----------
+        from_ : str
+            Caller ID. Must be an active or verified phone number on the account.
+
+        to : str
+            Destination number in E.164 format
+
+        callback_url : str
+            The callback URL where Wavix sends the call status updates
+
+        recording : typing.Optional[bool]
+            Specifies whether to record the call
+
+        voicemail_detection : typing.Optional[bool]
+            Specifies whether the AMD is turned on for the call
+
+        tag : typing.Optional[str]
+            Call metadata
+
+        timeout : typing.Optional[int]
+            The ring timeout, in seconds, before the call is considered unanswered.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CallCreateResponse
+            Returns the created call.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.create(
+            from_="+1234567890",
+            to="+1987654321",
+            callback_url="https://examples.com/callback",
+        )
+        """
+        _response = self._raw_client.create(
+            from_=from_,
+            to=to,
+            callback_url=callback_url,
+            recording=recording,
+            voicemail_detection=voicemail_detection,
+            tag=tag,
+            timeout=timeout,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> CallResponse:
+        """
+        Returns the call identified by `id`, including its current event and timestamps.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CallResponse
+            Returns the call.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.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) -> SuccessResponse:
+        """
+        Ends the active call identified by `id` by hanging up.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The call is ended.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.delete(
+            id="id",
+        )
+        """
+        _response = self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+    def update(self, id: str, *, tag: str, request_options: typing.Optional[RequestOptions] = None) -> SuccessResponse:
+        """
+        Updates the active call identified by `id`. Only the `tag` field can be changed.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        tag : str
+            User-defined label attached to the Call for tracking or reporting.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The call `tag` is updated.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.update(
+            id="id",
+            tag="marketing-campaign",
+        )
+        """
+        _response = self._raw_client.update(id, tag=tag, request_options=request_options)
+        return _response.data
+
+    def answer(
+        self,
+        id: str,
+        *,
+        call_recording: typing.Optional[bool] = OMIT,
+        call_transcription: typing.Optional[bool] = OMIT,
+        stream_url: typing.Optional[str] = OMIT,
+        stream_type: typing.Optional[CallStreamType] = OMIT,
+        stream_channel: typing.Optional[CallStreamChannel] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SuccessResponse:
+        """
+        Answers the inbound call identified by `id`. Optionally starts media streaming on answer.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        call_recording : typing.Optional[bool]
+            Indicates whether the call should be recorded.
+
+        call_transcription : typing.Optional[bool]
+            Indicates whether the call should be transcribed after it ends.
+
+        stream_url : typing.Optional[str]
+            WebSocket URL to stream the call.
+
+        stream_type : typing.Optional[CallStreamType]
+            Direction of audio streamed to `stream_url`.
+
+        stream_channel : typing.Optional[CallStreamChannel]
+            Audio channel streamed to `stream_url`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The call is answered.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.answer(
+            id="id",
+        )
+        """
+        _response = self._raw_client.answer(
+            id,
+            call_recording=call_recording,
+            call_transcription=call_transcription,
+            stream_url=stream_url,
+            stream_type=stream_type,
+            stream_channel=stream_channel,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def collect(
+        self,
+        id: str,
+        *,
+        max_digits: typing.Optional[int] = OMIT,
+        timeout: typing.Optional[int] = OMIT,
+        termination_character: typing.Optional[str] = OMIT,
+        max_attempts: typing.Optional[int] = OMIT,
+        prompt: typing.Optional[CallDtmfCollectRequestPrompt] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SuccessResponse:
+        """
+        Collects DTMF keypad input from the caller on the active call identified by `id`.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        max_digits : typing.Optional[int]
+            Maximum number of digits to collect.
+
+        timeout : typing.Optional[int]
+            Timeout for digit collection in seconds.
+
+        termination_character : typing.Optional[str]
+            DTMF character that ends input collection.
+
+        max_attempts : typing.Optional[int]
+            Maximum number of attempts.
+
+        prompt : typing.Optional[CallDtmfCollectRequestPrompt]
+            Prompt to play before collecting digits.
+             Play a prerecorded audio file or use Wavix Text-To-Speech.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. DTMF collection starts.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_control.collect(
+            id="id",
+        )
+        """
+        _response = self._raw_client.collect(
+            id,
+            max_digits=max_digits,
+            timeout=timeout,
+            termination_character=termination_character,
+            max_attempts=max_attempts,
+            prompt=prompt,
+            request_options=request_options,
+        )
+        return _response.data
+
+    @property
+    def streams(self):
+        if self._streams is None:
+            from .streams.client import StreamsClient  # noqa: E402
+
+            self._streams = StreamsClient(client_wrapper=self._client_wrapper)
+        return self._streams
+
+    @property
+    def audio(self):
+        if self._audio is None:
+            from .audio.client import AudioClient  # noqa: E402
+
+            self._audio = AudioClient(client_wrapper=self._client_wrapper)
+        return self._audio
+
+
+class AsyncCallControlClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCallControlClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._streams: typing.Optional[AsyncStreamsClient] = None
+        self._audio: typing.Optional[AsyncAudioClient] = None
+
+    @property
+    def with_raw_response(self) -> AsyncRawCallControlClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCallControlClient
+        """
+        return self._raw_client
+
+    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> CallListResponse:
+        """
+        Returns the calls currently in progress for the authenticated account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CallListResponse
+            Returns the list of active calls.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        from_: str,
+        to: str,
+        callback_url: str,
+        recording: typing.Optional[bool] = OMIT,
+        voicemail_detection: typing.Optional[bool] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        timeout: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CallCreateResponse:
+        """
+        Places an outbound call. Returns the call with its `uuid` for tracking and control.
+
+        Parameters
+        ----------
+        from_ : str
+            Caller ID. Must be an active or verified phone number on the account.
+
+        to : str
+            Destination number in E.164 format
+
+        callback_url : str
+            The callback URL where Wavix sends the call status updates
+
+        recording : typing.Optional[bool]
+            Specifies whether to record the call
+
+        voicemail_detection : typing.Optional[bool]
+            Specifies whether the AMD is turned on for the call
+
+        tag : typing.Optional[str]
+            Call metadata
+
+        timeout : typing.Optional[int]
+            The ring timeout, in seconds, before the call is considered unanswered.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CallCreateResponse
+            Returns the created call.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.create(
+                from_="+1234567890",
+                to="+1987654321",
+                callback_url="https://examples.com/callback",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            from_=from_,
+            to=to,
+            callback_url=callback_url,
+            recording=recording,
+            voicemail_detection=voicemail_detection,
+            tag=tag,
+            timeout=timeout,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> CallResponse:
+        """
+        Returns the call identified by `id`, including its current event and timestamps.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CallResponse
+            Returns the call.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.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) -> SuccessResponse:
+        """
+        Ends the active call identified by `id` by hanging up.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The call is ended.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.delete(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self, id: str, *, tag: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> SuccessResponse:
+        """
+        Updates the active call identified by `id`. Only the `tag` field can be changed.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        tag : str
+            User-defined label attached to the Call for tracking or reporting.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The call `tag` is updated.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.update(
+                id="id",
+                tag="marketing-campaign",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(id, tag=tag, request_options=request_options)
+        return _response.data
+
+    async def answer(
+        self,
+        id: str,
+        *,
+        call_recording: typing.Optional[bool] = OMIT,
+        call_transcription: typing.Optional[bool] = OMIT,
+        stream_url: typing.Optional[str] = OMIT,
+        stream_type: typing.Optional[CallStreamType] = OMIT,
+        stream_channel: typing.Optional[CallStreamChannel] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SuccessResponse:
+        """
+        Answers the inbound call identified by `id`. Optionally starts media streaming on answer.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        call_recording : typing.Optional[bool]
+            Indicates whether the call should be recorded.
+
+        call_transcription : typing.Optional[bool]
+            Indicates whether the call should be transcribed after it ends.
+
+        stream_url : typing.Optional[str]
+            WebSocket URL to stream the call.
+
+        stream_type : typing.Optional[CallStreamType]
+            Direction of audio streamed to `stream_url`.
+
+        stream_channel : typing.Optional[CallStreamChannel]
+            Audio channel streamed to `stream_url`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The call is answered.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.answer(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.answer(
+            id,
+            call_recording=call_recording,
+            call_transcription=call_transcription,
+            stream_url=stream_url,
+            stream_type=stream_type,
+            stream_channel=stream_channel,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def collect(
+        self,
+        id: str,
+        *,
+        max_digits: typing.Optional[int] = OMIT,
+        timeout: typing.Optional[int] = OMIT,
+        termination_character: typing.Optional[str] = OMIT,
+        max_attempts: typing.Optional[int] = OMIT,
+        prompt: typing.Optional[CallDtmfCollectRequestPrompt] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SuccessResponse:
+        """
+        Collects DTMF keypad input from the caller on the active call identified by `id`.
+
+        Parameters
+        ----------
+        id : str
+            The `uuid` of the call.
+
+        max_digits : typing.Optional[int]
+            Maximum number of digits to collect.
+
+        timeout : typing.Optional[int]
+            Timeout for digit collection in seconds.
+
+        termination_character : typing.Optional[str]
+            DTMF character that ends input collection.
+
+        max_attempts : typing.Optional[int]
+            Maximum number of attempts.
+
+        prompt : typing.Optional[CallDtmfCollectRequestPrompt]
+            Prompt to play before collecting digits.
+             Play a prerecorded audio file or use Wavix Text-To-Speech.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. DTMF collection starts.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_control.collect(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.collect(
+            id,
+            max_digits=max_digits,
+            timeout=timeout,
+            termination_character=termination_character,
+            max_attempts=max_attempts,
+            prompt=prompt,
+            request_options=request_options,
+        )
+        return _response.data
+
+    @property
+    def streams(self):
+        if self._streams is None:
+            from .streams.client import AsyncStreamsClient  # noqa: E402
+
+            self._streams = AsyncStreamsClient(client_wrapper=self._client_wrapper)
+        return self._streams
+
+    @property
+    def audio(self):
+        if self._audio is None:
+            from .audio.client import AsyncAudioClient  # noqa: E402
+
+            self._audio = AsyncAudioClient(client_wrapper=self._client_wrapper)
+        return self._audio