Updating for v1.12.0

Author: TKIPisalegacycipher

meraki/__init__.py

@@ -25,7 +25,7 @@
     SUPPRESS_LOGGING, SIMULATE_API_CALLS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
-__version__ = '1.10.0'
+__version__ = '1.12.0'
 
 
 class DashboardAPI(object):

meraki/aio/api/appliance.py

@@ -1234,6 +1234,33 @@ def updateNetworkApplianceTrafficShapingUplinkSelection(self, networkId: str, **
 
 
 
+    def getNetworkApplianceUplinksUsageHistory(self, networkId: str, **kwargs):
+        """
+        **Get the sent and received bytes for each uplink of a network.**
+        https://developer.cisco.com/meraki/api-v1/#!get-network-appliance-uplinks-usage-history
+
+        - networkId (string): (required)
+        - t0 (string): The beginning of the timespan for the data. 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 14 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 14 days. The default is 10 minutes.
+        - resolution (integer): The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 600, 1800, 3600, 86400. The default is 60.
+        """
+
+        kwargs.update(locals())
+
+        metadata = {
+            'tags': ['appliance', 'monitor', 'uplinks', 'usageHistory'],
+            'operation': 'getNetworkApplianceUplinksUsageHistory'
+        }
+        resource = f'/networks/{networkId}/appliance/uplinks/usageHistory'
+
+        query_params = ['t0', 't1', 'timespan', 'resolution', ]
+        params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
+
+        return self._session.get(metadata, resource, params)
+        
+
+
     def getNetworkApplianceVlans(self, networkId: str):
         """
         **List the VLANs for an MX network**

meraki/aio/api/camera.py

@@ -185,7 +185,7 @@ def updateDeviceCameraQualityAndRetention(self, serial: str, **kwargs):
         - profileId (string): The ID of a quality and retention profile to assign to the camera. The profile's settings will override all of the per-camera quality and retention settings. If the value of this parameter is null, any existing profile will be unassigned from the camera.
         - motionBasedRetentionEnabled (boolean): Boolean indicating if motion-based retention is enabled(true) or disabled(false) on the camera.
         - audioRecordingEnabled (boolean): Boolean indicating if audio recording is enabled(true) or disabled(false) on the camera
-        - restrictedBandwidthModeEnabled (boolean): Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera
+        - restrictedBandwidthModeEnabled (boolean): Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera. This setting does not apply to MV2 cameras.
         - quality (string): Quality of the camera. Can be one of 'Standard', 'High' or 'Enhanced'. Not all qualities are supported by every camera model.
         - resolution (string): Resolution of the camera. Can be one of '1280x720', '1920x1080', '1080x1080' or '2058x2058'. Not all resolutions are supported by every camera model.
         - motionDetectorVersion (integer): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
@@ -412,8 +412,8 @@ def createNetworkCameraQualityRetentionProfile(self, networkId: str, name: str,
 
         - networkId (string): (required)
         - name (string): The name of the new profile. Must be unique. This parameter is required.
-        - motionBasedRetentionEnabled (boolean): Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false.
-        - restrictedBandwidthModeEnabled (boolean): Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false.
+        - motionBasedRetentionEnabled (boolean): Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras.
+        - restrictedBandwidthModeEnabled (boolean): Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras.
         - audioRecordingEnabled (boolean): Whether or not to record audio. Can be either true or false. Defaults to false.
         - cloudArchiveEnabled (boolean): Create redundant video backup using Cloud Archive. Can be either true or false. Defaults to false.
         - motionDetectorVersion (integer): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
@@ -464,8 +464,8 @@ def updateNetworkCameraQualityRetentionProfile(self, networkId: str, qualityRete
         - networkId (string): (required)
         - qualityRetentionProfileId (string): (required)
         - name (string): The name of the new profile. Must be unique.
-        - motionBasedRetentionEnabled (boolean): Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false.
-        - restrictedBandwidthModeEnabled (boolean): Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false.
+        - motionBasedRetentionEnabled (boolean): Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras.
+        - restrictedBandwidthModeEnabled (boolean): Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras.
         - audioRecordingEnabled (boolean): Whether or not to record audio. Can be either true or false. Defaults to false.
         - cloudArchiveEnabled (boolean): Create redundant video backup using Cloud Archive. Can be either true or false. Defaults to false.
         - motionDetectorVersion (integer): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.

meraki/aio/api/insight.py

@@ -5,13 +5,13 @@ def __init__(self, session):
 
 
 
-    def getNetworkInsightApplicationHealthByTime(self, network_id: str, application_id: str, **kwargs):
+    def getNetworkInsightApplicationHealthByTime(self, networkId: str, applicationId: str, **kwargs):
         """
         **Get application health by time**
         https://developer.cisco.com/meraki/api-v1/#!get-network-insight-application-health-by-time
 
-        - network_id (string): (required)
-        - application_id (string): (required)
+        - networkId (string): (required)
+        - applicationId (string): (required)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 7 days from today.
         - t1 (string): The end of the timespan for the data. t1 can be a maximum of 7 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 7 days. The default is 2 hours.
@@ -24,7 +24,7 @@ def getNetworkInsightApplicationHealthByTime(self, network_id: str, application_
             'tags': ['insight', 'monitor', 'applications', 'healthByTime'],
             'operation': 'getNetworkInsightApplicationHealthByTime'
         }
-        resource = f'/networks/{network_id}/insight/applications/{application_id}/healthByTime'
+        resource = f'/networks/{networkId}/insight/applications/{applicationId}/healthByTime'
 
         query_params = ['t0', 't1', 'timespan', 'resolution', ]
         params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
@@ -33,6 +33,24 @@ def getNetworkInsightApplicationHealthByTime(self, network_id: str, application_
 
 
 
+    def getOrganizationInsightApplications(self, organizationId: str):
+        """
+        **List all Insight tracked applications**
+        https://developer.cisco.com/meraki/api-v1/#!get-organization-insight-applications
+
+        - organizationId (string): (required)
+        """
+
+        metadata = {
+            'tags': ['insight', 'configure', 'applications'],
+            'operation': 'getOrganizationInsightApplications'
+        }
+        resource = f'/organizations/{organizationId}/insight/applications'
+
+        return self._session.get(metadata, resource)
+        
+
+
     def getOrganizationInsightMonitoredMediaServers(self, organizationId: str):
         """
         **List the monitored media servers for this organization**
@@ -140,21 +158,3 @@ def deleteOrganizationInsightMonitoredMediaServer(self, organizationId: str, mon
 
         return self._session.delete(metadata, resource)
 
-
-
-    def getOrganizationInsightApplications(self, organization_id: str):
-        """
-        **List all Insight tracked applications**
-        https://developer.cisco.com/meraki/api-v1/#!get-organization-insight-applications
-
-        - organization_id (string): (required)
-        """
-
-        metadata = {
-            'tags': ['insight', 'configure', 'applications'],
-            'operation': 'getOrganizationInsightApplications'
-        }
-        resource = f'/organizations/{organization_id}/insight/applications'
-
-        return self._session.get(metadata, resource)
-        

meraki/aio/api/networks.py

@@ -207,6 +207,14 @@ def getNetworkClients(self, networkId: str, total_pages=1, direction='next', **k
         - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.
         - 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.
+        - statuses (array): Filters clients based on status. Can be one of 'Online' or 'Offline'.
+        - ip (string): Filters clients based on a partial or full match for the ip address field.
+        - ip6 (string): Filters clients based on a partial or full match for the ip6 address field.
+        - ip6Local (string): Filters clients based on a partial or full match for the ip6Local address field.
+        - mac (string): Filters clients based on a partial or full match for the mac address field.
+        - os (string): Filters clients based on a partial or full match for the os (operating system) field.
+        - description (string): Filters clients based on a partial or full match for the description field.
+        - recentDeviceConnections (array): Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'.
         """
 
         kwargs.update(locals())
@@ -217,9 +225,15 @@ def getNetworkClients(self, networkId: str, total_pages=1, direction='next', **k
         }
         resource = f'/networks/{networkId}/clients'
 
-        query_params = ['t0', 'timespan', 'perPage', 'startingAfter', 'endingBefore', ]
+        query_params = ['t0', 'timespan', 'perPage', 'startingAfter', 'endingBefore', 'statuses', 'ip', 'ip6', 'ip6Local', 'mac', 'os', 'description', 'recentDeviceConnections', ]
         params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
 
+        array_params = ['statuses', 'recentDeviceConnections', ]
+        for k, v in kwargs.items():
+            if k.strip() in array_params:
+                params[f'{k.strip()}[]'] = kwargs[f'{k}']
+                params.pop(k.strip())
+
         return self._session.get_pages(metadata, resource, params, total_pages, direction)
 
 
@@ -588,7 +602,7 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', even
         - 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" or "prev" (default) page
         - event_log_end_time (string): ISO8601 Zulu/UTC time, to use in conjunction with startingAfter, to retrieve events within a time window
-        - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental
+        - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
         - includedEventTypes (array): A list of event types. The returned events will be filtered to only include events with these types.
         - excludedEventTypes (array): A list of event types. The returned events will be filtered to exclude events with these types.
         - deviceMac (string): The MAC address of the Meraki device which the list of events will be filtered with
@@ -606,6 +620,10 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', even
 
         kwargs.update(locals())
 
+        if 'productType' in kwargs:
+            options = ['wireless', 'appliance', 'switch', 'systemsManager', 'camera', 'cellularGateway']
+            assert kwargs['productType'] in options, f'''"productType" cannot be "{kwargs['productType']}", & must be set to one of: {options}'''
+
         metadata = {
             'tags': ['networks', 'monitor', 'events'],
             'operation': 'getNetworkEvents'
@@ -1221,6 +1239,8 @@ def updateNetworkNetflow(self, networkId: str, **kwargs):
         - reportingEnabled (boolean): Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
         - collectorIp (string): The IPv4 address of the NetFlow collector.
         - collectorPort (integer): The port that the NetFlow collector will be listening on.
+        - etaEnabled (boolean): Boolean indicating whether Encrypted Traffic Analysis is enabled (true) or disabled (false).
+        - etaDstPort (integer): The port that the Encrypted Traffic Analysis collector will be listening on.
         """
 
         kwargs.update(locals())
@@ -1231,7 +1251,7 @@ def updateNetworkNetflow(self, networkId: str, **kwargs):
         }
         resource = f'/networks/{networkId}/netflow'
 
-        body_params = ['reportingEnabled', 'collectorIp', 'collectorPort', ]
+        body_params = ['reportingEnabled', 'collectorIp', 'collectorPort', 'etaEnabled', 'etaDstPort', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)