feat(insights): add countOrgClientFingerprints and searchOrgClientFingerprints functions with detailed API documentation

Author: tmunzer-AIDE

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

@@ -14,6 +14,163 @@
 from mistapi.__api_response import APIResponse as _APIResponse
 
 
+def countOrgClientFingerprints(
+    mist_session: _APISession,
+    org_id: str,
+    distinct: str | None = None,
+    start: str | None = None,
+    end: str | None = None,
+    duration: str | None = None,
+    limit: int | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-fingerprints/count-org-client-fingerprints
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    distinct : str{'family', 'model', 'os', 'os_type'}, default: family
+      Field used to group this count response. enum: `family`, `model`, `os`, `os_type`
+    start : str
+      Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
+    end : str
+      Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
+    duration : str, default: 1d
+      Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
+    limit : int, default: 100
+      Maximum number of results to return per page
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/insights/fingerprints/count"
+    query_params: dict[str, str] = {}
+    if distinct:
+        query_params["distinct"] = str(distinct)
+    if start:
+        query_params["start"] = str(start)
+    if end:
+        query_params["end"] = str(end)
+    if duration:
+        query_params["duration"] = str(duration)
+    if limit:
+        query_params["limit"] = str(limit)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
+def searchOrgClientFingerprints(
+    mist_session: _APISession,
+    org_id: str,
+    family: str | None = None,
+    client_type: str | None = None,
+    model: str | None = None,
+    mfg: str | None = None,
+    os: str | None = None,
+    os_type: str | None = None,
+    mac: str | None = None,
+    limit: int | None = None,
+    start: str | None = None,
+    end: str | None = None,
+    duration: str | None = None,
+    interval: str | None = None,
+    sort: str | None = None,
+    search_after: str | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-fingerprints/search-org-client-fingerprints
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    family : str
+      Device Category of the client device
+    client_type : str{'wireless', 'wired', 'vty'}
+      Filter results by client type. enum: `wireless`, `wired`, `vty`
+    model : str
+      Filter results by device model
+    mfg : str
+      Manufacturer name of the client device
+    os : str
+      Operating System name and version of the client device
+    os_type : str
+      Operating system name of the client device
+    mac : str
+      Filter results by MAC address
+    limit : int, default: 100
+      Maximum number of results to return per page
+    start : str
+      Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
+    end : str
+      Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
+    duration : str, default: 1d
+      Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
+    interval : str
+      Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
+    sort : str, default: wxid
+      On which field the list should be sorted, -prefix represents DESC order.
+    search_after : str
+      Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/insights/fingerprints/search"
+    query_params: dict[str, str] = {}
+    if family:
+        query_params["family"] = str(family)
+    if client_type:
+        query_params["client_type"] = str(client_type)
+    if model:
+        query_params["model"] = str(model)
+    if mfg:
+        query_params["mfg"] = str(mfg)
+    if os:
+        query_params["os"] = str(os)
+    if os_type:
+        query_params["os_type"] = str(os_type)
+    if mac:
+        query_params["mac"] = str(mac)
+    if limit:
+        query_params["limit"] = str(limit)
+    if start:
+        query_params["start"] = str(start)
+    if end:
+        query_params["end"] = str(end)
+    if duration:
+        query_params["duration"] = str(duration)
+    if interval:
+        query_params["interval"] = str(interval)
+    if sort:
+        query_params["sort"] = str(sort)
+    if search_after:
+        query_params["search_after"] = str(search_after)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
 def getOrgMarvisClientInsights(
     mist_session: _APISession,
     org_id: str,