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

wavix/api_keys/client.py

@@ -0,0 +1,764 @@
+# 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.api_key import ApiKey
+from ..types.api_key_calls_scope_permission import ApiKeyCallsScopePermission
+from ..types.api_key_scope_permission import ApiKeyScopePermission
+from ..types.success_response import SuccessResponse
+from .raw_client import AsyncRawApiKeysClient, RawApiKeysClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ApiKeysClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawApiKeysClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawApiKeysClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawApiKeysClient
+        """
+        return self._raw_client
+
+    def list(
+        self, *, label: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[ApiKey]:
+        """
+        Returns the API keys belonging to the authenticated account.
+
+        Parameters
+        ----------
+        label : typing.Optional[str]
+            Filters API keys by `label`. Matches partial values.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[ApiKey]
+            Returns the list of API keys.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.api_keys.list(
+            label="production",
+        )
+        """
+        _response = self._raw_client.list(label=label, request_options=request_options)
+        return _response.data
+
+    def create(
+        self,
+        *,
+        label: str,
+        active: typing.Optional[bool] = OMIT,
+        restricted: typing.Optional[bool] = OMIT,
+        permitted_ips: typing.Optional[typing.Sequence[str]] = OMIT,
+        scopes_enabled: typing.Optional[bool] = OMIT,
+        numbers: typing.Optional[ApiKeyScopePermission] = OMIT,
+        trunks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        calls: typing.Optional[ApiKeyCallsScopePermission] = OMIT,
+        messages: typing.Optional[ApiKeyScopePermission] = OMIT,
+        recordings: typing.Optional[ApiKeyScopePermission] = OMIT,
+        campaigns: typing.Optional[ApiKeyScopePermission] = OMIT,
+        two_fa: typing.Optional[ApiKeyScopePermission] = OMIT,
+        validator: typing.Optional[ApiKeyScopePermission] = OMIT,
+        webhooks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        embeddable: typing.Optional[ApiKeyScopePermission] = OMIT,
+        billing: typing.Optional[ApiKeyScopePermission] = OMIT,
+        account: typing.Optional[ApiKeyScopePermission] = OMIT,
+        subaccounts: typing.Optional[ApiKeyScopePermission] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ApiKey:
+        """
+        Creates an API key for the authenticated account. Restrict access by listing permitted IP addresses in `permitted_ips`.
+
+        Parameters
+        ----------
+        label : str
+            API key label.
+
+        active : typing.Optional[bool]
+            Indicates whether the API key should be activated upon creation.
+
+        restricted : typing.Optional[bool]
+            Indicates whether to restrict API key access by IP address. When enabled, only requests from IP addresses listed in `permitted_ips` are allowed.
+
+        permitted_ips : typing.Optional[typing.Sequence[str]]
+            List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `restricted` is true.
+
+        scopes_enabled : typing.Optional[bool]
+            When `true`, scope fields below are enforced. When `false` (default), the
+            key has full access. Omitted scope fields default to `{ allow: none }`,
+            so with `scopes_enabled: true` and no scopes set the key has no access.
+
+        numbers : typing.Optional[ApiKeyScopePermission]
+            View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
+
+        trunks : typing.Optional[ApiKeyScopePermission]
+            View, create, update, and delete SIP trunks and their settings.
+
+        calls : typing.Optional[ApiKeyCallsScopePermission]
+            Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests.
+
+        messages : typing.Optional[ApiKeyScopePermission]
+            Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
+
+        recordings : typing.Optional[ApiKeyScopePermission]
+            List, download, and delete call recordings.
+
+        campaigns : typing.Optional[ApiKeyScopePermission]
+            View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
+
+        two_fa : typing.Optional[ApiKeyScopePermission]
+            View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes.
+
+        validator : typing.Optional[ApiKeyScopePermission]
+            View number validation results and trigger single or bulk validation or HLR lookup requests.
+
+        webhooks : typing.Optional[ApiKeyScopePermission]
+            List, create, and delete webhooks.
+
+        embeddable : typing.Optional[ApiKeyScopePermission]
+            Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
+
+        billing : typing.Optional[ApiKeyScopePermission]
+            Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates.
+
+        account : typing.Optional[ApiKeyScopePermission]
+            View and update account profile information and timezone.
+
+        subaccounts : typing.Optional[ApiKeyScopePermission]
+            Manage subaccounts: list and view them, create, update, and suspend them.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ApiKey
+            Returns the created API key.
+
+        Examples
+        --------
+        from wavix import ApiKeyCallsScopePermission, ApiKeyScopePermission, Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.api_keys.create(
+            label="Production API Key",
+            active=True,
+            restricted=True,
+            permitted_ips=["192.168.1.1", "10.0.0.1"],
+            scopes_enabled=True,
+            numbers=ApiKeyScopePermission(
+                allow="read",
+            ),
+            calls=ApiKeyCallsScopePermission(
+                allow="read",
+            ),
+            messages=ApiKeyScopePermission(
+                allow="write",
+            ),
+            two_fa=ApiKeyScopePermission(
+                allow="write",
+            ),
+            billing=ApiKeyScopePermission(
+                allow="read",
+            ),
+        )
+        """
+        _response = self._raw_client.create(
+            label=label,
+            active=active,
+            restricted=restricted,
+            permitted_ips=permitted_ips,
+            scopes_enabled=scopes_enabled,
+            numbers=numbers,
+            trunks=trunks,
+            calls=calls,
+            messages=messages,
+            recordings=recordings,
+            campaigns=campaigns,
+            two_fa=two_fa,
+            validator=validator,
+            webhooks=webhooks,
+            embeddable=embeddable,
+            billing=billing,
+            account=account,
+            subaccounts=subaccounts,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> SuccessResponse:
+        """
+        Deletes the API key identified by `id`. Deletion is permanent and revokes the key immediately.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the API key.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The API key is revoked.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.api_keys.delete(
+            id=1,
+        )
+        """
+        _response = self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        id: int,
+        *,
+        active: typing.Optional[bool] = OMIT,
+        restricted: typing.Optional[bool] = OMIT,
+        scopes_enabled: typing.Optional[bool] = OMIT,
+        permitted_ips: typing.Optional[typing.Sequence[str]] = OMIT,
+        label: typing.Optional[str] = OMIT,
+        numbers: typing.Optional[ApiKeyScopePermission] = OMIT,
+        trunks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        calls: typing.Optional[ApiKeyCallsScopePermission] = OMIT,
+        messages: typing.Optional[ApiKeyScopePermission] = OMIT,
+        recordings: typing.Optional[ApiKeyScopePermission] = OMIT,
+        campaigns: typing.Optional[ApiKeyScopePermission] = OMIT,
+        two_fa: typing.Optional[ApiKeyScopePermission] = OMIT,
+        validator: typing.Optional[ApiKeyScopePermission] = OMIT,
+        webhooks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        embeddable: typing.Optional[ApiKeyScopePermission] = OMIT,
+        billing: typing.Optional[ApiKeyScopePermission] = OMIT,
+        account: typing.Optional[ApiKeyScopePermission] = OMIT,
+        subaccounts: typing.Optional[ApiKeyScopePermission] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ApiKey:
+        """
+        Updates an API key identified by `id`. Only the provided fields are changed.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the API key.
+
+        active : typing.Optional[bool]
+            Indicates whether the API key is active.
+
+        restricted : typing.Optional[bool]
+            Indicates whether the API key is restricted to the listed permitted IPs.
+
+        scopes_enabled : typing.Optional[bool]
+            Indicates whether per-resource scope permissions are enforced for the API key.
+
+        permitted_ips : typing.Optional[typing.Sequence[str]]
+            IP addresses allowed to use the API key when restriction is enabled.
+
+        label : typing.Optional[str]
+            Human-readable label for the API key.
+
+        numbers : typing.Optional[ApiKeyScopePermission]
+            View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
+
+        trunks : typing.Optional[ApiKeyScopePermission]
+            View, create, update, and delete SIP trunks and their settings.
+
+        calls : typing.Optional[ApiKeyCallsScopePermission]
+            Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests.
+
+        messages : typing.Optional[ApiKeyScopePermission]
+            Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
+
+        recordings : typing.Optional[ApiKeyScopePermission]
+            List, download, and delete call recordings.
+
+        campaigns : typing.Optional[ApiKeyScopePermission]
+            View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
+
+        two_fa : typing.Optional[ApiKeyScopePermission]
+            View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes.
+
+        validator : typing.Optional[ApiKeyScopePermission]
+            View number validation results and trigger single or bulk validation or HLR lookup requests.
+
+        webhooks : typing.Optional[ApiKeyScopePermission]
+            List, create, and delete webhooks.
+
+        embeddable : typing.Optional[ApiKeyScopePermission]
+            Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
+
+        billing : typing.Optional[ApiKeyScopePermission]
+            Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates.
+
+        account : typing.Optional[ApiKeyScopePermission]
+            View and update account profile information and timezone.
+
+        subaccounts : typing.Optional[ApiKeyScopePermission]
+            Manage subaccounts: list and view them, create, update, and suspend them.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ApiKey
+            Returns the updated API key.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.api_keys.update(
+            id=1,
+            active=True,
+            restricted=True,
+            scopes_enabled=True,
+            permitted_ips=["192.168.1.1", "10.0.0.1"],
+            label="Production API Key",
+        )
+        """
+        _response = self._raw_client.update(
+            id,
+            active=active,
+            restricted=restricted,
+            scopes_enabled=scopes_enabled,
+            permitted_ips=permitted_ips,
+            label=label,
+            numbers=numbers,
+            trunks=trunks,
+            calls=calls,
+            messages=messages,
+            recordings=recordings,
+            campaigns=campaigns,
+            two_fa=two_fa,
+            validator=validator,
+            webhooks=webhooks,
+            embeddable=embeddable,
+            billing=billing,
+            account=account,
+            subaccounts=subaccounts,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncApiKeysClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawApiKeysClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawApiKeysClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawApiKeysClient
+        """
+        return self._raw_client
+
+    async def list(
+        self, *, label: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[ApiKey]:
+        """
+        Returns the API keys belonging to the authenticated account.
+
+        Parameters
+        ----------
+        label : typing.Optional[str]
+            Filters API keys by `label`. Matches partial values.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[ApiKey]
+            Returns the list of API keys.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.list(
+                label="production",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(label=label, request_options=request_options)
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        label: str,
+        active: typing.Optional[bool] = OMIT,
+        restricted: typing.Optional[bool] = OMIT,
+        permitted_ips: typing.Optional[typing.Sequence[str]] = OMIT,
+        scopes_enabled: typing.Optional[bool] = OMIT,
+        numbers: typing.Optional[ApiKeyScopePermission] = OMIT,
+        trunks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        calls: typing.Optional[ApiKeyCallsScopePermission] = OMIT,
+        messages: typing.Optional[ApiKeyScopePermission] = OMIT,
+        recordings: typing.Optional[ApiKeyScopePermission] = OMIT,
+        campaigns: typing.Optional[ApiKeyScopePermission] = OMIT,
+        two_fa: typing.Optional[ApiKeyScopePermission] = OMIT,
+        validator: typing.Optional[ApiKeyScopePermission] = OMIT,
+        webhooks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        embeddable: typing.Optional[ApiKeyScopePermission] = OMIT,
+        billing: typing.Optional[ApiKeyScopePermission] = OMIT,
+        account: typing.Optional[ApiKeyScopePermission] = OMIT,
+        subaccounts: typing.Optional[ApiKeyScopePermission] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ApiKey:
+        """
+        Creates an API key for the authenticated account. Restrict access by listing permitted IP addresses in `permitted_ips`.
+
+        Parameters
+        ----------
+        label : str
+            API key label.
+
+        active : typing.Optional[bool]
+            Indicates whether the API key should be activated upon creation.
+
+        restricted : typing.Optional[bool]
+            Indicates whether to restrict API key access by IP address. When enabled, only requests from IP addresses listed in `permitted_ips` are allowed.
+
+        permitted_ips : typing.Optional[typing.Sequence[str]]
+            List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `restricted` is true.
+
+        scopes_enabled : typing.Optional[bool]
+            When `true`, scope fields below are enforced. When `false` (default), the
+            key has full access. Omitted scope fields default to `{ allow: none }`,
+            so with `scopes_enabled: true` and no scopes set the key has no access.
+
+        numbers : typing.Optional[ApiKeyScopePermission]
+            View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
+
+        trunks : typing.Optional[ApiKeyScopePermission]
+            View, create, update, and delete SIP trunks and their settings.
+
+        calls : typing.Optional[ApiKeyCallsScopePermission]
+            Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests.
+
+        messages : typing.Optional[ApiKeyScopePermission]
+            Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
+
+        recordings : typing.Optional[ApiKeyScopePermission]
+            List, download, and delete call recordings.
+
+        campaigns : typing.Optional[ApiKeyScopePermission]
+            View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
+
+        two_fa : typing.Optional[ApiKeyScopePermission]
+            View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes.
+
+        validator : typing.Optional[ApiKeyScopePermission]
+            View number validation results and trigger single or bulk validation or HLR lookup requests.
+
+        webhooks : typing.Optional[ApiKeyScopePermission]
+            List, create, and delete webhooks.
+
+        embeddable : typing.Optional[ApiKeyScopePermission]
+            Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
+
+        billing : typing.Optional[ApiKeyScopePermission]
+            Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates.
+
+        account : typing.Optional[ApiKeyScopePermission]
+            View and update account profile information and timezone.
+
+        subaccounts : typing.Optional[ApiKeyScopePermission]
+            Manage subaccounts: list and view them, create, update, and suspend them.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ApiKey
+            Returns the created API key.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import ApiKeyCallsScopePermission, ApiKeyScopePermission, AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.create(
+                label="Production API Key",
+                active=True,
+                restricted=True,
+                permitted_ips=["192.168.1.1", "10.0.0.1"],
+                scopes_enabled=True,
+                numbers=ApiKeyScopePermission(
+                    allow="read",
+                ),
+                calls=ApiKeyCallsScopePermission(
+                    allow="read",
+                ),
+                messages=ApiKeyScopePermission(
+                    allow="write",
+                ),
+                two_fa=ApiKeyScopePermission(
+                    allow="write",
+                ),
+                billing=ApiKeyScopePermission(
+                    allow="read",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            label=label,
+            active=active,
+            restricted=restricted,
+            permitted_ips=permitted_ips,
+            scopes_enabled=scopes_enabled,
+            numbers=numbers,
+            trunks=trunks,
+            calls=calls,
+            messages=messages,
+            recordings=recordings,
+            campaigns=campaigns,
+            two_fa=two_fa,
+            validator=validator,
+            webhooks=webhooks,
+            embeddable=embeddable,
+            billing=billing,
+            account=account,
+            subaccounts=subaccounts,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> SuccessResponse:
+        """
+        Deletes the API key identified by `id`. Deletion is permanent and revokes the key immediately.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the API key.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The API key is revoked.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        id: int,
+        *,
+        active: typing.Optional[bool] = OMIT,
+        restricted: typing.Optional[bool] = OMIT,
+        scopes_enabled: typing.Optional[bool] = OMIT,
+        permitted_ips: typing.Optional[typing.Sequence[str]] = OMIT,
+        label: typing.Optional[str] = OMIT,
+        numbers: typing.Optional[ApiKeyScopePermission] = OMIT,
+        trunks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        calls: typing.Optional[ApiKeyCallsScopePermission] = OMIT,
+        messages: typing.Optional[ApiKeyScopePermission] = OMIT,
+        recordings: typing.Optional[ApiKeyScopePermission] = OMIT,
+        campaigns: typing.Optional[ApiKeyScopePermission] = OMIT,
+        two_fa: typing.Optional[ApiKeyScopePermission] = OMIT,
+        validator: typing.Optional[ApiKeyScopePermission] = OMIT,
+        webhooks: typing.Optional[ApiKeyScopePermission] = OMIT,
+        embeddable: typing.Optional[ApiKeyScopePermission] = OMIT,
+        billing: typing.Optional[ApiKeyScopePermission] = OMIT,
+        account: typing.Optional[ApiKeyScopePermission] = OMIT,
+        subaccounts: typing.Optional[ApiKeyScopePermission] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ApiKey:
+        """
+        Updates an API key identified by `id`. Only the provided fields are changed.
+
+        Parameters
+        ----------
+        id : int
+            The unique ID of the API key.
+
+        active : typing.Optional[bool]
+            Indicates whether the API key is active.
+
+        restricted : typing.Optional[bool]
+            Indicates whether the API key is restricted to the listed permitted IPs.
+
+        scopes_enabled : typing.Optional[bool]
+            Indicates whether per-resource scope permissions are enforced for the API key.
+
+        permitted_ips : typing.Optional[typing.Sequence[str]]
+            IP addresses allowed to use the API key when restriction is enabled.
+
+        label : typing.Optional[str]
+            Human-readable label for the API key.
+
+        numbers : typing.Optional[ApiKeyScopePermission]
+            View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
+
+        trunks : typing.Optional[ApiKeyScopePermission]
+            View, create, update, and delete SIP trunks and their settings.
+
+        calls : typing.Optional[ApiKeyCallsScopePermission]
+            Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests.
+
+        messages : typing.Optional[ApiKeyScopePermission]
+            Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
+
+        recordings : typing.Optional[ApiKeyScopePermission]
+            List, download, and delete call recordings.
+
+        campaigns : typing.Optional[ApiKeyScopePermission]
+            View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
+
+        two_fa : typing.Optional[ApiKeyScopePermission]
+            View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes.
+
+        validator : typing.Optional[ApiKeyScopePermission]
+            View number validation results and trigger single or bulk validation or HLR lookup requests.
+
+        webhooks : typing.Optional[ApiKeyScopePermission]
+            List, create, and delete webhooks.
+
+        embeddable : typing.Optional[ApiKeyScopePermission]
+            Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
+
+        billing : typing.Optional[ApiKeyScopePermission]
+            Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates.
+
+        account : typing.Optional[ApiKeyScopePermission]
+            View and update account profile information and timezone.
+
+        subaccounts : typing.Optional[ApiKeyScopePermission]
+            Manage subaccounts: list and view them, create, update, and suspend them.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ApiKey
+            Returns the updated API key.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.update(
+                id=1,
+                active=True,
+                restricted=True,
+                scopes_enabled=True,
+                permitted_ips=["192.168.1.1", "10.0.0.1"],
+                label="Production API Key",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            id,
+            active=active,
+            restricted=restricted,
+            scopes_enabled=scopes_enabled,
+            permitted_ips=permitted_ips,
+            label=label,
+            numbers=numbers,
+            trunks=trunks,
+            calls=calls,
+            messages=messages,
+            recordings=recordings,
+            campaigns=campaigns,
+            two_fa=two_fa,
+            validator=validator,
+            webhooks=webhooks,
+            embeddable=embeddable,
+            billing=billing,
+            account=account,
+            subaccounts=subaccounts,
+            request_options=request_options,
+        )
+        return _response.data