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

wavix/numbers/client.py

@@ -0,0 +1,689 @@
+# 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.number import Number
+from ..types.number_destination import NumberDestination
+from ..types.number_list_response import NumberListResponse
+from .raw_client import AsyncRawNumbersClient, RawNumbersClient
+from .types.bulk_update_numbers_response import BulkUpdateNumbersResponse
+from .types.delete_numbers_response import DeleteNumbersResponse
+
+if typing.TYPE_CHECKING:
+    from .papers.client import AsyncPapersClient, PapersClient
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class NumbersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawNumbersClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._papers: typing.Optional[PapersClient] = None
+
+    @property
+    def with_raw_response(self) -> RawNumbersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawNumbersClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        city_id: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
+        label: typing.Optional[str] = None,
+        label_present: typing.Optional[bool] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NumberListResponse:
+        """
+        Returns a paginated list of the phone numbers owned by the authenticated account.
+
+        Parameters
+        ----------
+        city_id : typing.Optional[int]
+            Filters numbers by the ID of their city or rate center.
+
+        search : typing.Optional[str]
+            Filters numbers by a full or partial phone number.
+
+        label : typing.Optional[str]
+            Filters numbers by `label`.
+
+        label_present : typing.Optional[bool]
+            When `true`, returns only numbers that have a label; when `false`, only numbers without one.
+
+        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
+        -------
+        NumberListResponse
+            Returns a paginated list of phone numbers.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.numbers.list(
+            city_id=123,
+            search="256537",
+            label="ALEX",
+            label_present=True,
+            page=2,
+            per_page=50,
+        )
+        """
+        _response = self._raw_client.list(
+            city_id=city_id,
+            search=search,
+            label=label,
+            label_present=label_present,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete(
+        self,
+        *,
+        ids: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
+        dids: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DeleteNumbersResponse:
+        """
+        Releases the listed phone numbers back to stock. Selection accepts either `ids` (record IDs) or `dids` (phone numbers), but not both.
+
+        Parameters
+        ----------
+        ids : typing.Optional[typing.Union[int, typing.Sequence[int]]]
+            Record IDs of the phone numbers to release. Mutually exclusive with `dids`.
+
+        dids : typing.Optional[str]
+            Comma-separated phone numbers to release. Mutually exclusive with `ids`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteNumbersResponse
+            Returns a success confirmation. The numbers are released back to stock.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.numbers.delete(
+            dids="47832123321,47832123324,478321233215",
+        )
+        """
+        _response = self._raw_client.delete(ids=ids, dids=dids, request_options=request_options)
+        return _response.data
+
+    def bulk_update(
+        self,
+        *,
+        ids: typing.Sequence[int],
+        sms_enabled: typing.Optional[bool] = OMIT,
+        destinations: typing.Optional[typing.Sequence[NumberDestination]] = OMIT,
+        sms_relay_url: typing.Optional[str] = OMIT,
+        call_recording_enabled: typing.Optional[bool] = OMIT,
+        transcription_enabled: typing.Optional[bool] = OMIT,
+        transcription_threshold: typing.Optional[int] = OMIT,
+        call_status_url: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> BulkUpdateNumbersResponse:
+        """
+        Applies the same changes to every listed phone number. Only the provided fields are changed. Destination and SMS callback changes are applied asynchronously and may not be reflected in the response immediately.
+
+        Parameters
+        ----------
+        ids : typing.Sequence[int]
+            Numbers (by ID) to apply the patch to. The same patch is
+            applied to every listed number.
+
+        sms_enabled : typing.Optional[bool]
+            Indicates whether SMS is enabled for the phone numbers.
+
+        destinations : typing.Optional[typing.Sequence[NumberDestination]]
+            Inbound call routing destinations for the phone numbers.
+
+        sms_relay_url : typing.Optional[str]
+            Callback URL for inbound messages.
+
+        call_recording_enabled : typing.Optional[bool]
+            Indicates whether call recording is enabled.
+
+        transcription_enabled : typing.Optional[bool]
+            Indicates whether call transcription is enabled.
+
+        transcription_threshold : typing.Optional[int]
+            Minimum call duration in seconds before transcription runs.
+
+        call_status_url : typing.Optional[str]
+            Callback URL for call status updates.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BulkUpdateNumbersResponse
+            Returns the updated phone numbers.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.numbers.bulk_update(
+            ids=[123, 456],
+        )
+        """
+        _response = self._raw_client.bulk_update(
+            ids=ids,
+            sms_enabled=sms_enabled,
+            destinations=destinations,
+            sms_relay_url=sms_relay_url,
+            call_recording_enabled=call_recording_enabled,
+            transcription_enabled=transcription_enabled,
+            transcription_threshold=transcription_threshold,
+            call_status_url=call_status_url,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Number:
+        """
+        Returns the phone number identified by `id`, including its destinations, documents, and feature settings.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the phone number.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Number
+            Returns the phone number.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.numbers.get(
+            id=123,
+        )
+        """
+        _response = self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        id: int,
+        *,
+        sms_enabled: typing.Optional[bool] = OMIT,
+        destinations: typing.Optional[typing.Sequence[NumberDestination]] = OMIT,
+        sms_relay_url: typing.Optional[str] = OMIT,
+        call_recording_enabled: typing.Optional[bool] = OMIT,
+        transcription_enabled: typing.Optional[bool] = OMIT,
+        transcription_threshold: typing.Optional[int] = OMIT,
+        call_status_url: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Number:
+        """
+        Updates the phone number identified by `id`. Only the provided fields are changed.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the phone number.
+
+        sms_enabled : typing.Optional[bool]
+            Indicates whether SMS is enabled for the phone number.
+
+        destinations : typing.Optional[typing.Sequence[NumberDestination]]
+            Inbound call routing destinations for the phone number.
+
+        sms_relay_url : typing.Optional[str]
+            Callback URL for inbound messages.
+
+        call_recording_enabled : typing.Optional[bool]
+            Indicates whether call recording is enabled.
+
+        transcription_enabled : typing.Optional[bool]
+            Indicates whether call transcription is enabled.
+
+        transcription_threshold : typing.Optional[int]
+            Minimum call duration in seconds before transcription runs.
+
+        call_status_url : typing.Optional[str]
+            Callback URL for call status updates.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Number
+            Returns the updated phone number.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.numbers.update(
+            id=123,
+        )
+        """
+        _response = self._raw_client.update(
+            id,
+            sms_enabled=sms_enabled,
+            destinations=destinations,
+            sms_relay_url=sms_relay_url,
+            call_recording_enabled=call_recording_enabled,
+            transcription_enabled=transcription_enabled,
+            transcription_threshold=transcription_threshold,
+            call_status_url=call_status_url,
+            request_options=request_options,
+        )
+        return _response.data
+
+    @property
+    def papers(self):
+        if self._papers is None:
+            from .papers.client import PapersClient  # noqa: E402
+
+            self._papers = PapersClient(client_wrapper=self._client_wrapper)
+        return self._papers
+
+
+class AsyncNumbersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawNumbersClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._papers: typing.Optional[AsyncPapersClient] = None
+
+    @property
+    def with_raw_response(self) -> AsyncRawNumbersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawNumbersClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        city_id: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
+        label: typing.Optional[str] = None,
+        label_present: typing.Optional[bool] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NumberListResponse:
+        """
+        Returns a paginated list of the phone numbers owned by the authenticated account.
+
+        Parameters
+        ----------
+        city_id : typing.Optional[int]
+            Filters numbers by the ID of their city or rate center.
+
+        search : typing.Optional[str]
+            Filters numbers by a full or partial phone number.
+
+        label : typing.Optional[str]
+            Filters numbers by `label`.
+
+        label_present : typing.Optional[bool]
+            When `true`, returns only numbers that have a label; when `false`, only numbers without one.
+
+        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
+        -------
+        NumberListResponse
+            Returns a paginated list of phone numbers.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.numbers.list(
+                city_id=123,
+                search="256537",
+                label="ALEX",
+                label_present=True,
+                page=2,
+                per_page=50,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            city_id=city_id,
+            search=search,
+            label=label,
+            label_present=label_present,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete(
+        self,
+        *,
+        ids: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
+        dids: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DeleteNumbersResponse:
+        """
+        Releases the listed phone numbers back to stock. Selection accepts either `ids` (record IDs) or `dids` (phone numbers), but not both.
+
+        Parameters
+        ----------
+        ids : typing.Optional[typing.Union[int, typing.Sequence[int]]]
+            Record IDs of the phone numbers to release. Mutually exclusive with `dids`.
+
+        dids : typing.Optional[str]
+            Comma-separated phone numbers to release. Mutually exclusive with `ids`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteNumbersResponse
+            Returns a success confirmation. The numbers are released back to stock.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.numbers.delete(
+                dids="47832123321,47832123324,478321233215",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(ids=ids, dids=dids, request_options=request_options)
+        return _response.data
+
+    async def bulk_update(
+        self,
+        *,
+        ids: typing.Sequence[int],
+        sms_enabled: typing.Optional[bool] = OMIT,
+        destinations: typing.Optional[typing.Sequence[NumberDestination]] = OMIT,
+        sms_relay_url: typing.Optional[str] = OMIT,
+        call_recording_enabled: typing.Optional[bool] = OMIT,
+        transcription_enabled: typing.Optional[bool] = OMIT,
+        transcription_threshold: typing.Optional[int] = OMIT,
+        call_status_url: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> BulkUpdateNumbersResponse:
+        """
+        Applies the same changes to every listed phone number. Only the provided fields are changed. Destination and SMS callback changes are applied asynchronously and may not be reflected in the response immediately.
+
+        Parameters
+        ----------
+        ids : typing.Sequence[int]
+            Numbers (by ID) to apply the patch to. The same patch is
+            applied to every listed number.
+
+        sms_enabled : typing.Optional[bool]
+            Indicates whether SMS is enabled for the phone numbers.
+
+        destinations : typing.Optional[typing.Sequence[NumberDestination]]
+            Inbound call routing destinations for the phone numbers.
+
+        sms_relay_url : typing.Optional[str]
+            Callback URL for inbound messages.
+
+        call_recording_enabled : typing.Optional[bool]
+            Indicates whether call recording is enabled.
+
+        transcription_enabled : typing.Optional[bool]
+            Indicates whether call transcription is enabled.
+
+        transcription_threshold : typing.Optional[int]
+            Minimum call duration in seconds before transcription runs.
+
+        call_status_url : typing.Optional[str]
+            Callback URL for call status updates.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BulkUpdateNumbersResponse
+            Returns the updated phone numbers.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.numbers.bulk_update(
+                ids=[123, 456],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.bulk_update(
+            ids=ids,
+            sms_enabled=sms_enabled,
+            destinations=destinations,
+            sms_relay_url=sms_relay_url,
+            call_recording_enabled=call_recording_enabled,
+            transcription_enabled=transcription_enabled,
+            transcription_threshold=transcription_threshold,
+            call_status_url=call_status_url,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Number:
+        """
+        Returns the phone number identified by `id`, including its destinations, documents, and feature settings.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the phone number.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Number
+            Returns the phone number.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.numbers.get(
+                id=123,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        id: int,
+        *,
+        sms_enabled: typing.Optional[bool] = OMIT,
+        destinations: typing.Optional[typing.Sequence[NumberDestination]] = OMIT,
+        sms_relay_url: typing.Optional[str] = OMIT,
+        call_recording_enabled: typing.Optional[bool] = OMIT,
+        transcription_enabled: typing.Optional[bool] = OMIT,
+        transcription_threshold: typing.Optional[int] = OMIT,
+        call_status_url: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Number:
+        """
+        Updates the phone number identified by `id`. Only the provided fields are changed.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the phone number.
+
+        sms_enabled : typing.Optional[bool]
+            Indicates whether SMS is enabled for the phone number.
+
+        destinations : typing.Optional[typing.Sequence[NumberDestination]]
+            Inbound call routing destinations for the phone number.
+
+        sms_relay_url : typing.Optional[str]
+            Callback URL for inbound messages.
+
+        call_recording_enabled : typing.Optional[bool]
+            Indicates whether call recording is enabled.
+
+        transcription_enabled : typing.Optional[bool]
+            Indicates whether call transcription is enabled.
+
+        transcription_threshold : typing.Optional[int]
+            Minimum call duration in seconds before transcription runs.
+
+        call_status_url : typing.Optional[str]
+            Callback URL for call status updates.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Number
+            Returns the updated phone number.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.numbers.update(
+                id=123,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            id,
+            sms_enabled=sms_enabled,
+            destinations=destinations,
+            sms_relay_url=sms_relay_url,
+            call_recording_enabled=call_recording_enabled,
+            transcription_enabled=transcription_enabled,
+            transcription_threshold=transcription_threshold,
+            call_status_url=call_status_url,
+            request_options=request_options,
+        )
+        return _response.data
+
+    @property
+    def papers(self):
+        if self._papers is None:
+            from .papers.client import AsyncPapersClient  # noqa: E402
+
+            self._papers = AsyncPapersClient(client_wrapper=self._client_wrapper)
+        return self._papers

wavix/numbers/papers/__init__.py

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