Small fix for bind/unbind networks, and added spacing for IDE documentation

Author: Shiyue Cheng

meraki/__init__.py

@@ -93,14 +93,15 @@ class DashboardAPI(object):
     - print_console (boolean): if output log used, output to console too?
     - simulate (boolean): simulate POST/PUT/DELETE calls to prevent changes?
     """
+
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT,
                  wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT, maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG,
                  log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, simulate=SIMULATE_API_CALLS):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:
             raise APIKeyError()
-        
+
         # Configure logging
         self._logger = logging.getLogger(__name__)
         self._log_file = f'{log_file_prefix}_log__{datetime.now():%Y-%m-%d_%H-%M-%S}.txt'

meraki/api/action_batches.py

@@ -7,6 +7,7 @@ def createOrganizationActionBatch(self, organizationId: str, actions: list, **kw
         """
         **Create an action batch**
         https://api.meraki.com/api_docs#create-an-action-batch
+        
         - organizationId (string)
         - actions (array): A set of changes to make as part of this action (<a href='https://developer.cisco.com/meraki/api/#/rest/guides/action-batches/'>more details</a>)
         - confirmed (boolean): Set to true for immediate execution. Set to false if the action should be previewed before executing. This property cannot be unset once it is true. Defaults to false.
@@ -30,6 +31,7 @@ def getOrganizationActionBatches(self, organizationId: str):
         """
         **Return the list of action batches in the organization**
         https://api.meraki.com/api_docs#return-the-list-of-action-batches-in-the-organization
+        
         - organizationId (string)
         """
 
@@ -45,6 +47,7 @@ def getOrganizationActionBatch(self, organizationId: str, actionBatchId: str):
         """
         **Return an action batch**
         https://api.meraki.com/api_docs#return-an-action-batch
+        
         - organizationId (string)
         - actionBatchId (string)
         """
@@ -61,6 +64,7 @@ def deleteOrganizationActionBatch(self, organizationId: str, actionBatchId: str)
         """
         **Delete an action batch**
         https://api.meraki.com/api_docs#delete-an-action-batch
+        
         - organizationId (string)
         - actionBatchId (string)
         """
@@ -77,6 +81,7 @@ def updateOrganizationActionBatch(self, organizationId: str, actionBatchId: str,
         """
         **Update an action batch**
         https://api.meraki.com/api_docs#update-an-action-batch
+        
         - organizationId (string)
         - actionBatchId (string)
         - confirmed (boolean): A boolean representing whether or not the batch has been confirmed. This property cannot be unset once it is true.

meraki/api/admins.py

@@ -7,6 +7,7 @@ def getOrganizationAdmins(self, organizationId: str):
         """
         **List the dashboard administrators in this organization**
         https://api.meraki.com/api_docs#list-the-dashboard-administrators-in-this-organization
+        
         - organizationId (string)
         """
 
@@ -22,6 +23,7 @@ def createOrganizationAdmin(self, organizationId: str, email: str, name: str, or
         """
         **Create a new dashboard administrator**
         https://api.meraki.com/api_docs#create-a-new-dashboard-administrator
+        
         - organizationId (string)
         - email (string): The email of the dashboard administrator. This attribute can not be updated.
         - name (string): The name of the dashboard administrator
@@ -51,6 +53,7 @@ def updateOrganizationAdmin(self, organizationId: str, id: str, **kwargs):
         """
         **Update an administrator**
         https://api.meraki.com/api_docs#update-an-administrator
+        
         - organizationId (string)
         - id (string)
         - name (string): The name of the dashboard administrator
@@ -80,6 +83,7 @@ def deleteOrganizationAdmin(self, organizationId: str, id: str):
         """
         **Revoke all access for a dashboard administrator within this organization**
         https://api.meraki.com/api_docs#revoke-all-access-for-a-dashboard-administrator-within-this-organization
+        
         - organizationId (string)
         - id (string)
         """

meraki/api/alert_settings.py

@@ -7,6 +7,7 @@ def getNetworkAlertSettings(self, networkId: str):
         """
         **Return the alert configuration for this network**
         https://api.meraki.com/api_docs#return-the-alert-configuration-for-this-network
+        
         - networkId (string)
         """
 
@@ -22,6 +23,7 @@ def updateNetworkAlertSettings(self, networkId: str, **kwargs):
         """
         **Update the alert configuration for this network**
         https://api.meraki.com/api_docs#update-the-alert-configuration-for-this-network
+        
         - networkId (string)
         - defaultDestinations (object): The network_wide destinations for all alerts on the network.
         - alerts (array): Alert-specific configuration for each type. Only alerts that pertain to the network can be updated.

meraki/api/api_usage.py

@@ -7,6 +7,7 @@ def getOrganizationApiRequests(self, organizationId: str, total_pages=1, directi
         """
         **List the API requests made by an organization**
         https://api.meraki.com/api_docs#list-the-api-requests-made-by-an-organization
+        
         - organizationId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" (default) or "prev" page

meraki/api/bluetooth_clients.py

@@ -7,6 +7,7 @@ def getNetworkBluetoothClients(self, networkId: str, total_pages=1, direction='n
         """
         **List the Bluetooth clients seen by APs in this network**
         https://api.meraki.com/api_docs#list-the-bluetooth-clients-seen-by-aps-in-this-network
+        
         - networkId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" (default) or "prev" page
@@ -36,6 +37,7 @@ def getNetworkBluetoothClient(self, networkId: str, bluetoothClientId: str, **kw
         """
         **Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.**
         https://api.meraki.com/api_docs#return-a-bluetooth-client
+        
         - networkId (string)
         - bluetoothClientId (string)
         - includeConnectivityHistory (boolean): Include the connectivity history for this client

meraki/api/cameras.py

@@ -7,6 +7,7 @@ def generateNetworkCameraSnapshot(self, networkId: str, serial: str, **kwargs):
         """
         **Generate a snapshot of what the camera sees at the specified time and return a link to that image.**
         https://api.meraki.com/api_docs#generate-a-snapshot-of-what-the-camera-sees-at-the-specified-time-and-return-a-link-to-that-image
+        
         - networkId (string)
         - serial (string)
         - 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.
@@ -29,6 +30,7 @@ def getNetworkCameraVideoLink(self, networkId: str, serial: str, **kwargs):
         """
         **Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.**
         https://api.meraki.com/api_docs#returns-video-link-to-the-specified-camera
+        
         - networkId (string)
         - serial (string)
         - timestamp (string): [optional] The video link will start at this timestamp. The timestamp is in UNIX Epoch time (milliseconds). If no timestamp is specified, we will assume current time.

meraki/api/clients.py

@@ -7,6 +7,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://api.meraki.com/api_docs#list-the-clients-of-a-device-up-to-a-maximum-of-a-month-ago
+        
         - serial (string)
         - 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.
@@ -29,6 +30,7 @@ def getNetworkClients(self, networkId: str, total_pages=1, direction='next', **k
         """
         **List the clients that have used this network in the timespan**
         https://api.meraki.com/api_docs#list-the-clients-that-have-used-this-network-in-the-timespan
+        
         - networkId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" (default) or "prev" page
@@ -57,6 +59,7 @@ def provisionNetworkClients(self, networkId: str, **kwargs):
         """
         **Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.**
         https://api.meraki.com/api_docs#provisions-a-client-with-a-name-and-policy
+        
         - networkId (string)
         - mac (string): The MAC address of the client. Required.
         - name (string): The display name for the client. Optional. Limited to 255 bytes.
@@ -81,6 +84,7 @@ 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.**
         https://api.meraki.com/api_docs#return-the-client-associated-with-the-given-identifier
+        
         - networkId (string)
         - clientId (string)
         """
@@ -97,6 +101,7 @@ def getNetworkClientEvents(self, networkId: str, clientId: str, total_pages=1, d
         """
         **Return the events associated with this client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.**
         https://api.meraki.com/api_docs#return-the-events-associated-with-this-client
+        
         - networkId (string)
         - clientId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
@@ -124,6 +129,7 @@ def getNetworkClientLatencyHistory(self, networkId: str, clientId: str, **kwargs
         """
         **Return the latency history 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. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds.**
         https://api.meraki.com/api_docs#return-the-latency-history-for-a-client
+        
         - networkId (string)
         - clientId (string)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 791 days from today.
@@ -149,6 +155,7 @@ 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.**
         https://api.meraki.com/api_docs#return-the-policy-assigned-to-a-client-on-the-network
+        
         - networkId (string)
         - clientId (string)
         """
@@ -165,6 +172,7 @@ def updateNetworkClientPolicy(self, networkId: str, clientId: 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.**
         https://api.meraki.com/api_docs#update-the-policy-assigned-to-a-client-on-the-network
+        
         - networkId (string)
         - clientId (string)
         - devicePolicy (string): The group policy (Whitelisted, Blocked, Normal, Group policy)
@@ -188,6 +196,7 @@ def getNetworkClientSplashAuthorizationStatus(self, networkId: str, clientId: st
         """
         **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.**
         https://api.meraki.com/api_docs#return-the-splash-authorization-for-a-client-for-each-ssid-theyve-associated-with-through-splash
+        
         - networkId (string)
         - clientId (string)
         """
@@ -204,6 +213,7 @@ def updateNetworkClientSplashAuthorizationStatus(self, networkId: str, clientId:
         """
         **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.**
         https://api.meraki.com/api_docs#update-a-clients-splash-authorization
+        
         - networkId (string)
         - clientId (string)
         - ssids (object): The target SSIDs. Each SSID must be enabled and must have Click-through splash enabled. For each SSID where isAuthorized is true, the expiration time will automatically be set according to the SSID's splash frequency.
@@ -226,6 +236,7 @@ def getNetworkClientTrafficHistory(self, networkId: str, clientId: str, total_pa
         """
         **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.**
         https://api.meraki.com/api_docs#return-the-clients-network-traffic-data-over-time
+        
         - networkId (string)
         - clientId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
@@ -253,6 +264,7 @@ 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.**
         https://api.meraki.com/api_docs#return-the-clients-daily-usage-history
+        
         - networkId (string)
         - clientId (string)
         """

meraki/api/config_templates.py

@@ -7,6 +7,7 @@ def getOrganizationConfigTemplates(self, organizationId: str):
         """
         **List the configuration templates for this organization**
         https://api.meraki.com/api_docs#list-the-configuration-templates-for-this-organization
+        
         - organizationId (string)
         """
 
@@ -22,6 +23,7 @@ def deleteOrganizationConfigTemplate(self, organizationId: str, configTemplateId
         """
         **Remove a configuration template**
         https://api.meraki.com/api_docs#remove-a-configuration-template
+        
         - organizationId (string)
         - configTemplateId (string)
         """

meraki/api/connectivity_monitoring_destinations.py

@@ -7,6 +7,7 @@ def getNetworkConnectivityMonitoringDestinations(self, networkId: str):
         """
         **Return the connectivity testing destinations for an MX network**
         https://api.meraki.com/api_docs#return-the-connectivity-testing-destinations-for-an-mx-network
+        
         - networkId (string)
         """
 
@@ -22,6 +23,7 @@ def updateNetworkConnectivityMonitoringDestinations(self, networkId: str, **kwar
         """
         **Update the connectivity testing destinations for an MX network**
         https://api.meraki.com/api_docs#update-the-connectivity-testing-destinations-for-an-mx-network
+        
         - networkId (string)
         - destinations (array): The list of connectivity monitoring destinations
         """