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

skyflow/generated/rest/tokens/raw_client.py

@@ -0,0 +1,507 @@
+# 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.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.internal_server_error import InternalServerError
+from ..errors.not_found_error import NotFoundError
+from ..errors.too_many_requests_error import TooManyRequestsError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..types.detokenize_response import DetokenizeResponse
+from ..types.error_response import ErrorResponse
+from ..types.get_tokens_from_values_request_object import GetTokensFromValuesRequestObject
+from ..types.get_tokens_from_values_response import GetTokensFromValuesResponse
+from ..types.token_group_redactions import TokenGroupRedactions
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawTokensClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_tokens(
+        self,
+        *,
+        vault_id: str,
+        records: typing.Sequence[GetTokensFromValuesRequestObject],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[GetTokensFromValuesResponse]:
+        """
+        Returns the deterministic token previously issued for each supplied plaintext value within the specified token group. Only applicable to deterministic tokengroups.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        records : typing.Sequence[GetTokensFromValuesRequestObject]
+            Array of value/token-group pairs to look up.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetTokensFromValuesResponse]
+            OK
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v2/records/getTokens",
+            method="POST",
+            json={
+                "vaultID": vault_id,
+                "records": convert_and_respect_annotation_metadata(
+                    object_=records, annotation=typing.Sequence[GetTokensFromValuesRequestObject], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetTokensFromValuesResponse,
+                    parse_obj_as(
+                        type_=GetTokensFromValuesResponse,  # 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(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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 detokenize(
+        self,
+        *,
+        vault_id: str,
+        tokens: typing.Sequence[str],
+        token_group_redactions: typing.Optional[typing.Sequence[TokenGroupRedactions]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[DetokenizeResponse]:
+        """
+        Returns values that correspond to the specified tokens.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        tokens : typing.Sequence[str]
+            Token to be detokenized
+
+        token_group_redactions : typing.Optional[typing.Sequence[TokenGroupRedactions]]
+            List of token groups to redact.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[DetokenizeResponse]
+            OK
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v2/tokens/detokenize",
+            method="POST",
+            json={
+                "vaultID": vault_id,
+                "tokens": tokens,
+                "tokenGroupRedactions": convert_and_respect_annotation_metadata(
+                    object_=token_group_redactions, annotation=typing.Sequence[TokenGroupRedactions], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    DetokenizeResponse,
+                    parse_obj_as(
+                        type_=DetokenizeResponse,  # 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(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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 AsyncRawTokensClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_tokens(
+        self,
+        *,
+        vault_id: str,
+        records: typing.Sequence[GetTokensFromValuesRequestObject],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[GetTokensFromValuesResponse]:
+        """
+        Returns the deterministic token previously issued for each supplied plaintext value within the specified token group. Only applicable to deterministic tokengroups.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        records : typing.Sequence[GetTokensFromValuesRequestObject]
+            Array of value/token-group pairs to look up.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetTokensFromValuesResponse]
+            OK
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v2/records/getTokens",
+            method="POST",
+            json={
+                "vaultID": vault_id,
+                "records": convert_and_respect_annotation_metadata(
+                    object_=records, annotation=typing.Sequence[GetTokensFromValuesRequestObject], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetTokensFromValuesResponse,
+                    parse_obj_as(
+                        type_=GetTokensFromValuesResponse,  # 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(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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 detokenize(
+        self,
+        *,
+        vault_id: str,
+        tokens: typing.Sequence[str],
+        token_group_redactions: typing.Optional[typing.Sequence[TokenGroupRedactions]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[DetokenizeResponse]:
+        """
+        Returns values that correspond to the specified tokens.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        tokens : typing.Sequence[str]
+            Token to be detokenized
+
+        token_group_redactions : typing.Optional[typing.Sequence[TokenGroupRedactions]]
+            List of token groups to redact.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[DetokenizeResponse]
+            OK
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v2/tokens/detokenize",
+            method="POST",
+            json={
+                "vaultID": vault_id,
+                "tokens": tokens,
+                "tokenGroupRedactions": convert_and_respect_annotation_metadata(
+                    object_=token_group_redactions, annotation=typing.Sequence[TokenGroupRedactions], direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    DetokenizeResponse,
+                    parse_obj_as(
+                        type_=DetokenizeResponse,  # 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(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)

skyflow/generated/rest/types/__init__.py

@@ -0,0 +1,116 @@
+# 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 .column_redactions import ColumnRedactions
+    from .delete_response import DeleteResponse
+    from .delete_response_object import DeleteResponseObject
+    from .detokenize_response import DetokenizeResponse
+    from .detokenize_response_object import DetokenizeResponseObject
+    from .error_response import ErrorResponse
+    from .error_response_error import ErrorResponseError
+    from .execute_query_record_response import ExecuteQueryRecordResponse
+    from .execute_query_response import ExecuteQueryResponse
+    from .execute_query_response_metadata import ExecuteQueryResponseMetadata
+    from .get_request_data import GetRequestData
+    from .get_response import GetResponse
+    from .get_tokens_from_values_request_object import GetTokensFromValuesRequestObject
+    from .get_tokens_from_values_response import GetTokensFromValuesResponse
+    from .google_protobuf_value import GoogleProtobufValue
+    from .http_code import HttpCode
+    from .insert_record_data import InsertRecordData
+    from .insert_response import InsertResponse
+    from .record_response_object import RecordResponseObject
+    from .token_group_redactions import TokenGroupRedactions
+    from .tokenize_response_object import TokenizeResponseObject
+    from .unique_value import UniqueValue
+    from .update_record_data import UpdateRecordData
+    from .update_record_data_update_type import UpdateRecordDataUpdateType
+    from .update_response import UpdateResponse
+    from .upsert import Upsert
+    from .upsert_update_type import UpsertUpdateType
+_dynamic_imports: typing.Dict[str, str] = {
+    "ColumnRedactions": ".column_redactions",
+    "DeleteResponse": ".delete_response",
+    "DeleteResponseObject": ".delete_response_object",
+    "DetokenizeResponse": ".detokenize_response",
+    "DetokenizeResponseObject": ".detokenize_response_object",
+    "ErrorResponse": ".error_response",
+    "ErrorResponseError": ".error_response_error",
+    "ExecuteQueryRecordResponse": ".execute_query_record_response",
+    "ExecuteQueryResponse": ".execute_query_response",
+    "ExecuteQueryResponseMetadata": ".execute_query_response_metadata",
+    "GetRequestData": ".get_request_data",
+    "GetResponse": ".get_response",
+    "GetTokensFromValuesRequestObject": ".get_tokens_from_values_request_object",
+    "GetTokensFromValuesResponse": ".get_tokens_from_values_response",
+    "GoogleProtobufValue": ".google_protobuf_value",
+    "HttpCode": ".http_code",
+    "InsertRecordData": ".insert_record_data",
+    "InsertResponse": ".insert_response",
+    "RecordResponseObject": ".record_response_object",
+    "TokenGroupRedactions": ".token_group_redactions",
+    "TokenizeResponseObject": ".tokenize_response_object",
+    "UniqueValue": ".unique_value",
+    "UpdateRecordData": ".update_record_data",
+    "UpdateRecordDataUpdateType": ".update_record_data_update_type",
+    "UpdateResponse": ".update_response",
+    "Upsert": ".upsert",
+    "UpsertUpdateType": ".upsert_update_type",
+}
+
+
+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__ = [
+    "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",
+]

skyflow/generated/rest/types/column_redactions.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class ColumnRedactions(UniversalBaseModel):
+    column_name: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="columnName"),
+        pydantic.Field(alias="columnName", description="Name of the column to redact."),
+    ]
+    """
+    Name of the column to redact.
+    """
+
+    redaction: str = pydantic.Field()
+    """
+    Name of the redaction type.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

skyflow/generated/rest/types/delete_response.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .delete_response_object import DeleteResponseObject
+
+
+class DeleteResponse(UniversalBaseModel):
+    records: typing.List[DeleteResponseObject] = pydantic.Field()
+    """
+    List of deleted records with skyflow ID and any partial errors.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow