feat(securityzones): implement CRUD operations for organization security zones with API documentation

Author: tmunzer-AIDE

src/mistapi/api/v1/orgs/securityzones.py

@@ -0,0 +1,174 @@
+"""
+--------------------------------------------------------------------------------
+------------------------- Mist API Python CLI Session --------------------------
+
+    Written by: Thomas Munzer (tmunzer@juniper.net)
+    Github    : https://github.com/tmunzer/mistapi_python
+
+    This package is licensed under the MIT License.
+
+--------------------------------------------------------------------------------
+"""
+
+from mistapi import APISession as _APISession
+from mistapi.__api_response import APIResponse as _APIResponse
+
+
+def listOrgSecurityZones(
+    mist_session: _APISession,
+    org_id: str,
+    limit: int | None = None,
+    page: int | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/security-zones/list-org-security-zones
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    limit : int, default: 100
+      Maximum number of results to return per page
+    page : int, default: 1
+      Select the page number to return when using page-based pagination; starts at `1`
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/securityzones"
+    query_params: dict[str, str] = {}
+    if limit:
+        query_params["limit"] = str(limit)
+    if page:
+        query_params["page"] = str(page)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
+def createOrgSecurityZone(
+    mist_session: _APISession, org_id: str, body: dict | list
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/security-zones/create-org-security-zone
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    BODY PARAMS
+    -----------
+    body : dict
+        JSON object to send to Mist Cloud (see API doc above for more details)
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/securityzones"
+    resp = mist_session.mist_post(uri=uri, body=body)
+    return resp
+
+
+def getOrgSecurityZone(
+    mist_session: _APISession, org_id: str, securityzone_id: str
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/security-zones/get-org-security-zone
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+    securityzone_id : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/securityzones/{securityzone_id}"
+    query_params: dict[str, str] = {}
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
+def deleteOrgSecurityZone(
+    mist_session: _APISession, org_id: str, securityzone_id: str
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/security-zones/delete-org-security-zone
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+    securityzone_id : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/securityzones/{securityzone_id}"
+    query_params: dict[str, str] = {}
+    resp = mist_session.mist_delete(uri=uri, query=query_params)
+    return resp
+
+
+def updateOrgSecurityZone(
+    mist_session: _APISession, org_id: str, securityzone_id: str, body: dict
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/security-zones/update-org-security-zone
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+    securityzone_id : str
+
+    BODY PARAMS
+    -----------
+    body : dict
+        JSON object to send to Mist Cloud (see API doc above for more details)
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/securityzones/{securityzone_id}"
+    resp = mist_session.mist_put(uri=uri, body=body)
+    return resp