pangea-sdk 6.1.1__py3-none-any.whl → 6.2.0b2__py3-none-any.whl

pangea/__init__.py

@@ -1,7 +1,15 @@
-__version__ = "6.1.1"
+__version__ = "6.2.0beta2"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig
 from pangea.file_uploader import FileUploader
 from pangea.request import PangeaRequest
 from pangea.response import PangeaResponse
+
+__all__ = (
+    "FileUploader",
+    "PangeaConfig",
+    "PangeaRequest",
+    "PangeaRequestAsync",
+    "PangeaResponse",
+)

pangea/asyncio/__init__.py

@@ -1 +1,2 @@
+# ruff: noqa: F401
 from .file_uploader import FileUploaderAsync

pangea/asyncio/file_uploader.py

@@ -1,8 +1,10 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+from __future__ import annotations
+
 import io
 import logging
-from typing import Dict, Optional
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.request import PangeaConfig
@@ -24,7 +26,7 @@ class FileUploaderAsync:
         url: str,
         file: io.BufferedReader,
         transfer_method: TransferMethod = TransferMethod.PUT_URL,
-        file_details: Optional[Dict] = None,
+        file_details: dict | None = None,
     ) -> None:
         if transfer_method == TransferMethod.PUT_URL:
             files = [("file", ("filename", file, "application/octet-stream"))]

pangea/asyncio/request.py

@@ -1,23 +1,39 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Modernize.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import asyncio
 import json
 import time
-from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast
+from collections.abc import Iterable, Mapping
+from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast, overload
 
 import aiohttp
 from aiohttp import FormData
-from pydantic import BaseModel
+from pydantic import BaseModel, TypeAdapter
 from pydantic_core import to_jsonable_python
-from typing_extensions import Any, TypeVar
+from typing_extensions import Any, Literal, TypeAlias, TypeVar, override
 
 import pangea.exceptions as pe
 from pangea.request import MultipartResponse, PangeaRequestBase
 from pangea.response import AttachedFile, PangeaResponse, PangeaResponseResult, ResponseStatus, TransferMethod
 from pangea.utils import default_encoder
 
+_FileName: TypeAlias = Union[str, None]
+_FileContent: TypeAlias = Union[str, bytes]
+_FileContentType: TypeAlias = str
+_FileCustomHeaders: TypeAlias = Mapping[str, str]
+_FileSpecTuple2: TypeAlias = tuple[_FileName, _FileContent]
+_FileSpecTuple3: TypeAlias = tuple[_FileName, _FileContent, _FileContentType]
+_FileSpecTuple4: TypeAlias = tuple[_FileName, _FileContent, _FileContentType, _FileCustomHeaders]
+_FileSpec: TypeAlias = Union[_FileContent, _FileSpecTuple2, _FileSpecTuple3, _FileSpecTuple4]
+_Files: TypeAlias = Union[Mapping[str, _FileSpec], Iterable[tuple[str, _FileSpec]]]
+
+
 TResult = TypeVar("TResult", bound=PangeaResponseResult)
 
 
@@ -30,26 +46,86 @@ class PangeaRequestAsync(PangeaRequestBase):
     be set in PangeaConfig.
     """
 
+    async def delete(self, endpoint: str) -> None:
+        """
+        Makes a DELETE call to a Pangea endpoint.
+
+        Args:
+            endpoint: The Pangea API endpoint.
+        """
+
+        url = self._url(endpoint)
+
+        self.logger.debug(
+            json.dumps({"service": self.service, "action": "delete", "url": url}, default=default_encoder)
+        )
+
+        requests_response = await self._http_delete(url, headers=self._headers())
+        await self._check_http_errors(requests_response)
+
+    @overload
     async def post(
         self,
         endpoint: str,
         result_class: Type[TResult],
-        data: str | BaseModel | dict[str, Any] | None = None,
+        data: str | BaseModel | Mapping[str, Any] | None = None,
         files: Optional[List[Tuple]] = None,
         poll_result: bool = True,
         url: Optional[str] = None,
+        *,
+        pangea_response: Literal[True] = True,
     ) -> PangeaResponse[TResult]:
-        """Makes the POST call to a Pangea Service endpoint.
+        """
+        Makes a POST call to a Pangea Service endpoint.
 
         Args:
-            endpoint(str): The Pangea Service API endpoint.
-            data(dict): The POST body payload object
+            endpoint: The Pangea Service API endpoint.
+            data: The POST body payload object
 
         Returns:
             PangeaResponse which contains the response in its entirety and
                various properties to retrieve individual fields
         """
 
+    @overload
+    async def post(
+        self,
+        endpoint: str,
+        result_class: Type[TResult],
+        data: str | BaseModel | Mapping[str, Any] | None = None,
+        files: Optional[List[Tuple]] = None,
+        poll_result: bool = True,
+        url: Optional[str] = None,
+        *,
+        pangea_response: Literal[False],
+    ) -> TResult:
+        """
+        Makes a POST call to a Pangea Service endpoint.
+
+        Args:
+            endpoint: The Pangea Service API endpoint.
+            data: The POST body payload object
+        """
+
+    async def post(
+        self,
+        endpoint: str,
+        result_class: Type[TResult],
+        data: str | BaseModel | Mapping[str, Any] | None = None,
+        files: Optional[List[Tuple]] = None,
+        poll_result: bool = True,
+        url: Optional[str] = None,
+        *,
+        pangea_response: bool = True,
+    ) -> PangeaResponse[TResult] | TResult:
+        """
+        Makes a POST call to a Pangea Service endpoint.
+
+        Args:
+            endpoint: The Pangea Service API endpoint.
+            data: The POST body payload object
+        """
+
         if isinstance(data, BaseModel):
             data = data.model_dump(exclude_none=True)
 
@@ -80,15 +156,22 @@ class PangeaRequestAsync(PangeaRequestBase):
                 endpoint, result_class=result_class, data=data, files=files
             )
         else:
+            headers = self._headers()
+            if transfer_method == TransferMethod.MULTIPART.value:
+                del headers["Content-Type"]
             requests_response = await self._http_post(
-                url, headers=self._headers(), data=data, files=files, presigned_url_post=False
+                url, headers=headers, data=data, files=files, presigned_url_post=False
             )
 
         await self._check_http_errors(requests_response)
 
+        if not pangea_response:
+            type_adapter = TypeAdapter(result_class)
+            return type_adapter.validate_python(await requests_response.json())
+
         if "multipart/form-data" in requests_response.headers.get("content-type", ""):
             multipart_response = await self._process_multipart_response(requests_response)
-            pangea_response: PangeaResponse = PangeaResponse(
+            pangea_response_obj: PangeaResponse = PangeaResponse(
                 requests_response,
                 result_class=result_class,
                 json=multipart_response.pangea_json,
@@ -101,47 +184,110 @@ class PangeaRequestAsync(PangeaRequestBase):
                     json.dumps({"service": self.service, "action": "post", "url": url, "response": json_resp})
                 )
 
-                pangea_response = PangeaResponse(requests_response, result_class=result_class, json=json_resp)
+                pangea_response_obj = PangeaResponse(requests_response, result_class=result_class, json=json_resp)
             except aiohttp.ContentTypeError as e:
-                raise pe.PangeaException(f"Failed to decode json response. {e}. Body: {await requests_response.text()}")
+                raise pe.PangeaException(
+                    f"Failed to decode json response. {e}. Body: {await requests_response.text()}"
+                ) from e
 
         if poll_result:
-            pangea_response = await self._handle_queued_result(pangea_response)
+            pangea_response_obj = await self._handle_queued_result(pangea_response_obj)
 
-        return self._check_response(pangea_response)
+        return self._check_response(pangea_response_obj)
 
-    async def get(self, path: str, result_class: Type[TResult], check_response: bool = True) -> PangeaResponse[TResult]:
-        """Makes the GET call to a Pangea Service endpoint.
+    @overload
+    async def get(
+        self,
+        path: str,
+        result_class: Type[TResult],
+        check_response: bool = True,
+        *,
+        params: (
+            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
+            | None
+        ) = None,
+        pangea_response: Literal[True] = True,
+    ) -> PangeaResponse[TResult]:
+        """
+        Makes the GET call to a Pangea Service endpoint.
 
         Args:
-            endpoint(str): The Pangea Service API endpoint.
-            path(str): Additional URL path
+            path: Additional URL path
+            params: Dictionary of querystring data to attach to the request
 
         Returns:
             PangeaResponse which contains the response in its entirety and
                various properties to retrieve individual fields
         """
 
+    @overload
+    async def get(
+        self,
+        path: str,
+        result_class: Type[TResult],
+        check_response: bool = True,
+        *,
+        params: (
+            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
+            | None
+        ) = None,
+        pangea_response: Literal[False] = False,
+    ) -> TResult:
+        """
+        Makes the GET call to a Pangea Service endpoint.
+
+        Args:
+            path: Additional URL path
+            params: Dictionary of querystring data to attach to the request
+        """
+
+    async def get(
+        self,
+        path: str,
+        result_class: Type[TResult],
+        check_response: bool = True,
+        *,
+        params: (
+            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
+            | None
+        ) = None,
+        pangea_response: bool = True,
+    ) -> PangeaResponse[TResult] | TResult:
+        """
+        Makes the GET call to a Pangea Service endpoint.
+
+        Args:
+            path: Additional URL path
+            params: Dictionary of querystring data to attach to the request
+            pangea_response: Whether or not the response body follows Pangea's
+              standard response schema
+        """
+
         url = self._url(path)
         self.logger.debug(json.dumps({"service": self.service, "action": "get", "url": url}))
 
-        async with self.session.get(url, headers=self._headers()) as requests_response:
+        async with self.session.get(url, params=params, headers=self._headers()) as requests_response:
             await self._check_http_errors(requests_response)
-            pangea_response = PangeaResponse(
+
+            if not pangea_response:
+                type_adapter = TypeAdapter(result_class)
+                return type_adapter.validate_python(await requests_response.json())
+
+            pangea_response_obj = PangeaResponse(
                 requests_response, result_class=result_class, json=await requests_response.json()
             )
 
         self.logger.debug(
             json.dumps(
-                {"service": self.service, "action": "get", "url": url, "response": pangea_response.json},
+                {"service": self.service, "action": "get", "url": url, "response": pangea_response_obj.json},
                 default=default_encoder,
             )
         )
 
         if check_response is False:
-            return pangea_response
+            return pangea_response_obj
 
-        return self._check_response(pangea_response)
+        return self._check_response(pangea_response_obj)
 
     async def _check_http_errors(self, resp: aiohttp.ClientResponse):
         if resp.status == 503:
@@ -164,7 +310,7 @@ class PangeaRequestAsync(PangeaRequestBase):
 
         return await self.poll_result_by_id(request_id, response.result_class, check_response=check_response)
 
-    async def post_presigned_url(self, url: str, data: Dict, files: List[Tuple]):
+    async def post_presigned_url(self, url: str, data: dict[Any, Any], files: Sequence[Tuple]):
         # Send form request with file and upload_details as body
         resp = await self._http_post(url=url, data=data, files=files, presigned_url_post=True)
         self.logger.debug(
@@ -275,38 +421,55 @@ class PangeaRequestAsync(PangeaRequestBase):
         attached_files = await self._get_attached_files(multipart_reader)
         return MultipartResponse(pangea_json, attached_files)  # type: ignore[arg-type]
 
+    async def _http_delete(
+        self,
+        url: str,
+        *,
+        headers: Mapping[str, str | bytes | None] = {},
+    ) -> aiohttp.ClientResponse:
+        return await self.session.delete(url, headers=headers)
+
     async def _http_post(
         self,
         url: str,
-        headers: Dict = {},
-        data: Union[str, Dict] = {},
-        files: Optional[List[Tuple]] = [],
+        headers: Mapping[str, str] = {},
+        data: str | dict[str, Any] | None = None,
+        files: _Files | None = None,
         presigned_url_post: bool = False,
     ) -> aiohttp.ClientResponse:
+        if data is None:
+            data = {}
+
         if files:
             form = FormData()
             if presigned_url_post:
-                for k, v in data.items():  # type: ignore[union-attr]
+                assert isinstance(data, dict)
+                assert isinstance(files, list)
+                for k, v in data.items():
                     form.add_field(k, v)
-                for name, value in files:
+                for _name, value in files:
                     form.add_field("file", value[1], filename=value[0], content_type=value[2])
             else:
-                data_send = json.dumps(data, default=default_encoder) if isinstance(data, dict) else data
+                assert isinstance(files, list)
+                data_send: str | FormData = (
+                    json.dumps(data, default=default_encoder) if isinstance(data, dict) else data
+                )
                 form.add_field("request", data_send, content_type="application/json")
                 for name, value in files:
                     form.add_field(name, value[1], filename=value[0], content_type=value[2])
 
-            data_send = form  # type: ignore[assignment]
+            data_send = form
         else:
             data_send = json.dumps(data, default=default_encoder) if isinstance(data, dict) else data
 
+        assert isinstance(self.session, aiohttp.ClientSession)
         return await self.session.post(url, headers=headers, data=data_send)
 
     async def _http_put(
         self,
         url: str,
         files: Sequence[Tuple],
-        headers: Dict = {},
+        headers: Mapping[str, str] = {},
     ) -> aiohttp.ClientResponse:
         self.logger.debug(
             json.dumps({"service": self.service, "action": "http_put", "url": url}, default=default_encoder)
@@ -318,8 +481,8 @@ class PangeaRequestAsync(PangeaRequestBase):
         self,
         endpoint: str,
         result_class: Type[PangeaResponseResult],
-        data: Union[str, Dict] = {},
-        files: List[Tuple] = [],
+        data: Union[str, Mapping[str, Any]] = {},
+        files: Sequence[Tuple] = [],
     ):
         if len(files) == 0:
             raise AttributeError("files attribute should have at least 1 file")
@@ -343,7 +506,7 @@ class PangeaRequestAsync(PangeaRequestBase):
         self,
         endpoint: str,
         result_class: Type[PangeaResponseResult],
-        data: Union[str, Dict] = {},
+        data: Union[str, Mapping[str, Any]] = {},
     ) -> PangeaResponse:
         # Send request
         try:
@@ -394,7 +557,7 @@ class PangeaRequestAsync(PangeaRequestBase):
                         {"service": self.service, "action": "poll_presigned_url", "step": "exit", "cause": {str(e)}}
                     )
                 )
-                raise pe.PresignedURLException("Failed to pull Presigned URL", loop_exc.response, e)
+                raise pe.PresignedURLException("Failed to pull Presigned URL", loop_exc.response, e) from e
 
         self.logger.debug(json.dumps({"service": self.service, "action": "poll_presigned_url", "step": "exit"}))
 
@@ -426,6 +589,7 @@ class PangeaRequestAsync(PangeaRequestBase):
         self.logger.debug(json.dumps({"service": self.service, "action": "poll_result_retry", "step": "exit"}))
         return self._check_response(response)
 
+    @override
     def _init_session(self) -> aiohttp.ClientSession:
         # retry_config = Retry(
         #     total=self.config.request_retries,

pangea/asyncio/services/__init__.py

@@ -1,3 +1,5 @@
+# ruff: noqa: F401
+
 from .ai_guard import AIGuardAsync
 from .audit import AuditAsync
 from .authn import AuthNAsync
@@ -5,6 +7,7 @@ from .authz import AuthZAsync
 from .embargo import EmbargoAsync
 from .file_scan import FileScanAsync
 from .intel import DomainIntelAsync, FileIntelAsync, IpIntelAsync, UrlIntelAsync, UserIntelAsync
+from .management import ManagementAsync
 from .prompt_guard import PromptGuardAsync
 from .redact import RedactAsync
 from .sanitize import SanitizeAsync

pangea/asyncio/services/ai_guard.py

@@ -1,13 +1,24 @@
 from __future__ import annotations
 
+from collections.abc import Mapping
 from typing import overload
 
-from typing_extensions import TypeVar
+from typing_extensions import Literal, TypeVar
 
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse
-from pangea.services.ai_guard import LogFields, Overrides, TextGuardResult
+from pangea.services.ai_guard import (
+    AuditDataActivityConfig,
+    ConnectionsConfig,
+    LogFields,
+    Overrides,
+    RecipeConfig,
+    ServiceConfig,
+    ServiceConfigFilter,
+    ServiceConfigsPage,
+    TextGuardResult,
+)
 
 _T = TypeVar("_T")
 
@@ -170,3 +181,81 @@ class AIGuardAsync(ServiceBaseAsync):
                 "log_fields": log_fields,
             },
         )
+
+    async def get_service_config(self, id: str) -> PangeaResponse[ServiceConfig]:
+        """
+        OperationId: ai_guard_post_v1beta_config
+        """
+        return await self.request.post("v1beta/config", data={"id": id}, result_class=ServiceConfig)
+
+    async def create_service_config(
+        self,
+        name: str,
+        *,
+        id: str | None = None,
+        audit_data_activity: AuditDataActivityConfig | None = None,
+        connections: ConnectionsConfig | None = None,
+        recipes: Mapping[str, RecipeConfig] | None = None,
+    ) -> PangeaResponse[ServiceConfig]:
+        """
+        OperationId: ai_guard_post_v1beta_config_create
+        """
+        return await self.request.post(
+            "v1beta/config/create",
+            data={
+                "name": name,
+                "id": id,
+                "audit_data_activity": audit_data_activity,
+                "connections": connections,
+                "recipes": recipes,
+            },
+            result_class=ServiceConfig,
+        )
+
+    async def update_service_config(
+        self,
+        id: str,
+        name: str,
+        *,
+        audit_data_activity: AuditDataActivityConfig | None = None,
+        connections: ConnectionsConfig | None = None,
+        recipes: Mapping[str, RecipeConfig] | None = None,
+    ) -> PangeaResponse[ServiceConfig]:
+        """
+        OperationId: ai_guard_post_v1beta_config_update
+        """
+        return await self.request.post(
+            "v1beta/config/update",
+            data={
+                "id": id,
+                "name": name,
+                "audit_data_activity": audit_data_activity,
+                "connections": connections,
+                "recipes": recipes,
+            },
+            result_class=ServiceConfig,
+        )
+
+    async def delete_service_config(self, id: str) -> PangeaResponse[ServiceConfig]:
+        """
+        OperationId: ai_guard_post_v1beta_config_delete
+        """
+        return await self.request.post("v1beta/config/delete", data={"id": id}, result_class=ServiceConfig)
+
+    async 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[ServiceConfigsPage]:
+        """
+        OperationId: ai_guard_post_v1beta_config_list
+        """
+        return await self.request.post(
+            "v1beta/config/list",
+            data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
+            result_class=ServiceConfigsPage,
+        )