zscaler-sdk-python 1.8.0__tar.gz → 1.8.2__tar.gz

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/PKG-INFO

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

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/pyproject.toml

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

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/__init__.py

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

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/oneapi_object.py

@@ -21,6 +21,22 @@ class ZscalerObject:
     def __contains__(self, key):
         return hasattr(self, key)
 
+    def get(self, key, default=None):
+        """
+        Get an attribute value with a default if the attribute doesn't exist.
+        Similar to dict.get() method.
+        
+        Args:
+            key (str): The attribute name to get
+            default: The default value to return if the attribute doesn't exist
+            
+        Returns:
+            The attribute value or the default value
+        """
+        if hasattr(self, key):
+            return getattr(self, key)
+        return default
+
     def as_dict(self):
         result = {}
         for key, val in self.request_format().items():

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/oneapi_response.py

@@ -66,9 +66,6 @@ class ZscalerAPIResponse:
         if end_time:
             self._params["endTime"] = end_time
 
-        # If service is ZPA and user did not specify a pagesize, set it to max=500 by default
-        if self._service_type.upper() == "ZPA" and "pagesize" not in self._params:
-            self._params["pagesize"] = self.SERVICE_PAGE_LIMITS["ZPA"]["max"]
 
         # If service is ZIA, ensure the pagination parameter is "pageSize" in camelCase
         if self._service_type == "zia":

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/utils.py

@@ -819,6 +819,60 @@ def format_url(base_string):
 
 #     return wrapper
 
+def validate_and_format_date(date_str: str) -> str:
+    """
+    Validates and formats date string for ZCC API.
+    Accepts various date formats and returns ZCC API format (YYYY-MM-DD HH:MM:SS GMT).
+    
+    Args:
+        date_str (str): Date string in various formats
+        
+    Returns:
+        str: Date in ZCC API format (YYYY-MM-DD HH:MM:SS GMT)
+        
+    Raises:
+        ValueError: If date format is invalid
+    """
+    if not date_str:
+        raise ValueError("Date string cannot be empty")
+    
+    try:
+        # Try to parse the date string
+        parsed_date = parser.parse(date_str)
+        
+        # If no timezone info, assume UTC
+        if parsed_date.tzinfo is None:
+            parsed_date = pytz.UTC.localize(parsed_date)
+        
+        # Convert to ZCC API format: YYYY-MM-DD HH:MM:SS GMT
+        return parsed_date.strftime("%Y-%m-%d %H:%M:%S GMT")
+    except (ValueError, TypeError) as e:
+        raise ValueError(f"Invalid date format: {date_str}. Expected formats: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS, etc. Error: {e}")
+
+
+def validate_time_zone(time_zone_str: str) -> str:
+    """
+    Validates time zone string against IANA Time Zone database.
+    
+    Args:
+        time_zone_str (str): IANA time zone string
+        
+    Returns:
+        str: Validated time zone string
+        
+    Raises:
+        ValueError: If time zone is invalid
+    """
+    if not time_zone_str:
+        raise ValueError("Time zone cannot be empty")
+    
+    # Check if it's a valid IANA time zone
+    if time_zone_str not in pytz.all_timezones:
+        raise ValueError(f"Invalid time zone: {time_zone_str}. Please use a valid IANA time zone (e.g., 'America/New_York', 'UTC', 'Europe/London')")
+    
+    return time_zone_str
+
+
 def zcc_param_mapper(func):
     @wraps(func)
     def wrapper(self, *args, **kwargs):
@@ -873,10 +927,54 @@ def zcc_param_mapper(func):
             else:
                 mapped_params["registrationTypes"] = ",".join(mapped)
 
+        # Handle date parameters
+        start_date = (
+            query_params.get("start_date") or
+            query_params.get("startDate") or
+            body.get("start_date") or
+            body.get("startDate")
+        )
+        
+        if start_date:
+            try:
+                mapped_params["startDate"] = validate_and_format_date(start_date)
+            except ValueError as e:
+                raise ValueError(f"Invalid start_date: {e}")
+        
+        end_date = (
+            query_params.get("end_date") or
+            query_params.get("endDate") or
+            body.get("end_date") or
+            body.get("endDate")
+        )
+        
+        if end_date:
+            try:
+                mapped_params["endDate"] = validate_and_format_date(end_date)
+            except ValueError as e:
+                raise ValueError(f"Invalid end_date: {e}")
+        
+        # Handle time zone parameter
+        time_zone = (
+            query_params.get("time_zone") or
+            query_params.get("Time-Zone") or
+            body.get("time_zone") or
+            body.get("Time-Zone")
+        )
+        
+        if time_zone:
+            try:
+                mapped_params["Time-Zone"] = validate_time_zone(time_zone)
+            except ValueError as e:
+                raise ValueError(f"Invalid time_zone: {e}")
+
         # Clean aliases
         for key in [
             "os_type", "os_types",
             "registration_type", "registration_types",
+            "start_date", "startDate",
+            "end_date", "endDate", 
+            "time_zone", "Time-Zone",
         ]:
             query_params.pop(key, None)
             kwargs.pop(key, None)

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/zcc/devices.py

@@ -209,6 +209,104 @@ class DevicesAPI(APIClient):
 
         return filename
 
+    @zcc_param_mapper
+    def download_disable_reasons(self, query_params=None, filename: str = None):
+        """
+        Downloads or exports a report as a CSV file showing the disable reasons of devices.
+
+        Args:
+            query_params (dict, optional): A dictionary containing supported filters.
+
+                ``[query_params.os_types]`` {list}: Filter by OS type. Valid values:
+                    ios, android, windows, macos, linux.
+
+                ``[query_params.start_date]`` {str}: Start date for the report. Accepts various formats:
+                    YYYY-MM-DD, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS, etc. Will be converted to ZCC API format.
+
+                ``[query_params.end_date]`` {str}: End date for the report. Accepts various formats:
+                    YYYY-MM-DD, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS, etc. Will be converted to ZCC API format.
+
+                ``[query_params.time_zone]`` {str}: IANA time zone for date interpretation. 
+                    Examples: 'America/New_York', 'UTC', 'Europe/London'.
+
+            filename (str, optional): Custom filename for the CSV file. Defaults to timestamped name.
+
+        Returns:
+            str: Path to the downloaded CSV file.
+
+        Examples:
+            Download disable reasons report for Windows devices:
+
+            >>> try:
+            ...     filename = client.zcc.devices.download_disable_reasons(
+            ...         query_params={
+            ...             "os_types": ["windows"],
+            ...             "start_date": "2024-01-01",
+            ...             "end_date": "2024-01-31",
+            ...             "time_zone": "America/New_York"
+            ...         },
+            ...         filename="disable_reasons_jan2024.csv"
+            ...     )
+            ...     print(f"Disable reasons report downloaded successfully: {filename}")
+            ... except Exception as e:
+            ...     print(f"Error during download: {e}")
+
+            Download disable reasons for all devices with specific date range:
+
+            >>> try:
+            ...     filename = client.zcc.devices.download_disable_reasons(
+            ...         query_params={
+            ...             "start_date": "2024-01-01 00:00:00",
+            ...             "end_date": "2024-01-31 23:59:59",
+            ...             "time_zone": "UTC"
+            ...         }
+            ...     )
+            ...     print(f"Report downloaded: {filename}")
+            ... except Exception as e:
+            ...     print(f"Error: {e}")
+        """
+        query_params = query_params or {}
+
+        if not filename:
+            filename = f"zcc-disable-reasons-{datetime.now().strftime('%Y%m%d-%H_%M_%S')}.csv"
+
+        # The zcc_param_mapper decorator handles parameter mapping and validation
+        # We just need to pass the query_params through
+        params = query_params.copy()
+
+        http_method = "get".upper()
+        api_url = format_url(f"{self._zcc_base_endpoint}/downloadDisableReasons")
+
+        # Prepare headers - include Time-Zone if provided
+        headers = {"Accept": "*/*"}
+        if "Time-Zone" in params:
+            headers["Time-Zone"] = params.pop("Time-Zone")
+
+        request, error = self._request_executor.create_request(
+            http_method,
+            api_url,
+            params=params,
+            headers=headers
+        )
+
+        if error:
+            raise Exception("Error creating request for downloading disable reasons report.")
+
+        response, error = self._request_executor.execute(request, return_raw_response=True)
+        if error:
+            raise error
+        if response is None:
+            raise Exception("No response received when downloading disable reasons report.")
+
+        content_type = response.headers.get("Content-Type", "").lower()
+        if not content_type.startswith("application/octet-stream") and not response.text.startswith('"User","Device type"'):
+            raise Exception("Invalid response content type or unexpected response format.")
+
+        with open(filename, "wb") as f:
+            f.write(response.content)
+
+        return filename
+
     @zcc_param_mapper
     def list_devices(self, query_params=None) -> tuple:
         """
@@ -624,3 +722,4 @@ class DevicesAPI(APIClient):
             return None, response, error
 
         return result, response, None
+

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/zia/intermediate_certificates.py

@@ -414,7 +414,7 @@ class IntermediateCertsAPI(APIClient):
         api_url = format_url(
             f"""
             {self._zia_base_endpoint}
-            //intermediateCaCertificate/downloadCsr/{cert_id}
+            /intermediateCaCertificate/downloadCsr/{cert_id}
         """
         )
 
@@ -575,12 +575,14 @@ class IntermediateCertsAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
-    def upload_cert(self, cert_id: int) -> tuple:
+    def upload_cert(self, cert_id: int, file_input_stream: str = None, file_path: str = None) -> tuple:
         """
         Uploads a custom intermediate CA certificate signed by your Certificate Authority (CA) for SSL inspection.
 
         Args:
             cert_id (int): The unique identifier for the intermediate CA certificate.
+            file_input_stream (str): The certificate content in PEM format (alternative to file_path).
+            file_path (str): Path to the certificate file (alternative to file_input_stream).
 
         Returns:
             tuple: A tuple containing (intermediate CA certificate instance, Response, error).
@@ -593,10 +595,45 @@ class IntermediateCertsAPI(APIClient):
         """
         )
 
-        body = {}
-        headers = {}
+        # Prepare file content
+        if file_path:
+            # Use file path for upload
+            with open(file_path, 'rb') as f:
+                file_content = f.read()
+        elif file_input_stream:
+            # Use string content for upload
+            file_content = file_input_stream.encode('utf-8')
+        else:
+            return (None, None, ValueError("Either file_path or file_input_stream must be provided"))
+
+        # Create multipart form data manually (like Postman does)
+        import io
+        import uuid
+        
+        # Generate a random boundary (like Postman does)
+        boundary = f"----WebKitFormBoundary{str(uuid.uuid4()).replace('-', '')}"
+        
+        # Build multipart form data
+        form_data = io.BytesIO()
+        
+        # Add the file part
+        form_data.write(f'--{boundary}\r\n'.encode())
+        form_data.write(b'Content-Disposition: form-data; name="fileUpload"; filename="certificate.pem"\r\n')
+        form_data.write(b'Content-Type: application/octet-stream\r\n\r\n')
+        form_data.write(file_content)
+        form_data.write(f'\r\n--{boundary}--\r\n'.encode())
+        
+        headers = {
+            'Content-Type': f'multipart/form-data; boundary={boundary}'
+        }
 
-        request, error = self._request_executor.create_request(http_method, api_url, body, headers)
+        request, error = self._request_executor.create_request(
+            http_method, 
+            api_url, 
+            body=form_data.getvalue(),
+            headers=headers,
+            use_raw_data_for_body=True
+        )
         if error:
             return (None, None, error)
 

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/zpa/models/application_segment.py

@@ -1093,7 +1093,7 @@ class MultiMatchUnsupportedReferences(ZscalerObject):
             self.unsupported_features = ZscalerCollection.form_list(
                 config["unsupportedFeatures"] if "unsupportedFeatures" in config else [], str
             )
-            
+
             self.tcp_ports = ZscalerCollection.form_list(
                 config["tcpPorts"] if "tcpPorts" in config else [], str
             )

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/zpa/models/common.py

@@ -16,6 +16,7 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 from zscaler.oneapi_object import ZscalerObject
 from zscaler.oneapi_collection import ZscalerCollection
+from zscaler.zpa.models import application_segment as application_segment
 
 
 class CommonIDName(ZscalerObject):
@@ -519,3 +520,54 @@ class SortBy(ZscalerObject):
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format
+
+
+class DesktopPolicyMappingsDTO(ZscalerObject):
+    """
+    A class for DesktopPolicyMappingsDTO objects.
+    Handles common block attributes shared across multiple resources
+    """
+
+    def __init__(self, config=None):
+        """
+        Initialize the DesktopPolicyMappingsDTO model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the response.
+        """
+        super().__init__(config)
+        if config:
+            self.id = config["id"] if "id" in config else None
+            self.modified_time = config["modifiedTime"] if "modifiedTime" in config else None
+            self.creation_time = config["creationTime"] if "creationTime" in config else None
+            self.modified_by = config["modifiedBy"] if "modifiedBy" in config else None
+            self.image_id = config["imageId"] if "imageId" in config else None
+            self.image_name = config["imageName"] if "imageName" in config else None
+            self.app_segments = ZscalerCollection.form_list(
+                config["appSegments"] if "appSegments" in config else [], application_segment.ApplicationSegments
+            )
+        else:
+            self.id = None
+            self.modified_time = None
+            self.creation_time = None
+            self.modified_by = None
+            self.image_id = None
+            self.image_name = None
+            self.app_segments = []
+
+    def request_format(self):
+        """
+        Returns the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "id": self.id,
+            "modifiedTime": self.modified_time,
+            "creationTime": self.creation_time,
+            "modifiedBy": self.modified_by,
+            "imageId": self.image_id,
+            "imageName": self.image_name,
+            "appSegments": [segment.as_dict() for segment in self.app_segments],
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/zpa/models/policyset_controller_v1.py

@@ -49,6 +49,8 @@ class PolicySetControllerV1(ZscalerObject):
             self.reauth_idle_timeout = config["reauthIdleTimeout"] if "reauthIdleTimeout" in config else None
             self.reauth_timeout = config["reauthTimeout"] if "reauthTimeout" in config else None
             self.custom_msg = config["customMsg"] if "customMsg" in config else None
+            self.device_posture_failure_notification_enabled = config["devicePostureFailureNotificationEnabled"] \
+                if "devicePostureFailureNotificationEnabled" in config else None
             self.disabled = config["disabled"] if "disabled" in config else None
             self.extranet_enabled = config["extranetEnabled"] if "extranetEnabled" in config else False
             self.microtenant_id = config["microtenantId"] if "microtenantId" in config else None
@@ -78,6 +80,10 @@ class PolicySetControllerV1(ZscalerObject):
                 config["serviceEdgeGroups"] if "serviceEdgeGroups" in config else [], service_edge_groups.ServiceEdgeGroup
             )
 
+            self.desktop_policy_mappings = ZscalerCollection.form_list(
+                config["desktopPolicyMappings"] if "desktopPolicyMappings" in config else [], common.DesktopPolicyMappingsDTO
+            )
+
             if "privilegedCapabilities" in config:
                 if isinstance(config["privilegedCapabilities"], common.PrivilegedCapabilitiesResource):
                     self.privileged_capabilities = config["privilegedCapabilities"]
@@ -167,6 +173,8 @@ class PolicySetControllerV1(ZscalerObject):
             self.reauth_timeout = None
             self.read_only = None
             self.zscaler_managed = None
+            self.device_posture_failure_notification_enabled = None
+            self.desktop_policy_mappings = []
 
     def request_format(self):
         parent_req_format = super().request_format()
@@ -208,6 +216,8 @@ class PolicySetControllerV1(ZscalerObject):
             "appConnectorGroups": [group.request_format() for group in self.app_connector_groups],
             "appServerGroups": [group.request_format() for group in self.app_server_groups],
             "serviceEdgeGroups": [group.request_format() for group in self.service_edge_groups],
+            "devicePostureFailureNotificationEnabled": self.device_posture_failure_notification_enabled,
+            "desktopPolicyMappings": [mapping.request_format() for mapping in self.desktop_policy_mappings],
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format

{zscaler_sdk_python-1.8.0 → zscaler_sdk_python-1.8.2}/zscaler/zpa/models/policyset_controller_v2.py

@@ -48,6 +48,8 @@ class PolicySetControllerV2(ZscalerObject):
             self.reauth_idle_timeout = config["reauthIdleTimeout"] if "reauthIdleTimeout" in config else None
             self.reauth_timeout = config["reauthTimeout"] if "reauthTimeout" in config else None
             self.custom_msg = config["customMsg"] if "customMsg" in config else None
+            self.device_posture_failure_notification_enabled = config["devicePostureFailureNotificationEnabled"] \
+                if "devicePostureFailureNotificationEnabled" in config else None
             self.disabled = config["disabled"] if "disabled" in config else None
             self.extranet_enabled = config["extranetEnabled"] if "extranetEnabled" in config else False
             self.microtenant_id = config["microtenantId"] if "microtenantId" in config else None
@@ -81,6 +83,10 @@ class PolicySetControllerV2(ZscalerObject):
                 config["serviceEdgeGroups"] if "serviceEdgeGroups" in config else [], service_edge_groups.ServiceEdgeGroup
             )
 
+            self.desktop_policy_mappings = ZscalerCollection.form_list(
+                config["desktopPolicyMappings"] if "desktopPolicyMappings" in config else [], common.DesktopPolicyMappingsDTO
+            )
+
             if "privilegedCapabilities" in config:
                 if isinstance(config["privilegedCapabilities"], common.PrivilegedCapabilitiesResource):
                     self.privileged_capabilities = config["privilegedCapabilities"]
@@ -172,6 +178,8 @@ class PolicySetControllerV2(ZscalerObject):
             self.reauth_timeout = None
             self.read_only = None
             self.zscaler_managed = None
+            self.device_posture_failure_notification_enabled = None
+            self.desktop_policy_mappings = []
 
     def request_format(self):
         parent_req_format = super().request_format()
@@ -214,6 +222,8 @@ class PolicySetControllerV2(ZscalerObject):
             "appConnectorGroups": [group.request_format() for group in self.app_connector_groups],
             "appServerGroups": [group.request_format() for group in self.app_server_groups],
             "serviceEdgeGroups": [group.request_format() for group in self.service_edge_groups],
+            "devicePostureFailureNotificationEnabled": self.device_posture_failure_notification_enabled,
+            "desktopPolicyMappings": [mapping.request_format() for mapping in self.desktop_policy_mappings],
         }
         parent_req_format.update(current_obj_format)
         return parent_req_format