mistapi_python/src/mistapi/api/v1/const/states.py at 8250c604b7e6614f9fd053d4c754b355c1f9fb75 · tmunzer/mistapi_python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
"""
--------------------------------------------------------------------------------
------------------------- 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 listStates(mist_session: _APISession, country_code: str) -> _APIResponse:
    """
    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-states

    PARAMS
    -----------
    mistapi.APISession : mist_session
        mistapi session including authentication and Mist host information

    QUERY PARAMS
    ------------
    country_code : str
      Country code, in [two-character](/#operations/listCountryCodes)

    RETURN
    -----------
    mistapi.APIResponse
        response from the API call
    """

    uri = "/api/v1/const/states"
    query_params: dict[str, str] = {}
    if country_code:
        query_params["country_code"] = str(country_code)
    resp = mist_session.mist_get(uri=uri, query=query_params)
    return resp