pangea-sdk 6.2.0b1__py3-none-any.whl → 6.3.0__py3-none-any.whl

pangea/services/redact.py

@@ -1,76 +1,18 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum
-from collections.abc import Mapping, Sequence
-from typing import Dict, List, Optional, Union, cast, overload
-
-from pydantic import Field, TypeAdapter
-from typing_extensions import Annotated, Literal
+from typing import Dict, List, Optional, Union
 
 from pangea.config import PangeaConfig
 from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
 
-MatcherType = Literal[
-    "CREDIT_CARD",
-    "CRYPTO",
-    "DATE_TIME",
-    "EMAIL_ADDRESS",
-    "IBAN_CODE",
-    "IP_ADDRESS",
-    "NRP",
-    "LOCATION",
-    "PERSON",
-    "PHONE_NUMBER",
-    "MEDICAL_LICENSE",
-    "URL",
-    "US_BANK_NUMBER",
-    "US_DRIVER_LICENSE",
-    "US_ITIN",
-    "US_PASSPORT",
-    "US_SSN",
-    "UK_NHS",
-    "NIF",
-    "FIN/NRIC",
-    "AU_ABN",
-    "AU_ACN",
-    "AU_TFN",
-    "AU_MEDICARE",
-    "FIREBASE_URL",
-    "RSA_PRIVATE_KEY",
-    "SSH_DSA_PRIVATE_KEY",
-    "SSH_EC_PRIVATE_KEY",
-    "PGP_PRIVATE_KEY_BLOCK",
-    "AMAZON_AWS_ACCESS_KEY_ID",
-    "AMAZON_AWS_SECRET_ACCESS_KEY",
-    "AMAZON_MWS_AUTH_TOKEN",
-    "FACEBOOK_ACCESS_TOKEN",
-    "GITHUB_ACCESS_TOKEN",
-    "JWT_TOKEN",
-    "GOOGLE_API_KEY",
-    "GOOGLE_CLOUD_PLATFORM_API_KEY",
-    "GOOGLE_DRIVE_API_KEY",
-    "GOOGLE_CLOUD_PLATFORM_SERVICE_ACCOUNT",
-    "GOOGLE_GMAIL_API_KEY",
-    "YOUTUBE_API_KEY",
-    "MAILCHIMP_API_KEY",
-    "MAILGUN_API_KEY",
-    "MONEY",
-    "BASIC_AUTH",
-    "PICATIC_API_KEY",
-    "SLACK_TOKEN",
-    "SLACK_WEBHOOK",
-    "STRIPE_API_KEY",
-    "STRIPE_RESTRICTED_API_KEY",
-    "SQUARE_ACCESS_TOKEN",
-    "SQUARE_OAUTH_SECRET",
-    "TWILIO_API_KEY",
-    "PANGEA_TOKEN",
-    "PROFANITY",
-]
-
 
 class RedactFormat(str, enum.Enum):
     """Structured data format."""
@@ -106,10 +48,10 @@ class PartialMasking(APIRequestModel):
     masked_from_left: Optional[int] = None
     masked_from_right: Optional[int] = None
     chars_to_ignore: Optional[List[str]] = None
-    masking_char: Optional[str] = Field(min_length=1, max_length=1)
+    masking_char: Optional[List[str]] = None
 
 
-class Redaction(APIRequestModel):
+class RedactionMethodOverrides(APIRequestModel):
     redaction_type: RedactType
     hash: Optional[Dict] = None
     fpe_alphabet: Optional[FPEAlphabet] = None
@@ -117,10 +59,6 @@ class Redaction(APIRequestModel):
     redaction_value: Optional[str] = None
 
 
-class RedactionMethodOverrides(Redaction):
-    """This field allows users to specify the redaction method per rule and its various parameters."""
-
-
 class RedactRequest(APIRequestModel):
     """
     Input class to make a redact request
@@ -131,7 +69,7 @@ class RedactRequest(APIRequestModel):
     rules: Optional[List[str]] = None
     rulesets: Optional[List[str]] = None
     return_result: Optional[bool] = None
-    redaction_method_overrides: Optional[Mapping[str, RedactionMethodOverrides]] = None
+    redaction_method_overrides: Optional[RedactionMethodOverrides] = None
     vault_parameters: Optional[VaultParameters] = None
     llm_request: Optional[bool] = None
     """Is this redact call going to be used in an LLM request?"""
@@ -212,7 +150,7 @@ class StructuredRequest(APIRequestModel):
     rules: Optional[List[str]] = None
     rulesets: Optional[List[str]] = None
     return_result: Optional[bool] = None
-    redaction_method_overrides: Optional[Mapping[str, RedactionMethodOverrides]] = None
+    redaction_method_overrides: Optional[RedactionMethodOverrides] = None
     vault_parameters: Optional[VaultParameters] = None
     llm_request: Optional[bool] = None
     """Is this redact call going to be used in an LLM request?"""
@@ -260,145 +198,6 @@ class UnredactResult(PangeaResponseResult):
     data: RedactedData
 
 
-class Matcher(APIResponseModel):
-    match_type: str
-    match_value: str
-    match_score: float
-
-
-class RuleV1(APIResponseModel):
-    entity_name: str
-    matchers: Union[List[Matcher], MatcherType]
-    ruleset: str
-
-    match_threshold: Optional[float] = None
-    context_values: Optional[List[str]] = None
-    name: Optional[str] = None
-    description: Optional[str] = None
-
-
-class RuleV2(APIResponseModel):
-    entity_name: str
-    matchers: Union[List[Matcher], MatcherType]
-
-    match_threshold: Optional[float] = None
-    context_values: Optional[List[str]] = None
-    negative_context_values: Optional[List[str]] = None
-    name: Optional[str] = None
-    description: Optional[str] = None
-
-
-class RulesetV1(APIResponseModel):
-    name: Optional[str] = None
-    description: Optional[str] = None
-    rules: List[str]
-
-
-class RulesetV2(APIResponseModel):
-    name: Optional[str] = None
-    description: Optional[str] = None
-
-
-class ServiceConfigV1(PangeaResponseResult):
-    version: Literal["1.0.0"] = "1.0.0"
-    id: str
-    name: str
-    updated_at: str
-    enabled_rules: List[str]
-
-    redactions: Optional[Dict[str, Redaction]] = None
-
-    vault_service_config_id: Optional[str] = None
-    """Service config used to create the secret"""
-
-    salt_vault_secret_id: Optional[str] = None
-    """Pangea only allows hashing to be done using a salt value to prevent brute-force attacks."""
-
-    rules: Optional[Dict[str, RuleV1]] = None
-    rulesets: Optional[Dict[str, RulesetV1]] = None
-    supported_languages: Optional[List[Literal["en"]]] = None
-
-
-class ServiceConfigV2(PangeaResponseResult):
-    version: Literal["2.0.0"] = "2.0.0"
-    id: str
-    name: str
-    updated_at: str
-    enabled_rules: List[str]
-
-    enforce_enabled_rules: Optional[bool] = None
-    """Always run service config enabled rules across all redact calls regardless of flags?"""
-
-    redactions: Optional[Dict[str, Redaction]] = None
-
-    vault_service_config_id: Optional[str] = None
-    """Service config used to create the secret"""
-
-    salt_vault_secret_id: Optional[str] = None
-    """Pangea only allows hashing to be done using a salt value to prevent brute-force attacks."""
-
-    fpe_vault_secret_id: Optional[str] = None
-    """The ID of the key used by FF3 Encryption algorithms for FPE."""
-
-    rules: Optional[Dict[str, RuleV2]] = None
-    rulesets: Optional[Dict[str, RulesetV2]] = None
-    supported_languages: Optional[List[Literal["en"]]] = None
-
-
-ServiceConfigResult = Annotated[Union[ServiceConfigV1, ServiceConfigV2], Field(discriminator="version")]
-
-
-class ServiceConfigFilter(APIRequestModel):
-    id: Optional[str] = None
-    """Only records where id equals this value."""
-
-    id__contains: Optional[Sequence[str]] = None
-    """Only records where id includes each substring."""
-
-    id__in: Optional[Sequence[str]] = None
-    """Only records where id equals one of the provided substrings."""
-
-    created_at: Optional[str] = None
-    """Only records where created_at equals this value."""
-
-    created_at__gt: Optional[str] = None
-    """Only records where created_at is greater than this value."""
-
-    created_at__gte: Optional[str] = None
-    """Only records where created_at is greater than or equal to this value."""
-
-    created_at__lt: Optional[str] = None
-    """Only records where created_at is less than this value."""
-
-    created_at__lte: Optional[str] = None
-    """Only records where created_at is less than or equal to this value."""
-
-    updated_at: Optional[str] = None
-    """Only records where updated_at equals this value."""
-
-    updated_at__gt: Optional[str] = None
-    """Only records where updated_at is greater than this value."""
-
-    updated_at__gte: Optional[str] = None
-    """Only records where updated_at is greater than or equal to this value."""
-
-    updated_at__lt: Optional[str] = None
-    """Only records where updated_at is less than this value."""
-
-    updated_at__lte: Optional[str] = None
-    """Only records where updated_at is less than or equal to this value."""
-
-
-class ServiceConfigListResult(PangeaResponseResult):
-    count: int
-    """The total number of service configs matched by the list request."""
-
-    last: str
-    """Used to fetch the next page of the current listing when provided in a repeated request's last parameter."""
-
-    items: Sequence[ServiceConfigResult]
-
-
 class Redact(ServiceBase):
     """Redact service client.
 
@@ -453,7 +252,7 @@ class Redact(ServiceBase):
         rules: Optional[List[str]] = None,
         rulesets: Optional[List[str]] = None,
         return_result: Optional[bool] = None,
-        redaction_method_overrides: Optional[Mapping[str, RedactionMethodOverrides]] = None,
+        redaction_method_overrides: Optional[RedactionMethodOverrides] = None,
         llm_request: Optional[bool] = None,
         vault_parameters: Optional[VaultParameters] = None,
     ) -> PangeaResponse[RedactResult]:
@@ -481,7 +280,7 @@ class Redact(ServiceBase):
         Returns:
             Pangea Response with redacted text in the response.result property,
                 available response fields can be found in our
-                [API Documentation](https://pangea.cloud/docs/api/redact#redact).
+                [API Documentation](https://pangea.cloud/docs/api/redact#redact-post).
 
         Examples:
             response = redact.redact(text="Jenny Jenny... 555-867-5309")
@@ -508,7 +307,7 @@ class Redact(ServiceBase):
         rules: Optional[List[str]] = None,
         rulesets: Optional[List[str]] = None,
         return_result: Optional[bool] = None,
-        redaction_method_overrides: Mapping[str, RedactionMethodOverrides] | None = None,
+        redaction_method_overrides: Optional[RedactionMethodOverrides] = None,
         llm_request: Optional[bool] = None,
         vault_parameters: Optional[VaultParameters] = None,
     ) -> PangeaResponse[StructuredResult]:
@@ -540,7 +339,7 @@ class Redact(ServiceBase):
         Returns:
             Pangea Response with redacted data in the response.result field,
                 available response fields can be found in our
-                [API Documentation](https://pangea.cloud/docs/api/redact#redact-structured)
+                [API Documentation](https://pangea.cloud/docs/api/redact#redact-structured-post)
 
         Examples:
             data = {
@@ -583,268 +382,7 @@ class Redact(ServiceBase):
         Returns:
             Pangea Response with redacted data in the response.result field,
                 available response fields can be found in our
-                [API Documentation](https://pangea.cloud/docs/api/redact#unredact)
+                [API Documentation](https://pangea.cloud/docs/api/redact#unredact-post)
         """
         input = UnredactRequest(redacted_data=redacted_data, fpe_context=fpe_context)
         return self.request.post("v1/unredact", UnredactResult, data=input.model_dump(exclude_none=True))
-
-    def get_service_config(self, config_id: str) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Get a service config.
-
-
-        OperationId: redact_post_v1beta_config
-        """
-        response = self.request.post("v1beta/config", PangeaResponseResult, data={"id": config_id})
-        response.result = TypeAdapter(ServiceConfigResult).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfigResult], response)
-
-    @overload
-    def create_service_config(
-        self,
-        name: str,
-        *,
-        version: Literal["1.0.0"],
-        enabled_rules: Sequence[str] | None = None,
-        redactions: Mapping[str, Redaction] | None = None,
-        vault_service_config_id: str | None = None,
-        salt_vault_secret_id: str | None = None,
-        rules: Mapping[str, RuleV1] | None = None,
-        rulesets: Mapping[str, RulesetV1] | None = None,
-        supported_languages: Sequence[Literal["en"]] | None = None,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Create a v1.0.0 service config.
-
-        OperationId: redact_post_v1beta_config_create
-
-        Args:
-            vault_service_config_id: Service config used to create the secret
-            salt_vault_secret_id: Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.
-        """
-
-    @overload
-    def create_service_config(
-        self,
-        name: str,
-        *,
-        version: Literal["2.0.0"] | None = None,
-        enabled_rules: Sequence[str] | None = None,
-        enforce_enabled_rules: bool | None = None,
-        redactions: Mapping[str, Redaction] | None = None,
-        vault_service_config_id: str | None = None,
-        salt_vault_secret_id: str | None = None,
-        fpe_vault_secret_id: str | None = None,
-        rules: Mapping[str, RuleV2] | None = None,
-        rulesets: Mapping[str, RulesetV2] | None = None,
-        supported_languages: Sequence[Literal["en"]] | None = None,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Create a v2.0.0 service config.
-
-        OperationId: redact_post_v1beta_config_create
-
-        Args:
-            enforce_enabled_rules: Always run service config enabled rules across all redact calls regardless of flags?
-            vault_service_config_id: Service config used to create the secret
-            salt_vault_secret_id: Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.
-            fpe_vault_secret_id: The ID of the key used by FF3 Encryption algorithms for FPE.
-        """
-
-    def create_service_config(
-        self,
-        name: str,
-        *,
-        version: Literal["1.0.0", "2.0.0"] | None = None,
-        enabled_rules: Sequence[str] | None = None,
-        enforce_enabled_rules: bool | None = None,
-        fpe_vault_secret_id: str | None = None,
-        redactions: Mapping[str, Redaction] | None = None,
-        rules: Mapping[str, RuleV1 | RuleV2] | None = None,
-        rulesets: Mapping[str, RulesetV1 | RulesetV2] | None = None,
-        salt_vault_secret_id: str | None = None,
-        supported_languages: Sequence[Literal["en"]] | None = None,
-        vault_service_config_id: str | None = None,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Create a service config.
-
-        OperationId: redact_post_v1beta_config_create
-
-        Args:
-            enforce_enabled_rules: Always run service config enabled rules across all redact calls regardless of flags?
-            fpe_vault_secret_id: The ID of the key used by FF3 Encryption algorithms for FPE.
-            salt_vault_secret_id: Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.
-            vault_service_config_id: Service config used to create the secret
-        """
-
-        response = self.request.post(
-            "v1beta/config/create",
-            PangeaResponseResult,
-            data={
-                "name": name,
-                "version": version,
-                "enabled_rules": enabled_rules,
-                "enforce_enabled_rules": enforce_enabled_rules,
-                "fpe_vault_secret_id": fpe_vault_secret_id,
-                "redactions": redactions,
-                "rules": rules,
-                "rulesets": rulesets,
-                "salt_vault_secret_id": salt_vault_secret_id,
-                "supported_languages": supported_languages,
-                "vault_service_config_id": vault_service_config_id,
-            },
-        )
-        response.result = TypeAdapter(ServiceConfigResult).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfigResult], response)
-
-    @overload
-    def update_service_config(
-        self,
-        config_id: str,
-        *,
-        version: Literal["1.0.0"],
-        name: str,
-        updated_at: str,
-        enabled_rules: Sequence[str] | None = None,
-        redactions: Mapping[str, Redaction] | None = None,
-        vault_service_config_id: str | None = None,
-        salt_vault_secret_id: str | None = None,
-        rules: Mapping[str, RuleV1] | None = None,
-        rulesets: Mapping[str, RulesetV1] | None = None,
-        supported_languages: Sequence[Literal["en"]] | None = None,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Update a v1.0.0 service config.
-
-        OperationId: redact_post_v1beta_config_update
-
-        Args:
-            vault_service_config_id: Service config used to create the secret
-            salt_vault_secret_id: Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.
-        """
-
-    @overload
-    def update_service_config(
-        self,
-        config_id: str,
-        *,
-        version: Literal["2.0.0"] | None = None,
-        name: str,
-        updated_at: str,
-        enabled_rules: Sequence[str] | None = None,
-        enforce_enabled_rules: bool | None = None,
-        redactions: Mapping[str, Redaction] | None = None,
-        vault_service_config_id: str | None = None,
-        salt_vault_secret_id: str | None = None,
-        fpe_vault_secret_id: str | None = None,
-        rules: Mapping[str, RuleV2] | None = None,
-        rulesets: Mapping[str, RulesetV2] | None = None,
-        supported_languages: Sequence[Literal["en"]] | None = None,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Update a v2.0.0 service config.
-
-        OperationId: redact_post_v1beta_config_update
-
-        Args:
-            enforce_enabled_rules: Always run service config enabled rules across all redact calls regardless of flags?
-            vault_service_config_id: Service config used to create the secret
-            salt_vault_secret_id: Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.
-            fpe_vault_secret_id: The ID of the key used by FF3 Encryption algorithms for FPE.
-        """
-
-    def update_service_config(
-        self,
-        config_id: str,
-        *,
-        version: Literal["1.0.0", "2.0.0"] | None = None,
-        name: str,
-        updated_at: str,
-        enabled_rules: Sequence[str] | None = None,
-        enforce_enabled_rules: bool | None = None,
-        fpe_vault_secret_id: str | None = None,
-        redactions: Mapping[str, Redaction] | None = None,
-        rules: Mapping[str, RuleV1 | RuleV2] | None = None,
-        rulesets: Mapping[str, RulesetV1 | RulesetV2] | None = None,
-        salt_vault_secret_id: str | None = None,
-        supported_languages: Sequence[Literal["en"]] | None = None,
-        vault_service_config_id: str | None = None,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Update a service config.
-
-        OperationId: redact_post_v1beta_config_update
-
-        Args:
-            enforce_enabled_rules: Always run service config enabled rules across all redact calls regardless of flags?
-            fpe_vault_secret_id: The ID of the key used by FF3 Encryption algorithms for FPE.
-            salt_vault_secret_id: Pangea only allows hashing to be done using a salt value to prevent brute-force attacks.
-            vault_service_config_id: Service config used to create the secret
-        """
-
-        response = self.request.post(
-            "v1beta/config/update",
-            PangeaResponseResult,
-            data={
-                "id": config_id,
-                "updated_at": updated_at,
-                "name": name,
-                "version": version,
-                "enabled_rules": enabled_rules,
-                "enforce_enabled_rules": enforce_enabled_rules,
-                "fpe_vault_secret_id": fpe_vault_secret_id,
-                "redactions": redactions,
-                "rules": rules,
-                "rulesets": rulesets,
-                "salt_vault_secret_id": salt_vault_secret_id,
-                "supported_languages": supported_languages,
-                "vault_service_config_id": vault_service_config_id,
-            },
-        )
-        response.result = TypeAdapter(ServiceConfigResult).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfigResult], response)
-
-    def delete_service_config(
-        self,
-        config_id: str,
-    ) -> PangeaResponse[ServiceConfigResult]:
-        """
-        Delete a service config.
-
-        OperationId: redact_post_v1beta_config_delete
-
-        Args:
-            config_id: An ID for a service config
-        """
-
-        response = self.request.post("v1beta/config/delete", PangeaResponseResult, data={"id": config_id})
-        response.result = TypeAdapter(ServiceConfigResult).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfigResult], response)
-
-    def list_service_configs(
-        self,
-        *,
-        filter: ServiceConfigFilter | None = None,
-        last: str | None = None,
-        order: Literal["asc", "desc"] | None = None,
-        order_by: Literal["id", "created_at", "updated_at"] | None = None,
-        size: int | None = None,
-    ) -> PangeaResponse[ServiceConfigListResult]:
-        """
-        List service configs.
-
-        OperationId: redact_post_v1beta_config_list
-
-        Args:
-            last: Reflected value from a previous response to obtain the next page of results.
-            order: Order results asc(ending) or desc(ending).
-            order_by: Which field to order results by.
-            size: Maximum results to include in the response.
-        """
-
-        return self.request.post(
-            "v1beta/config/list",
-            ServiceConfigListResult,
-            data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
-        )

pangea/services/sanitize.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import io
@@ -267,7 +271,7 @@ class Sanitize(ServiceBase):
         files: Optional[List[Tuple]] = None
         if file or file_path:
             if file_path:
-                file = open(file_path, "rb")
+                file = open(file_path, "rb")  # noqa: SIM115
             if (
                 transfer_method == TransferMethod.POST_URL
                 and file

pangea/services/share/share.py

@@ -1,10 +1,16 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum
 import io
-from typing import Dict, List, NewType, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union
+
+from pydantic import RootModel
 
 from pangea.config import PangeaConfig
 from pangea.response import APIRequestModel, PangeaResponse, PangeaResponseResult, TransferMethod
@@ -12,8 +18,8 @@ from pangea.services.base import ServiceBase
 from pangea.services.share.file_format import FileFormat
 from pangea.utils import get_file_size, get_file_upload_params
 
-Metadata = NewType("Metadata", Dict[str, str])
-Tags = NewType("Tags", List[str])
+Metadata = RootModel[dict[str, str]]
+Tags = RootModel[list[str]]
 
 
 class ItemOrder(str, enum.Enum):
@@ -916,10 +922,10 @@ class Share(ServiceBase):
 
     def get_archive(
         self,
-        ids: List[str] = [],
-        format: Optional[ArchiveFormat] = None,
-        transfer_method: Optional[TransferMethod] = None,
-        bucket_id: Optional[str] = None,
+        ids: list[str],
+        format: ArchiveFormat | None = None,
+        transfer_method: TransferMethod | None = None,
+        bucket_id: str | None = None,
     ) -> PangeaResponse[GetArchiveResult]:
         """
         Get archive

pangea/services/vault/models/asymmetric.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 from enum import Enum