zscaler-sdk-python 1.9.29__tar.gz → 1.9.31__tar.gz

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.9.29
+Version: 1.9.31
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.29"
+version = "1.9.31"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.31}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "1.9.29"
+__version__ = "1.9.31"
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa

zscaler_sdk_python-1.9.31/zscaler/zia/email_profiles.py

@@ -0,0 +1,279 @@
+"""
+Copyright (c) 2023, Zscaler Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+"""
+
+from typing import List, Optional
+
+from zscaler.api_client import APIClient
+from zscaler.request_executor import RequestExecutor
+from zscaler.types import APIResult
+from zscaler.utils import format_url
+from zscaler.zia.models.email_profiles import EmailProfiles
+
+
+class EmailProfilesAPI(APIClient):
+    """
+    A Client object for the Email profiles resource.
+    """
+
+    _zia_base_endpoint = "/zia/api/v1"
+
+    def __init__(self, request_executor: "RequestExecutor") -> None:
+        super().__init__()
+        self._request_executor: RequestExecutor = request_executor
+
+    def list_email_profiles(self, query_params: Optional[dict] = None) -> APIResult[List[EmailProfiles]]:
+        """
+        Lists email profiles in your organization with pagination.
+        A subset of email profiles can be returned that match a supported
+        filter expression or query.
+
+        Args:
+            query_params {dict}: Map of query parameters for the request.
+                ``[query_params.page]`` {int}: Specifies the page offset.
+
+                ``[query_params.page_size]`` {int}: Page size for pagination.
+
+                ``[query_params.search]`` {str}: Search string for filtering results.
+
+        Returns:
+            tuple: A tuple containing (list of Email Profiles instances, Response, error)
+
+        Examples:
+            List Email Profiles using default settings:
+
+            >>> profile_list, _, error = client.zia.email_profiles.list_email_profiles(
+                query_params={'search': updated_profile.name})
+            >>> if error:
+            ...     print(f"Error listing email profiles: {error}")
+            ...     return
+            ... print(f"Total email profiles found: {len(profile_list)}")
+            ... for profile in profile_list:
+            ...     print(profile.as_dict())
+
+            Client-side filtering with JMESPath:
+
+            The response object supports client-side filtering and
+            projection via ``resp.search(expression)``.  See the
+            `JMESPath documentation <https://jmespath.org/>`_ for
+            expression syntax.
+
+        """
+        http_method = "get".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile
+        """)
+
+        query_params = query_params or {}
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=query_params)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            result = []
+            for item in response.get_results():
+                result.append(EmailProfiles(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def get_email_profile(self, profile_id: int) -> APIResult[dict]:
+        """
+        Fetches a specific email profile by ID.
+
+        Args:
+            profile_id (int): The unique identifier for the email profile.
+
+        Returns:
+            tuple: A tuple containing (Email Profile instance, Response, error).
+
+        Examples:
+            Print a specific Email Profile
+
+            >>> fetched_profile, _, error = client.zia.email_profiles.get_email_profile(
+                '1254654')
+            >>> if error:
+            ...     print(f"Error fetching Email Profile by ID: {error}")
+            ...     return
+            ... print(f"Fetched Email Profile by ID: {fetched_profile.as_dict()}")
+        """
+        http_method = "get".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile/{profile_id}
+        """)
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, EmailProfiles)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = EmailProfiles(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def add_email_profile(self, **kwargs) -> APIResult[dict]:
+        """
+        Creates a new ZIA Email Profile.
+
+        Args:
+            name (str): The name of the email profile.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            description (str): Additional notes or information
+
+        Returns:
+            tuple: A tuple containing the newly added Email Profile, response, and error.
+
+        Examples:
+            Add a new Email Profile :
+
+            >>> added_profile, _, error = client.zia.email_profiles.add_email_profile(
+            ...     name=f"NewProfile_{random.randint(1000, 10000)}",
+            ...     description=f"NewProfile_{random.randint(1000, 10000)}",
+            ...     emails=['john.doe@example.com', 'mary.jane@example.com']
+            ... )
+            >>> if error:
+            ...     print(f"Error adding email profile: {error}")
+            ...     return
+            ... print(f"Email Profile added successfully: {added_profile.as_dict()}")
+        """
+        http_method = "post".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile
+        """)
+
+        body = kwargs
+
+        request, error = self._request_executor.create_request(
+            method=http_method,
+            endpoint=api_url,
+            body=body,
+        )
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, EmailProfiles)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = EmailProfiles(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def update_email_profile(self, profile_id: int, **kwargs) -> APIResult[dict]:
+        """
+        Updates information for the specified ZIA Email Profile.
+
+        Args:
+            profile_id (int): The unique ID for the Email Profile.
+
+        Returns:
+            tuple: A tuple containing the updated Email Profile, response, and error.
+
+        Examples:
+            Update an existing Email Profile :
+
+            >>> updated_profile, _, error = client.zia.email_profiles.update_email_profile(
+                profile_id='1524566'
+            ... name=f"UpdatedEmailProfile_{random.randint(1000, 10000)}",
+            ... description=f"UpdatedEmailProfile_{random.randint(1000, 10000)}",
+            ... )
+            >>> if error:
+            ...     print(f"Error updating Email Profile: {error}")
+            ...     return
+            ... print(f"Email Profile updated successfully: {updated_profile.as_dict()}")
+        """
+        http_method = "put".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile/{profile_id}
+        """)
+        body = kwargs
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, {})
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, EmailProfiles)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = EmailProfiles(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def delete_email_profile(self, profile_id: int) -> APIResult[dict]:
+        """
+        Deletes the specified Email Profile.
+
+        Args:
+            profile_id (str): The unique identifier of the Email Profile.
+
+        Returns:
+            tuple: A tuple containing the response object and error (if any).
+
+        Examples:
+            Delete an Email Profile:
+
+            >>> _, _, error = client.zia.email_profiles.delete_email_profile('73459')
+            >>> if error:
+            ...     print(f"Error deleting Email Profile: {error}")
+            ...     return
+            ... print(f"Email Profile with ID {'73459'} deleted successfully.")
+        """
+        http_method = "delete".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile/{profile_id}
+        """)
+
+        params = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, params=params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+        if error:
+            return (None, response, error)
+        return (None, response, None)

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.31}/zscaler/zia/ips_signature_rules.py

@@ -40,8 +40,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Lists custom IPS signature rules.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-get>`_
+        See the `List ZIA Custom IPS Signature Rules API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-get>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -106,8 +106,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Fetches the custom IPS signature rules based on the specified ID
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`_
+        See the `Get ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -190,8 +190,8 @@ class IPSSignatureRulesAPI(APIClient):
         issued. If the rule is syntactically or semantically invalid, the method
         returns ``(None, None, ValueError(...))`` and no create call is made.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`_
+        See the `Add ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules-post>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -264,8 +264,8 @@ class IPSSignatureRulesAPI(APIClient):
             If you want to validate ``rule_text`` before updating, call
             :meth:`validate_ips_signature_rule` explicitly from your code.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-put>`_
+        See the `Update ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-put>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -319,8 +319,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Deletes the specified IPS Signature Rule.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-delete>`_
+        See the `Delete ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/{id}-delete>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -360,8 +360,8 @@ class IPSSignatureRulesAPI(APIClient):
         Validates a new custom signature rule based on specific predefined conditions,
         such as syntax errors, duplicate signatures, and more.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/validateRuleText-post>`_
+        See the `Validate ZIA Custom IPS Signature Rule API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/validateRuleText-post>`__
         for further detail on optional keyword parameter structures.
 
         Args:
@@ -424,8 +424,8 @@ class IPSSignatureRulesAPI(APIClient):
         """
         Exports the custom IPS signature rules to a CSV file.
 
-        See the `ZIA Custom IPS Signature Rules API reference
-        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/export-get>`_
+        See the `Export ZIA Custom IPS Signature Rules API reference
+        <https://help.zscaler.com/legacy-apis/ips-control-policy#/ipsSignatureRules/export-get>`__
         for further detail on optional keyword parameter structures.
 
         Args:

{zscaler_sdk_python-1.9.29 → zscaler_sdk_python-1.9.31}/zscaler/zia/legacy.py

@@ -75,6 +75,7 @@ if TYPE_CHECKING:
     from zscaler.zia.dlp_templates import DLPTemplatesAPI
     from zscaler.zia.dlp_web_rules import DLPWebRuleAPI
     from zscaler.zia.dns_gatways import DNSGatewayAPI
+    from zscaler.zia.email_profiles import EmailProfilesAPI
     from zscaler.zia.end_user_notification import EndUserNotificationAPI
     from zscaler.zia.file_type_control_rule import FileTypeControlRuleAPI
     from zscaler.zia.ftp_control_policy import FTPControlPolicyAPI
@@ -97,6 +98,7 @@ if TYPE_CHECKING:
     from zscaler.zia.saas_security_api import SaaSSecurityAPI
     from zscaler.zia.sandbox import CloudSandboxAPI
     from zscaler.zia.sandbox_rules import SandboxRulesAPI
+    from zscaler.zia.secure_browsing import SecureBrowsingAPI
     from zscaler.zia.security_policy_settings import SecurityPolicyAPI
     from zscaler.zia.shadow_it_report import ShadowITAPI
     from zscaler.zia.ssl_inspection_rules import SSLInspectionAPI
@@ -1263,6 +1265,22 @@ class LegacyZIAClientHelper:
         """
         return IPSSignatureRulesAPI(self.request_executor)
 
+    @property
+    def secure_browsing(self) -> "SecureBrowsingAPI":
+        """
+        The interface object for the :ref:`ZIA Secure Browsing API interface <zia-secure_browsing>`.
+
+        """
+        return SecureBrowsingAPI(self.request_executor)
+
+    @property
+    def email_profiles(self) -> "EmailProfilesAPI":
+        """
+        The interface object for the :ref:`ZIA Email Profiles API interface <zia-email_profiles>`.
+
+        """
+        return EmailProfilesAPI(self.request_executor)
+
     """
     Misc
     """

zscaler_sdk_python-1.9.31/zscaler/zia/models/email_profiles.py

@@ -0,0 +1,67 @@
+"""
+Copyright (c) 2023, Zscaler Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+"""
+
+# AUTO-GENERATED! DO NOT EDIT FILE DIRECTLY
+# SEE CONTRIBUTOR DOCUMENTATION
+from typing import Any, Dict, List, Optional
+
+from zscaler.oneapi_collection import ZscalerCollection
+from zscaler.oneapi_object import ZscalerObject
+
+
+class EmailProfiles(ZscalerObject):
+    """
+    A class for EmailProfiles objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the EmailProfiles model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.id: Optional[Any] = config["id"] \
+                if "id" in config else None
+            self.name: Optional[Any] = config["name"] \
+                if "name" in config else None
+            self.description: Optional[Any] = config["description"] \
+                if "description" in config else None
+            self.emails: List[Any] = ZscalerCollection.form_list(
+                config["emails"] if "emails" in config else [], str
+            )
+        else:
+            self.id: Optional[Any] = None
+            self.name: Optional[Any] = None
+            self.description: Optional[Any] = None
+            self.emails: List[Any] = []
+
+    def request_format(self) -> Dict[str, Any]:
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "id": self.id,
+            "name": self.name,
+            "description": self.description,
+            "emails": self.emails
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format