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

skyflow/generated/rest/types/delete_response_object.py

@@ -0,0 +1,42 @@
+# 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 DeleteResponseObject(UniversalBaseModel):
+    skyflow_id: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="skyflowID"),
+        pydantic.Field(alias="skyflowID", description="Skyflow ID of the deleted record."),
+    ]
+    """
+    Skyflow ID of the deleted record.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message, if any.
+    """
+
+    http_code: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="httpCode"),
+        pydantic.Field(alias="httpCode", description="HTTP status code of the response."),
+    ]
+    """
+    HTTP status code of the response.
+    """
+
+    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/detokenize_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 .detokenize_response_object import DetokenizeResponseObject
+
+
+class DetokenizeResponse(UniversalBaseModel):
+    response: typing.List[DetokenizeResponseObject] = pydantic.Field()
+    """
+    Detokenized data
+    """
+
+    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/detokenize_response_object.py

@@ -0,0 +1,54 @@
+# 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
+from .google_protobuf_value import GoogleProtobufValue
+
+
+class DetokenizeResponseObject(UniversalBaseModel):
+    token: str = pydantic.Field()
+    """
+    Token that was detokenized.
+    """
+
+    value: typing.Optional[GoogleProtobufValue] = None
+    token_group_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="tokenGroupName"),
+        pydantic.Field(alias="tokenGroupName", description="Name of the token group."),
+    ] = None
+    """
+    Name of the token group.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message, if any.
+    """
+
+    http_code: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="httpCode"),
+        pydantic.Field(alias="httpCode", description="HTTP status code of the response."),
+    ] = None
+    """
+    HTTP status code of the response.
+    """
+
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Additional metadata associated with the token, such as tableName or skyflowID.
+    """
+
+    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/error_response.py

@@ -0,0 +1,20 @@
+# 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 .error_response_error import ErrorResponseError
+
+
+class ErrorResponse(UniversalBaseModel):
+    error: ErrorResponseError
+
+    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/error_response_error.py

@@ -0,0 +1,28 @@
+# 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 .http_code import HttpCode
+
+
+class ErrorResponseError(UniversalBaseModel):
+    grpc_code: int = pydantic.Field()
+    """
+    gRPC status codes. See https://grpc.io/docs/guides/status-codes.
+    """
+
+    http_code: HttpCode
+    http_status: str
+    message: str
+    details: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None
+
+    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/execute_query_record_response.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ExecuteQueryRecordResponse(UniversalBaseModel):
+    data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Fields and values for the record.
+    """
+
+    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/execute_query_response.py

@@ -0,0 +1,26 @@
+# 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 .execute_query_record_response import ExecuteQueryRecordResponse
+from .execute_query_response_metadata import ExecuteQueryResponseMetadata
+
+
+class ExecuteQueryResponse(UniversalBaseModel):
+    records: typing.Optional[typing.List[ExecuteQueryRecordResponse]] = pydantic.Field(default=None)
+    """
+    Records corresponding to the specified query.
+    """
+
+    metadata: typing.Optional[ExecuteQueryResponseMetadata] = None
+
+    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/execute_query_response_metadata.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ExecuteQueryResponseMetadata(UniversalBaseModel):
+    """
+    Metadata for the query.
+    """
+
+    columns: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Columns returned for the query.
+    """
+
+    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/get_request_data.py

@@ -0,0 +1,60 @@
+# 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
+from .column_redactions import ColumnRedactions
+from .unique_value import UniqueValue
+
+
+class GetRequestData(UniversalBaseModel):
+    table_name: typing_extensions.Annotated[
+        str, FieldMetadata(alias="tableName"), pydantic.Field(alias="tableName", description="Name of the table.")
+    ]
+    """
+    Name of the table.
+    """
+
+    skyflow_i_ds: typing_extensions.Annotated[
+        typing.List[str],
+        FieldMetadata(alias="skyflowIDs"),
+        pydantic.Field(alias="skyflowIDs", description="Skyflow IDs of the records to return."),
+    ]
+    """
+    Skyflow IDs of the records to return.
+    """
+
+    column_redactions: typing_extensions.Annotated[
+        typing.Optional[typing.List[ColumnRedactions]],
+        FieldMetadata(alias="columnRedactions"),
+        pydantic.Field(alias="columnRedactions", description="List of columns to redact."),
+    ] = None
+    """
+    List of columns to redact.
+    """
+
+    columns: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    List of columns to return.
+    """
+
+    unique_values: typing_extensions.Annotated[
+        typing.Optional[typing.List[UniqueValue]],
+        FieldMetadata(alias="uniqueValues"),
+        pydantic.Field(alias="uniqueValues", description="List of unique constraint values to query records by data."),
+    ] = None
+    """
+    List of unique constraint values to query records by data.
+    """
+
+    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/get_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 .record_response_object import RecordResponseObject
+
+
+class GetResponse(UniversalBaseModel):
+    records: typing.List[RecordResponseObject] = pydantic.Field()
+    """
+    List of fetched records. For file columns, the value in the data map is an object containing: fileName, mimeType, sizeBytes, fileStatus (PENDING | READY | FAILED | SCAN_ERROR), fileFailureReason (non-null only when fileStatus is FAILED), url (pre-signed download URL, non-null only when fileStatus is READY), and urlExpiresAt (UTC expiry of the URL).
+    """
+
+    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/get_tokens_from_values_request_object.py

@@ -0,0 +1,30 @@
+# 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
+from .google_protobuf_value import GoogleProtobufValue
+
+
+class GetTokensFromValuesRequestObject(UniversalBaseModel):
+    value: GoogleProtobufValue
+    token_group_name: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="tokenGroupName"),
+        pydantic.Field(alias="tokenGroupName", description="Name of the deterministic token group."),
+    ]
+    """
+    Name of the deterministic token group.
+    """
+
+    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/get_tokens_from_values_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 .tokenize_response_object import TokenizeResponseObject
+
+
+class GetTokensFromValuesResponse(UniversalBaseModel):
+    records: typing.List[TokenizeResponseObject] = pydantic.Field()
+    """
+    Array of token result objects, one per input entry, in the same order as the request.
+    """
+
+    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/google_protobuf_value.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GoogleProtobufValue = typing.Any
+"""
+Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
+"""

skyflow/generated/rest/types/http_code.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+HttpCode = int
+"""
+HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
+"""

skyflow/generated/rest/types/insert_record_data.py

@@ -0,0 +1,36 @@
+# 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
+from .upsert import Upsert
+
+
+class InsertRecordData(UniversalBaseModel):
+    data: typing.Dict[str, typing.Any] = pydantic.Field()
+    """
+    Columns and values for the record.
+    """
+
+    table_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="tableName"),
+        pydantic.Field(alias="tableName", description="Name of the table to insert data into."),
+    ] = None
+    """
+    Name of the table to insert data into.
+    """
+
+    upsert: typing.Optional[Upsert] = None
+
+    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/insert_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 .record_response_object import RecordResponseObject
+
+
+class InsertResponse(UniversalBaseModel):
+    records: typing.List[RecordResponseObject] = pydantic.Field()
+    """
+    List of inserted records.
+    """
+
+    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/record_response_object.py

@@ -0,0 +1,70 @@
+# 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 RecordResponseObject(UniversalBaseModel):
+    skyflow_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="skyflowID"),
+        pydantic.Field(alias="skyflowID", description="Skyflow ID for the inserted record"),
+    ] = None
+    """
+    Skyflow ID for the inserted record
+    """
+
+    tokens: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Columns and tokens for the record.
+    """
+
+    data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Columns and values for the record. For file columns, the value is an object containing file metadata: fileName, mimeType, sizeBytes, fileStatus (PENDING | READY | FAILED | SCAN_ERROR), fileFailureReason (populated only when fileStatus is FAILED), url (pre-signed download URL, populated only when fileStatus is READY), and urlExpiresAt (UTC expiry of the URL).
+    """
+
+    hashed_data: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Any]],
+        FieldMetadata(alias="hashedData"),
+        pydantic.Field(alias="hashedData", description="Columns and hashed values for the record."),
+    ] = None
+    """
+    Columns and hashed values for the record.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message, if any.
+    """
+
+    http_code: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="httpCode"),
+        pydantic.Field(alias="httpCode", description="HTTP status code of the response."),
+    ]
+    """
+    HTTP status code of the response.
+    """
+
+    table_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="tableName"),
+        pydantic.Field(alias="tableName", description="Name of the table that the record belongs to."),
+    ] = None
+    """
+    Name of the table that the record belongs to.
+    """
+
+    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/token_group_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 TokenGroupRedactions(UniversalBaseModel):
+    token_group_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="tokenGroupName"),
+        pydantic.Field(alias="tokenGroupName", description="Name of the token group to redact."),
+    ] = None
+    """
+    Name of the token group to redact.
+    """
+
+    redaction: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the redaction to perform.
+    """
+
+    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/tokenize_response_object.py

@@ -0,0 +1,49 @@
+# 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
+from .google_protobuf_value import GoogleProtobufValue
+
+
+class TokenizeResponseObject(UniversalBaseModel):
+    token: str = pydantic.Field()
+    """
+    Token that was generated.
+    """
+
+    value: GoogleProtobufValue
+    token_group_name: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="tokenGroupName"),
+        pydantic.Field(alias="tokenGroupName", description="Name of the token group."),
+    ]
+    """
+    Name of the token group.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message, if any.
+    """
+
+    http_code: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="httpCode"),
+        pydantic.Field(alias="httpCode", description="HTTP status code of the response."),
+    ] = None
+    """
+    HTTP status code of the response.
+    """
+
+    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/unique_value.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class UniqueValue(UniversalBaseModel):
+    data: typing.Dict[str, typing.Any] = pydantic.Field()
+    """
+    Columns names and values for the unique value entry.
+    """
+
+    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