pangea-sdk 5.2.1__py3-none-any.whl → 5.4.0__py3-none-any.whl

pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "5.2.1"
+__version__ = "5.4.0"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

pangea/asyncio/services/intel.py

@@ -361,7 +361,7 @@ class IpIntelAsync(ServiceBaseAsync):
             ip (str): The IP to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -393,7 +393,7 @@ class IpIntelAsync(ServiceBaseAsync):
             ips (List[str]): The IP list to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -697,7 +697,7 @@ class UrlIntelAsync(ServiceBaseAsync):
             url (str): The URL to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -734,7 +734,7 @@ class UrlIntelAsync(ServiceBaseAsync):
             urls (List[str]): The URL list to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -808,7 +808,7 @@ class UserIntelAsync(ServiceBaseAsync):
             end (str): Latest date for search
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
             cursor (str, optional): A token given in the raw response from SpyCloud. Post this back to paginate results
 
         Raises:
@@ -873,7 +873,7 @@ class UserIntelAsync(ServiceBaseAsync):
             end (str): Latest date for search
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -922,7 +922,7 @@ class UserIntelAsync(ServiceBaseAsync):
             hash_prefix (str): The prefix of the hash to be looked up.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -966,7 +966,7 @@ class UserIntelAsync(ServiceBaseAsync):
             hash_prefixes (List[str]): The list of prefixes of the hash to be looked up.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -985,3 +985,53 @@ class UserIntelAsync(ServiceBaseAsync):
         return await self.request.post(
             "v2/password/breached", m.UserPasswordBreachedBulkResult, data=input.model_dump(exclude_none=True)
         )
+
+    async def breach(
+        self,
+        breach_id: str,
+        verbose: Optional[bool] = None,
+        provider: Optional[str] = None,
+        cursor: Optional[str] = None,
+        start: Optional[str] = None,
+        end: Optional[str] = None,
+        severity: Optional[List[int]] = None,
+    ) -> PangeaResponse[m.BreachResult]:
+        """
+        Look up information about a specific breach
+
+        Given a provider specific breach ID, find details about the breach.
+
+        OperationId: user_intel_post_v1_breach
+
+        Args:
+            breach_id (str, optional): The ID of a breach returned by a provider
+            verbose (bool, optional): Echo the API parameters in the response
+            provider (str, optional): Use reputation data from this provider
+            cursor (str, optional): A token given in the raw response from SpyCloud. Post this back to paginate results
+            start (str, optional): This parameter allows you to define the starting point for a date range query on the spycloud_publish_date field
+            end (str, optional): This parameter allows you to define the ending point for a date range query on the spycloud_publish_date field
+            severity (List[int], optional): Filter for records that match one of the given severities
+
+        Raises:
+            PangeaAPIException: If an API Error happens
+
+        Returns:
+            A PangeaResponse where the breach details are in the
+                response.result field.  Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/user-intel)
+
+        Examples:
+            response = await user_intel.breach(
+                breach_id="66111",
+            )
+        """
+
+        input = m.BreachRequest(
+            breach_id=breach_id,
+            provider=provider,
+            verbose=verbose,
+            cursor=cursor,
+            start=start,
+            end=end,
+            severity=severity,
+        )
+        return await self.request.post("v1/breach", m.BreachResult, data=input.model_dump(exclude_none=True))

pangea/asyncio/services/sanitize.py

@@ -97,7 +97,7 @@ class SanitizeAsync(ServiceBaseAsync):
             performed.
 
         Examples:
-            with open("/path/to/file.pdf", "rb") as f:
+            with open("/path/to/file.txt", "rb") as f:
                 response = await sanitize.sanitize(
                     file=f,
                     transfer_method=TransferMethod.POST_URL,

pangea/asyncio/services/share.py

@@ -93,6 +93,11 @@ class ShareAsync(ServiceBaseAsync):
         folder: Optional[str] = None,
         tags: Optional[m.Tags] = None,
         bucket_id: Optional[str] = None,
+        *,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[m.FolderCreateResult]:
         """
         Create a folder
@@ -109,6 +114,13 @@ class ShareAsync(ServiceBaseAsync):
               match `parent_id` if also set.
             tags (Tags, optional): A list of user-defined tags.
             bucket_id (str, optional): The bucket to use, if not the default.
+            file_ttl: Duration until files within this folder are automatically
+              deleted.
+            root_folder: The path of a root folder to restrict the operation to. Must resolve to
+              `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must match
+              `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -126,7 +138,16 @@ class ShareAsync(ServiceBaseAsync):
         """
 
         input = m.FolderCreateRequest(
-            name=name, metadata=metadata, parent_id=parent_id, folder=folder, tags=tags, bucket_id=bucket_id
+            name=name,
+            metadata=metadata,
+            parent_id=parent_id,
+            folder=folder,
+            tags=tags,
+            bucket_id=bucket_id,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
         return await self.request.post(
             "v1/folder/create", m.FolderCreateResult, data=input.model_dump(exclude_none=True)
@@ -138,6 +159,8 @@ class ShareAsync(ServiceBaseAsync):
         transfer_method: Optional[TransferMethod] = None,
         bucket_id: Optional[str] = None,
         password: Optional[str] = None,
+        *,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[m.GetResult]:
         """
         Get an object
@@ -152,6 +175,7 @@ class ShareAsync(ServiceBaseAsync):
             transfer_method (TransferMethod, optional): The requested transfer method for the file data.
             bucket_id (str, optional): The bucket to use, if not the default.
             password (str, optional): If the file was protected with a password, the password to decrypt with.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -163,7 +187,9 @@ class ShareAsync(ServiceBaseAsync):
             )
         """
 
-        input = m.GetRequest(id=id, transfer_method=transfer_method, bucket_id=bucket_id, password=password)
+        input = m.GetRequest(
+            id=id, transfer_method=transfer_method, bucket_id=bucket_id, password=password, tenant_id=tenant_id
+        )
         return await self.request.post("v1/get", m.GetResult, data=input.model_dump(exclude_none=True))
 
     async def get_archive(
@@ -259,6 +285,11 @@ class ShareAsync(ServiceBaseAsync):
         bucket_id: Optional[str] = None,
         password: Optional[str] = None,
         password_algorithm: Optional[str] = None,
+        *,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[m.PutResult]:
         """
         Upload a file
@@ -287,6 +318,13 @@ class ShareAsync(ServiceBaseAsync):
             bucket_id (str, optional): The bucket to use, if not the default.
             password (str, optional): An optional password to protect the file with. Downloading the file will require this password.
             password_algorithm (str, optional): An optional password algorithm to protect the file with. See symmetric vault password_algorithm.
+            file_ttl: The TTL before expiry for the file.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
+
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
 
@@ -330,6 +368,10 @@ class ShareAsync(ServiceBaseAsync):
             bucket_id=bucket_id,
             password=password,
             password_algorithm=password_algorithm,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
         data = input.model_dump(exclude_none=True)
         return await self.request.post("v1/put", m.PutResult, data=data, files=files)
@@ -351,6 +393,13 @@ class ShareAsync(ServiceBaseAsync):
         sha256: Optional[str] = None,
         size: Optional[int] = None,
         bucket_id: Optional[str] = None,
+        *,
+        password: Optional[str] = None,
+        password_algorithm: Optional[str] = None,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[m.PutResult]:
         """
         Request upload URL
@@ -376,6 +425,16 @@ class ShareAsync(ServiceBaseAsync):
             sha256 (str, optional): The SHA256 hash of the file data, which will be verified by the server if provided.
             size (str, optional): The size (in bytes) of the file. If the upload doesn't match, the call will fail.
             bucket_id (str, optional): The bucket to use, if not the default.
+            password: An optional password to protect the file with. Downloading
+              the file will require this password.
+            password_algorithm: An optional password algorithm to protect the
+              file with. See symmetric vault password_algorithm.
+            file_ttl: The TTL before expiry for the file.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -412,6 +471,12 @@ class ShareAsync(ServiceBaseAsync):
             sha512=sha512,
             size=size,
             bucket_id=bucket_id,
+            password=password,
+            password_algorithm=password_algorithm,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
 
         data = input.model_dump(exclude_none=True)
@@ -430,6 +495,14 @@ class ShareAsync(ServiceBaseAsync):
         parent_id: Optional[str] = None,
         updated_at: Optional[str] = None,
         bucket_id: Optional[str] = None,
+        *,
+        add_password: Optional[str] = None,
+        add_password_algorithm: Optional[str] = None,
+        remove_password: Optional[str] = None,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[m.UpdateResult]:
         """
         Update a file
@@ -451,6 +524,16 @@ class ShareAsync(ServiceBaseAsync):
             parent_id (str, optional): Set the parent (folder) of the object.
             updated_at (str, optional): The date and time the object was last updated. If included, the update will fail if this doesn't match what's stored.
             bucket_id (str, optional): The bucket to use, if not the default.
+            add_password: Protect the file with the supplied password.
+            add_password_algorithm: The algorithm to use to password protect the
+              file.
+            remove_password: Remove the supplied password from the file.
+            file_ttl: Set the file TTL.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -478,6 +561,13 @@ class ShareAsync(ServiceBaseAsync):
             parent_id=parent_id,
             updated_at=updated_at,
             bucket_id=bucket_id,
+            add_password=add_password,
+            add_password_algorithm=add_password_algorithm,
+            remove_password=remove_password,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
         return await self.request.post("v1/update", m.UpdateResult, data=input.model_dump(exclude_none=True))
 

pangea/services/intel.py

@@ -821,7 +821,7 @@ class IpIntel(ServiceBase):
             ip (str): The IP to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -853,7 +853,7 @@ class IpIntel(ServiceBase):
             ips (List[str]): The IP list to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1172,7 +1172,7 @@ class UrlIntel(ServiceBase):
             url (str): The URL to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1209,7 +1209,7 @@ class UrlIntel(ServiceBase):
             urls (List[str]): The URL list to be looked up
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1250,6 +1250,9 @@ class UserBreachedRequest(IntelCommonRequest):
     end: Optional[str] = None
     cursor: Optional[str] = None
 
+    severity: Optional[List[int]] = None
+    """Filter for records that match one of the given severities"""
+
 
 class UserBreachedBulkRequest(IntelCommonRequest):
     """
@@ -1272,6 +1275,9 @@ class UserBreachedBulkRequest(IntelCommonRequest):
     start: Optional[str] = None
     end: Optional[str] = None
 
+    severity: Optional[List[int]] = None
+    """Filter for records that match one of the given severities"""
+
 
 class UserBreachedCommonData(PangeaResponseResult):
     """
@@ -1320,7 +1326,7 @@ class UserPasswordBreachedRequest(IntelCommonRequest):
 
 class UserPasswordBreachedBulkRequest(IntelCommonRequest):
     """
-    User password breached common request data
+    User password breached bulk request data
 
     hash_type (str): Hash type to be looked up
     hash_prefixes (List[str]): The list of prefixes of the hashes to be looked up.
@@ -1354,6 +1360,44 @@ class UserPasswordBreachedBulkResult(IntelCommonResult):
     data: Dict[str, UserPasswordBreachedData]
 
 
+class BreachRequest(APIRequestModel):
+    """Breach request data"""
+
+    breach_id: Optional[str] = None
+    """The ID of a breach returned by a provider."""
+
+    verbose: Optional[bool] = None
+    """Echo back the parameters of the API in the response."""
+
+    provider: Optional[str] = None
+    """Provider of the information. Default provider defined by the configuration."""
+
+    severity: Optional[List[int]] = None
+    """Filter for records that match one of the given severities"""
+
+    start: Optional[str] = None
+    """This parameter allows you to define the starting point for a date range query on the spycloud_publish_date field."""
+
+    end: Optional[str] = None
+    """This parameter allows you to define the ending point for a date range query on the spycloud_publish_date field."""
+
+    cursor: Optional[str] = None
+    """A token given in the raw response from SpyCloud. Post this back to paginate results"""
+
+
+class BreachResult(PangeaResponseResult):
+    """Breach result"""
+
+    found: bool
+    """A flag indicating if the lookup was successful."""
+
+    data: Optional[Dict] = None
+    """Breach details given by the provider."""
+
+    parameters: Optional[Dict] = None
+    """The parameters, which were passed in the request, echoed back."""
+
+
 class UserIntel(ServiceBase):
     """User Intel service client.
 
@@ -1392,6 +1436,7 @@ class UserIntel(ServiceBase):
         raw: Optional[bool] = None,
         provider: Optional[str] = None,
         cursor: Optional[str] = None,
+        severity: Optional[List[int]] = None,
     ) -> PangeaResponse[UserBreachedResult]:
         """
         Look up breached users
@@ -1409,8 +1454,9 @@ class UserIntel(ServiceBase):
             end (str): Latest date for search
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "spycloud"
+            provider (str, optional): Use reputation data from this provider
             cursor (str, optional): A token given in the raw response from SpyCloud. Post this back to paginate results
+            severity (List[int], optional): Filter for records that match one of the given severities
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1439,6 +1485,7 @@ class UserIntel(ServiceBase):
             verbose=verbose,
             raw=raw,
             cursor=cursor,
+            severity=severity,
         )
         return self.request.post("v1/user/breached", UserBreachedResult, data=input.model_dump(exclude_none=True))
 
@@ -1454,6 +1501,7 @@ class UserIntel(ServiceBase):
         verbose: Optional[bool] = None,
         raw: Optional[bool] = None,
         provider: Optional[str] = None,
+        severity: Optional[List[int]] = None,
     ) -> PangeaResponse[UserBreachedBulkResult]:
         """
         Look up breached users V2
@@ -1472,7 +1520,8 @@ class UserIntel(ServiceBase):
             end (str): Latest date for search
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "spycloud"
+            provider (str, optional): Use reputation data from this provider
+            severity (List[int], optional): Filter for records that match one of the given severities
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1501,6 +1550,7 @@ class UserIntel(ServiceBase):
             end=end,
             verbose=verbose,
             raw=raw,
+            severity=severity,
         )
         return self.request.post("v2/user/breached", UserBreachedBulkResult, data=input.model_dump(exclude_none=True))
 
@@ -1524,7 +1574,7 @@ class UserIntel(ServiceBase):
             hash_prefix (str): The prefix of the hash to be looked up.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1568,7 +1618,7 @@ class UserIntel(ServiceBase):
             hash_prefixes (List[str]): The list of prefixes of the hashes to be looked up.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
-            provider (str, optional): Use reputation data from this provider: "crowdstrike"
+            provider (str, optional): Use reputation data from this provider
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1592,6 +1642,56 @@ class UserIntel(ServiceBase):
             "v2/password/breached", UserPasswordBreachedBulkResult, data=input.model_dump(exclude_none=True)
         )
 
+    def breach(
+        self,
+        breach_id: Optional[str] = None,
+        verbose: Optional[bool] = None,
+        provider: Optional[str] = None,
+        cursor: Optional[str] = None,
+        start: Optional[str] = None,
+        end: Optional[str] = None,
+        severity: Optional[List[int]] = None,
+    ) -> PangeaResponse[BreachResult]:
+        """
+        Look up information about a specific breach
+
+        Given a provider specific breach ID, find details about the breach.
+
+        OperationId: user_intel_post_v1_breach
+
+        Args:
+            breach_id (str, optional): The ID of a breach returned by a provider
+            verbose (bool, optional): Echo the API parameters in the response
+            provider (str, optional): Use reputation data from this provider
+            cursor (str, optional): A token given in the raw response from SpyCloud. Post this back to paginate results
+            start (str, optional): This parameter allows you to define the starting point for a date range query on the spycloud_publish_date field
+            end (str, optional): This parameter allows you to define the ending point for a date range query on the spycloud_publish_date field
+            severity (List[int], optional): Filter for records that match one of the given severities
+
+        Raises:
+            PangeaAPIException: If an API Error happens
+
+        Returns:
+            A PangeaResponse where the breach details are in the
+                response.result field.  Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/user-intel)
+
+        Examples:
+            response = user_intel.breach(
+                breach_id="66111",
+            )
+        """
+
+        input = BreachRequest(
+            breach_id=breach_id,
+            provider=provider,
+            verbose=verbose,
+            cursor=cursor,
+            start=start,
+            end=end,
+            severity=severity,
+        )
+        return self.request.post("v1/breach", BreachResult, data=input.model_dump(exclude_none=True))
+
     class PasswordStatus(enum.Enum):
         BREACHED = 0
         UNBREACHED = 1

pangea/services/sanitize.py

@@ -46,12 +46,6 @@ class SanitizeContent(APIRequestModel):
     analysis engine results. Only works if redact is enabled.
     """
 
-    remove_attachments: Optional[bool] = None
-    """Remove file attachments (PDF only)."""
-
-    remove_interactive: Optional[bool] = None
-    """Remove interactive content (PDF only)."""
-
 
 class SanitizeShareOutput(APIRequestModel):
     enabled: Optional[bool] = None
@@ -144,14 +138,6 @@ class RedactData(PangeaResponseResult):
     """The scoring result of a set of rules."""
 
 
-class CDR(PangeaResponseResult):
-    file_attachments_removed: Optional[int] = None
-    """Number of file attachments removed."""
-
-    interactive_contents_removed: Optional[int] = None
-    """Number of interactive content items removed."""
-
-
 class SanitizeData(PangeaResponseResult):
     defang: Optional[DefangData] = None
     """Defang."""
@@ -162,9 +148,6 @@ class SanitizeData(PangeaResponseResult):
     malicious_file: Optional[bool] = None
     """If the file scanned was malicious."""
 
-    cdr: Optional[CDR] = None
-    """Content Disarm and Reconstruction."""
-
 
 class SanitizeResult(PangeaResponseResult):
     dest_url: Optional[str] = None
@@ -265,7 +248,7 @@ class Sanitize(ServiceBase):
             performed.
 
         Examples:
-            with open("/path/to/file.pdf", "rb") as f:
+            with open("/path/to/file.txt", "rb") as f:
                 response = sanitize.sanitize(
                     file=f,
                     transfer_method=TransferMethod.POST_URL,

pangea/services/share/share.py

@@ -160,6 +160,21 @@ class ItemData(PangeaResponseResult):
     external_bucket_key: Optional[str] = None
     """The key in the external bucket that contains this file."""
 
+    file_ttl: Optional[str] = None
+    """The explicit file TTL setting for this object."""
+
+    file_ttl_effective: Optional[str] = None
+    """
+    The effective file TTL setting for this object, either explicitly set or
+    inherited (see `file_ttl_from_id`.)
+    """
+
+    file_ttl_from_id: Optional[str] = None
+    """
+    The ID of the object the expiry / TTL is set from. Either a service
+    configuration, the object itself, or a parent folder.
+    """
+
 
 class DeleteResult(PangeaResponseResult):
     count: int
@@ -170,11 +185,26 @@ class FolderCreateRequest(APIRequestModel):
     name: Optional[str] = None
     """The name of an object."""
 
+    file_ttl: Optional[str] = None
+    """Duration until files within this folder are automatically deleted."""
+
     metadata: Optional[Metadata] = None
     """A set of string-based key/value pairs used to provide additional data about an object."""
 
+    root_folder: Optional[str] = None
+    """
+    The path of a root folder to restrict the operation to. Must resolve to
+    `root_id` if also set.
+    """
+
+    root_id: Optional[str] = None
+    """
+    The ID of a root folder to restrict the operation to. Must match
+    `root_folder` if also set.
+    """
+
     parent_id: Optional[str] = None
-    """The ID of a stored object."""
+    """The ID of the parent folder. Must match `folder` if also set."""
 
     folder: Optional[str] = None
     """The folder to place the folder in. Must match `parent_id` if also set."""
@@ -182,6 +212,9 @@ class FolderCreateRequest(APIRequestModel):
     tags: Optional[Tags] = None
     """A list of user-defined tags"""
 
+    tenant_id: Optional[str] = None
+    """A tenant to associate with this request"""
+
     bucket_id: Optional[str] = None
     """The bucket to use, if not the default."""
 
@@ -204,6 +237,9 @@ class GetRequest(APIRequestModel):
     bucket_id: Optional[str] = None
     """The bucket to use, if not the default."""
 
+    tenant_id: Optional[str] = None
+    """A tenant to associate with this request."""
+
 
 class GetResult(PangeaResponseResult):
     object: ItemData
@@ -250,12 +286,27 @@ class PutRequest(APIRequestModel):
     folder: Optional[str] = None
     """The path to the parent folder. Leave blank for the root folder. Path must resolve to `parent_id` if also set."""
 
+    file_ttl: Optional[str] = None
+    """The TTL before expiry for the file."""
+
     password: Optional[str] = None
     """An optional password to protect the file with. Downloading the file will require this password."""
 
     password_algorithm: Optional[str] = None
     """An optional password algorithm to protect the file with. See symmetric vault password_algorithm."""
 
+    root_folder: Optional[str] = None
+    """
+    The path of a root folder to restrict the operation to. Must resolve to
+    `root_id` if also set.
+    """
+
+    root_id: Optional[str] = None
+    """
+    The ID of a root folder to restrict the operation to. Must match
+    `root_folder` if also set.
+    """
+
     sha1: Optional[str] = None
     """The hexadecimal-encoded SHA1 hash of the file data, which will be verified by the server if provided."""
 
@@ -265,6 +316,9 @@ class PutRequest(APIRequestModel):
     tags: Optional[Tags] = None
     """A list of user-defined tags"""
 
+    tenant_id: Optional[str] = None
+    """A tenant to associate with this request"""
+
 
 class PutResult(PangeaResponseResult):
     object: ItemData
@@ -292,6 +346,9 @@ class UpdateRequest(APIRequestModel):
     add_tags: Optional[Tags] = None
     """A list of Tags to add. It is not an error to provide a tag which already exists."""
 
+    file_ttl: Optional[str] = None
+    """Set the file TTL."""
+
     name: Optional[str] = None
     """Sets the object's Name."""
 
@@ -307,12 +364,27 @@ class UpdateRequest(APIRequestModel):
     remove_tags: Optional[Tags] = None
     """A list of tags to remove. It is not an error to provide a tag which is not present."""
 
+    root_folder: Optional[str] = None
+    """
+    The path of a root folder to restrict the operation to. Must resolve to
+    `root_id` if also set.
+    """
+
+    root_id: Optional[str] = None
+    """
+    The ID of a root folder to restrict the operation to. Must match
+    `root_folder` if also set.
+    """
+
     parent_id: Optional[str] = None
     """Set the parent (folder) of the object. Can be an empty string for the root folder."""
 
     tags: Optional[Tags] = None
     """Set the object's tags."""
 
+    tenant_id: Optional[str] = None
+    """A tenant to associate with this request."""
+
     updated_at: Optional[str] = None
     """The date and time the object was last updated. If included, the update will fail if this doesn't match the date and time of the last update for the object."""
 
@@ -747,6 +819,11 @@ class Share(ServiceBase):
         folder: Optional[str] = None,
         tags: Optional[Tags] = None,
         bucket_id: Optional[str] = None,
+        *,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[FolderCreateResult]:
         """
         Create a folder
@@ -763,6 +840,13 @@ class Share(ServiceBase):
               match `parent_id` if also set.
             tags (Tags, optional): A list of user-defined tags.
             bucket_id (str, optional): The bucket to use, if not the default.
+            file_ttl: Duration until files within this folder are automatically
+              deleted.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -779,7 +863,16 @@ class Share(ServiceBase):
             )
         """
         input = FolderCreateRequest(
-            name=name, metadata=metadata, parent_id=parent_id, folder=folder, tags=tags, bucket_id=bucket_id
+            name=name,
+            metadata=metadata,
+            parent_id=parent_id,
+            folder=folder,
+            tags=tags,
+            bucket_id=bucket_id,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
         return self.request.post("v1/folder/create", FolderCreateResult, data=input.model_dump(exclude_none=True))
 
@@ -789,6 +882,8 @@ class Share(ServiceBase):
         transfer_method: Optional[TransferMethod] = None,
         bucket_id: Optional[str] = None,
         password: Optional[str] = None,
+        *,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[GetResult]:
         """
         Get an object
@@ -803,6 +898,7 @@ class Share(ServiceBase):
             transfer_method (TransferMethod, optional): The requested transfer method for the file data.
             bucket_id (str, optional): The bucket to use, if not the default.
             password (str, optional): If the file was protected with a password, the password to decrypt with.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -813,7 +909,9 @@ class Share(ServiceBase):
                 folder="/",
             )
         """
-        input = GetRequest(id=id, transfer_method=transfer_method, bucket_id=bucket_id, password=password)
+        input = GetRequest(
+            id=id, transfer_method=transfer_method, bucket_id=bucket_id, password=password, tenant_id=tenant_id
+        )
         return self.request.post("v1/get", GetResult, data=input.model_dump(exclude_none=True))
 
     def get_archive(
@@ -907,6 +1005,11 @@ class Share(ServiceBase):
         bucket_id: Optional[str] = None,
         password: Optional[str] = None,
         password_algorithm: Optional[str] = None,
+        *,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[PutResult]:
         """
         Upload a file
@@ -935,6 +1038,13 @@ class Share(ServiceBase):
             bucket_id (str, optional): The bucket to use, if not the default.
             password (str, optional): An optional password to protect the file with. Downloading the file will require this password.
             password_algorithm (str, optional): An optional password algorithm to protect the file with. See symmetric vault password_algorithm.
+            file_ttl: The TTL before expiry for the file.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
+
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
 
@@ -977,6 +1087,10 @@ class Share(ServiceBase):
             bucket_id=bucket_id,
             password=password,
             password_algorithm=password_algorithm,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
         data = input.model_dump(exclude_none=True)
         return self.request.post("v1/put", PutResult, data=data, files=files)
@@ -998,6 +1112,13 @@ class Share(ServiceBase):
         sha256: Optional[str] = None,
         size: Optional[int] = None,
         bucket_id: Optional[str] = None,
+        *,
+        file_ttl: Optional[str] = None,
+        password: Optional[str] = None,
+        password_algorithm: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[PutResult]:
         """
         Request upload URL
@@ -1023,6 +1144,16 @@ class Share(ServiceBase):
             sha256 (str, optional): The SHA256 hash of the file data, which will be verified by the server if provided.
             size (str, optional): The size (in bytes) of the file. If the upload doesn't match, the call will fail.
             bucket_id (str, optional): The bucket to use, if not the default.
+            file_ttl: The TTL before expiry for the file.
+            password: An optional password to protect the file with. Downloading
+              the file will require this password.
+            password_algorithm: An optional password algorithm to protect the
+              file with. See symmetric vault password_algorithm.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -1058,6 +1189,12 @@ class Share(ServiceBase):
             sha512=sha512,
             size=size,
             bucket_id=bucket_id,
+            file_ttl=file_ttl,
+            password=password,
+            password_algorithm=password_algorithm,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
 
         data = input.model_dump(exclude_none=True)
@@ -1076,6 +1213,14 @@ class Share(ServiceBase):
         parent_id: Optional[str] = None,
         updated_at: Optional[str] = None,
         bucket_id: Optional[str] = None,
+        *,
+        add_password: Optional[str] = None,
+        add_password_algorithm: Optional[str] = None,
+        remove_password: Optional[str] = None,
+        file_ttl: Optional[str] = None,
+        root_folder: Optional[str] = None,
+        root_id: Optional[str] = None,
+        tenant_id: Optional[str] = None,
     ) -> PangeaResponse[UpdateResult]:
         """
         Update a file
@@ -1086,7 +1231,7 @@ class Share(ServiceBase):
 
         Args:
             id (str, optional): An identifier for the file to update.
-            path (str, optional): Set the parent (folder). Leave blank for the
+            folder (str, optional): Set the parent (folder). Leave blank for the
               root folder. Path must resolve to `parent_id` if also set.
             add_metadata (Metadata, optional): A list of Metadata key/values to set in the object. If a provided key exists, the value will be replaced.
             remove_metadata (Metadata, optional): A list of Metadata key/values to remove in the object. It is not an error for a provided key to not exist. If a provided key exists but doesn't match the provided value, it will not be removed.
@@ -1097,6 +1242,16 @@ class Share(ServiceBase):
             parent_id (str, optional): Set the parent (folder) of the object.
             updated_at (str, optional): The date and time the object was last updated. If included, the update will fail if this doesn't match what's stored.
             bucket_id (str, optional): The bucket to use, if not the default.
+            add_password: Protect the file with the supplied password.
+            add_password_algorithm: The algorithm to use to password protect the
+              file.
+            remove_password: Remove the supplied password from the file.
+            file_ttl: Set the file TTL.
+            root_folder: The path of a root folder to restrict the operation to.
+              Must resolve to `root_id` if also set.
+            root_id: The ID of a root folder to restrict the operation to. Must
+              match `root_folder` if also set.
+            tenant_id: A tenant to associate with this request.
 
         Returns:
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -1123,6 +1278,13 @@ class Share(ServiceBase):
             parent_id=parent_id,
             updated_at=updated_at,
             bucket_id=bucket_id,
+            add_password=add_password,
+            add_password_algorithm=add_password_algorithm,
+            remove_password=remove_password,
+            file_ttl=file_ttl,
+            root_folder=root_folder,
+            root_id=root_id,
+            tenant_id=tenant_id,
         )
         return self.request.post("v1/update", UpdateResult, data=input.model_dump(exclude_none=True))
 

{pangea_sdk-5.2.1.dist-info → pangea_sdk-5.4.0.dist-info}/METADATA

@@ -1,32 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pangea-sdk
-Version: 5.2.1
+Version: 5.4.0
 Summary: Pangea API SDK
-Home-page: https://pangea.cloud/docs/sdk/python/
 License: MIT
 Keywords: Pangea,SDK,Audit
 Author: Glenn Gallien
 Author-email: glenn.gallien@pangea.cloud
-Requires-Python: >=3.9.0,<4.0.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9,<4.0.0
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: aiohttp (>=3.11.10,<4.0.0)
+Requires-Dist: aiohttp (>=3.11.11,<4.0.0)
 Requires-Dist: cryptography (>=43.0.3,<44.0.0)
 Requires-Dist: deprecated (>=1.2.15,<2.0.0)
 Requires-Dist: google-crc32c (>=1.5.0,<2.0.0)
-Requires-Dist: pydantic (>=2.10.3,<3.0.0)
+Requires-Dist: pydantic (>=2.10.5,<3.0.0)
 Requires-Dist: python-dateutil (>=2.9.0,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
 Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
-Project-URL: Repository, https://github.com/pangeacyber/pangea-python/tree/main/packages/pangea-sdk
 Description-Content-Type: text/markdown
 
 <a href="https://pangea.cloud?utm_source=github&utm_medium=python-sdk" target="_blank" rel="noopener noreferrer">
@@ -72,13 +63,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.2.0b1
+$ pip3 install pangea-sdk==5.2.0b2
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.2.0b1
+$ poetry add pangea-sdk==5.2.0b2
 ```
 
 ## Usage

{pangea_sdk-5.2.1.dist-info → pangea_sdk-5.4.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pangea/__init__.py,sha256=YdVCSgR-OBewhxnne1SnOliwM7KXiu_EV88j_zSLRmM,246
+pangea/__init__.py,sha256=B29PtEg8t_Rt5FD7rRfZZ1HAvsBv0WSHWqH6BxDY10U,246
 pangea/asyncio/__init__.py,sha256=kjEMkqMQ521LlMSu5jn3_WgweyArwVZ2C-s3x7mR6Pk,45
 pangea/asyncio/file_uploader.py,sha256=wI7epib7Rc5jtZw4eJ1L1SlmutDG6CPv59C8N2UPhtY,1436
 pangea/asyncio/request.py,sha256=BREsLY8_MCxGSplHbdKFZTzr4TX5ya0-BsXLffZhsco,17849
@@ -9,10 +9,10 @@ pangea/asyncio/services/authz.py,sha256=B_0_nhDMJcjNpjpCx3Vi2LDRhlmfV9325GKbUZ8r
 pangea/asyncio/services/base.py,sha256=vRFVcO_uEAGJte3OUUBLD43RoiiFB1vC7SPyN6yEMoA,3158
 pangea/asyncio/services/embargo.py,sha256=ctzj3kip6xos-Eu3JuOskrCGYC8T3JlsgAopZHiPSXM,3068
 pangea/asyncio/services/file_scan.py,sha256=PLG1O-PL4Yk9uY9D6NbMrZ5LHg70Z311s7bFe46UMZA,7108
-pangea/asyncio/services/intel.py,sha256=Iwz_DleAPtmd1taekT4W8lVo65uHjIvA4TQ7WUQGrRk,38306
+pangea/asyncio/services/intel.py,sha256=BcxGKSoZ1nJiEHyZM9yOwKSSPJUrB6ibJ19KR27VlgQ,40261
 pangea/asyncio/services/redact.py,sha256=JPJcmeKFloMZRpkjAHAZbpZJpO993WsTfEwA-S5ov18,7951
-pangea/asyncio/services/sanitize.py,sha256=4pRWBH595kFUXBkmu8euyk6H7F1M_-xXB2Qxnz6St6c,8627
-pangea/asyncio/services/share.py,sha256=YPJm_Gc4tfcx2cX6P_vLWIsHOR6M3RYy9LdU2UzEZbk,26791
+pangea/asyncio/services/sanitize.py,sha256=EbSdq_v9yZWce9xEYWvZharE9bJcxw8cg5Pv8LVxdxc,8627
+pangea/asyncio/services/share.py,sha256=AXXtFtmbXud0dAAom7qqHVOK9zBfX5S10MFS_1DQvio,30767
 pangea/asyncio/services/vault.py,sha256=VqrJGSEdq6MlZRI6cJpkthhIsqLClSQdgVxwYCbIwEk,77079
 pangea/audit_logger.py,sha256=gRkCfUUT5LDNaycwxkhZUySgY47jDfn1ZeKOul4XCQI,3842
 pangea/config.py,sha256=mQUu8GX_6weIuv3vjNdG5plppXskXYASmxMWtFQh-hc,1662
@@ -37,11 +37,11 @@ pangea/services/authz.py,sha256=bB0ZEUuXLT7Xjs5kZef1hZK6Du6VUusHe5aekNaxamw,1274
 pangea/services/base.py,sha256=43pWQcR9CeT4sGzgctF3Sy4M_h7DaUzkuZD2Z7CcDUU,3845
 pangea/services/embargo.py,sha256=9Wfku4td5ORaIENKmnGmS5jxJJIRfWp6Q51L36Jsy0I,3897
 pangea/services/file_scan.py,sha256=QiO80uKqB_BnAOiYQKznXfxpa5j40qqETE3-zBRT_QE,7813
-pangea/services/intel.py,sha256=flVdK4WhllPutCkWh7H-MuBxMMz0f4Bl-fz2f-hPuWM,52679
+pangea/services/intel.py,sha256=y1EX2ctYIxQc52lmHp6-Q_UIDM--t3fOpXDssWiRPfo,56474
 pangea/services/redact.py,sha256=ovIcT0jkXe57O7keGzSClWNCic8y-4NZoemXoSKjjww,12913
-pangea/services/sanitize.py,sha256=D_R_XIe9FvRCX40b8b_3gouhAGduDdxI9bT2w-kiVHU,13444
+pangea/services/sanitize.py,sha256=eAN1HhObiKqygy6HHcfl0NmxYfPMvqSKepwEAVVIIEE,12936
 pangea/services/share/file_format.py,sha256=1svO1ee_aenA9zoO_AaU-Rk5Ulp7kcPOc_KwNoluyQE,2797
-pangea/services/share/share.py,sha256=8N4zXQJjkVDf2iR62pz6xpmxlbXRPNfHgYfOuEdNaZ8,46333
+pangea/services/share/share.py,sha256=b1Iuuog0XWXaI6rImoj0OeEx3DXbYqLWsLbCC_Zp6eg,52343
 pangea/services/vault/models/asymmetric.py,sha256=vspijmEvHm5WXri_fjOWfQc4maYyZfhDkLuaTM8-PZo,4991
 pangea/services/vault/models/common.py,sha256=PSZRFqHTUtEMJJGwywEFM2AU3aV8S-sbcoo3LLQ6uTc,17981
 pangea/services/vault/models/keys.py,sha256=duAuTiOby_D7MloRvN4gNj0P-b-jx9sdtplAWFxsShw,2786
@@ -51,6 +51,6 @@ pangea/services/vault/vault.py,sha256=ow-Zm7PYzfWIfUcA4UNnpeL2DHfZM4C7inRDmNR3zQ
 pangea/tools.py,sha256=2-Y4SAHWFv6Ocj42J_bWrVy27M5G3wi7a8LJn0dabHc,6427
 pangea/utils.py,sha256=dZ6MwFVEWXUgXvvDg-k6JnvVfsgslvtaBd7ez7afrqk,4983
 pangea/verify_audit.py,sha256=nSP17OzoSPdvezRExwfcf45H8ZPZnxZu-CbEp3qFJO0,17354
-pangea_sdk-5.2.1.dist-info/METADATA,sha256=YjlZ9hj9YmyyMIeS6Z_eSbpBeHsh_QNfzwxfbexlZVs,7513
-pangea_sdk-5.2.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-pangea_sdk-5.2.1.dist-info/RECORD,,
+pangea_sdk-5.4.0.dist-info/METADATA,sha256=Tc6nPFcfuzi0DADnc9fPhUrBxEAxhu9v5b3JE-qJtSo,7009
+pangea_sdk-5.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+pangea_sdk-5.4.0.dist-info/RECORD,,

{pangea_sdk-5.2.1.dist-info → pangea_sdk-5.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 2.0.1
 Root-Is-Purelib: true
 Tag: py3-none-any