updated w/ release 1.1.0b2

Author: Shiyue Cheng

meraki/__init__.py

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

meraki/aio/api/appliance.py

@@ -21,7 +21,7 @@ def getDeviceApplianceDhcpSubnets(self, serial: str):
 
     def getDeviceAppliancePerformance(self, serial: str):
         """
-        **Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned.**
+        **Return the performance score for a single MX**
         https://developer.cisco.com/meraki/api-v1/#!get-device-appliance-performance
 
         - serial (string): (required)
@@ -37,7 +37,7 @@ def getDeviceAppliancePerformance(self, serial: str):
 
     def getNetworkApplianceClientSecurityEvents(self, networkId: str, clientId: str, total_pages=1, direction='next', **kwargs):
         """
-        **List the security events for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **List the security events for a client**
         https://developer.cisco.com/meraki/api-v1/#!get-network-appliance-client-security-events
 
         - networkId (string): (required)
@@ -986,11 +986,7 @@ def updateNetworkApplianceTrafficShapingRules(self, networkId: str, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-traffic-shaping-rules
 
         - networkId (string): (required)
-        - defaultRulesEnabled (boolean):     Whether default traffic shaping rules are enabled (true) or disabled (false).
-    There are 4 default rules, which can
-    be seen on your network's traffic shaping page. Note that default rules
-    count against the rule limit of 8.
-
+        - defaultRulesEnabled (boolean): Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
         - rules (array):     An array of traffic shaping rules. Rules are applied in the order that
     they are specified in. An empty list (or null) means no rules. Note that
     you are allowed a maximum of 8 rules.
@@ -1270,7 +1266,7 @@ def deleteNetworkApplianceVlan(self, networkId: str, vlanId: str):
 
     def getNetworkApplianceVpnSiteToSiteVpn(self, networkId: str):
         """
-        **Return the site-to-site VPN settings of a network. Only valid for MX networks.**
+        **Return the site-to-site VPN settings of a network**
         https://developer.cisco.com/meraki/api-v1/#!get-network-appliance-vpn-site-to-site-vpn
 
         - networkId (string): (required)
@@ -1286,7 +1282,7 @@ def getNetworkApplianceVpnSiteToSiteVpn(self, networkId: str):
 
     def updateNetworkApplianceVpnSiteToSiteVpn(self, networkId: str, mode: str, **kwargs):
         """
-        **Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.**
+        **Update the site-to-site VPN settings of a network**
         https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-vpn-site-to-site-vpn
 
         - networkId (string): (required)

meraki/aio/api/camera.py

@@ -294,7 +294,7 @@ def updateDeviceCameraVideoSettings(self, serial: str, **kwargs):
 
     def getDeviceCameraVideoLink(self, serial: str, **kwargs):
         """
-        **Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.**
+        **Returns video link to the specified camera**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-video-link
 
         - serial (string): (required)

meraki/aio/api/devices.py

@@ -75,7 +75,7 @@ def blinkDeviceLeds(self, serial: str, **kwargs):
 
     def getDeviceClients(self, serial: str, **kwargs):
         """
-        **List the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is returned; otherwise the switchport field is null.**
+        **List the clients of a device, up to a maximum of a month ago**
         https://developer.cisco.com/meraki/api-v1/#!get-device-clients
 
         - serial (string): (required)

meraki/aio/api/insight.py

@@ -5,7 +5,7 @@ def __init__(self, session):
 
     def getOrganizationInsightMonitoredMediaServers(self, organizationId: str):
         """
-        **List the monitored media servers for this organization. Only valid for organizations with Meraki Insight.**
+        **List the monitored media servers for this organization**
         https://developer.cisco.com/meraki/api-v1/#!get-organization-insight-monitored-media-servers
 
         - organizationId (string): (required)
@@ -19,32 +19,33 @@ def getOrganizationInsightMonitoredMediaServers(self, organizationId: str):
 
         return self._session.get(metadata, resource)
 
-    def createOrganizationInsightMonitoredMediaServer(self, organizationId: str, name: str, address: str):
+    def createOrganizationInsightMonitoredMediaServer(self, organizationId: str, name: str, address: str, **kwargs):
         """
-        **Add a media server to be monitored for this organization. Only valid for organizations with Meraki Insight.**
+        **Add a media server to be monitored for this organization**
         https://developer.cisco.com/meraki/api-v1/#!create-organization-insight-monitored-media-server
 
         - organizationId (string): (required)
         - name (string): The name of the VoIP provider
         - address (string): The IP address (IPv4 only) or hostname of the media server to monitor
+        - bestEffortMonitoringEnabled (boolean): Indicates that if the media server doesn't respond to ICMP pings, the nearest hop will be used in its stead.
         """
 
-        kwargs = locals()
+        kwargs.update(locals())
 
         metadata = {
             'tags': ['insight', 'configure', 'monitoredMediaServers'],
             'operation': 'createOrganizationInsightMonitoredMediaServer'
         }
         resource = f'/organizations/{organizationId}/insight/monitoredMediaServers'
 
-        body_params = ['name', 'address', ]
+        body_params = ['name', 'address', 'bestEffortMonitoringEnabled', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.post(metadata, resource, payload)
 
     def getOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str):
         """
-        **Return a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
+        **Return a monitored media server for this organization**
         https://developer.cisco.com/meraki/api-v1/#!get-organization-insight-monitored-media-server
 
         - organizationId (string): (required)
@@ -61,13 +62,14 @@ def getOrganizationInsightMonitoredMediaServer(self, organizationId: str, monito
 
     def updateOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str, **kwargs):
         """
-        **Update a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
+        **Update a monitored media server for this organization**
         https://developer.cisco.com/meraki/api-v1/#!update-organization-insight-monitored-media-server
 
         - organizationId (string): (required)
         - monitoredMediaServerId (string): (required)
         - name (string): The name of the VoIP provider
         - address (string): The IP address (IPv4 only) or hostname of the media server to monitor
+        - bestEffortMonitoringEnabled (boolean): Indicates that if the media server doesn't respond to ICMP pings, the nearest hop will be used in its stead.
         """
 
         kwargs.update(locals())
@@ -78,14 +80,14 @@ def updateOrganizationInsightMonitoredMediaServer(self, organizationId: str, mon
         }
         resource = f'/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}'
 
-        body_params = ['name', 'address', ]
+        body_params = ['name', 'address', 'bestEffortMonitoringEnabled', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
 
     def deleteOrganizationInsightMonitoredMediaServer(self, organizationId: str, monitoredMediaServerId: str):
         """
-        **Delete a monitored media server from this organization. Only valid for organizations with Meraki Insight.**
+        **Delete a monitored media server from this organization**
         https://developer.cisco.com/meraki/api-v1/#!delete-organization-insight-monitored-media-server
 
         - organizationId (string): (required)

meraki/aio/api/networks.py

@@ -153,7 +153,7 @@ def getNetworkBluetoothClients(self, networkId: str, total_pages=1, direction='n
 
     def getNetworkBluetoothClient(self, networkId: str, bluetoothClientId: str, **kwargs):
         """
-        **Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.**
+        **Return a Bluetooth client**
         https://developer.cisco.com/meraki/api-v1/#!get-network-bluetooth-client
 
         - networkId (string): (required)
@@ -205,7 +205,7 @@ def getNetworkClients(self, networkId: str, total_pages=1, direction='next', **k
 
     def provisionNetworkClients(self, networkId: str, clients: list, devicePolicy: str, **kwargs):
         """
-        **Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.**
+        **Provisions a client with a name and policy**
         https://developer.cisco.com/meraki/api-v1/#!provision-network-clients
 
         - networkId (string): (required)
@@ -235,7 +235,7 @@ def provisionNetworkClients(self, networkId: str, clients: list, devicePolicy: s
 
     def getNetworkClient(self, networkId: str, clientId: str):
         """
-        **Return the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Return the client associated with the given identifier**
         https://developer.cisco.com/meraki/api-v1/#!get-network-client
 
         - networkId (string): (required)
@@ -252,7 +252,7 @@ def getNetworkClient(self, networkId: str, clientId: str):
 
     def getNetworkClientPolicy(self, networkId: str, clientId: str):
         """
-        **Return the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Return the policy assigned to a client on the network**
         https://developer.cisco.com/meraki/api-v1/#!get-network-client-policy
 
         - networkId (string): (required)
@@ -269,7 +269,7 @@ def getNetworkClientPolicy(self, networkId: str, clientId: str):
 
     def updateNetworkClientPolicy(self, networkId: str, clientId: str, devicePolicy: str, **kwargs):
         """
-        **Update the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Update the policy assigned to a client on the network**
         https://developer.cisco.com/meraki/api-v1/#!update-network-client-policy
 
         - networkId (string): (required)
@@ -293,7 +293,7 @@ def updateNetworkClientPolicy(self, networkId: str, clientId: str, devicePolicy:
 
     def getNetworkClientSplashAuthorizationStatus(self, networkId: str, clientId: str):
         """
-        **Return the splash authorization for a client, for each SSID they've associated with through splash. Only enabled SSIDs with Click-through splash enabled will be included. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Return the splash authorization for a client, for each SSID they've associated with through splash**
         https://developer.cisco.com/meraki/api-v1/#!get-network-client-splash-authorization-status
 
         - networkId (string): (required)
@@ -310,7 +310,7 @@ def getNetworkClientSplashAuthorizationStatus(self, networkId: str, clientId: st
 
     def updateNetworkClientSplashAuthorizationStatus(self, networkId: str, clientId: str, ssids: dict):
         """
-        **Update a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Update a client's splash authorization**
         https://developer.cisco.com/meraki/api-v1/#!update-network-client-splash-authorization-status
 
         - networkId (string): (required)
@@ -333,7 +333,7 @@ def updateNetworkClientSplashAuthorizationStatus(self, networkId: str, clientId:
 
     def getNetworkClientTrafficHistory(self, networkId: str, clientId: str, total_pages=1, direction='next', **kwargs):
         """
-        **Return the client's network traffic data over time. Usage data is in kilobytes. This endpoint requires detailed traffic analysis to be enabled on the Network-wide > General page. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Return the client's network traffic data over time**
         https://developer.cisco.com/meraki/api-v1/#!get-network-client-traffic-history
 
         - networkId (string): (required)
@@ -360,7 +360,7 @@ def getNetworkClientTrafficHistory(self, networkId: str, clientId: str, total_pa
 
     def getNetworkClientUsageHistory(self, networkId: str, clientId: str):
         """
-        **Return the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
+        **Return the client's daily usage history**
         https://developer.cisco.com/meraki/api-v1/#!get-network-client-usage-history
 
         - networkId (string): (required)
@@ -1040,7 +1040,7 @@ def getNetworkNetworkHealthChannelUtilization(self, networkId: str, total_pages=
 
     def getNetworkPiiPiiKeys(self, networkId: str, **kwargs):
         """
-        **List the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the organization contains org-wide Systems Manager users matching the key provided then there will be an entry with the key "0" containing the applicable keys.**
+        **List the keys required to access Personally Identifiable Information (PII) for a given identifier**
         https://developer.cisco.com/meraki/api-v1/#!get-network-pii-pii-keys
 
         - networkId (string): (required)
@@ -1149,7 +1149,7 @@ def deleteNetworkPiiRequest(self, networkId: str, requestId: str):
 
     def getNetworkPiiSmDevicesForKey(self, networkId: str, **kwargs):
         """
-        **Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be used with the Systems Manager API endpoints to retrieve device details. Exactly one identifier will be accepted.**
+        **Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier**
         https://developer.cisco.com/meraki/api-v1/#!get-network-pii-sm-devices-for-key
 
         - networkId (string): (required)
@@ -1176,7 +1176,7 @@ def getNetworkPiiSmDevicesForKey(self, networkId: str, **kwargs):
 
     def getNetworkPiiSmOwnersForKey(self, networkId: str, **kwargs):
         """
-        **Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be used with the Systems Manager API endpoints to retrieve owner details. Exactly one identifier will be accepted.**
+        **Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier**
         https://developer.cisco.com/meraki/api-v1/#!get-network-pii-sm-owners-for-key
 
         - networkId (string): (required)
@@ -1368,17 +1368,13 @@ def updateNetworkSyslogServers(self, networkId: str, servers: list):
 
     def getNetworkTraffic(self, networkId: str, **kwargs):
         """
-        **    The traffic analysis data for this network.
-    <a href="https://documentation.meraki.com/MR/Monitoring_and_Reporting/Hostname_Visibility">Traffic Analysis with Hostname Visibility</a> must be enabled on the network.
-**
+        **Return the traffic analysis data for this network**
         https://developer.cisco.com/meraki/api-v1/#!get-network-traffic
 
         - networkId (string): (required)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 30 days from today.
         - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days.
-        - deviceType (string):     Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'.
-    When using 'combined', for each rule the data will come from the device type with the most usage.
-
+        - deviceType (string): Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage.
         """
 
         kwargs.update(locals())