pangea-sdk 6.0.0__py3-none-any.whl → 6.1.1__py3-none-any.whl

pangea/asyncio/services/authz.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, List, Optional
+from typing import Any
 
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
@@ -73,14 +73,14 @@ class AuthZAsync(ServiceBaseAsync):
 
         super().__init__(token, config, logger_name, config_id=config_id)
 
-    async def tuple_create(self, tuples: List[Tuple]) -> PangeaResponse[TupleCreateResult]:
+    async def tuple_create(self, tuples: list[Tuple]) -> PangeaResponse[TupleCreateResult]:
         """Create tuples.
 
         Create tuples in the AuthZ Service. The request will fail if there is no schema
         or the tuples do not validate against the schema.
 
         Args:
-            tuples (List[Tuple]): List of tuples to be created.
+            tuples: Tuples to be created.
 
         Raises:
             PangeaAPIException: If an API Error happens.
@@ -88,7 +88,7 @@ class AuthZAsync(ServiceBaseAsync):
         Returns:
             Pangea Response with empty result.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/create).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/create-post).
 
         Examples:
             await authz.tuple_create(
@@ -110,10 +110,10 @@ class AuthZAsync(ServiceBaseAsync):
     async def tuple_list(
         self,
         filter: TupleListFilter,
-        size: Optional[int] = None,
-        last: Optional[str] = None,
-        order: Optional[ItemOrder] = None,
-        order_by: Optional[TupleOrderBy] = None,
+        size: int | None = None,
+        last: str | None = None,
+        order: ItemOrder | None = None,
+        order_by: TupleOrderBy | None = None,
     ) -> PangeaResponse[TupleListResult]:
         """List tuples.
 
@@ -122,11 +122,11 @@ class AuthZAsync(ServiceBaseAsync):
         is empty it will return all the tuples.
 
         Args:
-            filter (TupleListFilter): The filter for listing tuples.
-            size (Optional[int]): The size of the result set. Default is None.
-            last (Optional[str]): The last token from a previous response. Default is None.
-            order (Optional[ItemOrder]): Order results asc(ending) or desc(ending).
-            order_by (Optional[TupleOrderBy]): Which field to order results by.
+            filter: The filter for listing tuples.
+            size: The size of the result set. Default is None.
+            last: The last token from a previous response. Default is None.
+            order: Order results asc(ending) or desc(ending).
+            order_by: Which field to order results by.
 
         Raises:
             PangeaAPIException: If an API Error happens.
@@ -134,7 +134,7 @@ class AuthZAsync(ServiceBaseAsync):
         Returns:
             Pangea Response with a list of tuples and the last token.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/list).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/list-post).
 
         Examples:
             await authz.tuple_list(TupleListFilter(subject_type="user", subject_id="user_1"))
@@ -144,13 +144,13 @@ class AuthZAsync(ServiceBaseAsync):
         )
         return await self.request.post("v1/tuple/list", TupleListResult, data=input_data.model_dump(exclude_none=True))
 
-    async def tuple_delete(self, tuples: List[Tuple]) -> PangeaResponse[TupleDeleteResult]:
+    async def tuple_delete(self, tuples: list[Tuple]) -> PangeaResponse[TupleDeleteResult]:
         """Delete tuples.
 
         Delete tuples in the AuthZ Service.
 
         Args:
-            tuples (List[Tuple]): List of tuples to be deleted.
+            tuples: Tuples to be deleted.
 
         Raises:
             PangeaAPIException: If an API Error happens.
@@ -158,7 +158,7 @@ class AuthZAsync(ServiceBaseAsync):
         Returns:
             Pangea Response with empty result.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/delete).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/delete-post).
 
         Examples:
             await authz.tuple_delete(
@@ -182,8 +182,8 @@ class AuthZAsync(ServiceBaseAsync):
         resource: Resource,
         action: str,
         subject: Subject,
-        debug: Optional[bool] = None,
-        attributes: Optional[Dict[str, Any]] = None,
+        debug: bool | None = None,
+        attributes: dict[str, Any] | None = None,
     ) -> PangeaResponse[CheckResult]:
         """Perform a check request.
 
@@ -192,9 +192,9 @@ class AuthZAsync(ServiceBaseAsync):
         Args:
             resource (Resource): The resource to check.
             action (str): The action to check.
-            subject (Subject): The subject to check.
-            debug (Optional[bool]): Setting this value to True will provide a detailed analysis of the check.
-            attributes (Optional[Dict[str, Any]]): Additional attributes for the check.
+            subject: The subject to check.
+            debug: Setting this value to True will provide a detailed analysis of the check.
+            attributes: Additional attributes for the check.
 
         Raises:
             PangeaAPIException: If an API Error happens.
@@ -202,7 +202,7 @@ class AuthZAsync(ServiceBaseAsync):
         Returns:
             Pangea Response with the result of the check.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/check).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/check-post).
 
         Examples:
             await authz.check(
@@ -217,7 +217,7 @@ class AuthZAsync(ServiceBaseAsync):
         return await self.request.post("v1/check", CheckResult, data=input_data.model_dump(exclude_none=True))
 
     async def list_resources(
-        self, type: str, action: str, subject: Subject, attributes: Optional[Dict[str, Any]] = None
+        self, type: str, action: str, subject: Subject, attributes: dict[str, Any] | None = None
     ) -> PangeaResponse[ListResourcesResult]:
         """List resources.
 
@@ -225,10 +225,10 @@ class AuthZAsync(ServiceBaseAsync):
         type that the subject has access to the action with.
 
         Args:
-            type (str): The type to filter resources.
-            action (str): The action to filter resources.
-            subject (Subject): The subject to filter resources.
-            attributes (Optional[Dict[str, Any]]): A JSON object of attribute data.
+            type: The type to filter resources.
+            action: The action to filter resources.
+            subject: The subject to filter resources.
+            attributes: A JSON object of attribute data.
 
         Raises:
             PangeaAPIException: If an API Error happens.
@@ -236,7 +236,7 @@ class AuthZAsync(ServiceBaseAsync):
         Returns:
             Pangea Response with a list of resource IDs.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-resources).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-resources-post).
 
         Examples:
             await authz.list_resources(
@@ -252,7 +252,7 @@ class AuthZAsync(ServiceBaseAsync):
         )
 
     async def list_subjects(
-        self, resource: Resource, action: str, attributes: Optional[Dict[str, Any]] = None
+        self, resource: Resource, action: str, attributes: dict[str, Any] | None = None
     ) -> PangeaResponse[ListSubjectsResult]:
         """List subjects.
 
@@ -260,9 +260,9 @@ class AuthZAsync(ServiceBaseAsync):
         access to the action for the given resource.
 
         Args:
-            resource (Resource): The resource to filter subjects.
-            action (str): The action to filter subjects.
-            attributes (Optional[Dict[str, Any]]): A JSON object of attribute data.
+            resource: The resource to filter subjects.
+            action: The action to filter subjects.
+            attributes: A JSON object of attribute data.
 
         Raises:
             PangeaAPIException: If an API Error happens.
@@ -270,7 +270,7 @@ class AuthZAsync(ServiceBaseAsync):
         Returns:
             Pangea Response with a list of subjects.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-subjects).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-subjects-post).
 
         Examples:
             await authz.list_subjects(

pangea/asyncio/services/file_scan.py

@@ -16,7 +16,7 @@ class FileScanAsync(ServiceBaseAsync):
     """FileScan service client.
 
     Provides methods to interact with Pangea FileScan Service:
-        https://pangea.cloud/docs/api/embargo
+        https://pangea.cloud/docs/api/file-scan
 
     The following information is needed:
         PANGEA_TOKEN - service token which can be found on the Pangea User

pangea/asyncio/services/redact.py

@@ -92,7 +92,7 @@ class RedactAsync(ServiceBaseAsync):
         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")
@@ -151,7 +151,7 @@ class RedactAsync(ServiceBaseAsync):
         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 = {
@@ -196,7 +196,7 @@ class RedactAsync(ServiceBaseAsync):
         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 = m.UnredactRequest(redacted_data=redacted_data, fpe_context=fpe_context)
         return await self.request.post("v1/unredact", m.UnredactResult, data=input.model_dump(exclude_none=True))

pangea/asyncio/services/vault.py

@@ -164,7 +164,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the id of the deleted secret or key
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#delete).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/delete-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -197,7 +197,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the secret or key
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#retrieve).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/get-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -283,7 +283,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where a list of secrets or keys
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#list).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/list-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -345,7 +345,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the item ID is returned in the
             response.result field. Available response fields can be found in our
-            [API documentation](https://pangea.cloud/docs/api/vault#update).
+            [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/update-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1680,7 +1680,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the encrypted message in base64 is returned
             in the response.result field. Available response fields can be found
-            in our [API documentation](https://pangea.cloud/docs/api/vault#encrypt).
+            in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/encrypt-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1716,7 +1716,7 @@ class VaultAsync(ServiceBaseAsync):
 
         Returns:
             A PangeaResponse where the decrypted message in base64 is returned
-            in the response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#decrypt).
+            in the response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/decrypt-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1750,7 +1750,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the signature of the message in base64 is
             returned in the response.result field. Available response fields can
-            be found in our [API documentation](https://pangea.cloud/docs/api/vault#sign).
+            be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/sign-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1788,7 +1788,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the signature is valid
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#verify).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/verify-post).
 
         Examples:
             response = await vault.verify(
@@ -1826,7 +1826,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the signature is valid
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#verify-jwt).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-jwt#/v1/key/verify/jwt-post).
 
         Examples:
             response = await vault.jwt_verify(jws="ewogICJhbGciO...")
@@ -1851,7 +1851,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the signed JSON Web Token (JWS) is returned
             in the response.result field. Available response fields can be found
-            in our [API documentation](https://pangea.cloud/docs/api/vault#sign-a-jwt).
+            in our [API documentation](https://pangea.cloud/docs/api/vault/v1-jwt#/v1/key/sign/jwt-post).
 
         Examples:
             response = await vault.jwt_sign(
@@ -1881,7 +1881,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the JSON Web Key Set (JWKS) object is
             returned in the response.result field. Available response fields can
-            be found in our [API documentation](https://pangea.cloud/docs/api/vault#retrieve-jwk).
+            be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-jwt#/v1/get/jwk-post).
 
         Examples:
             response = await vault.jwk_get("pvi_p6g5i3gtbvqvc3u6zugab6qs6r63tqf5")
@@ -1913,7 +1913,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A PangeaResponse where the state change object is returned in the
             response.result field. Available response fields can be found in our
-            [API documentation](https://pangea.cloud/docs/api/vault#change-state).
+            [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/state/change-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -2014,7 +2014,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A `PangeaResponse` where the encrypted object is returned in the
             `response.result` field. Available response fields can be found in
-            our [API documentation](https://pangea.cloud/docs/api/vault#encrypt-structured).
+            our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/encrypt/structured-post).
 
         Raises:
             PangeaAPIException: If an API error happens.
@@ -2070,7 +2070,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A `PangeaResponse` where the decrypted object is returned in the
             `response.result` field. Available response fields can be found in
-            our [API documentation](https://pangea.cloud/docs/api/vault#decrypt-structured).
+            our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/decrypt/structured-post).
 
         Examples:
             data = {"field1": [1, 2, "kxcbC9E9IlgVaSCChPWUMgUC3ko=", "6FfI/LCzatLRLNAc8SuBK/TDnGxp"], "field2": "data2"}
@@ -2214,7 +2214,7 @@ class VaultAsync(ServiceBaseAsync):
         Returns:
             A `PangeaResponse` where the exported key is returned in the
             `response.result` field. Available response fields can be found in
-            our [API documentation](https://pangea.cloud/docs/api/vault#export).
+            our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/export-post).
 
         Raises:
             PangeaAPIException: If an API error happens.

pangea/request.py

@@ -231,7 +231,7 @@ class PangeaRequest(PangeaRequestBase):
             data = {}
 
         # Normalize.
-        data = cast(dict[str, Any], to_jsonable_python(data))
+        data = cast(dict[str, Any], to_jsonable_python(data, exclude_none=True))
 
         if url is None:
             url = self._url(endpoint)

pangea/services/audit/audit.py

@@ -457,7 +457,7 @@ class Audit(ServiceBase, AuditBase):
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
                 Available response fields can be found in our
-                [API documentation](https://pangea.cloud/docs/api/audit#/v1/log).
+                [API documentation](https://pangea.cloud/docs/api/audit#/v1/log-post).
 
         Examples:
             log_response = audit.log(
@@ -505,7 +505,7 @@ class Audit(ServiceBase, AuditBase):
         Returns:
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/log).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/log-post).
 
         Examples:
             response = audit.log_event({"message": "hello world"}, verbose=True)
@@ -543,7 +543,7 @@ class Audit(ServiceBase, AuditBase):
         Returns:
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v2/log).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v2/log-post).
 
         Examples:
             log_response = audit.log_bulk(
@@ -584,7 +584,7 @@ class Audit(ServiceBase, AuditBase):
         Returns:
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v2/log_async).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v2/log_async-post).
 
         Examples:
             log_response = audit.log_bulk_async(
@@ -659,8 +659,8 @@ class Audit(ServiceBase, AuditBase):
 
         Returns:
             A PangeaResponse[SearchOutput] where the first page of matched events is returned in the
-                response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/search).
-                Pagination can be found in the [search results endpoint](https://pangea.cloud/docs/api/audit#/v1/results).
+                response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/search-post).
+                Pagination can be found in the [search results endpoint](https://pangea.cloud/docs/api/audit#/v1/results-post).
 
         Examples:
             response = audit.search(