pangea-sdk 3.8.0b2__tar.gz → 3.8.0b3__tar.gz

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pangea-sdk
-Version: 3.8.0b2
+Version: 3.8.0b3
 Summary: Pangea API SDK
 Home-page: https://pangea.cloud/docs/sdk/python/
 License: MIT
@@ -44,6 +44,8 @@ above.
 
 ## Installation
 
+#### GA releases
+
 Via pip:
 
 ```bash
@@ -56,10 +58,32 @@ Via poetry:
 $ poetry add pangea-sdk
 ```
 
+<a name="beta-releases"></a>
+
+#### Beta releases
+
+Pre-release versions may be available with the `b` (beta) denotation in the
+version number. These releases serve to preview beta services and APIs. Per
+Semantic Versioning, they are considered unstable and do not carry the same
+compatibility guarantees as stable releases. [Beta changelog](https://github.com/pangeacyber/pangea-python/blob/beta/CHANGELOG.md).
+
+Via pip:
+
+```bash
+$ pip3 install pangea-sdk==3.8.0b3
+```
+
+Via poetry:
+
+```bash
+$ poetry add pangea-sdk==3.8.0b3
+```
+
 ## Usage
 
 - [Documentation][]
-- [Examples][]
+- [GA Examples][]
+- [Beta Examples][]
 
 General usage would be to create a token for a service through the
 [Pangea Console][] and then construct an API client for that respective service.
@@ -213,7 +237,8 @@ It accepts multiple file formats:
 
 
    [Documentation]: https://pangea.cloud/docs/sdk/python/
-   [Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+   [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+   [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
    [Pangea Console]: https://console.pangea.cloud/
    [Slack]: https://pangea.cloud/join-slack/
    [Secure Audit Log]: https://pangea.cloud/docs/audit

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/README.md

@@ -14,6 +14,8 @@ above.
 
 ## Installation
 
+#### GA releases
+
 Via pip:
 
 ```bash
@@ -26,10 +28,32 @@ Via poetry:
 $ poetry add pangea-sdk
 ```
 
+<a name="beta-releases"></a>
+
+#### Beta releases
+
+Pre-release versions may be available with the `b` (beta) denotation in the
+version number. These releases serve to preview beta services and APIs. Per
+Semantic Versioning, they are considered unstable and do not carry the same
+compatibility guarantees as stable releases. [Beta changelog](https://github.com/pangeacyber/pangea-python/blob/beta/CHANGELOG.md).
+
+Via pip:
+
+```bash
+$ pip3 install pangea-sdk==3.8.0b3
+```
+
+Via poetry:
+
+```bash
+$ poetry add pangea-sdk==3.8.0b3
+```
+
 ## Usage
 
 - [Documentation][]
-- [Examples][]
+- [GA Examples][]
+- [Beta Examples][]
 
 General usage would be to create a token for a service through the
 [Pangea Console][] and then construct an API client for that respective service.
@@ -183,7 +207,8 @@ It accepts multiple file formats:
 
 
    [Documentation]: https://pangea.cloud/docs/sdk/python/
-   [Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+   [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+   [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
    [Pangea Console]: https://console.pangea.cloud/
    [Slack]: https://pangea.cloud/join-slack/
    [Secure Audit Log]: https://pangea.cloud/docs/audit

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.8.0beta2"
+__version__ = "3.8.0beta3"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/pangea/asyncio/services/__init__.py

@@ -1,9 +1,10 @@
 from .audit import AuditAsync
 from .authn import AuthNAsync
+from .authz import AuthZAsync
 from .embargo import EmbargoAsync
 from .file_scan import FileScanAsync
 from .intel import DomainIntelAsync, FileIntelAsync, IpIntelAsync, UrlIntelAsync, UserIntelAsync
 from .redact import RedactAsync
-from .share import ShareAsync
 from .sanitize import SanitizeAsync
+from .share import ShareAsync
 from .vault import VaultAsync

pangea_sdk-3.8.0b3/pangea/asyncio/services/authz.py

@@ -0,0 +1,267 @@
+# Copyright 2022 Pangea Cyber Corporation
+# Author: Pangea Cyber Corporation
+
+from typing import Dict, List, Optional, Union
+
+from pangea.asyncio.services.base import ServiceBaseAsync
+from pangea.response import PangeaResponse
+from pangea.services.authz import (
+    CheckRequest,
+    CheckResult,
+    ItemOrder,
+    ListResourcesRequest,
+    ListResourcesResult,
+    ListSubjectsRequest,
+    ListSubjectsResult,
+    Resource,
+    Subject,
+    Tuple,
+    TupleCreateRequest,
+    TupleCreateResult,
+    TupleDeleteRequest,
+    TupleDeleteResult,
+    TupleListFilter,
+    TupleListRequest,
+    TupleListResult,
+    TupleOrderBy,
+)
+
+
+class AuthZAsync(ServiceBaseAsync):
+    """AuthZ service client. (Beta)
+
+    Provides methods to interact with the Pangea AuthZ Service.
+    Documentation for the AuthZ Service API can be found at
+    <https://pangea.cloud/docs/api/authz>. Note that this service is in Beta and
+    is subject to change.
+
+    Examples:
+        import os
+        from pangea.config import PangeaConfig
+        from pangea.services import AuthZ
+
+        PANGEA_TOKEN = os.getenv("PANGEA_AUTHZ_TOKEN")
+
+        authz_config = PangeaConfig(domain="aws.us.pangea.cloud")
+
+        # Setup Pangea AuthZ service client
+        authz = AuthZAsync(token=PANGEA_TOKEN, config=authz_config)
+    """
+
+    service_name = "authz"
+
+    def __init__(self, token: str, config=None, logger_name="pangea", config_id: Optional[str] = None):
+        super().__init__(token, config, logger_name, config_id=config_id)
+
+    async def tuple_create(self, tuples: List[Tuple]) -> PangeaResponse[TupleCreateResult]:
+        """Create tuples. (Beta)
+
+        Create tuples in the AuthZ Service. The request will fail if there is no schema
+        or the tuples do not validate against the schema.
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        Args:
+            tuples (List[Tuple]): List of tuples to be created.
+
+        Raises:
+            PangeaAPIException: If an API Error happens.
+
+        Returns:
+            Pangea Response with empty result.
+            Available response fields can be found in our
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/tuple/create).
+
+        Examples:
+            await authz.tuple_create(
+                tuples=[
+                    Tuple(
+                        resource=Resource(namespace="file", id="file_1"),
+                        relation="owner",
+                        subject=Subject(namespace="user", id="user_1"),
+                    )
+                ]
+            )
+        """
+
+        input_data = TupleCreateRequest(tuples=tuples)
+        return await self.request.post(
+            "v1beta/tuple/create", TupleCreateResult, data=input_data.dict(exclude_none=True)
+        )
+
+    async def tuple_list(
+        self,
+        filter: TupleListFilter,
+        size: Optional[int] = None,
+        last: Optional[str] = None,
+        order: Optional[ItemOrder] = None,
+        order_by: Optional[TupleOrderBy] = None,
+    ) -> PangeaResponse[TupleListResult]:
+        """List tuples. (Beta)
+
+        Return a paginated list of filtered tuples. The filter is given in terms
+        of a tuple. Fill out the fields that you want to filter. If the filter
+        is empty it will return all the tuples.
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        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.
+
+        Raises:
+            PangeaAPIException: If an API Error happens.
+
+        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#/v1beta/tuple/list).
+
+        Examples:
+            await authz.tuple_list(TupleListFilter(subject_namespace="user", subject_id="user_1"))
+        """
+        input_data = TupleListRequest(
+            filter=filter.dict(exclude_none=True), size=size, last=last, order=order, order_by=order_by
+        )
+        return await self.request.post("v1beta/tuple/list", TupleListResult, data=input_data.dict(exclude_none=True))
+
+    async def tuple_delete(self, tuples: List[Tuple]) -> PangeaResponse[TupleDeleteResult]:
+        """Delete tuples. (Beta)
+
+        Delete tuples in the AuthZ Service.
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        Args:
+            tuples (List[Tuple]): List of tuples to be deleted.
+
+        Raises:
+            PangeaAPIException: If an API Error happens.
+
+        Returns:
+            Pangea Response with empty result.
+            Available response fields can be found in our
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/tuple/delete).
+
+        Examples:
+            await authz.tuple_delete(
+                tuples=[
+                    Tuple(
+                        resource=Resource(namespace="file", id="file_1"),
+                        relation="owner",
+                        subject=Subject(namespace="user", id="user_1"),
+                    )
+                ]
+            )
+        """
+
+        input_data = TupleDeleteRequest(tuples=tuples)
+        return await self.request.post(
+            "v1beta/tuple/delete", TupleDeleteResult, data=input_data.dict(exclude_none=True)
+        )
+
+    async def check(
+        self,
+        resource: Resource,
+        action: str,
+        subject: Subject,
+        debug: Optional[bool] = None,
+        attributes: Optional[Dict[str, Union[int, str]]] = None,
+    ) -> PangeaResponse[CheckResult]:
+        """Perform a check request. (Beta)
+
+        Check if a subject has permission to perform an action on the resource.
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        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, Union[int, str]]]): Additional attributes for the check.
+
+        Raises:
+            PangeaAPIException: If an API Error happens.
+
+        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#/v1beta/check).
+
+        Examples:
+            await authz.check(
+                resource=Resource(namespace="file", id="file_1"),
+                action="update",
+                subject=Subject(namespace="user", id="user_1"),
+                debug=True,
+            )
+        """
+
+        input_data = CheckRequest(resource=resource, action=action, subject=subject, debug=debug, attributes=attributes)
+        return await self.request.post("v1beta/check", CheckResult, data=input_data.dict(exclude_none=True))
+
+    async def list_resources(
+        self, namespace: str, action: str, subject: Subject
+    ) -> PangeaResponse[ListResourcesResult]:
+        """List resources. (Beta)
+
+        Given a namespace, action, and subject, list all the resources in the
+        namespace that the subject has access to the action with.
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        Args:
+            namespace (str): The namespace to filter resources.
+            action (str): The action to filter resources.
+            subject (Subject): The subject to filter resources.
+
+        Raises:
+            PangeaAPIException: If an API Error happens.
+
+        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#/v1beta/list-resources).
+
+        Examples:
+            await authz.list_resources(
+                namespace="file",
+                action="update",
+                subject=Subject(namespace="user", id="user_1"),
+            )
+        """
+
+        input_data = ListResourcesRequest(namespace=namespace, action=action, subject=subject)
+        return await self.request.post(
+            "v1beta/list-resources", ListResourcesResult, data=input_data.dict(exclude_none=True)
+        )
+
+    async def list_subjects(self, resource: Resource, action: str) -> PangeaResponse[ListSubjectsResult]:
+        """List subjects. (Beta)
+
+        Given a resource and an action, return the list of subjects who have
+        access to the action for the given resource.
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        Args:
+            resource (Resource): The resource to filter subjects.
+            action (str): The action to filter subjects.
+
+        Raises:
+            PangeaAPIException: If an API Error happens.
+
+        Returns:
+            Pangea Response with a list of subjects.
+            Available response fields can be found in our
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/list-subjects).
+
+        Examples:
+            await authz.list_subjects(
+                resource=Resource(namespace="file", id="file_1"),
+                action="update",
+            )
+        """
+
+        input_data = ListSubjectsRequest(resource=resource, action=action)
+        return await self.request.post(
+            "v1beta/list-subjects", ListSubjectsResult, data=input_data.dict(exclude_none=True)
+        )

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/pangea/asyncio/services/sanitize.py

@@ -44,10 +44,10 @@ class SanitizeAsync(ServiceBaseAsync):
         sync_call: bool = True,
     ) -> PangeaResponse[m.SanitizeResult]:
         """
-        Sanitize
+        Sanitize (Beta)
 
         Apply file sanitization actions according to specified rules.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: sanitize_post_v1beta_sanitize
 
@@ -129,11 +129,11 @@ class SanitizeAsync(ServiceBaseAsync):
         uploaded_file_name: Optional[str] = None,
     ) -> PangeaResponse[m.SanitizeResult]:
         """
-        Sanitize via presigned URL
+        Sanitize via presigned URL (Beta)
 
         Apply file sanitization actions according to specified rules via a
         [presigned URL](https://pangea.cloud/docs/api/presigned-urls).
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: sanitize_post_v1beta_sanitize 2
 

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/pangea/asyncio/services/share.py

@@ -19,11 +19,11 @@ class ShareAsync(ServiceBaseAsync):
         self, id: Optional[str] = None, path: Optional[str] = None, force: Optional[bool] = None
     ) -> PangeaResponse[m.DeleteResult]:
         """
-        Delete
+        Delete (Beta)
 
         Delete object by ID or path. If both are supplied, the path must match
         that of the object represented by the ID.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_delete
 
@@ -51,10 +51,10 @@ class ShareAsync(ServiceBaseAsync):
         tags: Optional[m.Tags] = None,
     ) -> PangeaResponse[m.FolderCreateResult]:
         """
-        Create a folder
+        Create a folder (Beta)
 
         Create a folder, either by name or path and parent_id.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_folder_create
 
@@ -87,11 +87,11 @@ class ShareAsync(ServiceBaseAsync):
         self, id: Optional[str] = None, path: Optional[str] = None, transfer_method: Optional[TransferMethod] = None
     ) -> PangeaResponse[m.GetResult]:
         """
-        Get an object
+        Get an object (Beta)
 
         Get object. If both ID and Path are supplied, the call will fail if the
         target object doesn't match both properties.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_get
 
@@ -124,10 +124,10 @@ class ShareAsync(ServiceBaseAsync):
         transfer_method: Optional[TransferMethod] = None,
     ) -> PangeaResponse[m.GetArchiveResult]:
         """
-        Get archive
+        Get archive (Beta)
 
         Get an archive file of multiple objects.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_get_archive
 
@@ -164,10 +164,10 @@ class ShareAsync(ServiceBaseAsync):
         size: Optional[int] = None,
     ) -> PangeaResponse[m.ListResult]:
         """
-        List
+        List (Beta)
 
         List or filter/search records.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_list
 
@@ -207,10 +207,10 @@ class ShareAsync(ServiceBaseAsync):
         size: Optional[int] = None,
     ) -> PangeaResponse[m.PutResult]:
         """
-        Upload a file
+        Upload a file (Beta)
 
         Upload a file.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_put
 
@@ -293,10 +293,10 @@ class ShareAsync(ServiceBaseAsync):
         size: Optional[int] = None,
     ) -> PangeaResponse[m.PutResult]:
         """
-        Request upload URL
+        Request upload URL (Beta)
 
         Request an upload URL.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_put 2
 
@@ -369,10 +369,10 @@ class ShareAsync(ServiceBaseAsync):
         updated_at: Optional[str] = None,
     ) -> PangeaResponse[m.UpdateResult]:
         """
-        Update a file
+        Update a file (Beta)
 
         Update a file.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_update
 
@@ -418,10 +418,10 @@ class ShareAsync(ServiceBaseAsync):
 
     async def share_link_create(self, links: List[m.ShareLinkCreateItem]) -> PangeaResponse[m.ShareLinkCreateResult]:
         """
-        Create share links
+        Create share links (Beta)
 
         Create a share link.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_share_link_create
 
@@ -455,10 +455,10 @@ class ShareAsync(ServiceBaseAsync):
 
     async def share_link_get(self, id: str) -> PangeaResponse[m.ShareLinkGetResult]:
         """
-        Get share link
+        Get share link (Beta)
 
         Get a share link.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_share_link_get
 
@@ -488,10 +488,10 @@ class ShareAsync(ServiceBaseAsync):
         size: Optional[int] = None,
     ) -> PangeaResponse[m.ShareLinkListResult]:
         """
-        List share links
+        List share links (Beta)
 
         Look up share links by filter options.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_share_link_list
 
@@ -516,10 +516,10 @@ class ShareAsync(ServiceBaseAsync):
 
     async def share_link_delete(self, ids: List[str]) -> PangeaResponse[m.ShareLinkDeleteResult]:
         """
-        Delete share links
+        Delete share links (Beta)
 
         Delete share links.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_share_link_delete
 
@@ -544,13 +544,13 @@ class ShareAsync(ServiceBaseAsync):
         self, links: List[m.ShareLinkSendItem], sender_email: str, sender_name: Optional[str] = None
     ) -> PangeaResponse[m.ShareLinkSendResult]:
         """
-        Send share links
+        Send share links (Beta)
 
         Send a secure share-link notification to a set of email addresses. The
         notification email will contain an Open button that the recipient can
         use to follow the secured share-link to authenticate and then access the
         shared content.
-        [**Beta API**](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         OperationId: share_post_v1beta_share_link_send
 

{pangea_sdk-3.8.0b2 → pangea_sdk-3.8.0b3}/pangea/services/__init__.py

@@ -1,9 +1,10 @@
 from .audit.audit import Audit
 from .authn.authn import AuthN
+from .authz import AuthZ
 from .embargo import Embargo
 from .file_scan import FileScan
 from .intel import DomainIntel, FileIntel, IpIntel, UrlIntel, UserIntel
 from .redact import Redact
-from .share.share import Share
 from .sanitize import Sanitize
+from .share.share import Share
 from .vault.vault import Vault