zscaler-sdk-python 1.9.39__tar.gz → 1.9.40__tar.gz

{zscaler_sdk_python-1.9.39 → zscaler_sdk_python-1.9.40}/PKG-INFO

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

{zscaler_sdk_python-1.9.39 → zscaler_sdk_python-1.9.40}/pyproject.toml

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

{zscaler_sdk_python-1.9.39 → zscaler_sdk_python-1.9.40}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.39 → zscaler_sdk_python-1.9.40}/zscaler/zcell/models/sim_location_groups.py

@@ -78,24 +78,112 @@ class ResponseMessage(ZscalerObject):
         return parent_req_format
 
 
+class GeoFence(ZscalerObject):
+    """
+    A class representing the geo fence of a SIM location group.
+
+    The API spells this ``geoFenceData`` on read/update and ``geoFenceDetails`` on
+    create; both carry the same shape. ``lat``/``lng``/``radius`` are fractional --
+    e.g. ``{"lat": -17.687827, "lng": 52.8125, "radius": 1637864.965089}``.
+    """
+
+    def __init__(self, config=None):
+        super().__init__(config)
+        if config:
+            self.lat = config["lat"] if "lat" in config else None
+            self.lng = config["lng"] if "lng" in config else None
+            self.radius = config["radius"] if "radius" in config else None
+        else:
+            self.lat = None
+            self.lng = None
+            self.radius = None
+
+    def request_format(self):
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "lat": self.lat,
+            "lng": self.lng,
+            "radius": self.radius,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
+class LinkedPolicyDetails(ZscalerObject):
+    """
+    A class representing a policy linked to a SIM location group.
+    """
+
+    def __init__(self, config=None):
+        super().__init__(config)
+        if config:
+            self.policy_id = config["policyId"] if "policyId" in config else None
+            self.policy_name = config["policyName"] if "policyName" in config else None
+            self.policy_type = config["policyType"] if "policyType" in config else None
+            self.status = config["status"] if "status" in config else None
+        else:
+            self.policy_id = None
+            self.policy_name = None
+            self.policy_type = None
+            self.status = None
+
+    def request_format(self):
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "policyId": self.policy_id,
+            "policyName": self.policy_name,
+            "policyType": self.policy_type,
+            "status": self.status,
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format
+
+
 class ApiCreateSimLocationGroupRequestBody(ZscalerObject):
     """
     A class representing a ApiCreateSimLocationGroupRequestBody object.
+
+    Note the create payload uses ``geoFenceDetails``, where read and update use
+    ``geoFenceData``. The endpoint takes a *list* of these bodies per call.
     """
 
     def __init__(self, config=None):
         super().__init__(config)
         if config:
-            pass
+            self.name = config["name"] if "name" in config else None
+            self.tracked_devices = ZscalerCollection.form_list(
+                config["trackedDevices"] if "trackedDevices" in config else [], str
+            )
+            if "geoFenceDetails" in config:
+                if isinstance(config["geoFenceDetails"], sim_location_groups.GeoFence):
+                    self.geo_fence_details = config["geoFenceDetails"]
+                elif config["geoFenceDetails"] is not None:
+                    self.geo_fence_details = sim_location_groups.GeoFence(config["geoFenceDetails"])
+                else:
+                    self.geo_fence_details = None
+            else:
+                self.geo_fence_details = None
         else:
-            pass
+            self.name = None
+            self.tracked_devices = []
+            self.geo_fence_details = None
 
     def request_format(self):
         """
         Return the object as a dictionary in the format expected for API requests.
         """
         parent_req_format = super().request_format()
-        current_obj_format = {}
+        current_obj_format = {
+            "name": self.name,
+            "trackedDevices": self.tracked_devices,
+            "geoFenceDetails": self.geo_fence_details,
+        }
         parent_req_format.update(current_obj_format)
         return parent_req_format
 

{zscaler_sdk_python-1.9.39 → zscaler_sdk_python-1.9.40}/zscaler/zcell/sim_location_groups.py

@@ -100,7 +100,7 @@ class SimLocationGroupsAPI(APIClient):
             tuple: (result, Response, error)
 
         Examples:
-            >>> result, response, error = client.zcell.sim_location_groups.get_sim_location_groups(
+            >>> result, response, error = client.zcell.sim_location_groups.get_sim_location_group(
             ...     id='...',
             ...     group_id='...',
             ... )

{zscaler_sdk_python-1.9.39 → zscaler_sdk_python-1.9.40}/zscaler/zia/url_categories.py

@@ -104,6 +104,63 @@ class URLCategoriesAPI(APIClient):
 
         return (results, response, None)
 
+    def list_categories_lite(self, query_params: Optional[dict] = None) -> APIResult[List[URLCategory]]:
+        """
+        Returns lightweight key-value list of all or custom URL categories.
+
+        Keyword Args:
+
+        Returns:
+            :obj:`Tuple`: A list of configured categories.
+
+        Examples:
+            List locations with default settings:
+
+            >>> categories_list, _, err = client.zia.url_categories.list_categories_lite()
+            >>> if err:
+            ...     print(f"Error listing url categories: {err}")
+            ...     return
+            ... print(f"Total url categories found: {len(categories_list)}")
+            ... for category in categories_list:
+            ...     print(category.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}
+            /urlCategories/lite
+        """)
+
+        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(URLCategory(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+    
     def get_category(self, category_id: str) -> APIResult[URLCategory]:
         """
         Returns URL category information for the provided category.