quba-sensitive-data-protection 0.0.8__py3-none-any.whl

quba_sdp/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Sensitive Data Protection API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

quba_sdp/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

quba_sdp/api/anonymize_text.py

@@ -0,0 +1,206 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from .. import errors
+from ..client import AuthenticatedClient, Client
+from ..models.anonymize_request_body import AnonymizeRequestBody
+from ..models.anonymize_response_body import AnonymizeResponseBody
+from ..models.http_validation_error import HTTPValidationError
+from ..types import Response
+
+
+def _get_kwargs(
+    *,
+    body: AnonymizeRequestBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/anonymize",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AnonymizeResponseBody | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = AnonymizeResponseBody.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AnonymizeResponseBody | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> Response[AnonymizeResponseBody | HTTPValidationError]:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AnonymizeResponseBody | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> AnonymizeResponseBody | HTTPValidationError | None:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AnonymizeResponseBody | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> Response[AnonymizeResponseBody | HTTPValidationError]:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AnonymizeResponseBody | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnonymizeRequestBody,
+) -> AnonymizeResponseBody | HTTPValidationError | None:
+    """Anonymize Text
+
+     Anonymize sensitive data in text.
+
+    Scans the request text for the entities targeted by each supplied rule and
+    applies that rule's operation (replace, redact, mask, hash, or encrypt) to
+    every match. Returns the anonymized text together with a record of each
+    transformation, including the original and resulting character ranges.
+
+    Args:
+        body (AnonymizeRequestBody): Request body for the anonymize endpoint.
+
+            Carries the text to anonymize and the list of de-identification rules to
+            apply. See ``AnonymizationCommand`` for field-level details.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AnonymizeResponseBody | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

quba_sdp/api/health_check.py

@@ -0,0 +1,142 @@
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from .. import errors
+from ..client import AuthenticatedClient, Client
+from ..types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/health",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> str | None:
+    if response.status_code == 200:
+        response_200 = cast(str, response.json())
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[str]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[str]:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[str]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+) -> str | None:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        str
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[str]:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[str]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+) -> str | None:
+    """Health
+
+     Health check.
+
+    Returns a plain-text message confirming the service is running. Use this as
+    a liveness/readiness probe.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        str
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

quba_sdp/api/scan_text.py

@@ -0,0 +1,194 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from .. import errors
+from ..client import AuthenticatedClient, Client
+from ..models.http_validation_error import HTTPValidationError
+from ..models.scan_request_body import ScanRequestBody
+from ..models.scan_response_body import ScanResponseBody
+from ..types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ScanRequestBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/scan",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | ScanResponseBody | None:
+    if response.status_code == 200:
+        response_200 = ScanResponseBody.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HTTPValidationError | ScanResponseBody]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ScanRequestBody,
+) -> Response[HTTPValidationError | ScanResponseBody]:
+    """Scan Text
+
+     Scan text for sensitive data.
+
+    Runs the configured detection entities over the request text and returns
+    every match as a character range with its entity type and confidence score.
+    Detections below the confidence threshold are omitted.
+
+    Args:
+        body (ScanRequestBody): Request body for the scan endpoint: the text to inspect and which
+            entity types to detect.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[HTTPValidationError | ScanResponseBody]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ScanRequestBody,
+) -> HTTPValidationError | ScanResponseBody | None:
+    """Scan Text
+
+     Scan text for sensitive data.
+
+    Runs the configured detection entities over the request text and returns
+    every match as a character range with its entity type and confidence score.
+    Detections below the confidence threshold are omitted.
+
+    Args:
+        body (ScanRequestBody): Request body for the scan endpoint: the text to inspect and which
+            entity types to detect.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        HTTPValidationError | ScanResponseBody
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ScanRequestBody,
+) -> Response[HTTPValidationError | ScanResponseBody]:
+    """Scan Text
+
+     Scan text for sensitive data.
+
+    Runs the configured detection entities over the request text and returns
+    every match as a character range with its entity type and confidence score.
+    Detections below the confidence threshold are omitted.
+
+    Args:
+        body (ScanRequestBody): Request body for the scan endpoint: the text to inspect and which
+            entity types to detect.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[HTTPValidationError | ScanResponseBody]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ScanRequestBody,
+) -> HTTPValidationError | ScanResponseBody | None:
+    """Scan Text
+
+     Scan text for sensitive data.
+
+    Runs the configured detection entities over the request text and returns
+    every match as a character range with its entity type and confidence score.
+    Detections below the confidence threshold are omitted.
+
+    Args:
+        body (ScanRequestBody): Request body for the scan endpoint: the text to inspect and which
+            entity types to detect.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        HTTPValidationError | ScanResponseBody
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed