Automatically regenerated library to version 1.49.0. (#265)

Co-authored-by: GitHub Action <support@meraki.com>
meraki · Aug 8, 2024 · a5c2d04 · a5c2d04
1 parent 3c543d7
commit a5c2d04
Show file tree

Hide file tree

Showing 15 changed files with 215 additions and 71 deletions.
diff --git a/meraki/__init__.py b/meraki/__init__.py
@@ -43,7 +43,7 @@
 )
 from meraki.rest_session import *
 
-__version__ = '1.48.0'
+__version__ = '1.49.0'
 
 
 class DashboardAPI(object):

diff --git a/meraki/aio/api/administered.py b/meraki/aio/api/administered.py
@@ -23,3 +23,56 @@ def getAdministeredIdentitiesMe(self):
 
         return self._session.get(metadata, resource)
 
+
+
+    def getAdministeredIdentitiesMeApiKeys(self):
+        """
+        **List the non-sensitive metadata associated with the API keys that belong to the user**
+        https://developer.cisco.com/meraki/api-v1/#!get-administered-identities-me-api-keys
+
+        """
+
+        metadata = {
+            'tags': ['administered', 'configure', 'identities', 'me', 'api', 'keys'],
+            'operation': 'getAdministeredIdentitiesMeApiKeys'
+        }
+        resource = f'/administered/identities/me/api/keys'
+
+        return self._session.get(metadata, resource)
+
+
+
+    def generateAdministeredIdentitiesMeApiKeys(self):
+        """
+        **Generates an API key for an identity**
+        https://developer.cisco.com/meraki/api-v1/#!generate-administered-identities-me-api-keys
+
+        """
+
+        metadata = {
+            'tags': ['administered', 'configure', 'identities', 'me', 'api', 'keys'],
+            'operation': 'generateAdministeredIdentitiesMeApiKeys'
+        }
+        resource = f'/administered/identities/me/api/keys/generate'
+
+        return self._session.post(metadata, resource)
+
+
+
+    def revokeAdministeredIdentitiesMeApiKeys(self, suffix: str):
+        """
+        **Revokes an identity's API key, using the last four characters of the key**
+        https://developer.cisco.com/meraki/api-v1/#!revoke-administered-identities-me-api-keys
+
+        - suffix (string): Suffix
+        """
+
+        metadata = {
+            'tags': ['administered', 'configure', 'identities', 'me', 'api', 'keys'],
+            'operation': 'revokeAdministeredIdentitiesMeApiKeys'
+        }
+        suffix = urllib.parse.quote(str(suffix), safe='')
+        resource = f'/administered/identities/me/api/keys/{suffix}/revoke'
+
+        return self._session.post(metadata, resource)
+
diff --git a/meraki/aio/api/devices.py b/meraki/aio/api/devices.py
@@ -211,7 +211,7 @@ def createDeviceLiveToolsCableTest(self, serial: str, ports: list, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!create-device-live-tools-cable-test
 
         - serial (string): Serial
-        - ports (array): A list of ports for which to perform the cable test.
+        - ports (array): A list of ports for which to perform the cable test.  For Catalyst switches, IOS interface names are also supported, such as "GigabitEthernet1/0/8", "Gi1/0/8", or even "1/0/8".
         - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret
         """
 

diff --git a/meraki/aio/api/organizations.py b/meraki/aio/api/organizations.py
diff --git a/meraki/aio/api/sm.py b/meraki/aio/api/sm.py
@@ -975,7 +975,7 @@ def getNetworkSmUsers(self, networkId: str, **kwargs):
         kwargs.update(locals())
 
         metadata = {
-            'tags': ['sm', 'configure', 'users'],
+            'tags': ['sm', 'configure'],
             'operation': 'getNetworkSmUsers'
         }
         networkId = urllib.parse.quote(str(networkId), safe='')
@@ -1004,7 +1004,7 @@ def getNetworkSmUserDeviceProfiles(self, networkId: str, userId: str):
         """
 
         metadata = {
-            'tags': ['sm', 'configure', 'users', 'deviceProfiles'],
+            'tags': ['sm', 'configure', 'deviceProfiles'],
             'operation': 'getNetworkSmUserDeviceProfiles'
         }
         networkId = urllib.parse.quote(str(networkId), safe='')
@@ -1025,7 +1025,7 @@ def getNetworkSmUserSoftwares(self, networkId: str, userId: str):
         """
 
         metadata = {
-            'tags': ['sm', 'configure', 'users', 'softwares'],
+            'tags': ['sm', 'configure', 'softwares'],
             'operation': 'getNetworkSmUserSoftwares'
         }
         networkId = urllib.parse.quote(str(networkId), safe='')

diff --git a/meraki/aio/api/switch.py b/meraki/aio/api/switch.py
@@ -477,6 +477,7 @@ def updateDeviceSwitchRoutingStaticRoute(self, serial: str, staticRouteId: str,
         - name (string): Name or description for layer 3 static route
         - subnet (string): The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
         - nextHopIp (string): IP address of the next hop device to which the device sends its traffic for the subnet
+        - managementNextHop (string): Optional fallback IP address for management traffic
         - advertiseViaOspfEnabled (boolean): Option to advertise static route via OSPF
         - preferOverOspfRoutesEnabled (boolean): Option to prefer static route over OSPF routes
         """
@@ -491,7 +492,7 @@ def updateDeviceSwitchRoutingStaticRoute(self, serial: str, staticRouteId: str,
         staticRouteId = urllib.parse.quote(str(staticRouteId), safe='')
         resource = f'/devices/{serial}/switch/routing/staticRoutes/{staticRouteId}'
 
-        body_params = ['name', 'subnet', 'nextHopIp', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
+        body_params = ['name', 'subnet', 'nextHopIp', 'managementNextHop', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)
@@ -2200,6 +2201,7 @@ def updateNetworkSwitchStackRoutingStaticRoute(self, networkId: str, switchStack
         - name (string): Name or description for layer 3 static route
         - subnet (string): The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
         - nextHopIp (string): IP address of the next hop device to which the device sends its traffic for the subnet
+        - managementNextHop (string): Optional fallback IP address for management traffic
         - advertiseViaOspfEnabled (boolean): Option to advertise static route via OSPF
         - preferOverOspfRoutesEnabled (boolean): Option to prefer static route over OSPF routes
         """
@@ -2215,7 +2217,7 @@ def updateNetworkSwitchStackRoutingStaticRoute(self, networkId: str, switchStack
         staticRouteId = urllib.parse.quote(str(staticRouteId), safe='')
         resource = f'/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}'
 
-        body_params = ['name', 'subnet', 'nextHopIp', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
+        body_params = ['name', 'subnet', 'nextHopIp', 'managementNextHop', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)

diff --git a/meraki/aio/api/wireless.py b/meraki/aio/api/wireless.py
@@ -738,6 +738,7 @@ def getNetworkWirelessClientConnectivityEvents(self, networkId: str, clientId: s
         - perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000.
         - startingAfter (string): A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
         - endingBefore (string): A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
+        - sortOrder (string): Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.
         - t0 (string): The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
         - t1 (string): The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
         - timespan (number): The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
@@ -750,6 +751,9 @@ def getNetworkWirelessClientConnectivityEvents(self, networkId: str, clientId: s
 
         kwargs.update(locals())
 
+        if 'sortOrder' in kwargs:
+            options = ['ascending', 'descending']
+            assert kwargs['sortOrder'] in options, f'''"sortOrder" cannot be "{kwargs['sortOrder']}", & must be set to one of: {options}'''
         if 'band' in kwargs:
             options = ['2.4', '5', '6']
             assert kwargs['band'] in options, f'''"band" cannot be "{kwargs['band']}", & must be set to one of: {options}'''
@@ -765,7 +769,7 @@ def getNetworkWirelessClientConnectivityEvents(self, networkId: str, clientId: s
         clientId = urllib.parse.quote(str(clientId), safe='')
         resource = f'/networks/{networkId}/wireless/clients/{clientId}/connectivityEvents'
 
-        query_params = ['perPage', 'startingAfter', 'endingBefore', 't0', 't1', 'timespan', 'types', 'band', 'ssidNumber', 'includedSeverities', 'deviceSerial', ]
+        query_params = ['perPage', 'startingAfter', 'endingBefore', 'sortOrder', 't0', 't1', 'timespan', 'types', 'band', 'ssidNumber', 'includedSeverities', 'deviceSerial', ]
         params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
 
         array_params = ['types', 'includedSeverities', ]
@@ -1441,6 +1445,8 @@ def updateNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str, **kwa
         - networkId (string): Network ID
         - rfProfileId (string): Rf profile ID
         - name (string): The name of the new profile. Must be unique.
+        - isIndoorDefault (boolean): Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor',   then a new profile will be created from the respective ID and set as the default
+        - isOutdoorDefault (boolean): Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor',   then a new profile will be created from the respective ID and set as the default
         - clientBalancingEnabled (boolean): Steers client to best available access point. Can be either true or false.
         - minBitrateType (string): Minimum bitrate can be set to either 'band' or 'ssid'.
         - bandSelectionType (string): Band selection can be set to either 'ssid' or 'ap'.
@@ -1470,7 +1476,7 @@ def updateNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str, **kwa
         rfProfileId = urllib.parse.quote(str(rfProfileId), safe='')
         resource = f'/networks/{networkId}/wireless/rfProfiles/{rfProfileId}'
 
-        body_params = ['name', 'clientBalancingEnabled', 'minBitrateType', 'bandSelectionType', 'apBandSettings', 'twoFourGhzSettings', 'fiveGhzSettings', 'sixGhzSettings', 'transmission', 'perSsidSettings', 'flexRadios', ]
+        body_params = ['name', 'isIndoorDefault', 'isOutdoorDefault', 'clientBalancingEnabled', 'minBitrateType', 'bandSelectionType', 'apBandSettings', 'twoFourGhzSettings', 'fiveGhzSettings', 'sixGhzSettings', 'transmission', 'perSsidSettings', 'flexRadios', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
 
         return self._session.put(metadata, resource, payload)

diff --git a/meraki/api/administered.py b/meraki/api/administered.py
@@ -23,3 +23,56 @@ def getAdministeredIdentitiesMe(self):
 
         return self._session.get(metadata, resource)
 
+
+
+    def getAdministeredIdentitiesMeApiKeys(self):
+        """
+        **List the non-sensitive metadata associated with the API keys that belong to the user**
+        https://developer.cisco.com/meraki/api-v1/#!get-administered-identities-me-api-keys
+
+        """
+
+        metadata = {
+            'tags': ['administered', 'configure', 'identities', 'me', 'api', 'keys'],
+            'operation': 'getAdministeredIdentitiesMeApiKeys'
+        }
+        resource = f'/administered/identities/me/api/keys'
+
+        return self._session.get(metadata, resource)
+
+
+
+    def generateAdministeredIdentitiesMeApiKeys(self):
+        """
+        **Generates an API key for an identity**
+        https://developer.cisco.com/meraki/api-v1/#!generate-administered-identities-me-api-keys
+
+        """
+
+        metadata = {
+            'tags': ['administered', 'configure', 'identities', 'me', 'api', 'keys'],
+            'operation': 'generateAdministeredIdentitiesMeApiKeys'
+        }
+        resource = f'/administered/identities/me/api/keys/generate'
+
+        return self._session.post(metadata, resource)
+
+
+
+    def revokeAdministeredIdentitiesMeApiKeys(self, suffix: str):
+        """
+        **Revokes an identity's API key, using the last four characters of the key**
+        https://developer.cisco.com/meraki/api-v1/#!revoke-administered-identities-me-api-keys
+
+        - suffix (string): Suffix
+        """
+
+        metadata = {
+            'tags': ['administered', 'configure', 'identities', 'me', 'api', 'keys'],
+            'operation': 'revokeAdministeredIdentitiesMeApiKeys'
+        }
+        suffix = urllib.parse.quote(str(suffix), safe='')
+        resource = f'/administered/identities/me/api/keys/{suffix}/revoke'
+
+        return self._session.post(metadata, resource)
+
diff --git a/meraki/api/batch/switch.py b/meraki/api/batch/switch.py
@@ -321,6 +321,7 @@ def updateDeviceSwitchRoutingStaticRoute(self, serial: str, staticRouteId: str,
         - name (string): Name or description for layer 3 static route
         - subnet (string): The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
         - nextHopIp (string): IP address of the next hop device to which the device sends its traffic for the subnet
+        - managementNextHop (string): Optional fallback IP address for management traffic
         - advertiseViaOspfEnabled (boolean): Option to advertise static route via OSPF
         - preferOverOspfRoutesEnabled (boolean): Option to prefer static route over OSPF routes
         """
@@ -333,7 +334,7 @@ def updateDeviceSwitchRoutingStaticRoute(self, serial: str, staticRouteId: str,
         }
         resource = f'/devices/{serial}/switch/routing/staticRoutes/{staticRouteId}'
 
-        body_params = ['name', 'subnet', 'nextHopIp', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
+        body_params = ['name', 'subnet', 'nextHopIp', 'managementNextHop', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,
@@ -1451,6 +1452,7 @@ def updateNetworkSwitchStackRoutingStaticRoute(self, networkId: str, switchStack
         - name (string): Name or description for layer 3 static route
         - subnet (string): The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
         - nextHopIp (string): IP address of the next hop device to which the device sends its traffic for the subnet
+        - managementNextHop (string): Optional fallback IP address for management traffic
         - advertiseViaOspfEnabled (boolean): Option to advertise static route via OSPF
         - preferOverOspfRoutesEnabled (boolean): Option to prefer static route over OSPF routes
         """
@@ -1463,7 +1465,7 @@ def updateNetworkSwitchStackRoutingStaticRoute(self, networkId: str, switchStack
         }
         resource = f'/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}'
 
-        body_params = ['name', 'subnet', 'nextHopIp', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
+        body_params = ['name', 'subnet', 'nextHopIp', 'managementNextHop', 'advertiseViaOspfEnabled', 'preferOverOspfRoutesEnabled', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,

diff --git a/meraki/api/batch/wireless.py b/meraki/api/batch/wireless.py
@@ -574,12 +574,14 @@ def createNetworkWirelessRfProfile(self, networkId: str, name: str, bandSelectio
 
     def updateNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str, **kwargs):
         """
-        **Updates specified RF profile for this network**
+        **Updates specified RF profile for this network. Note: built-in RF profiles can only be assigned as a default, and its attributes are immutable**
         https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-rf-profile
 
         - networkId (string): Network ID
         - rfProfileId (string): Rf profile ID
         - name (string): The name of the new profile. Must be unique.
+        - isIndoorDefault (boolean): Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor',   then a new profile will be created from the respective ID and set as the default
+        - isOutdoorDefault (boolean): Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor',   then a new profile will be created from the respective ID and set as the default
         - clientBalancingEnabled (boolean): Steers client to best available access point. Can be either true or false.
         - minBitrateType (string): Minimum bitrate can be set to either 'band' or 'ssid'.
         - bandSelectionType (string): Band selection can be set to either 'ssid' or 'ap'.
@@ -607,7 +609,7 @@ def updateNetworkWirelessRfProfile(self, networkId: str, rfProfileId: str, **kwa
         }
         resource = f'/networks/{networkId}/wireless/rfProfiles/{rfProfileId}'
 
-        body_params = ['name', 'clientBalancingEnabled', 'minBitrateType', 'bandSelectionType', 'apBandSettings', 'twoFourGhzSettings', 'fiveGhzSettings', 'sixGhzSettings', 'transmission', 'perSsidSettings', 'flexRadios', ]
+        body_params = ['name', 'isIndoorDefault', 'isOutdoorDefault', 'clientBalancingEnabled', 'minBitrateType', 'bandSelectionType', 'apBandSettings', 'twoFourGhzSettings', 'fiveGhzSettings', 'sixGhzSettings', 'transmission', 'perSsidSettings', 'flexRadios', ]
         payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
         action = {
             "resource": resource,

diff --git a/meraki/api/devices.py b/meraki/api/devices.py
@@ -211,7 +211,7 @@ def createDeviceLiveToolsCableTest(self, serial: str, ports: list, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!create-device-live-tools-cable-test
 
         - serial (string): Serial
-        - ports (array): A list of ports for which to perform the cable test.
+        - ports (array): A list of ports for which to perform the cable test.  For Catalyst switches, IOS interface names are also supported, such as "GigabitEthernet1/0/8", "Gi1/0/8", or even "1/0/8".
         - callback (object): Details for the callback. Please include either an httpServerId OR url and sharedSecret
         """