0.54.4

Author: tmunzer-AIDE

README.md

@@ -13,14 +13,14 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 
 ## Features
-This package is build from the [Mist OpenAPI specifications](https://doc.mist-lab.fr) and is designed to simplify the use of the Mist APIs with Python scripts.
+This package is built from the [Mist OpenAPI specifications](https://doc.mist-lab.fr) and is designed to simplify the use of the Mist APIs with Python scripts.
 
 * Manage Mist Authentication with login/password (and 2FA if required) or API Token
 * Provide interactive user inputs for login and org/site selections
 * Provide easy access to Mist APIs endpoints and documentation
 
 ## Installation
-This Python Package can be install with `pip`:
+This Python Package can be installed with `pip`:
 ```python3
 # Linux/macOS
 python3 -m pip install mistapi
@@ -47,15 +47,15 @@ However, it is possible to set them in an `.env` file. The location of this file
 ```
 
 ### Environment Variables
-| Variable Name | Type | Default | Comment |
-| ------------- | ---- |  ------ | ------- |
-MIST_HOST | string | None | The Mist Cloud to use. It must be the "api" one (e.g. `api.mist.com`, `api.eu.mist.com`, ...) |
-MIST_APITOKEN | string | None | The API Token to use.  |
-MIST_USER | string | None | The login to use if no API Token is provided (apitoken use is prefered) |
-MIST_PASSWORD | string | None | The password to use if no API Token is provided (apitoken use is prefered) |
-CONSOLE_LOG_LEVEL | int | 20 | The minimum log level to display on the console, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical) |
-LOGGING_LOG_LEVEL | int | 10 | The minimum log level to log on the file, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical). This is only used when the script calling `mistapi` is using Python `logging` package and is configured to log to a file |
-HTTPS_PROXY | string | None | configure the package to use an HTTP/HTTPS (e.g. http://user:passowrd@myproxy.com:3128)
+| Variable Name     | Type   | Default | Comment                                                                                                                                                                                                                                                                   |
+|-------------------|--------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| MIST_HOST         | string | None    | The Mist Cloud to use. It must be the "api" one (e.g. `api.mist.com`, `api.eu.mist.com`, ...)                                                                                                                                                                             |
+| MIST_APITOKEN     | string | None    | The API Token to use.                                                                                                                                                                                                                                                     |
+| MIST_USER         | string | None    | The login to use if no API Token is provided (apitoken use is preferred)                                                                                                                                                                                                  |
+| MIST_PASSWORD     | string | None    | The password to use if no API Token is provided (apitoken use is preferred)                                                                                                                                                                                               |
+| CONSOLE_LOG_LEVEL | int    | 20      | The minimum log level to display on the console, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical)                                                                                                                    |
+| LOGGING_LOG_LEVEL | int    | 10      | The minimum log level to log on the file, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical). This is only used when the script calling `mistapi` is using Python `logging` package and is configured to log to a file |
+| HTTPS_PROXY       | string | None    | configure the package to use an HTTP/HTTPS (e.g. http://user:passowrd@myproxy.com:3128)                                                                                                                                                                                   |
 
 An example of the environment file content is:
 ```
@@ -66,28 +66,28 @@ MIST_APITOKEN = xxxxxx
 ## Usage
 Usage examples are available in the [mist_library repository](https://github.com/tmunzer/mist_library).
 
-To use it, 
-### 1. `APISession` must be instanciated:
+To use it:
+### 1. `APISession` must be instantiated:
 ```python3
 >>> import mistapi
 >>> apisession = mistapi.APISession()
 ```
 This class accepts different parameters, all optionals:
 
-| Parameter Name | Type | Default | Comment |
-| ------------- | ---- |  ------ | ------- |
-email | str | None | used if login/password is used. Can be defined later |
-password | str | None | used if login/password is used. Can be defined later |
-apitoken | str | None | used if API Token is used. Can de defined later |
-host | str | None | Mist Cloud to reach (e.g. "api.mist.com"). Can de defined later |
-env_file | str | None | path to the env file to load. See README.md for allowed variables |
-console_log_level | int | 20 | The minimum log level to display on the console, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical) |
-logging_log_level | int | 10 | The minimum log level to log on the file, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical). This is only used when the script calling `mistapi` is using Python `logging` package and is configured to log to a file |
-https_proxy | string | None | configure the package to use an HTTP/HTTPS (e.g. http://user:passowrd@myproxy.com:3128)
+| Parameter Name    | Type   | Default | Comment                                                                                                                                                                                                                                                                   |
+|-------------------|--------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| email             | str    | None    | used if login/password is used. Can be defined later                                                                                                                                                                                                                      |
+| password          | str    | None    | used if login/password is used. Can be defined later                                                                                                                                                                                                                      |
+| apitoken          | str    | None    | used if API Token is used. Can de defined later                                                                                                                                                                                                                           |
+| host              | str    | None    | Mist Cloud to reach (e.g. "api.mist.com"). Can de defined later                                                                                                                                                                                                           |
+| env_file          | str    | None    | path to the env file to load. See README.md for allowed variables                                                                                                                                                                                                         |
+| console_log_level | int    | 20      | The minimum log level to display on the console, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical)                                                                                                                    |
+| logging_log_level | int    | 10      | The minimum log level to log on the file, using `logging` schema (0 = Disabled, 10 = Debug, 20 = Info, 30 = Warning, 40 = Error, 50 = Critical). This is only used when the script calling `mistapi` is using Python `logging` package and is configured to log to a file |
+| https_proxy       | string | None    | configure the package to use an HTTP/HTTPS (e.g. http://user:passowrd@myproxy.com:3128)                                                                                                                                                                                   |
 
 ### 2. `login()` function must be called to validate the authentication. 
 
-#### 2.1. If the env file is provided and all the required information are valid, the session is validated:
+#### 2.1. If the env file is provided and all the required information is valid, the session is validated:
 ```python3
 >>> import mistapi
 >>> apisession = mistapi.APISession(env_file="~/.mist_env")
@@ -147,7 +147,7 @@ Welcome Thomas Munzer!
 [{'model': 'AP41', 'type': 'ap', 'ap_type': 'aph', 'description': 'AP-41', 'display': 'AP41', 'has_wifi_band5': True, 'has_wifi_band24': True, 'has_scanning_radio': True, 'has_usb': True, 'has_vble': True, 'vble': {'power': 8, 'beacon_rate': 4, 'beams': 8}, 'band24': {'max_clients': 128, 'max_power': 19, 'min_power': 8}, 'fcc_dfs_ok': ...
 ```
 
-## Usefull functions
+## Useful functions
 * easily find an Org Id from the current account with `mistapi.cli.select_org(apisession)`
 ```python3
 >>> mistapi.cli.select_org(apisession)
@@ -175,7 +175,9 @@ Select a Site (0 to 6, or q to exit): 0
 ```
 
 * get the next page or all the pages from a request
-For some requests, the Mist Cloud is using pagination to limit the size of the response. The required information the find the next page can either in the HTTP header (headers `X-Page-Total`, `X-Page-Limit` and `X-Page-Page`) or with the `next` key in the json document. To make it easier to request the next page or all the pages, the `mistapi` package is prossessing the response to extract or generate the URI to retrieve the next page.
+For some requests, the Mist Cloud is using pagination to limit the size of the response. 
+The required information the find the next page can either in the HTTP header (headers `X-Page-Total`, `X-Page-Limit` and `X-Page-Page`) or with the `next` key in the JSON document.
+To make it easier to request the next page or all the pages, the `mistapi` package  is possessing the response to extract or generate the URI to retrieve the next page.
 ```python3
 >>> response = mistapi.api.v1.orgs.clients.searchOrgClientsEvents(apisession, my_org_id, duration="1d")
 >>> len(response.data["results"])
@@ -197,7 +199,8 @@ To get the next page, use the `mistapi.get_next()` function. The returned respon
 >>> len(response_2.data["results"])
 100
 ```
-To retrieve all the pages, use the `mistapi.get_all()` function. The returned response will be a list with the concatained data from all the Mist responses:
+To retrieve all the pages, use the `mistapi.get_all()` function.
+The returned response will be a list with all the data from all the Mist responses:
 ```python3
 >>> response = mistapi.api.v1.orgs.clients.searchOrgClientsEvents(apisession, my_org_id, duration="1d")
 >>> len(response.data["results"])

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mistapi"
-version = "0.54.2"
+version = "0.54.4"
 authors = [{name="Thomas Munzer", email="tmunzer@juniper.net"}]
 description = "Python package to simplify the Mist System APIs usage"
 keywords = ["Mist", "Juniper", "API"]

requirements-dev.txt

@@ -5,3 +5,4 @@ deprecation
 urllib3>=2.2.2 # not directly required, pinned by Snyk to avoid a vulnerability
 twine
 build
+pyyaml

src/mistapi/__api_session.py

@@ -34,6 +34,7 @@
     {"short": "Global 02", "host": "api.gc1.mist.com", "cookies_ext": ".gc1"},
     {"short": "Global 03", "host": "api.ac2.mist.com", "cookies_ext": ".ac2"},
     {"short": "Global 04", "host": "api.gc2.mist.com", "cookies_ext": ".gc2"},
+    {"short": "Global 05", "host": "api.gc4.mist.com", "cookies_ext": ".gc4"},
 ]
 
 #### PARAMETERS #####

src/mistapi/__version.py

@@ -1,2 +1,2 @@
-__version__ = "0.54.2"
+__version__ = "0.54.4"
 __author__ = "Thomas Munzer <tmunzer@juniper.net>"

src/mistapi/api/v1/const/__init__.py

@@ -21,6 +21,7 @@
 from mistapi.api.v1.const import default_gateway_config
 from mistapi.api.v1.const import device_events
 from mistapi.api.v1.const import device_models
+from mistapi.api.v1.const import fingerprint_types
 from mistapi.api.v1.const import gateway_applications
 from mistapi.api.v1.const import insight_metrics
 from mistapi.api.v1.const import languages

src/mistapi/api/v1/installer/orgs/devices.py

@@ -14,9 +14,9 @@
 from mistapi.__api_response import APIResponse as _APIResponse
 import deprecation
 
-def listInstallerListOfRenctlyClaimedDevices(mist_session:_APISession, org_id:str, model:str=None, site_name:str=None, site_id:str=None, limit:int=100, page:int=1) -> _APIResponse:
+def listInstallerListOfRecentlyClaimedDevices(mist_session:_APISession, org_id:str, model:str=None, site_name:str=None, site_id:str=None, limit:int=100, page:int=1) -> _APIResponse:
     """
-    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/list-installer-list-of-renctly-claimed-devices
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/list-installer-list-of-recently-claimed-devices
     
     PARAMS
     -----------

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

@@ -12,6 +12,7 @@
 
 from mistapi.api.v1.orgs import orgs
 from mistapi.api.v1.orgs import ssr
+from mistapi.api.v1.orgs import aamwprofiles
 from mistapi.api.v1.orgs import admins
 from mistapi.api.v1.orgs import alarms
 from mistapi.api.v1.orgs import alarmtemplates

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

@@ -106,7 +106,7 @@ def countOrgAlarms(mist_session:_APISession, org_id:str, distinct:str=None, star
     resp = mist_session.mist_get(uri=uri, query=query_params)
     return resp
 
-def searchOrgAlarms(mist_session:_APISession, org_id:str, site_id:str=None, type:str=None, start:int=None, end:int=None, duration:str="1d", limit:int=100) -> _APIResponse:
+def searchOrgAlarms(mist_session:_APISession, org_id:str, site_id:str=None, type:str=None, status:str=None, start:int=None, end:int=None, duration:str="1d", limit:int=100) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/search-org-alarms
     
@@ -123,6 +123,7 @@ def searchOrgAlarms(mist_session:_APISession, org_id:str, site_id:str=None, type
     ------------
     site_id : str
     type : str
+    status : str
     start : int
     end : int
     duration : str, default: 1d
@@ -137,6 +138,7 @@ def searchOrgAlarms(mist_session:_APISession, org_id:str, site_id:str=None, type
     query_params={}
     if site_id: query_params["site_id"]=site_id
     if type: query_params["type"]=type
+    if status: query_params["status"]=status
     if start: query_params["start"]=start
     if end: query_params["end"]=end
     if duration: query_params["duration"]=duration
@@ -171,9 +173,9 @@ def unackOrgMultipleAlarms(mist_session:_APISession, org_id:str, body:object) ->
     resp = mist_session.mist_post(uri=uri, body=body)
     return resp
 
-def unackOrgAllArlarms(mist_session:_APISession, org_id:str, body:object) -> _APIResponse:
+def unackOrgAllAlarms(mist_session:_APISession, org_id:str, body:object) -> _APIResponse:
     """
-    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/unack-org-all-arlarms
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/unack-org-all-alarms
     
     PARAMS
     -----------

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

@@ -71,7 +71,7 @@ def createOrgAntivirusProfile(mist_session:_APISession, org_id:str, body:object)
     resp = mist_session.mist_post(uri=uri, body=body)
     return resp
 
-def getOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_id:str) -> _APIResponse:
+def getOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofile_id:str) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/get-org-antivirus-profile
     
@@ -83,19 +83,19 @@ def getOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_id:s
     PATH PARAMS
     -----------
     org_id : str
-    avprofiles_id : str        
+    avprofile_id : str        
     
     RETURN
     -----------
     mistapi.APIResponse
         response from the API call
     """
-    uri = f"/api/v1/orgs/{org_id}/avprofiles/{avprofiles_id}"
+    uri = f"/api/v1/orgs/{org_id}/avprofiles/{avprofile_id}"
     query_params={}
     resp = mist_session.mist_get(uri=uri, query=query_params)
     return resp
 
-def deleteOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_id:str) -> _APIResponse:
+def deleteOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofile_id:str) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/delete-org-antivirus-profile
     
@@ -107,19 +107,19 @@ def deleteOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_i
     PATH PARAMS
     -----------
     org_id : str
-    avprofiles_id : str        
+    avprofile_id : str        
     
     RETURN
     -----------
     mistapi.APIResponse
         response from the API call
     """
-    uri = f"/api/v1/orgs/{org_id}/avprofiles/{avprofiles_id}"
+    uri = f"/api/v1/orgs/{org_id}/avprofiles/{avprofile_id}"
     query_params={}
     resp = mist_session.mist_delete(uri=uri, query=query_params)
     return resp
 
-def updateOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_id:str, body:object) -> _APIResponse:
+def updateOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofile_id:str, body:object) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/update-org-antivirus-profile
     
@@ -131,7 +131,7 @@ def updateOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_i
     PATH PARAMS
     -----------
     org_id : str
-    avprofiles_id : str        
+    avprofile_id : str        
     
     BODY PARAMS
     -----------
@@ -143,7 +143,7 @@ def updateOrgAntivirusProfile(mist_session:_APISession, org_id:str, avprofiles_i
     mistapi.APIResponse
         response from the API call
     """
-    uri = f"/api/v1/orgs/{org_id}/avprofiles/{avprofiles_id}"
+    uri = f"/api/v1/orgs/{org_id}/avprofiles/{avprofile_id}"
     resp = mist_session.mist_put(uri=uri, body=body)
     return resp