Automatically regenerated library. (#227)

Co-authored-by: GitHub Action <[email protected]>

meraki/aio/api/networks.py

@@ -730,7 +730,7 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', even
         - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" or "prev" (default) page
         - event_log_end_time (string): ISO8601 Zulu/UTC time, to use in conjunction with startingAfter, to retrieve events within a time window
-        - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and cloudGateway
+        - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
         - includedEventTypes (array): A list of event types. The returned events will be filtered to only include events with these types.
         - excludedEventTypes (array): A list of event types. The returned events will be filtered to exclude events with these types.
         - deviceMac (string): The MAC address of the Meraki device which the list of events will be filtered with
@@ -749,7 +749,7 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', even
         kwargs.update(locals())
 
         if 'productType' in kwargs:
-            options = ['appliance', 'camera', 'cellularGateway', 'cloudGateway', 'switch', 'systemsManager', 'wireless']
+            options = ['appliance', 'camera', 'cellularGateway', 'switch', 'systemsManager', 'wireless']
             assert kwargs['productType'] in options, f'''"productType" cannot be "{kwargs['productType']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -852,7 +852,7 @@ def createNetworkFirmwareUpgradesRollback(self, networkId: str, reasons: list, *
         kwargs.update(locals())
 
         if 'product' in kwargs:
-            options = ['appliance', 'camera', 'cellularGateway', 'cloudGateway', 'switch', 'switchCatalyst', 'wireless']
+            options = ['appliance', 'camera', 'cellularGateway', 'switch', 'switchCatalyst', 'wireless']
             assert kwargs['product'] in options, f'''"product" cannot be "{kwargs['product']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -2275,7 +2275,7 @@ def updateNetworkTrafficAnalysis(self, networkId: str, **kwargs):
 
     def getNetworkTrafficShapingApplicationCategories(self, networkId: str):
         """
-        **Returns the application categories for traffic shaping rules.**
+        **Returns the application categories for traffic shaping rules**
         https://developer.cisco.com/meraki/api-v1/#!get-network-traffic-shaping-application-categories
 
         - networkId (string): Network ID

meraki/aio/api/organizations.py

@@ -1492,7 +1492,7 @@ def getOrganizationDevices(self, organizationId: str, total_pages=1, direction='
         - 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.
         - configurationUpdatedAfter (string): Filter results by whether or not the device's configuration has been updated after the given timestamp
         - networkIds (array): Optional parameter to filter devices by network.
-        - productTypes (array): Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway.
+        - productTypes (array): Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
         - tags (array): Optional parameter to filter devices by tags.
         - tagsFilterType (string): Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
         - name (string): Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
@@ -1724,7 +1724,7 @@ def getOrganizationDevicesStatuses(self, organizationId: str, total_pages=1, dir
         - networkIds (array): Optional parameter to filter devices by network ids.
         - serials (array): Optional parameter to filter devices by serials.
         - statuses (array): Optional parameter to filter devices by statuses. Valid statuses are ["online", "alerting", "offline", "dormant"].
-        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway.
+        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
         - models (array): Optional parameter to filter devices by models.
         - tags (array): An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
         - tagsFilterType (string): An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
@@ -1762,7 +1762,7 @@ def getOrganizationDevicesStatusesOverview(self, organizationId: str, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-statuses-overview
 
         - organizationId (string): Organization ID
-        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway.
+        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
         - networkIds (array): An optional parameter to filter device statuses by network.
         """
 
@@ -2004,8 +2004,8 @@ def getOrganizationFirmwareUpgrades(self, organizationId: str, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!get-organization-firmware-upgrades
 
         - organizationId (string): Organization ID
-        - status (array): The status of an upgrade 
-        - productTypes (array): The product type in a given upgrade ID
+        - status (array): Optional parameter to filter the upgrade by status.
+        - productTypes (array): Optional parameter to filter the upgrade by product type.
         """
 
         kwargs.update(locals())
@@ -2117,7 +2117,7 @@ def getOrganizationInventoryDevices(self, organizationId: str, total_pages=1, di
         - orderNumbers (array): Search for devices in inventory based on order numbers.
         - tags (array): Filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
         - tagsFilterType (string): To use with 'tags' parameter, to filter devices which contain ANY or ALL given tags. Accepted values are 'withAnyTags' or 'withAllTags', default is 'withAnyTags'.
-        - productTypes (array): Filter devices by product type. Accepted values are appliance, camera, cellularGateway, cloudGateway, sensor, switch, systemsManager, and wireless.
+        - productTypes (array): Filter devices by product type. Accepted values are appliance, camera, cellularGateway, sensor, switch, systemsManager, and wireless.
         """
 
         kwargs.update(locals())

meraki/aio/api/wireless.py

@@ -2092,7 +2092,7 @@ def updateNetworkWirelessSsidSplashSettings(self, networkId: str, number: str, *
 
     def updateNetworkWirelessSsidTrafficShapingRules(self, networkId: str, number: str, **kwargs):
         """
-        **Update the traffic shaping settings for an SSID on an MR network**
+        **Update the traffic shaping rules for an SSID on an MR network.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-traffic-shaping-rules
 
         - networkId (string): Network ID

meraki/api/batch/networks.py

@@ -283,7 +283,7 @@ def createNetworkFirmwareUpgradesRollback(self, networkId: str, reasons: list, *
         kwargs.update(locals())
 
         if 'product' in kwargs:
-            options = ['appliance', 'camera', 'cellularGateway', 'cloudGateway', 'switch', 'switchCatalyst', 'wireless']
+            options = ['appliance', 'camera', 'cellularGateway', 'switch', 'switchCatalyst', 'wireless']
             assert kwargs['product'] in options, f'''"product" cannot be "{kwargs['product']}", & must be set to one of: {options}'''
 
         metadata = {

meraki/api/batch/wireless.py

@@ -998,7 +998,7 @@ def updateNetworkWirelessSsidSplashSettings(self, networkId: str, number: str, *
 
     def updateNetworkWirelessSsidTrafficShapingRules(self, networkId: str, number: str, **kwargs):
         """
-        **Update the traffic shaping settings for an SSID on an MR network**
+        **Update the traffic shaping rules for an SSID on an MR network.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-traffic-shaping-rules
 
         - networkId (string): Network ID

meraki/api/networks.py

@@ -730,7 +730,7 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', even
         - total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
         - direction (string): direction to paginate, either "next" or "prev" (default) page
         - event_log_end_time (string): ISO8601 Zulu/UTC time, to use in conjunction with startingAfter, to retrieve events within a time window
-        - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and cloudGateway
+        - productType (string): The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway
         - includedEventTypes (array): A list of event types. The returned events will be filtered to only include events with these types.
         - excludedEventTypes (array): A list of event types. The returned events will be filtered to exclude events with these types.
         - deviceMac (string): The MAC address of the Meraki device which the list of events will be filtered with
@@ -749,7 +749,7 @@ def getNetworkEvents(self, networkId: str, total_pages=1, direction='prev', even
         kwargs.update(locals())
 
         if 'productType' in kwargs:
-            options = ['appliance', 'camera', 'cellularGateway', 'cloudGateway', 'switch', 'systemsManager', 'wireless']
+            options = ['appliance', 'camera', 'cellularGateway', 'switch', 'systemsManager', 'wireless']
             assert kwargs['productType'] in options, f'''"productType" cannot be "{kwargs['productType']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -852,7 +852,7 @@ def createNetworkFirmwareUpgradesRollback(self, networkId: str, reasons: list, *
         kwargs.update(locals())
 
         if 'product' in kwargs:
-            options = ['appliance', 'camera', 'cellularGateway', 'cloudGateway', 'switch', 'switchCatalyst', 'wireless']
+            options = ['appliance', 'camera', 'cellularGateway', 'switch', 'switchCatalyst', 'wireless']
             assert kwargs['product'] in options, f'''"product" cannot be "{kwargs['product']}", & must be set to one of: {options}'''
 
         metadata = {
@@ -2275,7 +2275,7 @@ def updateNetworkTrafficAnalysis(self, networkId: str, **kwargs):
 
     def getNetworkTrafficShapingApplicationCategories(self, networkId: str):
         """
-        **Returns the application categories for traffic shaping rules.**
+        **Returns the application categories for traffic shaping rules**
         https://developer.cisco.com/meraki/api-v1/#!get-network-traffic-shaping-application-categories
 
         - networkId (string): Network ID

meraki/api/organizations.py

@@ -1492,7 +1492,7 @@ def getOrganizationDevices(self, organizationId: str, total_pages=1, direction='
         - 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.
         - configurationUpdatedAfter (string): Filter results by whether or not the device's configuration has been updated after the given timestamp
         - networkIds (array): Optional parameter to filter devices by network.
-        - productTypes (array): Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway.
+        - productTypes (array): Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
         - tags (array): Optional parameter to filter devices by tags.
         - tagsFilterType (string): Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
         - name (string): Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match.
@@ -1724,7 +1724,7 @@ def getOrganizationDevicesStatuses(self, organizationId: str, total_pages=1, dir
         - networkIds (array): Optional parameter to filter devices by network ids.
         - serials (array): Optional parameter to filter devices by serials.
         - statuses (array): Optional parameter to filter devices by statuses. Valid statuses are ["online", "alerting", "offline", "dormant"].
-        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway.
+        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
         - models (array): Optional parameter to filter devices by models.
         - tags (array): An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
         - tagsFilterType (string): An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.
@@ -1762,7 +1762,7 @@ def getOrganizationDevicesStatusesOverview(self, organizationId: str, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!get-organization-devices-statuses-overview
 
         - organizationId (string): Organization ID
-        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway.
+        - productTypes (array): An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.
         - networkIds (array): An optional parameter to filter device statuses by network.
         """
 
@@ -2004,8 +2004,8 @@ def getOrganizationFirmwareUpgrades(self, organizationId: str, **kwargs):
         https://developer.cisco.com/meraki/api-v1/#!get-organization-firmware-upgrades
 
         - organizationId (string): Organization ID
-        - status (array): The status of an upgrade 
-        - productTypes (array): The product type in a given upgrade ID
+        - status (array): Optional parameter to filter the upgrade by status.
+        - productTypes (array): Optional parameter to filter the upgrade by product type.
         """
 
         kwargs.update(locals())
@@ -2117,7 +2117,7 @@ def getOrganizationInventoryDevices(self, organizationId: str, total_pages=1, di
         - orderNumbers (array): Search for devices in inventory based on order numbers.
         - tags (array): Filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
         - tagsFilterType (string): To use with 'tags' parameter, to filter devices which contain ANY or ALL given tags. Accepted values are 'withAnyTags' or 'withAllTags', default is 'withAnyTags'.
-        - productTypes (array): Filter devices by product type. Accepted values are appliance, camera, cellularGateway, cloudGateway, sensor, switch, systemsManager, and wireless.
+        - productTypes (array): Filter devices by product type. Accepted values are appliance, camera, cellularGateway, sensor, switch, systemsManager, and wireless.
         """
 
         kwargs.update(locals())

meraki/api/wireless.py

@@ -2092,7 +2092,7 @@ def updateNetworkWirelessSsidSplashSettings(self, networkId: str, number: str, *
 
     def updateNetworkWirelessSsidTrafficShapingRules(self, networkId: str, number: str, **kwargs):
         """
-        **Update the traffic shaping settings for an SSID on an MR network**
+        **Update the traffic shaping rules for an SSID on an MR network.**
         https://developer.cisco.com/meraki/api-v1/#!update-network-wireless-ssid-traffic-shaping-rules
 
         - networkId (string): Network ID