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

common/generated/rest/__init__.py

@@ -2,23 +2,239 @@
 
 # isort: skip_file
 
-from .types import GooglerpcStatus, ProtobufAny, V1GetAuthTokenResponse
-from .errors import BadRequestError, NotFoundError, UnauthorizedError
-from . import authentication
-from .client import AsyncSkyflowAuth, SkyflowAuth
-from .environment import SkyflowAuthEnvironment
-from .version import __version__
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        AudioV2,
+        AudioV2Bleep,
+        AudioV2OutputTranscription,
+        DeidentifyFileResponseV2,
+        DeidentifyStringResponseV2,
+        DeidentifyStringResponseV2DetectedEntity,
+        DeidentifyStringResponseV2EntityLocation,
+        Detect,
+        DetectConfigV2,
+        DetectConfigV2VaultType,
+        DetectCustomTypes,
+        DetectCustomTypesDeidentificationType,
+        DetectCustomTypesIncludePrefix,
+        DetectEntity,
+        DetectEntityDeidentificationType,
+        DetectEntityEntityType,
+        DetectEntityIncludePrefix,
+        DetectGuardrailsResponseV2,
+        DetectGuardrailsResponseV2Validation,
+        DetectObjectEntity,
+        DetectObjectEntityDeidentificationType,
+        DetectObjectEntityEntityType,
+        DetectReturnEntities,
+        DetectRunsResponseV2,
+        DetectRunsResponseV2OutputType,
+        DetectRunsResponseV2Status,
+        DocumentV2,
+        DocumentV2Pdf,
+        DocumentV2PdfProcessingMode,
+        EntityTransformation,
+        ErrorResponse,
+        ErrorResponseError,
+        FileMapping,
+        FileOutput,
+        FileOutputProcessedFileExtension,
+        FileOutputProcessedFileType,
+        GetAuthTokenResponse,
+        GetStsTokenResponse,
+        HttpCode,
+        ImageV2,
+        ImageV2MaskingMethod,
+        Media,
+        Metrics,
+        RedactionLevel,
+        RedactionLevelEntityName,
+        RedactionLevelRedactionType,
+        ReidentifyFileResponseV2,
+        ReidentifyFileResponseV2OutputType,
+        ReidentifyFileResponseV2Status,
+        ReidentifyStringResponseV2,
+        TransformationShiftDates,
+    )
+    from .errors import BadRequestError, InternalServerError, NotFoundError, UnauthorizedError
+    from . import authentication, files_v2, guardrails_v2, strings_v2, token_exchange
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .client import AsyncSkyflowAuth, SkyflowAuth
+    from .environment import SkyflowAuthEnvironment
+    from .files_v2 import (
+        DeidentifyFileRequestV2DataFormat,
+        DeidentifyFileRequestV2DataSource,
+        ReidentifyFileRequestV2DataFormat,
+        ReidentifyFileRequestV2DataSource,
+    )
+    from .version import __version__
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncSkyflowAuth": ".client",
+    "AudioV2": ".types",
+    "AudioV2Bleep": ".types",
+    "AudioV2OutputTranscription": ".types",
+    "BadRequestError": ".errors",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeidentifyFileRequestV2DataFormat": ".files_v2",
+    "DeidentifyFileRequestV2DataSource": ".files_v2",
+    "DeidentifyFileResponseV2": ".types",
+    "DeidentifyStringResponseV2": ".types",
+    "DeidentifyStringResponseV2DetectedEntity": ".types",
+    "DeidentifyStringResponseV2EntityLocation": ".types",
+    "Detect": ".types",
+    "DetectConfigV2": ".types",
+    "DetectConfigV2VaultType": ".types",
+    "DetectCustomTypes": ".types",
+    "DetectCustomTypesDeidentificationType": ".types",
+    "DetectCustomTypesIncludePrefix": ".types",
+    "DetectEntity": ".types",
+    "DetectEntityDeidentificationType": ".types",
+    "DetectEntityEntityType": ".types",
+    "DetectEntityIncludePrefix": ".types",
+    "DetectGuardrailsResponseV2": ".types",
+    "DetectGuardrailsResponseV2Validation": ".types",
+    "DetectObjectEntity": ".types",
+    "DetectObjectEntityDeidentificationType": ".types",
+    "DetectObjectEntityEntityType": ".types",
+    "DetectReturnEntities": ".types",
+    "DetectRunsResponseV2": ".types",
+    "DetectRunsResponseV2OutputType": ".types",
+    "DetectRunsResponseV2Status": ".types",
+    "DocumentV2": ".types",
+    "DocumentV2Pdf": ".types",
+    "DocumentV2PdfProcessingMode": ".types",
+    "EntityTransformation": ".types",
+    "ErrorResponse": ".types",
+    "ErrorResponseError": ".types",
+    "FileMapping": ".types",
+    "FileOutput": ".types",
+    "FileOutputProcessedFileExtension": ".types",
+    "FileOutputProcessedFileType": ".types",
+    "GetAuthTokenResponse": ".types",
+    "GetStsTokenResponse": ".types",
+    "HttpCode": ".types",
+    "ImageV2": ".types",
+    "ImageV2MaskingMethod": ".types",
+    "InternalServerError": ".errors",
+    "Media": ".types",
+    "Metrics": ".types",
+    "NotFoundError": ".errors",
+    "RedactionLevel": ".types",
+    "RedactionLevelEntityName": ".types",
+    "RedactionLevelRedactionType": ".types",
+    "ReidentifyFileRequestV2DataFormat": ".files_v2",
+    "ReidentifyFileRequestV2DataSource": ".files_v2",
+    "ReidentifyFileResponseV2": ".types",
+    "ReidentifyFileResponseV2OutputType": ".types",
+    "ReidentifyFileResponseV2Status": ".types",
+    "ReidentifyStringResponseV2": ".types",
+    "SkyflowAuth": ".client",
+    "SkyflowAuthEnvironment": ".environment",
+    "TransformationShiftDates": ".types",
+    "UnauthorizedError": ".errors",
+    "__version__": ".version",
+    "authentication": ".authentication",
+    "files_v2": ".files_v2",
+    "guardrails_v2": ".guardrails_v2",
+    "strings_v2": ".strings_v2",
+    "token_exchange": ".token_exchange",
+}
+
+
+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",
+    "AudioV2",
+    "AudioV2Bleep",
+    "AudioV2OutputTranscription",
     "BadRequestError",
-    "GooglerpcStatus",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeidentifyFileRequestV2DataFormat",
+    "DeidentifyFileRequestV2DataSource",
+    "DeidentifyFileResponseV2",
+    "DeidentifyStringResponseV2",
+    "DeidentifyStringResponseV2DetectedEntity",
+    "DeidentifyStringResponseV2EntityLocation",
+    "Detect",
+    "DetectConfigV2",
+    "DetectConfigV2VaultType",
+    "DetectCustomTypes",
+    "DetectCustomTypesDeidentificationType",
+    "DetectCustomTypesIncludePrefix",
+    "DetectEntity",
+    "DetectEntityDeidentificationType",
+    "DetectEntityEntityType",
+    "DetectEntityIncludePrefix",
+    "DetectGuardrailsResponseV2",
+    "DetectGuardrailsResponseV2Validation",
+    "DetectObjectEntity",
+    "DetectObjectEntityDeidentificationType",
+    "DetectObjectEntityEntityType",
+    "DetectReturnEntities",
+    "DetectRunsResponseV2",
+    "DetectRunsResponseV2OutputType",
+    "DetectRunsResponseV2Status",
+    "DocumentV2",
+    "DocumentV2Pdf",
+    "DocumentV2PdfProcessingMode",
+    "EntityTransformation",
+    "ErrorResponse",
+    "ErrorResponseError",
+    "FileMapping",
+    "FileOutput",
+    "FileOutputProcessedFileExtension",
+    "FileOutputProcessedFileType",
+    "GetAuthTokenResponse",
+    "GetStsTokenResponse",
+    "HttpCode",
+    "ImageV2",
+    "ImageV2MaskingMethod",
+    "InternalServerError",
+    "Media",
+    "Metrics",
     "NotFoundError",
-    "ProtobufAny",
+    "RedactionLevel",
+    "RedactionLevelEntityName",
+    "RedactionLevelRedactionType",
+    "ReidentifyFileRequestV2DataFormat",
+    "ReidentifyFileRequestV2DataSource",
+    "ReidentifyFileResponseV2",
+    "ReidentifyFileResponseV2OutputType",
+    "ReidentifyFileResponseV2Status",
+    "ReidentifyStringResponseV2",
     "SkyflowAuth",
     "SkyflowAuthEnvironment",
+    "TransformationShiftDates",
     "UnauthorizedError",
-    "V1GetAuthTokenResponse",
     "__version__",
     "authentication",
+    "files_v2",
+    "guardrails_v2",
+    "strings_v2",
+    "token_exchange",
 ]

common/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)

common/generated/rest/authentication/client.py

@@ -4,7 +4,7 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..types.v_1_get_auth_token_response import V1GetAuthTokenResponse
+from ..types.get_auth_token_response import GetAuthTokenResponse
 from .raw_client import AsyncRawAuthenticationClient, RawAuthenticationClient
 
 # this is used as the default value for optional parameters
@@ -26,7 +26,7 @@ class AuthenticationClient:
         """
         return self._raw_client
 
-    def authentication_service_get_auth_token(
+    def get_bearer_token(
         self,
         *,
         grant_type: str,
@@ -36,9 +36,9 @@ class AuthenticationClient:
         requested_token_use: typing.Optional[str] = OMIT,
         scope: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> V1GetAuthTokenResponse:
+    ) -> GetAuthTokenResponse:
         """
-        <p>Generates a Bearer Token to authenticate with Skyflow. This method doesn't require the <code>Authorization</code> header.</p><p><b>Note:</b> For recommended ways to authenticate, see <a href='/api-authentication/'>API authentication</a>.</p>
+        Generates a Bearer Token to authenticate with Skyflow.
 
         Parameters
         ----------
@@ -46,7 +46,7 @@ class AuthenticationClient:
             Grant type of the request. Set this to `urn:ietf:params:oauth:grant-type:jwt-bearer`.
 
         assertion : str
-            User-signed JWT token that contains the following fields: <br/> <ul><li><code>iss</code>: Issuer of the JWT.</li><li><code>key</code>: Unique identifier for the key.</li><li><code>aud</code>: Recipient the JWT is intended for.</li><li><code>exp</code>: Time the JWT expires.</li><li><code>sub</code>: Subject of the JWT.</li><li><code>ctx</code>: (Optional) Value for <a href='/context-aware-overview/'>Context-aware authorization</a>.</li></ul>
+            User-signed JWT token that contains the following fields: iss (Issuer), key (Unique identifier), aud (Recipient), exp (Expiry), sub (Subject), ctx (Optional context for context-aware authorization).
 
         subject_token : typing.Optional[str]
             Subject token.
@@ -58,15 +58,15 @@ class AuthenticationClient:
             Token use type. Either `delegation` or `impersonation`.
 
         scope : typing.Optional[str]
-            Subset of available <a href='#Roles'>roles</a> to associate with the requested token. Uses the format "role:\<roleID1\> role:\<roleID2\>".
+            Subset of available roles to associate with the requested token. Uses the format "role:<roleID1> role:<roleID2>".
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        V1GetAuthTokenResponse
-            A successful response.
+        GetAuthTokenResponse
+            OK
 
         Examples
         --------
@@ -75,12 +75,12 @@ class AuthenticationClient:
         client = SkyflowAuth(
             token="YOUR_TOKEN",
         )
-        client.authentication.authentication_service_get_auth_token(
-            grant_type="urn:ietf:params:oauth:grant-type:jwt-bearer",
-            assertion="eyLhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaXNzIjoiY29tcGFueSIsImV4cCI6MTYxNTE5MzgwNywiaWF0IjoxNjE1MTY1MDQwLCJhdWQiOiKzb21lYXVkaWVuY2UifQ.4pcPyMDQ9o1PSyXnrXCjTwXyr4BSezdI1AVTmud2fU3",
+        client.authentication.get_bearer_token(
+            grant_type="grant_type",
+            assertion="assertion",
         )
         """
-        _response = self._raw_client.authentication_service_get_auth_token(
+        _response = self._raw_client.get_bearer_token(
             grant_type=grant_type,
             assertion=assertion,
             subject_token=subject_token,
@@ -107,7 +107,7 @@ class AsyncAuthenticationClient:
         """
         return self._raw_client
 
-    async def authentication_service_get_auth_token(
+    async def get_bearer_token(
         self,
         *,
         grant_type: str,
@@ -117,9 +117,9 @@ class AsyncAuthenticationClient:
         requested_token_use: typing.Optional[str] = OMIT,
         scope: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> V1GetAuthTokenResponse:
+    ) -> GetAuthTokenResponse:
         """
-        <p>Generates a Bearer Token to authenticate with Skyflow. This method doesn't require the <code>Authorization</code> header.</p><p><b>Note:</b> For recommended ways to authenticate, see <a href='/api-authentication/'>API authentication</a>.</p>
+        Generates a Bearer Token to authenticate with Skyflow.
 
         Parameters
         ----------
@@ -127,7 +127,7 @@ class AsyncAuthenticationClient:
             Grant type of the request. Set this to `urn:ietf:params:oauth:grant-type:jwt-bearer`.
 
         assertion : str
-            User-signed JWT token that contains the following fields: <br/> <ul><li><code>iss</code>: Issuer of the JWT.</li><li><code>key</code>: Unique identifier for the key.</li><li><code>aud</code>: Recipient the JWT is intended for.</li><li><code>exp</code>: Time the JWT expires.</li><li><code>sub</code>: Subject of the JWT.</li><li><code>ctx</code>: (Optional) Value for <a href='/context-aware-overview/'>Context-aware authorization</a>.</li></ul>
+            User-signed JWT token that contains the following fields: iss (Issuer), key (Unique identifier), aud (Recipient), exp (Expiry), sub (Subject), ctx (Optional context for context-aware authorization).
 
         subject_token : typing.Optional[str]
             Subject token.
@@ -139,15 +139,15 @@ class AsyncAuthenticationClient:
             Token use type. Either `delegation` or `impersonation`.
 
         scope : typing.Optional[str]
-            Subset of available <a href='#Roles'>roles</a> to associate with the requested token. Uses the format "role:\<roleID1\> role:\<roleID2\>".
+            Subset of available roles to associate with the requested token. Uses the format "role:<roleID1> role:<roleID2>".
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        V1GetAuthTokenResponse
-            A successful response.
+        GetAuthTokenResponse
+            OK
 
         Examples
         --------
@@ -161,15 +161,15 @@ class AsyncAuthenticationClient:
 
 
         async def main() -> None:
-            await client.authentication.authentication_service_get_auth_token(
-                grant_type="urn:ietf:params:oauth:grant-type:jwt-bearer",
-                assertion="eyLhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaXNzIjoiY29tcGFueSIsImV4cCI6MTYxNTE5MzgwNywiaWF0IjoxNjE1MTY1MDQwLCJhdWQiOiKzb21lYXVkaWVuY2UifQ.4pcPyMDQ9o1PSyXnrXCjTwXyr4BSezdI1AVTmud2fU3",
+            await client.authentication.get_bearer_token(
+                grant_type="grant_type",
+                assertion="assertion",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.authentication_service_get_auth_token(
+        _response = await self._raw_client.get_bearer_token(
             grant_type=grant_type,
             assertion=assertion,
             subject_token=subject_token,