updated w/ release 1.0.0b13

Author: Shiyue Cheng

meraki_v1/__init__.py

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

meraki_v1/aio/api/appliance.py

@@ -7,6 +7,7 @@ def getDeviceCameraAnalyticsLive(self, serial: str):
         """
         **Returns live state from camera of analytics zones**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-analytics-live
+
         - serial (string): (required)
         """
 
@@ -22,6 +23,7 @@ def getDeviceCameraAnalyticsOverview(self, serial: str, **kwargs):
         """
         **Returns an overview of aggregate analytics data for a timespan**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-analytics-overview
+
         - serial (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 7 days after t0.
@@ -50,6 +52,7 @@ def getDeviceCameraAnalyticsRecent(self, serial: str, **kwargs):
         """
         **Returns most recent record for analytics zones**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-analytics-recent
+
         - serial (string): (required)
         - objectType (string): [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].
         """
@@ -75,6 +78,7 @@ def getDeviceCameraAnalyticsZones(self, serial: str):
         """
         **Returns all configured analytic zones for this camera**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-analytics-zones
+
         - serial (string): (required)
         """
 
@@ -90,6 +94,7 @@ def getDeviceCameraAnalyticsZoneHistory(self, serial: str, zoneId: str, **kwargs
         """
         **Return historical records for analytic zones**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-analytics-zone-history
+
         - serial (string): (required)
         - zoneId (string): (required)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
@@ -120,6 +125,7 @@ def generateDeviceCameraSnapshot(self, serial: str, **kwargs):
         """
         **Generate a snapshot of what the camera sees at the specified time and return a link to that image.**
         https://developer.cisco.com/meraki/api-v1/#!generate-device-camera-snapshot
+
         - serial (string): (required)
         - timestamp (string): [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
         - fullframe (boolean): [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
@@ -142,6 +148,7 @@ def getDeviceCameraQualityAndRetention(self, serial: str):
         """
         **Returns quality and retention settings for the given camera**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-quality-and-retention
+
         - serial (string): (required)
         """
 
@@ -157,6 +164,7 @@ def updateDeviceCameraQualityAndRetention(self, serial: str, **kwargs):
         """
         **Update quality and retention settings for the given camera**
         https://developer.cisco.com/meraki/api-v1/#!update-device-camera-quality-and-retention
+
         - serial (string): (required)
         - 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
@@ -194,6 +202,7 @@ def getDeviceCameraSense(self, serial: str):
         """
         **Returns sense settings for a given camera**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-sense
+
         - serial (string): (required)
         """
 
@@ -209,6 +218,7 @@ def updateDeviceCameraSense(self, serial: str, **kwargs):
         """
         **Update sense settings for the given camera**
         https://developer.cisco.com/meraki/api-v1/#!update-device-camera-sense
+
         - serial (string): (required)
         - senseEnabled (boolean): Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
         - mqttBrokerId (string): The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
@@ -232,6 +242,7 @@ def getDeviceCameraSenseObjectDetectionModels(self, serial: str):
         """
         **Returns the MV Sense object detection model list for the given camera**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-sense-object-detection-models
+
         - serial (string): (required)
         """
 
@@ -247,6 +258,7 @@ def getDeviceCameraVideoSettings(self, serial: str):
         """
         **Returns video settings for the given camera**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-video-settings
+
         - serial (string): (required)
         """
 
@@ -262,6 +274,7 @@ def updateDeviceCameraVideoSettings(self, serial: str, **kwargs):
         """
         **Update video settings for the given camera**
         https://developer.cisco.com/meraki/api-v1/#!update-device-camera-video-settings
+
         - serial (string): (required)
         - externalRtspEnabled (boolean): Boolean indicating if external rtsp stream is exposed
         """
@@ -283,6 +296,7 @@ def getDeviceCameraVideoLink(self, serial: str, **kwargs):
         """
         **Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.**
         https://developer.cisco.com/meraki/api-v1/#!get-device-camera-video-link
+
         - serial (string): (required)
         - timestamp (string): [optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time.
         """
@@ -304,6 +318,7 @@ def getNetworkCameraQualityRetentionProfiles(self, networkId: str):
         """
         **List the quality retention profiles for this network**
         https://developer.cisco.com/meraki/api-v1/#!get-network-camera-quality-retention-profiles
+
         - networkId (string): (required)
         """
 
@@ -319,6 +334,7 @@ def createNetworkCameraQualityRetentionProfile(self, networkId: str, name: str,
         """
         **Creates new quality retention profile for this network.**
         https://developer.cisco.com/meraki/api-v1/#!create-network-camera-quality-retention-profile
+
         - 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.
@@ -348,6 +364,7 @@ def getNetworkCameraQualityRetentionProfile(self, networkId: str, qualityRetenti
         """
         **Retrieve a single quality retention profile**
         https://developer.cisco.com/meraki/api-v1/#!get-network-camera-quality-retention-profile
+
         - networkId (string): (required)
         - qualityRetentionProfileId (string): (required)
         """
@@ -364,6 +381,7 @@ def updateNetworkCameraQualityRetentionProfile(self, networkId: str, qualityRete
         """
         **Update an existing quality retention profile for this network.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-camera-quality-retention-profile
+
         - networkId (string): (required)
         - qualityRetentionProfileId (string): (required)
         - name (string): The name of the new profile. Must be unique.
@@ -394,6 +412,7 @@ def deleteNetworkCameraQualityRetentionProfile(self, networkId: str, qualityRete
         """
         **Delete an existing quality retention profile for this network.**
         https://developer.cisco.com/meraki/api-v1/#!delete-network-camera-quality-retention-profile
+
         - networkId (string): (required)
         - qualityRetentionProfileId (string): (required)
         """
@@ -410,6 +429,7 @@ def getNetworkCameraSchedules(self, networkId: str):
         """
         **Returns a list of all camera recording schedules.**
         https://developer.cisco.com/meraki/api-v1/#!get-network-camera-schedules
+
         - networkId (string): (required)
         """
 

meraki_v1/aio/api/camera.py

@@ -7,6 +7,7 @@ def getDeviceCellularGatewayLan(self, serial: str):
         """
         **Show the LAN Settings of a MG**
         https://developer.cisco.com/meraki/api-v1/#!get-device-cellular-gateway-lan
+
         - serial (string): (required)
         """
 
@@ -22,6 +23,7 @@ def updateDeviceCellularGatewayLan(self, serial: str, **kwargs):
         """
         **Update the LAN Settings for a single MG.**
         https://developer.cisco.com/meraki/api-v1/#!update-device-cellular-gateway-lan
+
         - serial (string): (required)
         - reservedIpRanges (array): list of all reserved IP ranges for a single MG
         - fixedIpAssignments (array): list of all fixed IP assignments for a single MG
@@ -44,6 +46,7 @@ def getDeviceCellularGatewayPortForwardingRules(self, serial: str):
         """
         **Returns the port forwarding rules for a single MG.**
         https://developer.cisco.com/meraki/api-v1/#!get-device-cellular-gateway-port-forwarding-rules
+
         - serial (string): (required)
         """
 
@@ -59,6 +62,7 @@ def updateDeviceCellularGatewayPortForwardingRules(self, serial: str, **kwargs):
         """
         **Updates the port forwarding rules for a single MG.**
         https://developer.cisco.com/meraki/api-v1/#!update-device-cellular-gateway-port-forwarding-rules
+
         - serial (string): (required)
         - rules (array): An array of port forwarding params
         """
@@ -80,6 +84,7 @@ def getNetworkCellularGatewayConnectivityMonitoringDestinations(self, networkId:
         """
         **Return the connectivity testing destinations for an MG network**
         https://developer.cisco.com/meraki/api-v1/#!get-network-cellular-gateway-connectivity-monitoring-destinations
+
         - networkId (string): (required)
         """
 
@@ -95,6 +100,7 @@ def updateNetworkCellularGatewayConnectivityMonitoringDestinations(self, network
         """
         **Update the connectivity testing destinations for an MG network**
         https://developer.cisco.com/meraki/api-v1/#!update-network-cellular-gateway-connectivity-monitoring-destinations
+
         - networkId (string): (required)
         - destinations (array): The list of connectivity monitoring destinations
         """
@@ -116,6 +122,7 @@ def getNetworkCellularGatewayDhcp(self, networkId: str):
         """
         **List common DHCP settings of MGs**
         https://developer.cisco.com/meraki/api-v1/#!get-network-cellular-gateway-dhcp
+
         - networkId (string): (required)
         """
 
@@ -131,6 +138,7 @@ def updateNetworkCellularGatewayDhcp(self, networkId: str, **kwargs):
         """
         **Update common DHCP settings of MGs**
         https://developer.cisco.com/meraki/api-v1/#!update-network-cellular-gateway-dhcp
+
         - networkId (string): (required)
         - dhcpLeaseTime (string): DHCP Lease time for all MG of the network. It can be '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'.
         - dnsNameservers (string): DNS name servers mode for all MG of the network. It can take 4 different values: 'upstream_dns', 'google_dns', 'opendns', 'custom'.
@@ -154,6 +162,7 @@ def getNetworkCellularGatewaySubnetPool(self, networkId: str):
         """
         **Return the subnet pool and mask configured for MGs in the network.**
         https://developer.cisco.com/meraki/api-v1/#!get-network-cellular-gateway-subnet-pool
+
         - networkId (string): (required)
         """
 
@@ -169,6 +178,7 @@ def updateNetworkCellularGatewaySubnetPool(self, networkId: str, **kwargs):
         """
         **Update the subnet pool and mask configuration for MGs in the network.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-cellular-gateway-subnet-pool
+
         - networkId (string): (required)
         - mask (integer): Mask used for the subnet of all MGs in  this network.
         - cidr (string): CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from this pool.
@@ -191,6 +201,7 @@ def getNetworkCellularGatewayUplink(self, networkId: str):
         """
         **Returns the uplink settings for your MG network.**
         https://developer.cisco.com/meraki/api-v1/#!get-network-cellular-gateway-uplink
+
         - networkId (string): (required)
         """
 
@@ -206,6 +217,7 @@ def updateNetworkCellularGatewayUplink(self, networkId: str, **kwargs):
         """
         **Updates the uplink settings for your MG network.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-cellular-gateway-uplink
+
         - networkId (string): (required)
         - bandwidthLimits (object): The bandwidth settings for the 'cellular' uplink
         """

meraki_v1/aio/api/cellularGateway.py

@@ -7,6 +7,7 @@ def getDevice(self, serial: str):
         """
         **Return a single device**
         https://developer.cisco.com/meraki/api-v1/#!get-device
+
         - serial (string): (required)
         """
 
@@ -22,6 +23,7 @@ def updateDevice(self, serial: str, **kwargs):
         """
         **Update the attributes of a device**
         https://developer.cisco.com/meraki/api-v1/#!update-device
+
         - serial (string): (required)
         - name (string): The name of a device
         - tags (array): The list of tags of a device
@@ -51,6 +53,7 @@ def blinkDeviceLeds(self, serial: str, **kwargs):
         """
         **Blink the LEDs on a device**
         https://developer.cisco.com/meraki/api-v1/#!blink-device-leds
+
         - serial (string): (required)
         - duration (integer): The duration in seconds. Must be between 5 and 120. Default is 20 seconds
         - period (integer): The period in milliseconds. Must be between 100 and 1000. Default is 160 milliseconds
@@ -74,6 +77,7 @@ 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.**
         https://developer.cisco.com/meraki/api-v1/#!get-device-clients
+
         - serial (string): (required)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 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 31 days. The default is 1 day.
@@ -96,6 +100,7 @@ def getDeviceLldpCdp(self, serial: str):
         """
         **List LLDP and CDP information for a device**
         https://developer.cisco.com/meraki/api-v1/#!get-device-lldp-cdp
+
         - serial (string): (required)
         """
 
@@ -111,6 +116,7 @@ def getDeviceLossAndLatencyHistory(self, serial: str, ip: str, **kwargs):
         """
         **Get the uplink loss percentage and latency in milliseconds for a wired network device.**
         https://developer.cisco.com/meraki/api-v1/#!get-device-loss-and-latency-history
+
         - serial (string): (required)
         - ip (string): The destination IP used to obtain the requested stats. This is required.
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
@@ -141,6 +147,7 @@ def getDeviceManagementInterface(self, serial: str):
         """
         **Return the management interface settings for a device**
         https://developer.cisco.com/meraki/api-v1/#!get-device-management-interface
+
         - serial (string): (required)
         """
 
@@ -156,6 +163,7 @@ def updateDeviceManagementInterface(self, serial: str, **kwargs):
         """
         **Update the management interface settings for a device**
         https://developer.cisco.com/meraki/api-v1/#!update-device-management-interface
+
         - serial (string): (required)
         - wan1 (object): WAN 1 settings
         - wan2 (object): WAN 2 settings (only for MX devices)
@@ -178,6 +186,7 @@ def rebootDevice(self, serial: str):
         """
         **Reboot a device**
         https://developer.cisco.com/meraki/api-v1/#!reboot-device
+
         - serial (string): (required)
         """
 
@@ -193,6 +202,7 @@ def getDeviceUplink(self, serial: str):
         """
         **Return the uplink information for a device.**
         https://developer.cisco.com/meraki/api-v1/#!get-device-uplink
+
         - serial (string): (required)
         """
 

meraki_v1/aio/api/devices.py

@@ -7,6 +7,7 @@ def getOrganizationInsightMonitoredMediaServers(self, organizationId: str):
         """
         **List the monitored media servers for this organization. Only valid for organizations with Meraki Insight.**
         https://developer.cisco.com/meraki/api-v1/#!get-organization-insight-monitored-media-servers
+
         - organizationId (string): (required)
         """
 
@@ -22,6 +23,7 @@ def createOrganizationInsightMonitoredMediaServer(self, organizationId: str, nam
         """
         **Add a media server to be monitored for this organization. Only valid for organizations with Meraki Insight.**
         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
@@ -44,6 +46,7 @@ def getOrganizationInsightMonitoredMediaServer(self, organizationId: str, monito
         """
         **Return a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
         https://developer.cisco.com/meraki/api-v1/#!get-organization-insight-monitored-media-server
+
         - organizationId (string): (required)
         - monitoredMediaServerId (string): (required)
         """
@@ -60,6 +63,7 @@ def updateOrganizationInsightMonitoredMediaServer(self, organizationId: str, mon
         """
         **Update a monitored media server for this organization. Only valid for organizations with Meraki Insight.**
         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
@@ -83,6 +87,7 @@ def deleteOrganizationInsightMonitoredMediaServer(self, organizationId: str, mon
         """
         **Delete a monitored media server from this organization. Only valid for organizations with Meraki Insight.**
         https://developer.cisco.com/meraki/api-v1/#!delete-organization-insight-monitored-media-server
+
         - organizationId (string): (required)
         - monitoredMediaServerId (string): (required)
         """