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

wavix/call_recording/client.py

@@ -0,0 +1,430 @@
+# 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.call_recording_list_response import CallRecordingListResponse
+from ..types.recording import Recording
+from ..types.success_response import SuccessResponse
+from .raw_client import AsyncRawCallRecordingClient, RawCallRecordingClient
+
+
+class CallRecordingClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCallRecordingClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCallRecordingClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCallRecordingClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        from_date: typing.Optional[dt.date] = None,
+        to_date: typing.Optional[dt.date] = None,
+        from_: typing.Optional[str] = None,
+        to: typing.Optional[str] = None,
+        call_uuid: typing.Optional[str] = None,
+        sip_trunks: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CallRecordingListResponse:
+        """
+        Returns a paginated list of call recordings for the authenticated account, filtered by date range, number, call, or SIP trunk.
+
+        Parameters
+        ----------
+        from_date : typing.Optional[dt.date]
+            Start of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        to_date : typing.Optional[dt.date]
+            End of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        from_ : typing.Optional[str]
+            Filters recordings by originating phone number. Accepts a full or partial number.
+
+        to : typing.Optional[str]
+            Filters recordings by destination phone number. Accepts a full or partial number.
+
+        call_uuid : typing.Optional[str]
+            Filters recordings by the unique call ID.
+
+        sip_trunks : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Filters recordings of outbound calls placed through the listed SIP trunk logins.
+
+        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
+        -------
+        CallRecordingListResponse
+            Returns a paginated list of call recordings.
+
+        Examples
+        --------
+        import datetime
+
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_recording.list(
+            from_date=datetime.date.fromisoformat(
+                "2023-01-01",
+            ),
+            to_date=datetime.date.fromisoformat(
+                "2023-12-31",
+            ),
+            from_="123456",
+            to="1987654321",
+            call_uuid="aa566501-c591-4a8b-b3b9-cc1295398b72",
+            page=1,
+            per_page=25,
+        )
+        """
+        _response = self._raw_client.list(
+            from_date=from_date,
+            to_date=to_date,
+            from_=from_,
+            to=to,
+            call_uuid=call_uuid,
+            sip_trunks=sip_trunks,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_by_call(self, call_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Redirects to the recording file for the call identified by `call_id`. The download URL is returned in the `Location` header.
+
+        Parameters
+        ----------
+        call_id : str
+            The unique ID of the call whose recording is retrieved.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_recording.get_by_call(
+            call_id="aa566501-c591-4a8b-b3b9-cc1295398b72",
+        )
+        """
+        _response = self._raw_client.get_by_call(call_id, request_options=request_options)
+        return _response.data
+
+    def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Recording:
+        """
+        Returns the call recording identified by `id`, including its metadata and download URL.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the call recording.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Recording
+            Returns the call recording.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_recording.get(
+            id=123,
+        )
+        """
+        _response = self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> SuccessResponse:
+        """
+        Deletes the call recording identified by `id`. Deletion is permanent and removes the recording file.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the call recording.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The recording is deleted.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.call_recording.delete(
+            id=123,
+        )
+        """
+        _response = self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+
+class AsyncCallRecordingClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCallRecordingClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCallRecordingClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCallRecordingClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        from_date: typing.Optional[dt.date] = None,
+        to_date: typing.Optional[dt.date] = None,
+        from_: typing.Optional[str] = None,
+        to: typing.Optional[str] = None,
+        call_uuid: typing.Optional[str] = None,
+        sip_trunks: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CallRecordingListResponse:
+        """
+        Returns a paginated list of call recordings for the authenticated account, filtered by date range, number, call, or SIP trunk.
+
+        Parameters
+        ----------
+        from_date : typing.Optional[dt.date]
+            Start of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        to_date : typing.Optional[dt.date]
+            End of the date range to query, in `YYYY-MM-DD` format. Inclusive.
+
+        from_ : typing.Optional[str]
+            Filters recordings by originating phone number. Accepts a full or partial number.
+
+        to : typing.Optional[str]
+            Filters recordings by destination phone number. Accepts a full or partial number.
+
+        call_uuid : typing.Optional[str]
+            Filters recordings by the unique call ID.
+
+        sip_trunks : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Filters recordings of outbound calls placed through the listed SIP trunk logins.
+
+        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
+        -------
+        CallRecordingListResponse
+            Returns a paginated list of call recordings.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_recording.list(
+                from_date=datetime.date.fromisoformat(
+                    "2023-01-01",
+                ),
+                to_date=datetime.date.fromisoformat(
+                    "2023-12-31",
+                ),
+                from_="123456",
+                to="1987654321",
+                call_uuid="aa566501-c591-4a8b-b3b9-cc1295398b72",
+                page=1,
+                per_page=25,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            from_date=from_date,
+            to_date=to_date,
+            from_=from_,
+            to=to,
+            call_uuid=call_uuid,
+            sip_trunks=sip_trunks,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_by_call(self, call_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Redirects to the recording file for the call identified by `call_id`. The download URL is returned in the `Location` header.
+
+        Parameters
+        ----------
+        call_id : str
+            The unique ID of the call whose recording is retrieved.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_recording.get_by_call(
+                call_id="aa566501-c591-4a8b-b3b9-cc1295398b72",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_by_call(call_id, request_options=request_options)
+        return _response.data
+
+    async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Recording:
+        """
+        Returns the call recording identified by `id`, including its metadata and download URL.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the call recording.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Recording
+            Returns the call recording.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_recording.get(
+                id=123,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> SuccessResponse:
+        """
+        Deletes the call recording identified by `id`. Deletion is permanent and removes the recording file.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the call recording.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The recording is deleted.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.call_recording.delete(
+                id=123,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(id, request_options=request_options)
+        return _response.data