Dashboard API v1 release

Author: Shiyue Cheng

meraki_v1/__init__.py meraki/__init__.pymeraki_v1/__init__.py renamed to meraki/__init__.py

@@ -20,7 +20,7 @@
     SUPPRESS_LOGGING, SIMULATE_API_CALLS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
-__version__ = '1.0.0b15'
+__version__ = '1.0.0'
 
 class DashboardAPI(object):
     """

meraki_v1/aio/__init__.py meraki/aio/__init__.pymeraki_v1/aio/__init__.py renamed to meraki/aio/__init__.py

@@ -44,7 +44,7 @@ def getNetworkApplianceClientSecurityEvents(self, networkId: str, clientId: str,
         - clientId (string): (required)
         - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" (default) or "prev" page
-        - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 791 days from today.
+        - t0 (string): The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today.
         - t1 (string): The end of the timespan for the data. t1 can be a maximum of 791 days after t0.
         - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 31 days.
         - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.
@@ -583,7 +583,7 @@ def getNetworkApplianceSecurityEvents(self, networkId: str, total_pages=1, direc
         - networkId (string): (required)
         - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" (default) or "prev" page
-        - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
+        - t0 (string): The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today.
         - t1 (string): The end of the timespan for the data. t1 can be a maximum of 365 days after t0.
         - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days.
         - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.
@@ -1340,7 +1340,7 @@ def getOrganizationApplianceSecurityEvents(self, organizationId: str, total_page
         - organizationId (string): (required)
         - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" (default) or "prev" page
-        - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
+        - t0 (string): The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today.
         - t1 (string): The end of the timespan for the data. t1 can be a maximum of 365 days after t0.
         - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days.
         - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.
@@ -1382,13 +1382,13 @@ def getOrganizationApplianceSecurityIntrusion(self, organizationId: str):
 
         return self._session.get(metadata, resource)
 
-    def updateOrganizationApplianceSecurityIntrusion(self, organizationId: str, whitelistedRules: list):
+    def updateOrganizationApplianceSecurityIntrusion(self, organizationId: str, allowedRules: list):
         """
         **Sets supported intrusion settings for an organization**
         https://developer.cisco.com/meraki/api-v1/#!update-organization-appliance-security-intrusion
 
         - organizationId (string): (required)
-        - whitelistedRules (array): Sets a list of specific SNORT® signatures to whitelist
+        - allowedRules (array): Sets a list of specific SNORT® signatures to allow
         """
 
         kwargs = locals()
@@ -1399,11 +1399,37 @@ def updateOrganizationApplianceSecurityIntrusion(self, organizationId: str, whit
         }
         resource = f'/organizations/{organizationId}/appliance/security/intrusion'
 
-        body_params = ['whitelistedRules', ]
+        body_params = ['allowedRules', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
 
+    def getOrganizationApplianceUplinkStatuses(self, organizationId: str, total_pages=1, direction='next', **kwargs):
+        """
+        **List the uplink status of every Meraki MX and Z series appliances in the organization**
+        https://developer.cisco.com/meraki/api-v1/#!get-organization-appliance-uplink-statuses
+
+        - organizationId (string): (required)
+        - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
+        - direction (string): direction to paginate, either "next" (default) or "prev" page
+        - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
+        - startingAfter (string): A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
+        - endingBefore (string): A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
+        """
+
+        kwargs.update(locals())
+
+        metadata = {
+            'tags': ['appliance', 'monitor', 'uplink', 'statuses'],
+            'operation': 'getOrganizationApplianceUplinkStatuses'
+        }
+        resource = f'/organizations/{organizationId}/appliance/uplink/statuses'
+
+        query_params = ['perPage', 'startingAfter', 'endingBefore', ]
+        params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
+
+        return self._session.get_pages(metadata, resource, params, total_pages, direction)
+
     def getOrganizationApplianceVpnStats(self, organizationId: str, total_pages=1, direction='next', **kwargs):
         """
         **Show VPN history stat for networks in an organization**

meraki_v1/aio/api/__init__.py meraki/aio/api/__init__.pymeraki_v1/aio/api/__init__.py renamed to meraki/aio/api/__init__.py

@@ -3,22 +3,6 @@ def __init__(self, session):
         super().__init__()
         self._session = session
 
-    def getNetworkClientsPolicies(self, networkID: str):
-        """
-        **List the client policies within a wireless network.**
-        https://developer.cisco.com/meraki/api-v1/#!get-network-clients-policies
-
-        - networkID (string): (required)
-        """
-
-        metadata = {
-            'tags': ['networks', 'configure', 'clients', 'policies'],
-            'operation': 'getNetworkClientsPolicies'
-        }
-        resource = f'/networks/{networkID}/clients/policies'
-
-        return self._session.get(metadata, resource)
-
     def getNetwork(self, networkId: str):
         """
         **Return a network**

meraki_v1/aio/api/appliance.py meraki/aio/api/appliance.pymeraki_v1/aio/api/appliance.py renamed to meraki/aio/api/appliance.py

@@ -251,13 +251,13 @@ def createOrganizationAdmin(self, organizationId: str, email: str, name: str, or
 
         return self._session.post(metadata, resource, payload)
 
-    def updateOrganizationAdmin(self, organizationId: str, id: str, **kwargs):
+    def updateOrganizationAdmin(self, organizationId: str, adminId: str, **kwargs):
         """
         **Update an administrator**
         https://developer.cisco.com/meraki/api-v1/#!update-organization-admin
 
         - organizationId (string): (required)
-        - id (string): (required)
+        - adminId (string): (required)
         - name (string): The name of the dashboard administrator
         - orgAccess (string): The privilege of the dashboard administrator on the organization. Can be one of 'full', 'read-only', 'enterprise' or 'none'
         - tags (array): The list of tags that the dashboard administrator has privileges on
@@ -274,27 +274,27 @@ def updateOrganizationAdmin(self, organizationId: str, id: str, **kwargs):
             'tags': ['organizations', 'configure', 'admins'],
             'operation': 'updateOrganizationAdmin'
         }
-        resource = f'/organizations/{organizationId}/admins/{id}'
+        resource = f'/organizations/{organizationId}/admins/{adminId}'
 
         body_params = ['name', 'orgAccess', 'tags', 'networks', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
 
-    def deleteOrganizationAdmin(self, organizationId: str, id: str):
+    def deleteOrganizationAdmin(self, organizationId: str, adminId: str):
         """
         **Revoke all access for a dashboard administrator within this organization**
         https://developer.cisco.com/meraki/api-v1/#!delete-organization-admin
 
         - organizationId (string): (required)
-        - id (string): (required)
+        - adminId (string): (required)
         """
 
         metadata = {
             'tags': ['organizations', 'configure', 'admins'],
             'operation': 'deleteOrganizationAdmin'
         }
-        resource = f'/organizations/{organizationId}/admins/{id}'
+        resource = f'/organizations/{organizationId}/admins/{adminId}'
 
         return self._session.delete(metadata, resource)
 
@@ -1231,20 +1231,24 @@ def getOrganizationSamlRoles(self, organizationId: str):
 
         return self._session.get(metadata, resource)
 
-    def createOrganizationSamlRole(self, organizationId: str, **kwargs):
+    def createOrganizationSamlRole(self, organizationId: str, role: str, orgAccess: str, **kwargs):
         """
         **Create a SAML role**
         https://developer.cisco.com/meraki/api-v1/#!create-organization-saml-role
 
         - organizationId (string): (required)
         - role (string): The role of the SAML administrator
-        - orgAccess (string): The privilege of the SAML administrator on the organization
+        - orgAccess (string): The privilege of the SAML administrator on the organization. Can be one of 'none', 'read-only' or 'full'
         - tags (array): The list of tags that the SAML administrator has privleges on
         - networks (array): The list of networks that the SAML administrator has privileges on
         """
 
         kwargs.update(locals())
 
+        if 'orgAccess' in kwargs:
+            options = ['none', 'read-only', 'full']
+            assert kwargs['orgAccess'] in options, f'''"orgAccess" cannot be "{kwargs['orgAccess']}", & must be set to one of: {options}'''
+
         metadata = {
             'tags': ['organizations', 'configure', 'samlRoles'],
             'operation': 'createOrganizationSamlRole'
@@ -1281,13 +1285,17 @@ def updateOrganizationSamlRole(self, organizationId: str, samlRoleId: str, **kwa
         - organizationId (string): (required)
         - samlRoleId (string): (required)
         - role (string): The role of the SAML administrator
-        - orgAccess (string): The privilege of the SAML administrator on the organization
+        - orgAccess (string): The privilege of the SAML administrator on the organization. Can be one of 'none', 'read-only' or 'full'
         - tags (array): The list of tags that the SAML administrator has privleges on
         - networks (array): The list of networks that the SAML administrator has privileges on
         """
 
         kwargs.update(locals())
 
+        if 'orgAccess' in kwargs:
+            options = ['none', 'read-only', 'full']
+            assert kwargs['orgAccess'] in options, f'''"orgAccess" cannot be "{kwargs['orgAccess']}", & must be set to one of: {options}'''
+
         metadata = {
             'tags': ['organizations', 'configure', 'samlRoles'],
             'operation': 'updateOrganizationSamlRole'