skyflow-flowvault-python 1.0.0__py3-none-any.whl

skyflow/generated/rest/__init__.py

@@ -0,0 +1,164 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        ColumnRedactions,
+        DeleteResponse,
+        DeleteResponseObject,
+        DetokenizeResponse,
+        DetokenizeResponseObject,
+        ErrorResponse,
+        ErrorResponseError,
+        ExecuteQueryRecordResponse,
+        ExecuteQueryResponse,
+        ExecuteQueryResponseMetadata,
+        GetRequestData,
+        GetResponse,
+        GetTokensFromValuesRequestObject,
+        GetTokensFromValuesResponse,
+        GoogleProtobufValue,
+        HttpCode,
+        InsertRecordData,
+        InsertResponse,
+        RecordResponseObject,
+        TokenGroupRedactions,
+        TokenizeResponseObject,
+        UniqueValue,
+        UpdateRecordData,
+        UpdateRecordDataUpdateType,
+        UpdateResponse,
+        Upsert,
+        UpsertUpdateType,
+    )
+    from .errors import (
+        BadRequestError,
+        ForbiddenError,
+        InternalServerError,
+        NotFoundError,
+        TooManyRequestsError,
+        UnauthorizedError,
+    )
+    from . import query, records, tokens
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .client import AsyncSkyflowAuth, SkyflowAuth
+    from .environment import SkyflowAuthEnvironment
+    from .records import UpdateRequestUpdateType
+    from .version import __version__
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncSkyflowAuth": ".client",
+    "BadRequestError": ".errors",
+    "ColumnRedactions": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeleteResponse": ".types",
+    "DeleteResponseObject": ".types",
+    "DetokenizeResponse": ".types",
+    "DetokenizeResponseObject": ".types",
+    "ErrorResponse": ".types",
+    "ErrorResponseError": ".types",
+    "ExecuteQueryRecordResponse": ".types",
+    "ExecuteQueryResponse": ".types",
+    "ExecuteQueryResponseMetadata": ".types",
+    "ForbiddenError": ".errors",
+    "GetRequestData": ".types",
+    "GetResponse": ".types",
+    "GetTokensFromValuesRequestObject": ".types",
+    "GetTokensFromValuesResponse": ".types",
+    "GoogleProtobufValue": ".types",
+    "HttpCode": ".types",
+    "InsertRecordData": ".types",
+    "InsertResponse": ".types",
+    "InternalServerError": ".errors",
+    "NotFoundError": ".errors",
+    "RecordResponseObject": ".types",
+    "SkyflowAuth": ".client",
+    "SkyflowAuthEnvironment": ".environment",
+    "TokenGroupRedactions": ".types",
+    "TokenizeResponseObject": ".types",
+    "TooManyRequestsError": ".errors",
+    "UnauthorizedError": ".errors",
+    "UniqueValue": ".types",
+    "UpdateRecordData": ".types",
+    "UpdateRecordDataUpdateType": ".types",
+    "UpdateRequestUpdateType": ".records",
+    "UpdateResponse": ".types",
+    "Upsert": ".types",
+    "UpsertUpdateType": ".types",
+    "__version__": ".version",
+    "query": ".query",
+    "records": ".records",
+    "tokens": ".tokens",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncSkyflowAuth",
+    "BadRequestError",
+    "ColumnRedactions",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeleteResponse",
+    "DeleteResponseObject",
+    "DetokenizeResponse",
+    "DetokenizeResponseObject",
+    "ErrorResponse",
+    "ErrorResponseError",
+    "ExecuteQueryRecordResponse",
+    "ExecuteQueryResponse",
+    "ExecuteQueryResponseMetadata",
+    "ForbiddenError",
+    "GetRequestData",
+    "GetResponse",
+    "GetTokensFromValuesRequestObject",
+    "GetTokensFromValuesResponse",
+    "GoogleProtobufValue",
+    "HttpCode",
+    "InsertRecordData",
+    "InsertResponse",
+    "InternalServerError",
+    "NotFoundError",
+    "RecordResponseObject",
+    "SkyflowAuth",
+    "SkyflowAuthEnvironment",
+    "TokenGroupRedactions",
+    "TokenizeResponseObject",
+    "TooManyRequestsError",
+    "UnauthorizedError",
+    "UniqueValue",
+    "UpdateRecordData",
+    "UpdateRecordDataUpdateType",
+    "UpdateRequestUpdateType",
+    "UpdateResponse",
+    "Upsert",
+    "UpsertUpdateType",
+    "__version__",
+    "query",
+    "records",
+    "tokens",
+]

skyflow/generated/rest/_default_clients.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError(
+                "To use the aiohttp client, install the aiohttp extra: pip install skyflow.generated.rest[aiohttp]"
+            )
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

skyflow/generated/rest/client.py

@@ -0,0 +1,385 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .core.logging import LogConfig, Logger
+from .core.request_options import RequestOptions
+from .environment import SkyflowAuthEnvironment
+from .raw_client import AsyncRawSkyflowAuth, RawSkyflowAuth
+
+if typing.TYPE_CHECKING:
+    from .query.client import AsyncQueryClient, QueryClient
+    from .records.client import AsyncRecordsClient, RecordsClient
+    from .tokens.client import AsyncTokensClient, TokensClient
+
+
+class SkyflowAuth:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : SkyflowAuthEnvironment
+        The environment to use for requests from the client. from .environment import SkyflowAuthEnvironment
+
+
+
+        Defaults to SkyflowAuthEnvironment.PRODUCTION
+
+
+
+    vault_url : typing.Optional[str]
+        Server URL variable for 'vault_url'. Defaults to '{{vault_url}}'.
+
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    max_retries : typing.Optional[int]
+        The default maximum number of retries for failed requests. Defaults to 2. Per-request `max_retries` in `request_options` takes precedence over this value.
+
+    stream_reconnection_enabled : typing.Optional[bool]
+        Whether to automatically reconnect on stream disconnection for resumable streaming endpoints. Defaults to True. Per-request `stream_reconnection_enabled` in `request_options` takes precedence over this value.
+
+    max_stream_reconnection_attempts : typing.Optional[int]
+        The maximum number of reconnection attempts for resumable streaming endpoints. Defaults to no limit. Per-request `max_stream_reconnection_attempts` in `request_options` takes precedence over this value.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    logging : typing.Optional[typing.Union[LogConfig, Logger]]
+        Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
+
+    Examples
+    --------
+    from skyflow import SkyflowAuth
+
+    client = SkyflowAuth(
+        token="YOUR_TOKEN",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: SkyflowAuthEnvironment = SkyflowAuthEnvironment.PRODUCTION,
+        vault_url: typing.Optional[str] = None,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        max_retries: typing.Optional[int] = None,
+        stream_reconnection_enabled: typing.Optional[bool] = None,
+        max_stream_reconnection_attempts: typing.Optional[int] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+        logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
+    ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        _defaulted_max_retries = max_retries if max_retries is not None else 2
+        if vault_url is not None:
+            _vault_url = vault_url if vault_url is not None else "{{vault_url}}"
+            _environment_url_templates = {
+                SkyflowAuthEnvironment.PRODUCTION: "https://{vault_url}",
+                SkyflowAuthEnvironment.SANDBOX: "https://{vault_url}",
+            }
+            _url_template = _environment_url_templates.get(environment, "https://{vault_url}")
+            if base_url is None:
+                base_url = _url_template.format(vault_url=_vault_url)
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+            max_retries=_defaulted_max_retries,
+            stream_reconnection_enabled=stream_reconnection_enabled,
+            max_stream_reconnection_attempts=max_stream_reconnection_attempts,
+            logging=logging,
+        )
+        self._raw_client = RawSkyflowAuth(client_wrapper=self._client_wrapper)
+        self._query: typing.Optional[QueryClient] = None
+        self._records: typing.Optional[RecordsClient] = None
+        self._tokens: typing.Optional[TokensClient] = None
+
+    @property
+    def with_raw_response(self) -> RawSkyflowAuth:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSkyflowAuth
+        """
+        return self._raw_client
+
+    def patch_v2vaults_id(
+        self, vault_id: typing.Optional[str], *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Parameters
+        ----------
+        vault_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from skyflow import SkyflowAuth
+
+        client = SkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+        client.patch_v2vaults_id()
+        """
+        _response = self._raw_client.patch_v2vaults_id(vault_id, request_options=request_options)
+        return _response.data
+
+    @property
+    def query(self):
+        if self._query is None:
+            from .query.client import QueryClient  # noqa: E402
+
+            self._query = QueryClient(client_wrapper=self._client_wrapper)
+        return self._query
+
+    @property
+    def records(self):
+        if self._records is None:
+            from .records.client import RecordsClient  # noqa: E402
+
+            self._records = RecordsClient(client_wrapper=self._client_wrapper)
+        return self._records
+
+    @property
+    def tokens(self):
+        if self._tokens is None:
+            from .tokens.client import TokensClient  # noqa: E402
+
+            self._tokens = TokensClient(client_wrapper=self._client_wrapper)
+        return self._tokens
+
+
+def _make_default_async_client(
+    timeout: typing.Optional[float],
+    follow_redirects: typing.Optional[bool],
+) -> httpx.AsyncClient:
+    try:
+        import httpx_aiohttp  # type: ignore[import-not-found]
+    except ImportError:
+        pass
+    else:
+        if follow_redirects is not None:
+            return httpx_aiohttp.HttpxAiohttpClient(timeout=timeout, follow_redirects=follow_redirects)
+        return httpx_aiohttp.HttpxAiohttpClient(timeout=timeout)
+
+    if follow_redirects is not None:
+        return httpx.AsyncClient(timeout=timeout, follow_redirects=follow_redirects)
+    return httpx.AsyncClient(timeout=timeout)
+
+
+class AsyncSkyflowAuth:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : SkyflowAuthEnvironment
+        The environment to use for requests from the client. from .environment import SkyflowAuthEnvironment
+
+
+
+        Defaults to SkyflowAuthEnvironment.PRODUCTION
+
+
+
+    vault_url : typing.Optional[str]
+        Server URL variable for 'vault_url'. Defaults to '{{vault_url}}'.
+
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    async_token : typing.Optional[typing.Callable[[], typing.Awaitable[str]]]
+        An async callable that returns a bearer token. Use this when token acquisition involves async I/O (e.g., refreshing tokens via an async HTTP client). When provided, this is used instead of the synchronous token for async requests.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    max_retries : typing.Optional[int]
+        The default maximum number of retries for failed requests. Defaults to 2. Per-request `max_retries` in `request_options` takes precedence over this value.
+
+    stream_reconnection_enabled : typing.Optional[bool]
+        Whether to automatically reconnect on stream disconnection for resumable streaming endpoints. Defaults to True. Per-request `stream_reconnection_enabled` in `request_options` takes precedence over this value.
+
+    max_stream_reconnection_attempts : typing.Optional[int]
+        The maximum number of reconnection attempts for resumable streaming endpoints. Defaults to no limit. Per-request `max_stream_reconnection_attempts` in `request_options` takes precedence over this value.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    logging : typing.Optional[typing.Union[LogConfig, Logger]]
+        Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
+
+    Examples
+    --------
+    from skyflow import AsyncSkyflowAuth
+
+    client = AsyncSkyflowAuth(
+        token="YOUR_TOKEN",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: SkyflowAuthEnvironment = SkyflowAuthEnvironment.PRODUCTION,
+        vault_url: typing.Optional[str] = None,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        async_token: typing.Optional[typing.Callable[[], typing.Awaitable[str]]] = None,
+        timeout: typing.Optional[float] = None,
+        max_retries: typing.Optional[int] = None,
+        stream_reconnection_enabled: typing.Optional[bool] = None,
+        max_stream_reconnection_attempts: typing.Optional[int] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+        logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
+    ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        _defaulted_max_retries = max_retries if max_retries is not None else 2
+        if vault_url is not None:
+            _vault_url = vault_url if vault_url is not None else "{{vault_url}}"
+            _environment_url_templates = {
+                SkyflowAuthEnvironment.PRODUCTION: "https://{vault_url}",
+                SkyflowAuthEnvironment.SANDBOX: "https://{vault_url}",
+            }
+            _url_template = _environment_url_templates.get(environment, "https://{vault_url}")
+            if base_url is None:
+                base_url = _url_template.format(vault_url=_vault_url)
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            headers=headers,
+            async_token=async_token,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else _make_default_async_client(timeout=_defaulted_timeout, follow_redirects=follow_redirects),
+            timeout=_defaulted_timeout,
+            max_retries=_defaulted_max_retries,
+            stream_reconnection_enabled=stream_reconnection_enabled,
+            max_stream_reconnection_attempts=max_stream_reconnection_attempts,
+            logging=logging,
+        )
+        self._raw_client = AsyncRawSkyflowAuth(client_wrapper=self._client_wrapper)
+        self._query: typing.Optional[AsyncQueryClient] = None
+        self._records: typing.Optional[AsyncRecordsClient] = None
+        self._tokens: typing.Optional[AsyncTokensClient] = None
+
+    @property
+    def with_raw_response(self) -> AsyncRawSkyflowAuth:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSkyflowAuth
+        """
+        return self._raw_client
+
+    async def patch_v2vaults_id(
+        self, vault_id: typing.Optional[str], *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Parameters
+        ----------
+        vault_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from skyflow import AsyncSkyflowAuth
+
+        client = AsyncSkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.patch_v2vaults_id()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.patch_v2vaults_id(vault_id, request_options=request_options)
+        return _response.data
+
+    @property
+    def query(self):
+        if self._query is None:
+            from .query.client import AsyncQueryClient  # noqa: E402
+
+            self._query = AsyncQueryClient(client_wrapper=self._client_wrapper)
+        return self._query
+
+    @property
+    def records(self):
+        if self._records is None:
+            from .records.client import AsyncRecordsClient  # noqa: E402
+
+            self._records = AsyncRecordsClient(client_wrapper=self._client_wrapper)
+        return self._records
+
+    @property
+    def tokens(self):
+        if self._tokens is None:
+            from .tokens.client import AsyncTokensClient  # noqa: E402
+
+            self._tokens = AsyncTokensClient(client_wrapper=self._client_wrapper)
+        return self._tokens
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: SkyflowAuthEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")