Updated with v0.11 release

Author: Shiyue Cheng

README.md

@@ -24,11 +24,12 @@ While you can make direct HTTP requests to dashboard API in any programming lang
 
 3. Install the latest version of [Python 3](ttps://wiki.python.org/moin/BeginnersGuide/NonProgrammers)
 
-4. Use _pip_ (or an alternative such as _easy_install_) to install the library:
+4. Use _pip_ (or an alternative such as _easy_install_) to install the library from the Python [Package Index](https://pypi.org/project/meraki/):
     * `pip install meraki`
-    * If you have both Python3 and Python2 installed, you may need to use `pip3 install meraki`
-    * If _meraki_ was previously installed, you can upgrade with `pip install --upgrade meraki` or `pip3 install --upgrade meraki`
-    * You can specify the version of the library, for example `pip install meraki==0.100.2` for v0 or `pip install meraki==1.0.0b1` for v1
+    * If you have both Python3 and Python2 installed, you may need to use `pip3` (so `pip3 install meraki`) along with `python3` on your system
+    * If _meraki_ was previously installed, you can upgrade to the latest stable (non-beta) release with `pip install --upgrade meraki`
+    * You can specify the version of the library, for example `pip install meraki==0.110.0` for v0 or `pip install meraki==1.0.0b3` for v1 beta
+    * To see the [release history](https://pypi.org/project/meraki/#history), you can also use `pip install meraki==` without including a version number
 
 ## Usage
 1. Export your API key as an [environment variable](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html), for example:

meraki_v0/__init__.py meraki/__init__.pymeraki_v0/__init__.py renamed to meraki/__init__.py

@@ -83,10 +83,13 @@
 from .config import (
     API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, WAIT_ON_RATE_LIMIT,
     NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR, RETRY_4XX_ERROR_WAIT_TIME,
-    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SUPPRESS_LOGGING, SIMULATE_API_CALLS
+    MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SUPPRESS_LOGGING, SIMULATE_API_CALLS,
+    BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
-__version__ = '0.100.2'
+
+__version__ = '0.110.0'
+
 
 class DashboardAPI(object):
     """
@@ -119,7 +122,7 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
                  retry_4xx_error=RETRY_4XX_ERROR, retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
                  maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_path=LOG_PATH,
                  log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING,
-                 simulate=SIMULATE_API_CALLS, be_geo_id='', caller=''):
+                 simulate=SIMULATE_API_CALLS, be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:

meraki_v0/aio/__init__.py meraki/aio/__init__.pymeraki_v0/aio/__init__.py renamed to meraki/aio/__init__.py

@@ -83,10 +83,9 @@
     API_KEY_ENVIRONMENT_VARIABLE, DEFAULT_BASE_URL, SINGLE_REQUEST_TIMEOUT, CERTIFICATE_PATH, WAIT_ON_RATE_LIMIT,
     NGINX_429_RETRY_WAIT_TIME, ACTION_BATCH_RETRY_WAIT_TIME, RETRY_4XX_ERROR, RETRY_4XX_ERROR_WAIT_TIME,
     MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SUPPRESS_LOGGING, SIMULATE_API_CALLS,
-    AIO_MAXIMUM_CONCURRENT_REQUESTS
+    AIO_MAXIMUM_CONCURRENT_REQUESTS, BE_GEO_ID, MERAKI_PYTHON_SDK_CALLER
 )
 
-__version__ = '0.100.2'
 
 class AsyncDashboardAPI:
     """
@@ -109,6 +108,8 @@ class AsyncDashboardAPI:
     - suppress_logging (boolean): disable all logging? you're on your own then!
     - simulate (boolean): simulate POST/PUT/DELETE calls to prevent changes?
     - maximum_concurrent_requests (integer): number of concurrent API requests for asynchronous class
+    - be_geo_id (string): optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID
+    - caller (string): optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER
     """
 
     def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeout=SINGLE_REQUEST_TIMEOUT,
@@ -118,12 +119,19 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
                  retry_4xx_error=RETRY_4XX_ERROR, retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
                  maximum_retries=MAXIMUM_RETRIES, output_log=OUTPUT_LOG, log_path=LOG_PATH,
                  log_file_prefix=LOG_FILE_PREFIX, print_console=PRINT_TO_CONSOLE, suppress_logging=SUPPRESS_LOGGING,
-                 simulate=SIMULATE_API_CALLS, maximum_concurrent_requests=AIO_MAXIMUM_CONCURRENT_REQUESTS):
+                 simulate=SIMULATE_API_CALLS, maximum_concurrent_requests=AIO_MAXIMUM_CONCURRENT_REQUESTS,
+                 be_geo_id=BE_GEO_ID, caller=MERAKI_PYTHON_SDK_CALLER):
         # Check API key
         api_key = api_key or os.environ.get(API_KEY_ENVIRONMENT_VARIABLE)
         if not api_key:
             raise APIKeyError()
 
+        # Pull the BE GEO ID from an environment variable if present
+        be_geo_id = be_geo_id or os.environ.get('BE_GEO_ID')
+
+        # Pull the caller from an environment variable if present
+        caller = caller or os.environ.get('MERAKI_PYTHON_SDK_CALLER')
+
         # Configure logging
         if not suppress_logging:
             self._logger = logging.getLogger(__name__)
@@ -164,7 +172,9 @@ def __init__(self, api_key=None, base_url=DEFAULT_BASE_URL, single_request_timeo
             retry_4xx_error_wait_time=retry_4xx_error_wait_time,
             maximum_retries=maximum_retries,
             simulate=simulate,
-            maximum_concurrent_requests=maximum_concurrent_requests
+            maximum_concurrent_requests=maximum_concurrent_requests,
+            be_geo_id=be_geo_id,
+            caller=caller,
         )
 
         # API endpoints by section

meraki_v0/aio/api/__init__.py meraki/aio/api/__init__.pymeraki_v0/aio/api/__init__.py renamed to meraki/aio/api/__init__.py

@@ -6,7 +6,7 @@ def __init__(self, session):
     async def createOrganizationActionBatch(self, organizationId: str, actions: list, **kwargs):
         """
         **Create an action batch**
-        https://api.meraki.com/api_docs#create-an-action-batch
+        https://developer.cisco.com/docs/meraki-api-v0/#!create-organization-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>)
@@ -30,7 +30,7 @@ async def createOrganizationActionBatch(self, organizationId: str, actions: list
     async 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
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-organization-action-batches
         
         - organizationId (string)
         """
@@ -46,7 +46,7 @@ async def getOrganizationActionBatches(self, organizationId: str):
     async def getOrganizationActionBatch(self, organizationId: str, actionBatchId: str):
         """
         **Return an action batch**
-        https://api.meraki.com/api_docs#return-an-action-batch
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-organization-action-batch
         
         - organizationId (string)
         - actionBatchId (string)
@@ -63,7 +63,7 @@ async def getOrganizationActionBatch(self, organizationId: str, actionBatchId: s
     async def deleteOrganizationActionBatch(self, organizationId: str, actionBatchId: str):
         """
         **Delete an action batch**
-        https://api.meraki.com/api_docs#delete-an-action-batch
+        https://developer.cisco.com/docs/meraki-api-v0/#!delete-organization-action-batch
         
         - organizationId (string)
         - actionBatchId (string)
@@ -80,7 +80,7 @@ async def deleteOrganizationActionBatch(self, organizationId: str, actionBatchId
     async def updateOrganizationActionBatch(self, organizationId: str, actionBatchId: str, **kwargs):
         """
         **Update an action batch**
-        https://api.meraki.com/api_docs#update-an-action-batch
+        https://developer.cisco.com/docs/meraki-api-v0/#!update-organization-action-batch
         
         - organizationId (string)
         - actionBatchId (string)

meraki_v0/aio/api/action_batches.py meraki/aio/api/action_batches.pymeraki_v0/aio/api/action_batches.py renamed to meraki/aio/api/action_batches.py

@@ -6,7 +6,7 @@ def __init__(self, session):
     async 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
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-organization-admins
         
         - organizationId (string)
         """
@@ -22,7 +22,7 @@ async def getOrganizationAdmins(self, organizationId: str):
     async def createOrganizationAdmin(self, organizationId: str, email: str, name: str, orgAccess: str, **kwargs):
         """
         **Create a new dashboard administrator**
-        https://api.meraki.com/api_docs#create-a-new-dashboard-administrator
+        https://developer.cisco.com/docs/meraki-api-v0/#!create-organization-admin
         
         - organizationId (string)
         - email (string): The email of the dashboard administrator. This attribute can not be updated.
@@ -52,7 +52,7 @@ async def createOrganizationAdmin(self, organizationId: str, email: str, name: s
     async def updateOrganizationAdmin(self, organizationId: str, id: str, **kwargs):
         """
         **Update an administrator**
-        https://api.meraki.com/api_docs#update-an-administrator
+        https://developer.cisco.com/docs/meraki-api-v0/#!update-organization-admin
         
         - organizationId (string)
         - id (string)
@@ -82,7 +82,7 @@ async def updateOrganizationAdmin(self, organizationId: str, id: str, **kwargs):
     async 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
+        https://developer.cisco.com/docs/meraki-api-v0/#!delete-organization-admin
         
         - organizationId (string)
         - id (string)

meraki_v0/aio/api/admins.py meraki/aio/api/admins.pymeraki_v0/aio/api/admins.py renamed to meraki/aio/api/admins.py

@@ -6,7 +6,7 @@ def __init__(self, session):
     async 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
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-network-alert-settings
         
         - networkId (string)
         """
@@ -22,7 +22,7 @@ async def getNetworkAlertSettings(self, networkId: str):
     async 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
+        https://developer.cisco.com/docs/meraki-api-v0/#!update-network-alert-settings
         
         - networkId (string)
         - defaultDestinations (object): The network-wide destinations for all alerts on the network.

meraki_v0/aio/api/alert_settings.py meraki/aio/api/alert_settings.pymeraki_v0/aio/api/alert_settings.py renamed to meraki/aio/api/alert_settings.py

@@ -6,7 +6,7 @@ def __init__(self, session):
     async def getOrganizationApiRequests(self, organizationId: str, total_pages=1, direction='next', **kwargs):
         """
         **List the API requests made by an organization**
-        https://api.meraki.com/api_docs#list-the-api-requests-made-by-an-organization
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-organization-api-requests
         
         - organizationId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
@@ -41,7 +41,7 @@ async def getOrganizationApiRequests(self, organizationId: str, total_pages=1, d
     async def getOrganizationApiRequestsOverview(self, organizationId: str, **kwargs):
         """
         **Return an aggregated overview of API requests data**
-        https://api.meraki.com/api_docs#return-an-aggregated-overview-of-api-requests-data
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-organization-api-requests-overview
         
         - organizationId (string)
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

meraki_v0/aio/api/api_usage.py meraki/aio/api/api_usage.pymeraki_v0/aio/api/api_usage.py renamed to meraki/aio/api/api_usage.py

@@ -6,7 +6,7 @@ def __init__(self, session):
     async def getNetworkBluetoothClients(self, networkId: str, total_pages=1, direction='next', **kwargs):
         """
         **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
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-network-bluetooth-clients
         
         - networkId (string)
         - total_pages (integer or string): total number of pages to retrieve, -1 or "all" for all pages
@@ -36,7 +36,7 @@ async def getNetworkBluetoothClients(self, networkId: str, total_pages=1, direct
     async def getNetworkBluetoothClient(self, networkId: str, bluetoothClientId: str, **kwargs):
         """
         **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
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-network-bluetooth-client
         
         - networkId (string)
         - bluetoothClientId (string)

meraki_v0/aio/api/bluetooth_clients.py meraki/aio/api/bluetooth_clients.pymeraki_v0/aio/api/bluetooth_clients.py renamed to meraki/aio/api/bluetooth_clients.py

@@ -6,7 +6,7 @@ def __init__(self, session):
     async def getDeviceWirelessBluetoothSettings(self, serial: str):
         """
         **Return the bluetooth settings for a wireless device**
-        https://api.meraki.com/api_docs#return-the-bluetooth-settings-for-a-wireless-device
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-device-wireless-bluetooth-settings
         
         - serial (string)
         """
@@ -22,7 +22,7 @@ async def getDeviceWirelessBluetoothSettings(self, serial: str):
     async def updateDeviceWirelessBluetoothSettings(self, serial: str, **kwargs):
         """
         **Update the bluetooth settings for a wireless device**
-        https://api.meraki.com/api_docs#update-the-bluetooth-settings-for-a-wireless-device
+        https://developer.cisco.com/docs/meraki-api-v0/#!update-device-wireless-bluetooth-settings
         
         - serial (string)
         - uuid (string): Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
@@ -46,7 +46,7 @@ async def updateDeviceWirelessBluetoothSettings(self, serial: str, **kwargs):
     async def getNetworkBluetoothSettings(self, networkId: str):
         """
         **Return the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings</a> must be enabled on the network.**
-        https://api.meraki.com/api_docs#return-the-bluetooth-settings-for-a-network
+        https://developer.cisco.com/docs/meraki-api-v0/#!get-network-bluetooth-settings
         
         - networkId (string)
         """
@@ -62,7 +62,7 @@ async def getNetworkBluetoothSettings(self, networkId: str):
     async def updateNetworkBluetoothSettings(self, networkId: str, **kwargs):
         """
         **Update the Bluetooth settings for a network. See the docs page for <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings</a>.**
-        https://api.meraki.com/api_docs#update-the-bluetooth-settings-for-a-network
+        https://developer.cisco.com/docs/meraki-api-v0/#!update-network-bluetooth-settings
         
         - networkId (string)
         - scanningEnabled (boolean): Whether APs will scan for Bluetooth enabled clients. (true, false)