zscaler-sdk-python 1.9.14__tar.gz → 1.9.16__tar.gz

{zscaler_sdk_python-1.9.14 → zscaler_sdk_python-1.9.16}/PKG-INFO

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

{zscaler_sdk_python-1.9.14 → zscaler_sdk_python-1.9.16}/pyproject.toml

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

{zscaler_sdk_python-1.9.14 → zscaler_sdk_python-1.9.16}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.14 → zscaler_sdk_python-1.9.16}/zscaler/zia/casb_dlp_rules.py

@@ -32,21 +32,23 @@ class CasbdDlpRulesAPI(APIClient):
 
     def list_rules(
         self,
+        rule_type: str,
         query_params: Optional[dict] = None,
     ) -> APIResult[List[CasbdDlpRules]]:
         """
         Returns a list of all Casb DLP Rules for the specified rule type.
 
         Args:
-            query_params {dict}: Map of query parameters for the request.
+            rule_type (str): The type of rules to retrieve (e.g., "OFLCASB_DLP_ITSM").
+                Required by the API.
 
-                ``[query_params.search]`` {str}: Search string for filtering results.
+                Supported Values: `ANY`, `NONE`, `OFLCASB_DLP_FILE`, `OFLCASB_DLP_EMAIL`, `OFLCASB_DLP_CRM`,
+                    `OFLCASB_DLP_ITSM`, `OFLCASB_DLP_COLLAB`, `OFLCASB_DLP_REPO`, `OFLCASB_DLP_STORAGE`,
+                    `OFLCASB_DLP_GENAI`
 
-                ``[query_params.rule_type]`` {str}: The type of rules to retrieve (e.g., "OFLCASB_DLP_ITSM").
+            query_params (dict, optional): Additional query parameters for the request.
 
-                    Supported Values: `ANY`, `NONE`, `OFLCASB_DLP_FILE`, `OFLCASB_DLP_EMAIL`, `OFLCASB_DLP_CRM`,
-                        `OFLCASB_DLP_ITSM`, `OFLCASB_DLP_COLLAB`, `OFLCASB_DLP_REPO`, `OFLCASB_DLP_STORAGE`,
-                        `OFLCASB_DLP_GENAI`
+                ``[query_params.search]`` {str}: Search string for filtering results.
 
         Returns:
             tuple: The list of Casb DLP Rules.
@@ -55,13 +57,21 @@ class CasbdDlpRulesAPI(APIClient):
             List all rules for a specific type::
 
                 >>> rules_list, _, error = client.zia.casb_dlp_rules.list_rules(
-                ...     query_params={'rule_type': 'OFLCASB_DLP_ITSM'})
+                ...     rule_type='OFLCASB_DLP_ITSM'
+                ... )
                 >>> if error:
-                ...     print(f"Error listing casb dlp rules rules: {error}")
+                ...     print(f"Error listing casb dlp rules: {error}")
                 ...     return
                 ... print(f"Total rules found: {len(rules_list)}")
                 ... for rule in rules_list:
                 ...     print(rule.as_dict())
+
+            List rules with optional search filter::
+
+                >>> rules_list, _, error = client.zia.casb_dlp_rules.list_rules(
+                ...     rule_type='OFLCASB_DLP_ITSM',
+                ...     query_params={'search': 'MyRule'}
+                ... )
         """
         http_method = "get".upper()
         api_url = format_url(
@@ -71,12 +81,15 @@ class CasbdDlpRulesAPI(APIClient):
         """
         )
 
-        query_params = query_params or {}
+        params = {"ruleType": rule_type}
+        if query_params:
+            extra = {k: v for k, v in query_params.items() if k != "rule_type"}
+            params.update(extra)
 
         body = {}
         headers = {}
 
-        request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=query_params)
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=params)
 
         if error:
             return (None, None, error)
@@ -98,15 +111,16 @@ class CasbdDlpRulesAPI(APIClient):
     def get_rule(
         self,
         rule_id: int,
-        rule_type: str,
+        rule_type: Optional[str] = None,
     ) -> APIResult[dict]:
         """
-        Returns information for the specified Casb DLP Rule under the specified rule type.
+        Returns information for the specified Casb DLP Rule.
 
         Args:
             rule_id (int): The unique identifier for the Casb DLP Rule.
 
-            rule_type (str): The type of the rule (e.g., "OFLCASB_DLP_ITSM").
+            rule_type (str, optional): The type of the rule (e.g., "OFLCASB_DLP_ITSM").
+                Optional for GET by ID; when provided, passed as query parameter.
 
                 Supported Values: `ANY`, `NONE`, `OFLCASB_DLP_FILE`, `OFLCASB_DLP_EMAIL`, `OFLCASB_DLP_CRM`,
                     `OFLCASB_DLP_ITSM`, `OFLCASB_DLP_COLLAB`, `OFLCASB_DLP_REPO`, `OFLCASB_DLP_STORAGE`,
@@ -116,11 +130,17 @@ class CasbdDlpRulesAPI(APIClient):
             :obj:`Tuple`: The resource record for the Casb DLP Rule.
 
         Examples:
-            Get a specific rule by ID and type::
+            Get a specific rule by ID::
 
                 >>> fetched_rule, _, error = client.zia.casb_dlp_rules.get_rule(
-                ...     rule_type='OFLCASB_DLP_ITSM',
-                ...     rule_id='1070199'
+                ...     rule_id=1070199
+                ... )
+
+            Get a rule by ID with optional rule type::
+
+                >>> fetched_rule, _, error = client.zia.casb_dlp_rules.get_rule(
+                ...     rule_id=1070199,
+                ...     rule_type='OFLCASB_DLP_ITSM'
                 ... )
                 >>> if error:
                 ...     print(f"Error fetching rule by ID: {error}")
@@ -135,7 +155,7 @@ class CasbdDlpRulesAPI(APIClient):
         """
         )
 
-        params = {"ruleType": rule_type}
+        params = {"ruleType": rule_type} if rule_type else {}
 
         body = {}
         headers = {}
@@ -169,9 +189,9 @@ class CasbdDlpRulesAPI(APIClient):
             tuple: The list of all Casb DLP Rules.
 
         Examples:
-            List all rules for a specific type::
+            List all rules::
 
-                >>> rules_list, _, error = client.zia.casb_dlp_rules.list_all_rules(
+                >>> rules_list, _, error = client.zia.casb_dlp_rules.list_all_rules()
                 >>> if error:
                 ...     print(f"Error listing all casb dlp rules rules: {error}")
                 ...     return
@@ -574,10 +594,9 @@ class CasbdDlpRulesAPI(APIClient):
                 ...     },
                 ... )
                 >>> if error:
-                ...     print(f"Error adding rule: {error}")
+                ...     print(f"Error updating rule: {error}")
                 ...     return
-                ... print(f"Rule added successfully: {added_rule.as_dict()}")
-                ... )
+                ... print(f"Rule updated successfully: {updated_rule.as_dict()}")
         """
         http_method = "put".upper()
         api_url = format_url(
@@ -614,14 +633,15 @@ class CasbdDlpRulesAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
-    def delete_rule(self, rule_type: str, rule_id: int) -> APIResult[dict]:
+    def delete_rule(self, rule_id: int, rule_type: Optional[str] = None) -> APIResult[dict]:
         """
         Deletes the specified casb dlp rules.
 
         Args:
             rule_id (int): The unique identifier for the casb dlp rules.
 
-            rule_type (str): The type of the rule (e.g., "OFLCASB_DLP_ITSM").
+            rule_type (str, optional): The type of the rule (e.g., "OFLCASB_DLP_ITSM").
+                Optional for DELETE; when provided, passed as query parameter.
 
                 Supported Values: `ANY`, `NONE`, `OFLCASB_DLP_FILE`, `OFLCASB_DLP_EMAIL`, `OFLCASB_DLP_CRM`,
                     `OFLCASB_DLP_ITSM`, `OFLCASB_DLP_COLLAB`, `OFLCASB_DLP_REPO`, `OFLCASB_DLP_STORAGE`,
@@ -631,14 +651,22 @@ class CasbdDlpRulesAPI(APIClient):
             :obj:`int`: The status code for the operation.
 
         Examples:
-            >>> _, _, error = client.zia.casb_dlp_rules.delete_rule(
-            ...     rule_type='OFLCASB_DLP_ITSM',
-            ...     rule_id='1072324'
-            ... )
-            >>> if error:
-            ...     print(f"Error deleting rule: {error}")
-            ...     return
-            ... print(f"Rule with ID 1072324 deleted successfully.")
+            Delete a rule by ID::
+
+                >>> _, _, error = client.zia.casb_dlp_rules.delete_rule(
+                ...     rule_id=1072324
+                ... )
+
+            Delete a rule by ID with optional rule type::
+
+                >>> _, _, error = client.zia.casb_dlp_rules.delete_rule(
+                ...     rule_id=1072324,
+                ...     rule_type='OFLCASB_DLP_ITSM'
+                ... )
+                >>> if error:
+                ...     print(f"Error deleting rule: {error}")
+                ...     return
+                ... print(f"Rule with ID 1072324 deleted successfully.")
         """
         http_method = "delete".upper()
         api_url = format_url(
@@ -647,7 +675,7 @@ class CasbdDlpRulesAPI(APIClient):
             /casbDlpRules/{rule_id}
         """
         )
-        params = {"ruleType": rule_type}
+        params = {"ruleType": rule_type} if rule_type else {}
 
         request, error = self._request_executor.create_request(http_method, api_url, params=params)
         if error:

{zscaler_sdk_python-1.9.14 → zscaler_sdk_python-1.9.16}/zscaler/zia/cloud_firewall.py

@@ -68,7 +68,7 @@ class FirewallResourcesAPI(APIClient):
             Gets a list of all IP destination groups by excluding specific type.
 
             >>> group_list, response, error = zia.cloud_firewall.list_ip_destination_groups(
-                query_params={"exclude_type": 'DSTN_DOMAIN'}):
+                query_params={"name": 'Group01'}):
             ... if error:
             ...     print(f"Error listing ip destination groups: {error}")
             ...     return

zscaler_sdk_python-1.9.16/zscaler/zia/custom_file_types.py

@@ -0,0 +1,345 @@
+"""
+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 Dict, List, Optional, Any, Union
+from zscaler.request_executor import RequestExecutor
+from zscaler.utils import format_url
+from zscaler.api_client import APIClient
+from zscaler.zia.models.custom_file_types import CustomFileTypes
+from zscaler.types import APIResult
+
+
+class CustomFileTypesAPI(APIClient):
+
+    _zia_base_endpoint = "/zia/api/v1"
+
+    def __init__(self, request_executor: "RequestExecutor") -> None:
+        super().__init__()
+        self._request_executor: RequestExecutor = request_executor
+
+    def list_custom_file_types(
+        self,
+        query_params: Optional[dict] = None,
+    ) -> APIResult[List[CustomFileTypes]]:
+        """
+        Retrieves the list of Custom file types can be configured as rule conditions in different ZIA policies.
+
+        Args:
+            query_params {dict}: Map of query parameters for the request.
+
+                ``[query_params.search]`` {str}: Search string for filtering results.
+                ``[query_params.page]`` {int}: Specifies the page offset
+                ``[query_params.page_size]`` {int}: Specifies the page size. Default value: 250
+
+        Returns:
+            tuple: A tuple containing (list of custom file types instances, Response, error).
+
+        Example:
+            List all custom file types with a specific page size:
+
+            >>> files_list, response, error = zia.custom_file_types.list_custom_file_types(
+            ...    query_params={"page_size": 50}
+            ... )
+            >>> for file in files_list:
+            ...    print(file.as_dict())
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /customFileTypes
+        """
+        )
+
+        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(CustomFileTypes(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+
+        return (result, response, None)
+
+    def get_custom_file_tytpe(
+        self,
+        file_id: int,
+    ) -> APIResult[dict]:
+        """
+        Retrieves information about a custom file type based on the specified ID
+
+        Args:
+            file_id (str): The unique identifier for the custom file types filter.
+
+        Returns:
+            tuple: A tuple containing (custom file types instance, Response, error).
+
+        Example:
+            Retrieve a custom file types by its ID:
+
+            >>> file, response, error = zia.custom_file_types.get_custom_file_tytpe(file_id=123456)
+            >>> if not error:
+            ...    print(file.as_dict())
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /customFileTypes/{file_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, CustomFileTypes)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            result = CustomFileTypes(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def add_custom_file_type(
+        self,
+        **kwargs,
+    ) -> APIResult[dict]:
+        """
+        Adds a new custom file type.
+
+        Args:
+            name (str): Custom file type name
+
+        Keyword Args:
+            name (str): Custom file type name
+            description (str): Additional information about the custom file type, if any.
+
+            extension (str): Specifies the file type extension.
+                The maximum extension length is 10 characters.
+                Existing Zscaler extensions cannot be added to custom file types.
+
+            file_type_id (int): File type ID.
+                This ID is assigned and maintained for all file types including predefined and custom file types
+                and this value is different from the custom file type ID.
+
+        Returns:
+            tuple: new custom file type resource record.
+
+        Example:
+            add an a new custom file type:
+
+            >>> zia.custom_file_types.add_custom_file_type(
+            ...    name='FileType02',
+            ...    description='FileType02',
+            ...    extension='tf'
+            ... )
+        """
+        http_method = "post".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /customFileTypes
+        """
+        )
+
+        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, CustomFileTypes)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = CustomFileTypes(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def update_custom_file_type(self, file_id: int, **kwargs) -> APIResult[dict]:
+        """
+        Updates information for a custom file type based on the specified ID
+
+        Args:
+            file_id (int): The unique ID for the custom file type that is being updated.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            name (str): Custom file type name
+            description (str): Additional information about the custom file type, if any.
+
+            extension (str): Specifies the file type extension.
+                The maximum extension length is 10 characters.
+                Existing Zscaler extensions cannot be added to custom file types.
+
+            file_type_id (int): File type ID.
+                This ID is assigned and maintained for all file types including predefined and custom file types
+                and this value is different from the custom file type ID.
+
+        Returns:
+            tuple: update an existing custom file type resource record.
+
+        Example:
+            Update an existing custom file type to change its name and action:
+
+            >>> zia.custom_file_types.update_custom_file_type(
+            ...    file_id=123456,
+            ...    name='FileType02',
+            ...    description='FileType02',
+            ...    extension='tf'
+            ... )
+        """
+        http_method = "put".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /customFileTypes/{file_id}
+        """
+        )
+
+        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, CustomFileTypes)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = CustomFileTypes(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def delete_custom_file_type(self, file_id: int) -> APIResult[dict]:
+        """
+        Deletes a custom file type based on the specified ID
+
+        Args:
+            file_id (int): The unique identifier for the custom file types
+
+        Returns:
+            :obj:`int`: The status code for the operation.
+
+        Examples:
+            >>> zia.custom_file_types.delete_custom_file_type('278454')
+
+        """
+        http_method = "delete".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /customFileTypes/{file_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)
+
+    def get_custom_file_type_count(self) -> APIResult[int]:
+        """
+        Retrieves the count of custom file types available.
+        The API returns a scalar (e.g. 1); this method returns it as an int.
+
+        Returns:
+            tuple: A tuple containing (count of custom file types as int, Response, error).
+
+        Examples:
+            Retrieve the custom file type count (returns int)::
+
+                >>> count, response, error = zia.custom_file_types.get_custom_file_type_count()
+                >>> if not error:
+                ...     print(f"Custom file types count: {count}")
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /customFileTypes/count
+            """
+        )
+
+        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)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            body = response.get_body()
+            if isinstance(body, dict) and "count" in body:
+                result = int(body["count"])
+            elif isinstance(body, (int, float)):
+                result = int(body)
+            elif isinstance(body, str):
+                result = int(body)
+            else:
+                result = int(body) if body is not None else 0
+        except (TypeError, ValueError) as err:
+            return (None, response, err)
+        return (result, response, None)