client.py

# 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.create_platform_practice_api_key_response import CreatePlatformPracticeApiKeyResponse
from ..types.get_api_access_response import GetApiAccessResponse
from .raw_client import AsyncRawApiKeysClient, RawApiKeysClient
from .types.create_platform_practice_api_key_request_scopes_item import CreatePlatformPracticeApiKeyRequestScopesItem

# 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 create(
        self,
        practice_id: str,
        *,
        idempotency_key: str,
        name: str,
        allowed_ips: typing.Optional[typing.Sequence[str]] = OMIT,
        expires_at: typing.Optional[str] = OMIT,
        scopes: typing.Optional[typing.Sequence[CreatePlatformPracticeApiKeyRequestScopesItem]] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> CreatePlatformPracticeApiKeyResponse:
        """
        Creates a practice API key for a connected practice. Requires a platform key with service_keys:write and every requested scope. The practice key uses the platform key's Test or Live mode and cannot outlive it. Requires Idempotency-Key for safe retries; the secret is returned in the encrypted replay response for 24 hours.

        Parameters
        ----------
        practice_id : str

        idempotency_key : str

        name : str

        allowed_ips : typing.Optional[typing.Sequence[str]]

        expires_at : typing.Optional[str]

        scopes : typing.Optional[typing.Sequence[CreatePlatformPracticeApiKeyRequestScopesItem]]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        CreatePlatformPracticeApiKeyResponse
            HTTP 200

        Examples
        --------
        from affinity import Affinity

        client = Affinity(
            affinity_version="YOUR_AFFINITY_VERSION",
            api_key="YOUR_API_KEY",
        )
        client.api_keys.create(
            practice_id="practiceId",
            idempotency_key="Idempotency-Key",
            name="name",
        )
        """
        _response = self._raw_client.create(
            practice_id,
            idempotency_key=idempotency_key,
            name=name,
            allowed_ips=allowed_ips,
            expires_at=expires_at,
            scopes=scopes,
            request_options=request_options,
        )
        return _response.data

    def get_access(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetApiAccessResponse:
        """
        Returns the subject, mode, and scopes for the API key.

        Parameters
        ----------
        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        GetApiAccessResponse
            HTTP 200

        Examples
        --------
        from affinity import Affinity

        client = Affinity(
            affinity_version="YOUR_AFFINITY_VERSION",
            api_key="YOUR_API_KEY",
        )
        client.api_keys.get_access()
        """
        _response = self._raw_client.get_access(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 create(
        self,
        practice_id: str,
        *,
        idempotency_key: str,
        name: str,
        allowed_ips: typing.Optional[typing.Sequence[str]] = OMIT,
        expires_at: typing.Optional[str] = OMIT,
        scopes: typing.Optional[typing.Sequence[CreatePlatformPracticeApiKeyRequestScopesItem]] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> CreatePlatformPracticeApiKeyResponse:
        """
        Creates a practice API key for a connected practice. Requires a platform key with service_keys:write and every requested scope. The practice key uses the platform key's Test or Live mode and cannot outlive it. Requires Idempotency-Key for safe retries; the secret is returned in the encrypted replay response for 24 hours.

        Parameters
        ----------
        practice_id : str

        idempotency_key : str

        name : str

        allowed_ips : typing.Optional[typing.Sequence[str]]

        expires_at : typing.Optional[str]

        scopes : typing.Optional[typing.Sequence[CreatePlatformPracticeApiKeyRequestScopesItem]]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        CreatePlatformPracticeApiKeyResponse
            HTTP 200

        Examples
        --------
        import asyncio

        from affinity import AsyncAffinity

        client = AsyncAffinity(
            affinity_version="YOUR_AFFINITY_VERSION",
            api_key="YOUR_API_KEY",
        )


        async def main() -> None:
            await client.api_keys.create(
                practice_id="practiceId",
                idempotency_key="Idempotency-Key",
                name="name",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.create(
            practice_id,
            idempotency_key=idempotency_key,
            name=name,
            allowed_ips=allowed_ips,
            expires_at=expires_at,
            scopes=scopes,
            request_options=request_options,
        )
        return _response.data

    async def get_access(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetApiAccessResponse:
        """
        Returns the subject, mode, and scopes for the API key.

        Parameters
        ----------
        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        GetApiAccessResponse
            HTTP 200

        Examples
        --------
        import asyncio

        from affinity import AsyncAffinity

        client = AsyncAffinity(
            affinity_version="YOUR_AFFINITY_VERSION",
            api_key="YOUR_API_KEY",
        )


        async def main() -> None:
            await client.api_keys.get_access()


        asyncio.run(main())
        """
        _response = await self._raw_client.get_access(request_options=request_options)
        return _response.data