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

skyflow/generated/rest/types/update_record_data.py

@@ -0,0 +1,52 @@
+# 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 .update_record_data_update_type import UpdateRecordDataUpdateType
+
+
+class UpdateRecordData(UniversalBaseModel):
+    skyflow_id: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="skyflowID"),
+        pydantic.Field(alias="skyflowID", description="Skyflow ID of the record to update."),
+    ]
+    """
+    Skyflow ID of the record to update.
+    """
+
+    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 update data in."),
+    ] = None
+    """
+    Name of the table to update data in.
+    """
+
+    update_type: typing_extensions.Annotated[
+        typing.Optional[UpdateRecordDataUpdateType],
+        FieldMetadata(alias="updateType"),
+        pydantic.Field(alias="updateType", description="Type of update operation to perform."),
+    ] = None
+    """
+    Type of update operation 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/update_record_data_update_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UpdateRecordDataUpdateType = typing.Union[typing.Literal["UPDATE", "REPLACE"], typing.Any]

skyflow/generated/rest/types/update_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 UpdateResponse(UniversalBaseModel):
+    records: typing.List[RecordResponseObject] = pydantic.Field()
+    """
+    List of updated 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/upsert.py

@@ -0,0 +1,45 @@
+# 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_update_type import UpsertUpdateType
+
+
+class Upsert(UniversalBaseModel):
+    """
+    Upsert details.
+    """
+
+    update_type: typing_extensions.Annotated[
+        typing.Optional[UpsertUpdateType],
+        FieldMetadata(alias="updateType"),
+        pydantic.Field(alias="updateType", description="Type of update operation to perform."),
+    ] = None
+    """
+    Type of update operation to perform.
+    """
+
+    unique_columns: typing_extensions.Annotated[
+        typing.List[str],
+        FieldMetadata(alias="uniqueColumns"),
+        pydantic.Field(
+            alias="uniqueColumns",
+            description="List of unique columns in the table that upsert operations use to identify if a record with matching values exists. If a matching record exists, the record updates with the specified values. If a matching record doesn't exist, the upsert operation inserts a new record.",
+        ),
+    ]
+    """
+    List of unique columns in the table that upsert operations use to identify if a record with matching values exists. If a matching record exists, the record updates with the specified values. If a matching record doesn't exist, the upsert operation inserts a new 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/upsert_update_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UpsertUpdateType = typing.Union[typing.Literal["UPDATE", "REPLACE"], typing.Any]

skyflow/generated/rest/version.py

@@ -0,0 +1,6 @@
+from importlib import metadata
+
+try:
+    __version__ = metadata.version("skyflow-flowvault-python")
+except metadata.PackageNotFoundError:
+    __version__ = "0.0.0"

skyflow/service_account/__init__.py

@@ -0,0 +1,15 @@
+from common.service_account import (
+    generate_bearer_token,
+    generate_bearer_token_from_creds,
+    is_expired,
+    generate_signed_data_tokens,
+    generate_signed_data_tokens_from_creds,
+)
+
+__all__ = [
+    "generate_bearer_token",
+    "generate_bearer_token_from_creds",
+    "is_expired",
+    "generate_signed_data_tokens",
+    "generate_signed_data_tokens_from_creds",
+]

skyflow/utils/__init__.py

@@ -0,0 +1,9 @@
+# Must be imported before anything that pulls in common.utils -- see its _skyflow_messages.py
+# comment for why the load order matters.
+from ._version import SDK_VERSION
+
+from common.utils import LogLevel, Env
+
+from .enums import UpsertType, EnvUrls, CustomHeaderKey
+from ._skyflow_messages import SkyflowMessages
+from ._utils import get_metrics, get_vault_url

skyflow/utils/_http_config.py

@@ -0,0 +1,36 @@
+from common.utils.validations._validations import VALID_VAULT_CONFIG_KEYS
+
+TIMEOUT_KEY = "timeout"
+CONNECT_TIMEOUT_KEY = "connect_timeout"
+READ_TIMEOUT_KEY = "read_timeout"
+WRITE_TIMEOUT_KEY = "write_timeout"
+MAX_RETRIES_KEY = "max_retries"
+INITIAL_RETRY_DELAY_MILLIS_KEY = "initial_retry_delay_millis"
+MAX_RETRY_DELAY_MILLIS_KEY = "max_retry_delay_millis"
+VAULT_URL_KEY = "vault_url"
+
+DEFAULT_TIMEOUT = 60
+DEFAULT_CONNECT_TIMEOUT = 10
+DEFAULT_READ_TIMEOUT = 10
+DEFAULT_WRITE_TIMEOUT = 10
+DEFAULT_MAX_RETRIES = 0
+DEFAULT_INITIAL_RETRY_DELAY_MILLIS = 500
+DEFAULT_MAX_RETRY_DELAY_MILLIS = 2000
+
+DEFAULT_MAX_CONNECTIONS = 100
+DEFAULT_MAX_KEEPALIVE_CONNECTIONS = 100
+DEFAULT_KEEPALIVE_EXPIRY = 60
+
+POSITIVE_SECOND_KEYS = (TIMEOUT_KEY, CONNECT_TIMEOUT_KEY, READ_TIMEOUT_KEY, WRITE_TIMEOUT_KEY)
+NON_NEGATIVE_INT_KEYS = (MAX_RETRIES_KEY, INITIAL_RETRY_DELAY_MILLIS_KEY, MAX_RETRY_DELAY_MILLIS_KEY)
+
+CLIENT_HTTP_CONFIG_KEYS = (*POSITIVE_SECOND_KEYS, *NON_NEGATIVE_INT_KEYS)
+VAULT_CONFIG_KEYS = [*VALID_VAULT_CONFIG_KEYS, *CLIENT_HTTP_CONFIG_KEYS, VAULT_URL_KEY]
+
+
+def resolve_setting(vault_config, common_config, key, default):
+    if vault_config is not None and key in vault_config:
+        return vault_config[key]
+    if common_config is not None and key in common_config:
+        return common_config[key]
+    return default

skyflow/utils/_response_parsing.py

@@ -0,0 +1,66 @@
+def parse_tokens(raw):
+    if raw is None:
+        return None
+    parsed = {}
+    for column, value in raw.items():
+        entries = _parse_entries(value, _to_token)
+        if entries is not None:
+            parsed[column] = entries
+    return parsed
+
+
+def parse_hashed_data(raw):
+    if raw is None:
+        return None
+    parsed = {}
+    for column, value in raw.items():
+        entries = _parse_entries(value, _to_hash)
+        if entries is not None:
+            parsed[column] = entries
+    return parsed
+
+
+def parse_metadata(raw):
+    if raw is None:
+        return None
+    from skyflow.vault.data._detokenize_response_record_metadata import DetokenizeResponseRecordMetadata
+    return DetokenizeResponseRecordMetadata(
+        skyflow_id=raw.get('skyflowID', raw.get('skyflowId', raw.get('skyflow_id'))),
+        table_name=raw.get('table', raw.get('tableName', raw.get('table_name'))),
+    )
+
+
+def _parse_entries(raw_value, to_entry):
+    if raw_value is None:
+        return None
+    items = raw_value if isinstance(raw_value, list) else [raw_value]
+    entries = []
+    for item in items:
+        entry = to_entry(item)
+        if entry is not None:
+            entries.append(entry)
+    return entries
+
+
+def _to_token(entry):
+    from skyflow.vault.data._token import Token
+    if isinstance(entry, dict):
+        return Token(
+            token=entry.get('token'),
+            token_group_name=entry.get('tokenGroupName', entry.get('token_group_name')),
+            path=entry.get('path'),
+        )
+    if entry is not None:
+        return Token(token=entry)
+    return None
+
+
+def _to_hash(entry):
+    if isinstance(entry, dict):
+        return {
+            'data': entry.get('data'),
+            'hash_name': entry.get('hashName', entry.get('hash_name')),
+        }
+    if entry is not None:
+        return {'data': entry, 'hash_name': None}
+    return None

skyflow/utils/_retry.py

@@ -0,0 +1,97 @@
+import asyncio
+import time
+from random import randint
+
+import httpx
+
+RETRYABLE_STATUS_CODES = frozenset({408, 429})
+MIN_SERVER_ERROR_STATUS = 500
+JITTER_FACTOR = 0.2
+MILLIS_PER_SECOND = 1000.0
+
+
+def should_retry(status_code):
+    return status_code in RETRYABLE_STATUS_CODES or status_code >= MIN_SERVER_ERROR_STATUS
+
+
+def backoff_millis(attempt, initial_millis, max_millis):
+    delay = initial_millis
+    step = 1
+    while step < attempt and delay < max_millis:
+        delay = max_millis if delay > max_millis / 2 else delay * 2
+        step += 1
+    delay = min(delay, max_millis)
+    jitter = int(delay * JITTER_FACTOR)
+    if jitter <= 0:
+        return delay
+    return max(0, delay - jitter + randint(0, 2 * jitter))
+
+
+class _RetryPolicy:
+    def __init__(self, max_retries, initial_millis, max_millis, call_timeout):
+        self.max_retries = max_retries
+        self.initial_millis = initial_millis
+        self.max_millis = max_millis
+        self.call_timeout = call_timeout
+
+    def deadline(self):
+        return time.monotonic() + self.call_timeout if self.call_timeout else None
+
+    def next_sleep_seconds(self, retry, deadline):
+        if retry >= self.max_retries:
+            return None
+        if deadline is not None and time.monotonic() >= deadline:
+            return None
+        sleep_seconds = backoff_millis(retry + 1, self.initial_millis, self.max_millis) / MILLIS_PER_SECOND
+        if deadline is not None:
+            remaining = deadline - time.monotonic()
+            if remaining <= 0:
+                return None
+            sleep_seconds = min(sleep_seconds, remaining)
+        return sleep_seconds
+
+
+class RetryTransport(httpx.BaseTransport):
+    def __init__(self, transport, max_retries, initial_millis, max_millis, call_timeout):
+        self._transport = transport
+        self._policy = _RetryPolicy(max_retries, initial_millis, max_millis, call_timeout)
+
+    def handle_request(self, request):
+        deadline = self._policy.deadline()
+        response = self._transport.handle_request(request)
+        retry = 0
+        while should_retry(response.status_code):
+            sleep_seconds = self._policy.next_sleep_seconds(retry, deadline)
+            if sleep_seconds is None:
+                break
+            response.close()
+            time.sleep(sleep_seconds)
+            response = self._transport.handle_request(request)
+            retry += 1
+        return response
+
+    def close(self):
+        self._transport.close()
+
+
+class AsyncRetryTransport(httpx.AsyncBaseTransport):
+    def __init__(self, transport, max_retries, initial_millis, max_millis, call_timeout):
+        self._transport = transport
+        self._policy = _RetryPolicy(max_retries, initial_millis, max_millis, call_timeout)
+
+    async def handle_async_request(self, request):
+        deadline = self._policy.deadline()
+        response = await self._transport.handle_async_request(request)
+        retry = 0
+        while should_retry(response.status_code):
+            sleep_seconds = self._policy.next_sleep_seconds(retry, deadline)
+            if sleep_seconds is None:
+                break
+            await response.aclose()
+            await asyncio.sleep(sleep_seconds)
+            response = await self._transport.handle_async_request(request)
+            retry += 1
+        return response
+
+    async def aclose(self):
+        await self._transport.aclose()

skyflow/utils/_skyflow_messages.py

@@ -0,0 +1,114 @@
+from enum import Enum
+
+try:
+    from ._version import SDK_VERSION
+except ImportError:  # pragma: no cover
+    SDK_VERSION = "0.0.0"
+
+error_prefix = f"Skyflow Python SDK {SDK_VERSION}"
+INFO = "INFO"
+WARN = "WARN"
+ERROR = "ERROR"
+
+
+class SkyflowMessages:
+    """v3's own operation-specific message catalog, mirroring v2's per-variant pattern. Generic
+    infrastructure text lives in common.utils.SkyflowMessages instead."""
+
+    class Error(Enum):
+        INVALID_TIMEOUT = f"{error_prefix} Validation error. '{{}}' must be a positive number of seconds."
+        INVALID_RETRY_SETTING = f"{error_prefix} Validation error. '{{}}' must be a non-negative integer."
+        INVALID_VAULT_URL = f"{error_prefix} Validation error. 'vault_url' must be a non-empty string."
+        EMPTY_RECORDS_IN_INSERT = f"{error_prefix} Insert failed. Specify at least one record to insert."
+        INVALID_RECORDS_TYPE_IN_INSERT = f"{error_prefix} Insert failed. 'records' must be a list of InsertRequestRecord objects."
+        INVALID_RECORD_DATA_IN_INSERT = f"{error_prefix} Validation error. Each record's 'values' must be a non-empty dict."
+        INVALID_TABLE_NAME_IN_INSERT = f"{error_prefix} Validation error. 'table' must be a non-empty string."
+        INVALID_UPSERT_TYPE_IN_INSERT = f"{error_prefix} Insert failed. 'upsert' must be an UpsertOptions object."
+        INVALID_UPSERT_UNIQUE_COLUMNS_IN_INSERT = f"{error_prefix} Insert failed. Upsert's 'unique_columns' must be a non-empty list of strings."
+        INVALID_UPSERT_UPDATE_TYPE_IN_INSERT = f"{error_prefix} Insert failed. Upsert's 'update_type' must be an UpsertType value."
+        TABLE_NAME_IN_BOTH_PLACES_IN_INSERT = (
+            f"{error_prefix} Insert failed. 'table' cannot be set on InsertRequest at the same "
+            "time as any record's 'table' -- the vault accepts a table name outside the records "
+            "(request-level, applying to all of them) or inside each record, but not both at once."
+        )
+        TABLE_NAME_MISSING_IN_INSERT = (
+            f"{error_prefix} Insert failed. 'table' is not set on InsertRequest, so every record "
+            "must set its own 'table' -- either set 'table' once at the request level, or set it "
+            "individually on every record."
+        )
+        RECORD_LEVEL_UPSERT_NOT_ALLOWED_IN_INSERT = (
+            f"{error_prefix} Insert failed. 'table' is set on InsertRequest (request-level), so "
+            "'upsert' must also be provided at the request level -- a record cannot set its own "
+            "'upsert' while 'table' is set at the request level."
+        )
+        REQUEST_LEVEL_UPSERT_NOT_ALLOWED_IN_INSERT = (
+            f"{error_prefix} Insert failed. 'table' is set per-record, so 'upsert' must also be "
+            "provided per-record -- InsertRequest's request-level 'upsert' cannot be used while "
+            "'table' is set on individual records."
+        )
+        EMPTY_KEY_IN_INSERT_DATA = f"{error_prefix} Validation error. Each record's 'values' must not contain a null or empty key."
+        EMPTY_VALUE_IN_INSERT_DATA = f"{error_prefix} Insert failed. Each record's 'values' must not contain a null or empty value."
+
+        MISSING_TABLE_NAME_IN_GET = f"{error_prefix} Get failed. Specify a table name."
+        MISSING_IDS_OR_UNIQUE_VALUES_IN_GET = f"{error_prefix} Get failed. Specify at least one of 'ids' or 'unique_values'."
+        INVALID_IDS_IN_GET = f"{error_prefix} Get failed. 'ids' must be a non-empty list of strings."
+        INVALID_RECORDS_TYPE_IN_GET = f"{error_prefix} Get failed. 'records' must be a non-empty list of GetRequestRecord objects."
+        GET_MODE_CONFLICT = f"{error_prefix} Get failed. Use either 'records' (multi-table) or the single-table fields (table/ids/unique_values/columns/column_redactions/limit/offset), not both."
+
+        EMPTY_RECORDS_IN_UPDATE = f"{error_prefix} Update failed. Specify at least one record to update."
+        INVALID_RECORDS_TYPE_IN_UPDATE = f"{error_prefix} Update failed. 'records' must be a list of UpdateRequestRecord objects."
+        MISSING_SKYFLOW_ID_IN_UPDATE = f"{error_prefix} Update failed. Each record must specify a non-empty 'skyflow_id'."
+        MISSING_DATA_IN_UPDATE = f"{error_prefix} Update failed. Each record must specify a non-empty 'data' object."
+        INVALID_DATA_TYPE_IN_UPDATE = f"{error_prefix} Update failed. Each record's 'data' must be a dict."
+        INVALID_UPDATE_TYPE_IN_UPDATE = f"{error_prefix} Update failed. 'update_type' must be an UpsertType value."
+        TABLE_NAME_IN_BOTH_PLACES_IN_UPDATE = (
+            f"{error_prefix} Update failed. 'table' cannot be set on UpdateRequest at the same "
+            "time as any record's 'table' -- specify a table name outside the records "
+            "(request-level, applying to all of them) or inside each record, but not both at once."
+        )
+        TABLE_NAME_MISSING_IN_UPDATE = (
+            f"{error_prefix} Update failed. 'table' is not set on UpdateRequest, so every record "
+            "must set its own 'table' -- either set 'table' once at the request level, or set it "
+            "individually on every record."
+        )
+
+        MISSING_TABLE_NAME_IN_DELETE = f"{error_prefix} Delete failed. Specify a table name."
+        MISSING_IDS_OR_UNIQUE_VALUES_IN_DELETE = f"{error_prefix} Delete failed. Specify at least one of 'ids' or 'unique_values'."
+        INVALID_IDS_IN_DELETE = f"{error_prefix} Delete failed. 'ids' must be a non-empty list of strings."
+
+        EMPTY_TOKENS_IN_DETOKENIZE = f"{error_prefix} Detokenize failed. Specify at least one token to detokenize."
+        INVALID_TOKENS_TYPE_IN_DETOKENIZE = f"{error_prefix} Detokenize failed. 'tokens' must be a non-empty list of strings."
+        INVALID_TOKEN_GROUP_REDACTIONS_IN_DETOKENIZE = f"{error_prefix} Detokenize failed. 'token_group_redactions' must be a list of TokenGroupRedactions objects with a non-empty 'token_group_name'."
+
+    class Info(Enum):
+        VALIDATE_INSERT_REQUEST = f"{INFO}: [{error_prefix}] Validating insert request."
+        INSERT_TRIGGERED = f"{INFO}: [{error_prefix}] Insert method triggered."
+        INSERT_REQUEST_RESOLVED = f"{INFO}: [{error_prefix}] Insert request resolved."
+        INSERT_SUCCESS = f"{INFO}: [{error_prefix}] Data inserted."
+
+        VALIDATE_GET_REQUEST = f"{INFO}: [{error_prefix}] Validating get request."
+        GET_TRIGGERED = f"{INFO}: [{error_prefix}] Get method triggered."
+        GET_REQUEST_RESOLVED = f"{INFO}: [{error_prefix}] Get request resolved."
+        GET_SUCCESS = f"{INFO}: [{error_prefix}] Data fetched."
+
+        VALIDATE_UPDATE_REQUEST = f"{INFO}: [{error_prefix}] Validating update request."
+        UPDATE_TRIGGERED = f"{INFO}: [{error_prefix}] Update method triggered."
+        UPDATE_REQUEST_RESOLVED = f"{INFO}: [{error_prefix}] Update request resolved."
+        UPDATE_SUCCESS = f"{INFO}: [{error_prefix}] Data updated."
+
+        VALIDATE_DELETE_REQUEST = f"{INFO}: [{error_prefix}] Validating delete request."
+        DELETE_TRIGGERED = f"{INFO}: [{error_prefix}] Delete method triggered."
+        DELETE_REQUEST_RESOLVED = f"{INFO}: [{error_prefix}] Delete request resolved."
+        DELETE_SUCCESS = f"{INFO}: [{error_prefix}] Data deleted."
+
+        VALIDATE_DETOKENIZE_REQUEST = f"{INFO}: [{error_prefix}] Validating detokenize request."
+        DETOKENIZE_TRIGGERED = f"{INFO}: [{error_prefix}] Detokenize method triggered."
+        DETOKENIZE_REQUEST_RESOLVED = f"{INFO}: [{error_prefix}] Detokenize request resolved."
+        DETOKENIZE_SUCCESS = f"{INFO}: [{error_prefix}] Tokens detokenized."
+
+    class ErrorLogs(Enum):
+        INSERT_RECORDS_REJECTED = f"{ERROR}: [{error_prefix}] Insert call resulted in failure."
+        GET_RECORDS_REJECTED = f"{ERROR}: [{error_prefix}] Get call resulted in failure."
+        UPDATE_RECORDS_REJECTED = f"{ERROR}: [{error_prefix}] Update call resulted in failure."
+        DELETE_RECORDS_REJECTED = f"{ERROR}: [{error_prefix}] Delete call resulted in failure."
+        DETOKENIZE_RECORDS_REJECTED = f"{ERROR}: [{error_prefix}] Detokenize call resulted in failure."

skyflow/utils/_utils.py

@@ -0,0 +1,54 @@
+import platform
+import sys
+
+from common.errors import SkyflowError
+from common.utils import SkyflowMessages as CommonMessages
+from common.utils.constants import PROTOCOL, SdkMetricsKey, SdkPrefix
+from common.utils.enums import Env
+from ._version import SDK_VERSION
+from .enums import EnvUrls
+
+_CACHED_METRICS: dict = {}
+
+invalid_input_error_code = CommonMessages.ErrorCodes.INVALID_INPUT.value
+
+
+def get_vault_url(cluster_id, env, vault_id, logger=None):
+    """Mirrors common.utils.get_vault_url with v3's own EnvUrls (different subdomain)."""
+    if not cluster_id or not isinstance(cluster_id, str) or not cluster_id.strip():
+        raise SkyflowError(CommonMessages.Error.INVALID_CLUSTER_ID.value.format(vault_id), invalid_input_error_code)
+
+    if not isinstance(env, Env):
+        raise SkyflowError(CommonMessages.Error.INVALID_ENV.value.format(vault_id), invalid_input_error_code)
+
+    base_url = EnvUrls[env.name].value
+
+    return f"{PROTOCOL}://{cluster_id}.{base_url}"
+
+
+def get_metrics():
+    if _CACHED_METRICS:
+        return _CACHED_METRICS
+
+    try:
+        sdk_client_device_model = platform.node()
+    except Exception:
+        sdk_client_device_model = ""
+
+    try:
+        sdk_client_os_details = sys.platform
+    except Exception:
+        sdk_client_os_details = ""
+
+    try:
+        sdk_runtime_details = sys.version
+    except Exception:
+        sdk_runtime_details = ""
+
+    _CACHED_METRICS.update({
+        SdkMetricsKey.SDK_NAME_VERSION: SdkPrefix.SKYFLOW_PYTHON + SDK_VERSION,
+        SdkMetricsKey.SDK_CLIENT_DEVICE_MODEL: sdk_client_device_model,
+        SdkMetricsKey.SDK_CLIENT_OS_DETAILS: sdk_client_os_details,
+        SdkMetricsKey.SDK_RUNTIME_DETAILS: SdkPrefix.PYTHON_RUNTIME + sdk_runtime_details,
+    })
+    return _CACHED_METRICS

skyflow/utils/_version.py

@@ -0,0 +1 @@
+SDK_VERSION = '1.0.0'

skyflow/utils/enums/__init__.py

@@ -0,0 +1,3 @@
+from ._upsert_type import UpsertType
+from ._env_urls import EnvUrls
+from ._custom_header_key import CustomHeaderKey

skyflow/utils/enums/_custom_header_key.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class CustomHeaderKey(Enum):
+    SKYFLOW_ACCOUNT_ID = "x-skyflow-account-id"
+    SKYFLOW_ACCOUNT_NAME = "x-skyflow-account-name"
+    REQUEST_ID_HEADER = "x-request-id"
+
+    def __str__(self):
+        return self.value

skyflow/utils/enums/_env_urls.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class EnvUrls(Enum):
+    """v3 vault hosts -- a different subdomain than v2 (skyvault vs. vault). All four confirmed."""
+    DEV = "skyvault.skyflowapis.dev"
+    PROD = "skyvault.skyflowapis.com"
+    SANDBOX = "skyvault.skyflowapis-preview.com"
+    STAGE = "skyvault.skyflowapis.tech"

skyflow/utils/enums/_upsert_type.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class UpsertType(Enum):
+    """Mirrors the wire enum FlowEnumUpdateType (V1Upsert.update_type)."""
+    REPLACE = "REPLACE"
+    UPDATE = "UPDATE"

skyflow/utils/validations/__init__.py

@@ -0,0 +1,9 @@
+from ._validations import (
+    validate_vault_config,
+    validate_update_vault_config,
+    validate_insert_request,
+    validate_get_request,
+    validate_update_request,
+    validate_delete_request,
+    validate_detokenize_request,
+)