levelfour 0.1.0__py3-none-any.whl

levelfour/api_keys/client.py

@@ -0,0 +1,337 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.create_api_key_response import CreateApiKeyResponse
+from ..types.list_api_keys_response import ListApiKeysResponse
+from ..types.revoke_api_key_response import RevokeApiKeyResponse
+from .raw_client import AsyncRawApiKeysClient, RawApiKeysClient
+from .types.create_api_key_request_scope import CreateApiKeyRequestScope
+
+# 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, *, request_options: typing.Optional[RequestOptions] = None) -> ListApiKeysResponse:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListApiKeysResponse
+            Successful Response
+
+        Examples
+        --------
+        from levelfour import BaseLevelFour
+
+        client = BaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.api_keys.list()
+        """
+        _response = self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    def create(
+        self,
+        *,
+        name: str,
+        scope: typing.Optional[CreateApiKeyRequestScope] = OMIT,
+        expires_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateApiKeyResponse:
+        """
+        Parameters
+        ----------
+        name : str
+
+        scope : typing.Optional[CreateApiKeyRequestScope]
+
+        expires_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        from levelfour import BaseLevelFour
+
+        client = BaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.api_keys.create(
+            name="name",
+        )
+        """
+        _response = self._raw_client.create(
+            name=name, scope=scope, expires_at=expires_at, request_options=request_options
+        )
+        return _response.data
+
+    def revoke(self, key_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> RevokeApiKeyResponse:
+        """
+        Parameters
+        ----------
+        key_id : str
+            API key UUID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RevokeApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        from levelfour import BaseLevelFour
+
+        client = BaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.api_keys.revoke(
+            key_id="key_id",
+        )
+        """
+        _response = self._raw_client.revoke(key_id, request_options=request_options)
+        return _response.data
+
+    def rotate(self, key_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> CreateApiKeyResponse:
+        """
+        Parameters
+        ----------
+        key_id : str
+            API key UUID to rotate
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        from levelfour import BaseLevelFour
+
+        client = BaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.api_keys.rotate(
+            key_id="key_id",
+        )
+        """
+        _response = self._raw_client.rotate(key_id, 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, *, request_options: typing.Optional[RequestOptions] = None) -> ListApiKeysResponse:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListApiKeysResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from levelfour import AsyncBaseLevelFour
+
+        client = AsyncBaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        name: str,
+        scope: typing.Optional[CreateApiKeyRequestScope] = OMIT,
+        expires_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateApiKeyResponse:
+        """
+        Parameters
+        ----------
+        name : str
+
+        scope : typing.Optional[CreateApiKeyRequestScope]
+
+        expires_at : typing.Optional[dt.datetime]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from levelfour import AsyncBaseLevelFour
+
+        client = AsyncBaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.create(
+                name="name",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            name=name, scope=scope, expires_at=expires_at, request_options=request_options
+        )
+        return _response.data
+
+    async def revoke(
+        self, key_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> RevokeApiKeyResponse:
+        """
+        Parameters
+        ----------
+        key_id : str
+            API key UUID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RevokeApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from levelfour import AsyncBaseLevelFour
+
+        client = AsyncBaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.revoke(
+                key_id="key_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.revoke(key_id, request_options=request_options)
+        return _response.data
+
+    async def rotate(
+        self, key_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateApiKeyResponse:
+        """
+        Parameters
+        ----------
+        key_id : str
+            API key UUID to rotate
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from levelfour import AsyncBaseLevelFour
+
+        client = AsyncBaseLevelFour(
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.api_keys.rotate(
+                key_id="key_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.rotate(key_id, request_options=request_options)
+        return _response.data