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

wavix/api_keys/raw_client.py

@@ -0,0 +1,1191 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import encode_path_param
+from ..core.parse_error import ParsingError
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..errors.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+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 ..types.unauthorized_error_response import UnauthorizedErrorResponse
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawApiKeysClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self, *, label: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[typing.List[ApiKey]]
+            Returns the list of API keys.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/api-keys",
+            method="GET",
+            params={
+                "label": label,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[ApiKey],
+                    parse_obj_as(
+                        type_=typing.List[ApiKey],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    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,
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[ApiKey]
+            Returns the created API key.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/api-keys",
+            method="POST",
+            json={
+                "label": label,
+                "active": active,
+                "restricted": restricted,
+                "permitted_ips": permitted_ips,
+                "scopes_enabled": scopes_enabled,
+                "numbers": convert_and_respect_annotation_metadata(
+                    object_=numbers, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "trunks": convert_and_respect_annotation_metadata(
+                    object_=trunks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "calls": convert_and_respect_annotation_metadata(
+                    object_=calls, annotation=ApiKeyCallsScopePermission, direction="write"
+                ),
+                "messages": convert_and_respect_annotation_metadata(
+                    object_=messages, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "recordings": convert_and_respect_annotation_metadata(
+                    object_=recordings, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "campaigns": convert_and_respect_annotation_metadata(
+                    object_=campaigns, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "two_fa": convert_and_respect_annotation_metadata(
+                    object_=two_fa, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "validator": convert_and_respect_annotation_metadata(
+                    object_=validator, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "webhooks": convert_and_respect_annotation_metadata(
+                    object_=webhooks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "embeddable": convert_and_respect_annotation_metadata(
+                    object_=embeddable, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "billing": convert_and_respect_annotation_metadata(
+                    object_=billing, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "account": convert_and_respect_annotation_metadata(
+                    object_=account, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "subaccounts": convert_and_respect_annotation_metadata(
+                    object_=subaccounts, annotation=ApiKeyScopePermission, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ApiKey,
+                    parse_obj_as(
+                        type_=ApiKey,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def delete(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[SuccessResponse]
+            Returns a success confirmation. The API key is revoked.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/api-keys/{encode_path_param(id)}",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SuccessResponse,
+                    parse_obj_as(
+                        type_=SuccessResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    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,
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[ApiKey]
+            Returns the updated API key.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/api-keys/{encode_path_param(id)}",
+            method="PATCH",
+            json={
+                "active": active,
+                "restricted": restricted,
+                "scopes_enabled": scopes_enabled,
+                "permitted_ips": permitted_ips,
+                "label": label,
+                "numbers": convert_and_respect_annotation_metadata(
+                    object_=numbers, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "trunks": convert_and_respect_annotation_metadata(
+                    object_=trunks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "calls": convert_and_respect_annotation_metadata(
+                    object_=calls, annotation=ApiKeyCallsScopePermission, direction="write"
+                ),
+                "messages": convert_and_respect_annotation_metadata(
+                    object_=messages, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "recordings": convert_and_respect_annotation_metadata(
+                    object_=recordings, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "campaigns": convert_and_respect_annotation_metadata(
+                    object_=campaigns, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "two_fa": convert_and_respect_annotation_metadata(
+                    object_=two_fa, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "validator": convert_and_respect_annotation_metadata(
+                    object_=validator, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "webhooks": convert_and_respect_annotation_metadata(
+                    object_=webhooks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "embeddable": convert_and_respect_annotation_metadata(
+                    object_=embeddable, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "billing": convert_and_respect_annotation_metadata(
+                    object_=billing, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "account": convert_and_respect_annotation_metadata(
+                    object_=account, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "subaccounts": convert_and_respect_annotation_metadata(
+                    object_=subaccounts, annotation=ApiKeyScopePermission, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ApiKey,
+                    parse_obj_as(
+                        type_=ApiKey,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawApiKeysClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self, *, label: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[typing.List[ApiKey]]
+            Returns the list of API keys.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/api-keys",
+            method="GET",
+            params={
+                "label": label,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[ApiKey],
+                    parse_obj_as(
+                        type_=typing.List[ApiKey],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    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,
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[ApiKey]
+            Returns the created API key.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/api-keys",
+            method="POST",
+            json={
+                "label": label,
+                "active": active,
+                "restricted": restricted,
+                "permitted_ips": permitted_ips,
+                "scopes_enabled": scopes_enabled,
+                "numbers": convert_and_respect_annotation_metadata(
+                    object_=numbers, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "trunks": convert_and_respect_annotation_metadata(
+                    object_=trunks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "calls": convert_and_respect_annotation_metadata(
+                    object_=calls, annotation=ApiKeyCallsScopePermission, direction="write"
+                ),
+                "messages": convert_and_respect_annotation_metadata(
+                    object_=messages, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "recordings": convert_and_respect_annotation_metadata(
+                    object_=recordings, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "campaigns": convert_and_respect_annotation_metadata(
+                    object_=campaigns, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "two_fa": convert_and_respect_annotation_metadata(
+                    object_=two_fa, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "validator": convert_and_respect_annotation_metadata(
+                    object_=validator, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "webhooks": convert_and_respect_annotation_metadata(
+                    object_=webhooks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "embeddable": convert_and_respect_annotation_metadata(
+                    object_=embeddable, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "billing": convert_and_respect_annotation_metadata(
+                    object_=billing, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "account": convert_and_respect_annotation_metadata(
+                    object_=account, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "subaccounts": convert_and_respect_annotation_metadata(
+                    object_=subaccounts, annotation=ApiKeyScopePermission, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ApiKey,
+                    parse_obj_as(
+                        type_=ApiKey,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def delete(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[SuccessResponse]
+            Returns a success confirmation. The API key is revoked.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/api-keys/{encode_path_param(id)}",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SuccessResponse,
+                    parse_obj_as(
+                        type_=SuccessResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    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,
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[ApiKey]
+            Returns the updated API key.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/api-keys/{encode_path_param(id)}",
+            method="PATCH",
+            json={
+                "active": active,
+                "restricted": restricted,
+                "scopes_enabled": scopes_enabled,
+                "permitted_ips": permitted_ips,
+                "label": label,
+                "numbers": convert_and_respect_annotation_metadata(
+                    object_=numbers, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "trunks": convert_and_respect_annotation_metadata(
+                    object_=trunks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "calls": convert_and_respect_annotation_metadata(
+                    object_=calls, annotation=ApiKeyCallsScopePermission, direction="write"
+                ),
+                "messages": convert_and_respect_annotation_metadata(
+                    object_=messages, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "recordings": convert_and_respect_annotation_metadata(
+                    object_=recordings, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "campaigns": convert_and_respect_annotation_metadata(
+                    object_=campaigns, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "two_fa": convert_and_respect_annotation_metadata(
+                    object_=two_fa, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "validator": convert_and_respect_annotation_metadata(
+                    object_=validator, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "webhooks": convert_and_respect_annotation_metadata(
+                    object_=webhooks, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "embeddable": convert_and_respect_annotation_metadata(
+                    object_=embeddable, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "billing": convert_and_respect_annotation_metadata(
+                    object_=billing, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "account": convert_and_respect_annotation_metadata(
+                    object_=account, annotation=ApiKeyScopePermission, direction="write"
+                ),
+                "subaccounts": convert_and_respect_annotation_metadata(
+                    object_=subaccounts, annotation=ApiKeyScopePermission, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ApiKey,
+                    parse_obj_as(
+                        type_=ApiKey,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UnauthorizedErrorResponse,
+                        parse_obj_as(
+                            type_=UnauthorizedErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)