Added new config settings for async REST session

Author: Shiyue Cheng

meraki/__init__.py

@@ -86,7 +86,7 @@
     MAXIMUM_RETRIES, OUTPUT_LOG, LOG_PATH, LOG_FILE_PREFIX, PRINT_TO_CONSOLE, SIMULATE_API_CALLS
 )
 
-__version__ = '0.100.0'
+__version__ = '0.100.1'
 
 class DashboardAPI(object):
     """

meraki/aio/__init__.py

@@ -25,7 +25,7 @@ async def updateNetworkAlertSettings(self, networkId: str, **kwargs):
         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.
+        - 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/aio/api/alert_settings.py

@@ -31,6 +31,7 @@ async def updateDeviceCameraQualityAndRetentionSettings(self, serial: str, **kwa
         - restrictedBandwidthModeEnabled (boolean): Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera
         - 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.
         """
 
         kwargs.update(locals())
@@ -41,14 +42,17 @@ async def updateDeviceCameraQualityAndRetentionSettings(self, serial: str, **kwa
         if 'resolution' in kwargs:
             options = ['1280x720', '1920x1080', '1080x1080', '2058x2058']
             assert kwargs['resolution'] in options, f'''"resolution" cannot be "{kwargs['resolution']}", & must be set to one of: {options}'''
+        if 'motionDetectorVersion' in kwargs:
+            options = [1, 2]
+            assert kwargs['motionDetectorVersion'] in options, f'''"motionDetectorVersion" cannot be "{kwargs['motionDetectorVersion']}", & must be set to one of: {options}'''
 
         metadata = {
             'tags': ['Cameras'],
             'operation': 'updateDeviceCameraQualityAndRetentionSettings',
         }
         resource = f'/devices/{serial}/camera/qualityAndRetentionSettings'
 
-        body_params = ['profileId', 'motionBasedRetentionEnabled', 'audioRecordingEnabled', 'restrictedBandwidthModeEnabled', 'quality', 'resolution']
+        body_params = ['profileId', 'motionBasedRetentionEnabled', 'audioRecordingEnabled', 'restrictedBandwidthModeEnabled', 'quality', 'resolution', 'motionDetectorVersion']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return await self._session.put(metadata, resource, payload)

meraki/aio/api/cameras.py

@@ -59,7 +59,7 @@ async def claimNetworkDevices(self, networkId: str, **kwargs):
         }
         resource = f'/networks/{networkId}/devices/claim'
 
-        body_params = ['serials', 'serial', 'serials']
+        body_params = ['serials', 'serial']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return await self._session.post(metadata, resource, payload)

meraki/aio/api/devices.py

@@ -194,13 +194,17 @@ async def getNetworkTraffic(self, networkId: str, **kwargs):
         - networkId (string)
         - 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 (default), wireless, switch, appliance.
-    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())
 
+        if 'deviceType' in kwargs:
+            options = ['combined', 'wireless', 'switch', 'appliance']
+            assert kwargs['deviceType'] in options, f'''"deviceType" cannot be "{kwargs['deviceType']}", & must be set to one of: {options}'''
+
         metadata = {
             'tags': ['Networks'],
             'operation': 'getNetworkTraffic',

meraki/aio/api/networks.py

@@ -93,7 +93,7 @@ async def deleteOrganization(self, organizationId: str):
 
         return await self._session.delete(metadata, resource)
 
-    async def claimOrganization(self, organizationId: str, **kwargs):
+    async def claimIntoOrganization(self, organizationId: str, **kwargs):
         """
         **Claim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory.**
         https://api.meraki.com/api_docs#claim-a-list-of-devices-licenses-and/or-orders-into-an-organization
@@ -108,7 +108,31 @@ async def claimOrganization(self, organizationId: str, **kwargs):
 
         metadata = {
             'tags': ['Organizations'],
-            'operation': 'claimOrganization',
+            'operation': 'claimIntoOrganization',
+        }
+        resource = f'/organizations/{organizationId}/claim'
+
+        body_params = ['orders', 'serials', 'licenses']
+        payload = {k: v for (k, v) in kwargs.items() if k in body_params}
+
+        return await self._session.post(metadata, resource, payload)
+
+    async def claimOrganization(self, organizationId: str, **kwargs):
+        """
+        **Claim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory.**
+        https://api.meraki.com/api_docs#claim-a-list-of-devices-licenses-and/or-orders-into-an-organization
+
+        - organizationId (string)
+        - orders (array): The numbers of the orders that should be claimed
+        - serials (array): The serials of the devices that should be claimed
+        - licenses (array): The licenses that should be claimed
+        """
+
+        kwargs.update(locals())
+
+        metadata = {
+            'tags': ['Organizations'],
+            'operation': 'claimIntoOrganization',
         }
         resource = f'/organizations/{organizationId}/claim'
 

meraki/aio/api/organizations.py

@@ -62,18 +62,18 @@ async def updateNetworkSsid(self, networkId: str, number: str, **kwargs):
         - number (string)
         - name (string): The name of the SSID
         - enabled (boolean): Whether or not the SSID is enabled
-        - authMode (string): The association control method for the SSID ('open', 'psk', 'open-with-radius', '8021x-meraki' or '8021x-radius')
+        - authMode (string): The association control method for the SSID ('open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius', 'ipsk-with-radius' or 'ipsk-without-radius')
         - enterpriseAdminAccess (string): Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled')
         - encryptionMode (string): The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'
         - psk (string): The passkey for the SSID. This param is only valid if the authMode is 'psk'
         - wpaEncryptionMode (string): The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode' or 'WPA3 only')
         - splashPage (string): The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth' or 'Sponsored guest'). This attribute is not supported for template children.
-        - radiusServers (array): The RADIUS 802.1x servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius' or '8021x-radius'
+        - radiusServers (array): The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'
         - radiusCoaEnabled (boolean): If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server.
         - radiusFailoverPolicy (string): This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access')
         - radiusLoadBalancingPolicy (string): This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin')
-        - radiusAccountingEnabled (boolean): Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius' or '8021x-radius'
-        - radiusAccountingServers (array): The RADIUS accounting 802.1x servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius' or '8021x-radius' and radiusAccountingEnabled is 'true'
+        - radiusAccountingEnabled (boolean): Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'
+        - radiusAccountingServers (array): The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'
         - radiusAttributeForGroupPolicies (string): Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba-User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message
         - ipAssignmentMode (string): The client IP assignment mode ('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Layer 3 roaming with a concentrator' or 'VPN')
         - useVlanTagging (boolean): Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'
@@ -94,7 +94,7 @@ async def updateNetworkSsid(self, networkId: str, number: str, **kwargs):
         kwargs.update(locals())
 
         if 'authMode' in kwargs:
-            options = ['open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius']
+            options = ['open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius', 'ipsk-with-radius', 'ipsk-without-radius']
             assert kwargs['authMode'] in options, f'''"authMode" cannot be "{kwargs['authMode']}", & must be set to one of: {options}'''
         if 'enterpriseAdminAccess' in kwargs:
             options = ['access disabled', 'access enabled']

meraki/aio/api/ssids.py

@@ -19,7 +19,7 @@ async def getNetworkVlans(self, networkId: str):
 
         return await self._session.get(metadata, resource)
 
-    async def createNetworkVlan(self, networkId: str, id: str, name: str, subnet: str, applianceIp: str):
+    async def createNetworkVlan(self, networkId: str, id: str, name: str, subnet: str, applianceIp: str, **kwargs):
         """
         **Add a VLAN**
         https://api.meraki.com/api_docs#add-a-vlan
@@ -29,17 +29,18 @@ async def createNetworkVlan(self, networkId: str, id: str, name: str, subnet: st
         - name (string): The name of the new VLAN
         - subnet (string): The subnet of the VLAN
         - applianceIp (string): The local IP of the appliance on the VLAN
+        - groupPolicyId (string): The id of the desired group policy to apply to the VLAN
         """
 
-        kwargs = locals()
+        kwargs.update(locals())
 
         metadata = {
             'tags': ['VLANs'],
             'operation': 'createNetworkVlan',
         }
         resource = f'/networks/{networkId}/vlans'
 
-        body_params = ['id', 'name', 'subnet', 'applianceIp']
+        body_params = ['id', 'name', 'subnet', 'applianceIp', 'groupPolicyId']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return await self._session.post(metadata, resource, payload)
@@ -71,6 +72,7 @@ async def updateNetworkVlan(self, networkId: str, vlanId: str, **kwargs):
         - name (string): The name of the VLAN
         - subnet (string): The subnet of the VLAN
         - applianceIp (string): The local IP of the appliance on the VLAN
+        - groupPolicyId (string): The id of the desired group policy to apply to the VLAN
         - vpnNatSubnet (string): The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN
         - dhcpHandling (string): The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'
         - dhcpRelayServerIps (array): The IPs of the DHCP servers that DHCP requests should be relayed to
@@ -99,7 +101,7 @@ async def updateNetworkVlan(self, networkId: str, vlanId: str, **kwargs):
         }
         resource = f'/networks/{networkId}/vlans/{vlanId}'
 
-        body_params = ['name', 'subnet', 'applianceIp', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions']
+        body_params = ['name', 'subnet', 'applianceIp', 'groupPolicyId', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions']
         payload = {k: v for (k, v) in kwargs.items() if k in body_params}
 
         return await self._session.put(metadata, resource, payload)