pangea-sdk 6.5.0b1__py3-none-any.whl → 6.6.0__py3-none-any.whl

pangea/asyncio/services/audit.py

@@ -8,10 +8,7 @@ from __future__ import annotations
 
 import datetime
 from collections.abc import Mapping
-from typing import Any, Dict, Iterable, List, Optional, Sequence, Union, cast, overload
-
-from pydantic import TypeAdapter
-from typing_extensions import Literal
+from typing import Any, Dict, Iterable, List, Optional, Sequence, Union
 
 import pangea.exceptions as pexc
 from pangea.asyncio.services.base import ServiceBaseAsync
@@ -20,13 +17,11 @@ from pangea.response import PangeaResponse, PangeaResponseResult
 from pangea.services.audit.audit import AuditBase
 from pangea.services.audit.exceptions import AuditException
 from pangea.services.audit.models import (
-    AuditSchema,
     DownloadFormat,
     DownloadRequest,
     DownloadResult,
     Event,
     ExportRequest,
-    ForwardingConfiguration,
     LogBulkResult,
     LogResult,
     PublishedRoot,
@@ -39,9 +34,6 @@ from pangea.services.audit.models import (
     SearchRequest,
     SearchResultOutput,
     SearchResultRequest,
-    ServiceConfig,
-    ServiceConfigFilter,
-    ServiceConfigListResult,
 )
 from pangea.services.audit.util import format_datetime
 
@@ -603,298 +595,6 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
         )
         return await self.request.post("v1/download_results", DownloadResult, data=input.model_dump(exclude_none=True))
 
-    async def get_service_config(self, config_id: str) -> PangeaResponse[ServiceConfig]:
-        """
-        Get a service config.
-
-        OperationId: audit_post_v1beta_config
-
-        Args:
-            id: The config ID
-        """
-
-        response = await self.request.post("v1beta/config", PangeaResponseResult, data={"id": config_id})
-        response.result = TypeAdapter(ServiceConfig).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfig], response)
-
-    @overload
-    async def create_service_config(
-        self,
-        version: Literal[1],
-        name: str,
-        *,
-        cold_query_result_retention: str | None = None,
-        hot_storage: str | None = None,
-        query_result_retention: str | None = None,
-        redact_service_config_id: str | None = None,
-        redaction_fields: Sequence[str] | None = None,
-        retention: str | None = None,
-        vault_key_id: str | None = None,
-        vault_service_config_id: str | None = None,
-        vault_sign: bool | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        Create a v1 service config.
-
-        OperationId: audit_post_v1beta_config_create
-
-        Args:
-            name: Configuration name
-            cold_query_result_retention: Retention window for cold query result / state information.
-            hot_storage: Retention window to keep audit logs in hot storage.
-            query_result_retention: Length of time to preserve server-side query result caching.
-            redact_service_config_id: A redact service config that will be used to redact PII from logs.
-            redaction_fields: Fields to perform redaction against.
-            retention: Retention window to store audit logs.
-            vault_key_id: ID of the Vault key used for signing. If missing, use a default Audit key.
-            vault_service_config_id: A vault service config that will be used to sign logs.
-            vault_sign: Enable/disable event signing.
-        """
-
-    @overload
-    async def create_service_config(
-        self,
-        version: Literal[2],
-        name: str,
-        *,
-        schema: AuditSchema,
-        cold_query_result_retention: str | None = None,
-        forwarding_configuration: ForwardingConfiguration | None = None,
-        hot_storage: str | None = None,
-        query_result_retention: str | None = None,
-        redact_service_config_id: str | None = None,
-        retention: str | None = None,
-        vault_key_id: str | None = None,
-        vault_service_config_id: str | None = None,
-        vault_sign: bool | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        Create a v2 service config.
-
-        OperationId: audit_post_v1beta_config_create
-
-        Args:
-            name: Configuration name
-            schema: Audit log field configuration. Only settable at create time.
-            cold_query_result_retention: Retention window for cold query result / state information.
-            forwarding_configuration: Configuration for forwarding audit logs to external systems.
-            hot_storage: Retention window to keep audit logs in hot storage.
-            query_result_retention: Length of time to preserve server-side query result caching.
-            redact_service_config_id: A redact service config that will be used to redact PII from logs.
-            retention: Retention window to store audit logs.
-            vault_key_id: ID of the Vault key used for signing. If missing, use a default Audit key.
-            vault_service_config_id: A vault service config that will be used to sign logs.
-            vault_sign: Enable/disable event signing.
-        """
-
-    @overload
-    async def create_service_config(
-        self,
-        version: Literal[3],
-        name: str,
-        *,
-        schema: AuditSchema,
-        cold_storage: str | None = None,
-        hot_storage: str | None = None,
-        warm_storage: str | None = None,
-        redact_service_config_id: str | None = None,
-        vault_service_config_id: str | None = None,
-        vault_key_id: str | None = None,
-        vault_sign: bool | None = None,
-        forwarding_configuration: ForwardingConfiguration | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        Create a v3 service config.
-
-        OperationId: audit_post_v1beta_config_create
-
-        Args:
-            name: Configuration name
-            schema: Audit log field configuration. Only settable at create time.
-            cold_storage: Retention window for logs in cold storage. Deleted afterwards.
-            hot_storage: Retention window for logs in hot storage. Migrated to warm, cold, or deleted afterwards.
-            warm_storage: Retention window for logs in warm storage. Migrated to cold or deleted afterwards.
-            redact_service_config_id: A redact service config that will be used to redact PII from logs.
-            vault_service_config_id: A vault service config that will be used to sign logs.
-            vault_key_id: ID of the Vault key used for signing. If missing, use a default Audit key.
-            vault_sign: Enable/disable event signing.
-            forwarding_configuration: Configuration for forwarding audit logs to external systems.
-        """
-
-    async def create_service_config(
-        self,
-        version: Literal[1, 2, 3],
-        name: str,
-        *,
-        cold_query_result_retention: str | None = None,
-        cold_storage: str | None = None,
-        forwarding_configuration: ForwardingConfiguration | None = None,
-        hot_storage: str | None = None,
-        query_result_retention: str | None = None,
-        redact_service_config_id: str | None = None,
-        redaction_fields: Sequence[str] | None = None,
-        retention: str | None = None,
-        schema: AuditSchema | None = None,
-        vault_key_id: str | None = None,
-        vault_service_config_id: str | None = None,
-        vault_sign: bool | None = None,
-        warm_storage: str | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        Create a service config.
-
-        OperationId: audit_post_v1beta_config_create
-
-        Args:
-            name: Configuration name
-            cold_query_result_retention: Retention window for cold query result / state information.
-            cold_storage: Retention window for logs in cold storage. Deleted afterwards.
-            forwarding_configuration: Configuration for forwarding audit logs to external systems.
-            hot_storage: Retention window to keep audit logs in hot storage.
-            query_result_retention: Length of time to preserve server-side query result caching.
-            redact_service_config_id: A redact service config that will be used to redact PII from logs.
-            redaction_fields: Fields to perform redaction against.
-            retention: Retention window to store audit logs.
-            schema: Audit log field configuration. Only settable at create time.
-            vault_key_id: ID of the Vault key used for signing. If missing, use a default Audit key.
-            vault_service_config_id: A vault service config that will be used to sign logs.
-            vault_sign: Enable/disable event signing.
-            warm_storage: Retention window for logs in warm storage. Migrated to cold or deleted afterwards.
-        """
-
-        response = await self.request.post(
-            "v1beta/config/create",
-            PangeaResponseResult,
-            data={
-                "cold_query_result_retention": cold_query_result_retention,
-                "cold_storage": cold_storage,
-                "forwarding_configuration": forwarding_configuration,
-                "hot_storage": hot_storage,
-                "name": name,
-                "query_result_retention": query_result_retention,
-                "redact_service_config_id": redact_service_config_id,
-                "redaction_fields": redaction_fields,
-                "retention": retention,
-                "schema": schema,
-                "vault_key_id": vault_key_id,
-                "vault_service_config_id": vault_service_config_id,
-                "vault_sign": vault_sign,
-                "warm_storage": warm_storage,
-                "version": version,
-            },
-        )
-        response.result = TypeAdapter(ServiceConfig).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfig], response)
-
-    async def update_service_config(
-        self,
-        config_id: str,
-        *,
-        name: str,
-        updated_at: datetime.datetime,
-        # Optionals.
-        cold_query_result_retention: str | None = None,
-        cold_storage: str | None = None,
-        forwarding_configuration: ForwardingConfiguration | None = None,
-        hot_storage: str | None = None,
-        query_result_retention: str | None = None,
-        redact_service_config_id: str | None = None,
-        retention: str | None = None,
-        schema: AuditSchema | None = None,
-        vault_key_id: str | None = None,
-        vault_service_config_id: str | None = None,
-        vault_sign: bool | None = None,
-        warm_storage: str | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        Update a service config.
-
-        OperationId: audit_post_v1beta_config_update
-
-        Args:
-            id: The config ID
-            name: Configuration name
-            updated_at: The DB timestamp when this config was last updated at
-            cold_query_result_retention: Retention window for cold query result / state information.
-            cold_storage: Retention window for logs in cold storage. Deleted afterwards.
-            forwarding_configuration: Configuration for forwarding audit logs to external systems
-            hot_storage: Retention window to keep audit logs in hot storage
-            query_result_retention: Length of time to preserve server-side query result caching
-            redact_service_config_id: A redact service config that will be used to redact PII from logs
-            retention: Retention window to store audit logs
-            schema: Audit log field configuration
-            vault_key_id: ID of the Vault key used for signing. If missing, use a default Audit key.
-            vault_service_config_id: A vault service config that will be used to sign logs
-            vault_sign: Enable/disable event signing
-            warm_storage: Retention window for logs in warm storage. Migrated to cold or deleted afterwards.
-        """
-
-        response = await self.request.post(
-            "v1beta/config/update",
-            PangeaResponseResult,
-            data={
-                "id": config_id,
-                "name": name,
-                "updated_at": updated_at,
-                # Optionals.
-                "cold_query_result_retention": cold_query_result_retention,
-                "cold_storage": cold_storage,
-                "forwarding_configuration": forwarding_configuration,
-                "hot_storage": hot_storage,
-                "query_result_retention": query_result_retention,
-                "redact_service_config_id": redact_service_config_id,
-                "retention": retention,
-                "schema": schema,
-                "vault_key_id": vault_key_id,
-                "vault_service_config_id": vault_service_config_id,
-                "vault_sign": vault_sign,
-                "warm_storage": warm_storage,
-            },
-        )
-        response.result = TypeAdapter(ServiceConfig).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfig], response)
-
-    async def delete_service_config(self, config_id: str) -> PangeaResponse[ServiceConfig]:
-        """
-        Delete a service config.
-
-        OperationId: audit_post_v1beta_config_delete
-
-        Args:
-            id: The config ID
-        """
-
-        response = await self.request.post("v1beta/config/delete", PangeaResponseResult, data={"id": config_id})
-        response.result = TypeAdapter(ServiceConfig).validate_python(response.json["result"])
-        return cast(PangeaResponse[ServiceConfig], response)
-
-    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[ServiceConfigListResult]:
-        """
-        List service configs.
-
-        OperationId: audit_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 await self.request.post(
-            "v1beta/config/list",
-            ServiceConfigListResult,
-            data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
-        )
-
     async def update_published_roots(self, result: SearchResultOutput):
         """Fetches series of published root hashes from Arweave
 

pangea/asyncio/services/authn.py

@@ -10,9 +10,9 @@ from collections.abc import Mapping
 from typing import Dict, List, Literal, Optional, Union
 
 import pangea.services.authn.models as m
+from pangea import PangeaResponse, PangeaResponseResult
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
-from pangea.response import PangeaResponse, PangeaResponseResult
 
 __all__ = ["AuthNAsync"]
 
@@ -66,11 +66,18 @@ class AuthNAsync(ServiceBaseAsync):
              authn = AuthNAsync(token="pangea_token", config=config)
         """
         super().__init__(token, config, logger_name=logger_name)
-        self.user = AuthNAsync.UserAsync(token, config, logger_name=logger_name)
-        self.flow = AuthNAsync.FlowAsync(token, config, logger_name=logger_name)
+        self.agreements = AuthNAsync.AgreementsAsync(token, config, logger_name=logger_name)
         self.client = AuthNAsync.ClientAsync(token, config, logger_name=logger_name)
+        self.flow = AuthNAsync.FlowAsync(token, config, logger_name=logger_name)
         self.session = AuthNAsync.SessionAsync(token, config, logger_name=logger_name)
-        self.agreements = AuthNAsync.AgreementsAsync(token, config, logger_name=logger_name)
+        self.user = AuthNAsync.UserAsync(token, config, logger_name=logger_name)
+
+    async def close(self) -> None:
+        await self.agreements.close()
+        await self.client.close()
+        await self.flow.close()
+        await self.session.close()
+        await self.user.close()
 
     class SessionAsync(ServiceBaseAsync):
         service_name = _SERVICE_NAME
@@ -179,10 +186,15 @@ class AuthNAsync(ServiceBaseAsync):
             logger_name: str = "pangea",
         ) -> None:
             super().__init__(token, config, logger_name=logger_name)
-            self.session = AuthNAsync.ClientAsync.SessionAsync(token, config, logger_name=logger_name)
             self.password = AuthNAsync.ClientAsync.PasswordAsync(token, config, logger_name=logger_name)
+            self.session = AuthNAsync.ClientAsync.SessionAsync(token, config, logger_name=logger_name)
             self.token_endpoints = AuthNAsync.ClientAsync.TokenAsync(token, config, logger_name=logger_name)
 
+        async def close(self) -> None:
+            await self.password.close()
+            await self.session.close()
+            await self.token_endpoints.close()
+
         async def userinfo(self, code: str) -> PangeaResponse[m.ClientUserinfoResult]:
             """
             Get User (client token)
@@ -470,9 +482,14 @@ class AuthNAsync(ServiceBaseAsync):
             logger_name: str = "pangea",
         ) -> None:
             super().__init__(token, config, logger_name=logger_name)
-            self.profile = AuthNAsync.UserAsync.ProfileAsync(token, config, logger_name=logger_name)
             self.authenticators = AuthNAsync.UserAsync.AuthenticatorsAsync(token, config, logger_name=logger_name)
             self.invites = AuthNAsync.UserAsync.InvitesAsync(token, config, logger_name=logger_name)
+            self.profile = AuthNAsync.UserAsync.ProfileAsync(token, config, logger_name=logger_name)
+
+        async def close(self) -> None:
+            await self.authenticators.close()
+            await self.invites.close()
+            await self.profile.close()
 
         async def create(
             self,
@@ -932,7 +949,7 @@ class AuthNAsync(ServiceBaseAsync):
                 return await self.request.post(
                     "v2/user/group/assign",
                     data={"id": user_id, "group_ids": group_ids},
-                    result_class=m.PangeaResponseResult,
+                    result_class=PangeaResponseResult,
                 )
 
             async def remove(self, user_id: str, group_id: str) -> PangeaResponse[PangeaResponseResult]:
@@ -946,7 +963,7 @@ class AuthNAsync(ServiceBaseAsync):
                 return await self.request.post(
                     "v2/user/group/remove",
                     data={"id": user_id, "group_id": group_id},
-                    result_class=m.PangeaResponseResult,
+                    result_class=PangeaResponseResult,
                 )
 
             async def list(self, user_id: str) -> PangeaResponse[m.GroupList]:

pangea/asyncio/services/base.py

@@ -6,14 +6,20 @@
 
 from __future__ import annotations
 
+from types import TracebackType
 from typing import Dict, Optional, Type, Union
 
 from typing_extensions import override
 
+from pangea import PangeaResponse, PangeaResponseResult
+from pangea._typing import T
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.exceptions import AcceptedRequestException
-from pangea.response import AttachedFile, PangeaResponse, PangeaResponseResult
-from pangea.services.base import PangeaRequest, ServiceBase
+from pangea.request import PangeaRequest
+from pangea.response import AttachedFile
+from pangea.services.base import ServiceBase
+
+__all__ = ("ServiceBaseAsync",)
 
 
 class ServiceBaseAsync(ServiceBase):
@@ -85,8 +91,17 @@ class ServiceBaseAsync(ServiceBase):
         return await self.request.download_file(url=url, filename=filename)
 
     async def close(self):
+        """Close the underlying aiohttp client."""
+
         await self.request.session.close()
-        # Loop over all attributes to check if they are derived from ServiceBaseAsync and close them
-        for _, value in self.__dict__.items():
-            if issubclass(type(value), ServiceBaseAsync):
-                await value.close()
+
+    async def __aenter__(self: T) -> T:
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        await self.close()

pangea/asyncio/services/file_scan.py

@@ -11,9 +11,9 @@ import logging
 from typing import Dict, List, Optional, Tuple
 
 import pangea.services.file_scan as m
+from pangea import PangeaConfig
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.asyncio.services.base import ServiceBaseAsync
-from pangea.request import PangeaConfig
 from pangea.response import PangeaResponse, TransferMethod
 from pangea.utils import FileUploadParams, get_file_upload_params