Skip to content

Commit

Permalink
Automatically regenerated library to version 1.53.0. (#273)
Browse files Browse the repository at this point in the history
Co-authored-by: GitHub Action <support@meraki.com>
  • Loading branch information
TKIPisalegacycipher and GitHub Action authored Dec 5, 2024
1 parent 41b3cbc commit 5e7abed
Show file tree
Hide file tree
Showing 18 changed files with 233 additions and 51 deletions.
2 changes: 1 addition & 1 deletion meraki/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
)
from meraki.rest_session import *

__version__ = '1.52.0'
__version__ = '1.53.0'


class DashboardAPI(object):
Expand Down
2 changes: 1 addition & 1 deletion meraki/aio/api/appliance.py
Original file line number Diff line number Diff line change
Expand Up @@ -2524,7 +2524,7 @@ def getOrganizationApplianceUplinksStatusesOverview(self, organizationId: str):
"""

metadata = {
'tags': ['appliance', 'configure', 'uplinks', 'statuses', 'overview'],
'tags': ['appliance', 'monitor', 'uplinks', 'statuses', 'overview'],
'operation': 'getOrganizationApplianceUplinksStatusesOverview'
}
organizationId = urllib.parse.quote(str(organizationId), safe='')
Expand Down
4 changes: 2 additions & 2 deletions meraki/aio/api/camera.py
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ def createNetworkCameraQualityRetentionProfile(self, networkId: str, name: str,
- motionDetectorVersion (integer): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
- smartRetention (object): Smart Retention records footage in two qualities and intelligently retains higher quality when motion, people or vehicles are detected.
- scheduleId (string): Schedule for which this camera will record video, or 'null' to always record.
- maxRetentionDays (integer): The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 14, 30, 60, 90] days.
- maxRetentionDays (integer): The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be in the range of one to ninety days.
- videoSettings (object): Video quality and resolution settings for all the camera models.
"""

Expand Down Expand Up @@ -542,7 +542,7 @@ def updateNetworkCameraQualityRetentionProfile(self, networkId: str, qualityRete
- motionDetectorVersion (integer): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
- smartRetention (object): Smart Retention records footage in two qualities and intelligently retains higher quality when motion, people or vehicles are detected.
- scheduleId (string): Schedule for which this camera will record video, or 'null' to always record.
- maxRetentionDays (integer): The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 14, 30, 60, 90] days.
- maxRetentionDays (integer): The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be in the range of one to ninety days.
- videoSettings (object): Video quality and resolution settings for all the camera models.
"""

Expand Down
4 changes: 2 additions & 2 deletions meraki/aio/api/licensing.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,14 @@ def getAdministeredLicensingSubscriptionSubscriptionsComplianceStatuses(self, or



def bindAdministeredLicensingSubscriptionSubscription(self, subscriptionId: str, networkIds: list, **kwargs):
def bindAdministeredLicensingSubscriptionSubscription(self, subscriptionId: str, **kwargs):
"""
**Bind networks to a subscription**
https://developer.cisco.com/meraki/api-v1/#!bind-administered-licensing-subscription-subscription
- subscriptionId (string): Subscription ID
- networkIds (array): List of network ids to bind to the subscription
- validate (boolean): Check if the provided networks can be bound to the subscription. Returns any licensing problems and does not commit the results.
- networkIds (array): List of network ids to bind to the subscription
"""

kwargs.update(locals())
Expand Down
4 changes: 2 additions & 2 deletions meraki/aio/api/networks.py
Original file line number Diff line number Diff line change
Expand Up @@ -2797,8 +2797,8 @@ def createNetworkWebhooksPayloadTemplate(self, networkId: str, name: str, **kwar
- name (string): The name of the new template
- body (string): The liquid template used for the body of the webhook message. Either `body` or `bodyFile` must be specified.
- headers (array): The liquid template used with the webhook headers.
- bodyFile (string): A file containing liquid template used for the body of the webhook message. Either `body` or `bodyFile` must be specified.
- headersFile (string): A file containing the liquid template used with the webhook headers.
- bodyFile (string): A Base64 encoded file containing liquid template used for the body of the webhook message. Either `body` or `bodyFile` must be specified.
- headersFile (string): A Base64 encoded file containing the liquid template used with the webhook headers.
"""

kwargs.update(locals())
Expand Down
7 changes: 4 additions & 3 deletions meraki/aio/api/organizations.py
Original file line number Diff line number Diff line change
Expand Up @@ -2839,16 +2839,17 @@ def getOrganizationInventoryOnboardingCloudMonitoringNetworks(self, organization



def createOrganizationInventoryOnboardingCloudMonitoringPrepare(self, organizationId: str, devices: list):
def createOrganizationInventoryOnboardingCloudMonitoringPrepare(self, organizationId: str, devices: list, **kwargs):
"""
**Initiates or updates an import session**
https://developer.cisco.com/meraki/api-v1/#!create-organization-inventory-onboarding-cloud-monitoring-prepare
- organizationId (string): Organization ID
- devices (array): A set of devices to import (or update)
- options (object): Additional options for the import
"""

kwargs = locals()
kwargs.update(locals())

metadata = {
'tags': ['organizations', 'configure', 'inventory', 'onboarding', 'cloudMonitoring', 'prepare'],
Expand All @@ -2857,7 +2858,7 @@ def createOrganizationInventoryOnboardingCloudMonitoringPrepare(self, organizati
organizationId = urllib.parse.quote(str(organizationId), safe='')
resource = f'/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare'

body_params = ['devices', ]
body_params = ['devices', 'options', ]
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}

return self._session.post(metadata, resource, payload)
Expand Down
90 changes: 90 additions & 0 deletions meraki/aio/api/switch.py
Original file line number Diff line number Diff line change
Expand Up @@ -2571,6 +2571,51 @@ def getOrganizationSwitchPortsBySwitch(self, organizationId: str, total_pages=1,



def getOrganizationSwitchPortsClientsOverviewByDevice(self, organizationId: str, total_pages=1, direction='next', **kwargs):
"""
**List the number of clients for all switchports with at least one online client in an organization.**
https://developer.cisco.com/meraki/api-v1/#!get-organization-switch-ports-clients-overview-by-device
- organizationId (string): Organization ID
- 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" (default) or "prev" page
- 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.
- perPage (integer): The number of entries per page returned. Acceptable range is 3 - 20. Default is 20.
- 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.
- configurationUpdatedAfter (string): Optional parameter to filter items to switches where the configuration has been updated after the given timestamp.
- mac (string): Optional parameter to filter items to switches with MAC addresses that contain the search term or are an exact match.
- macs (array): Optional parameter to filter items to switches that have one of the provided MAC addresses.
- name (string): Optional parameter to filter items to switches with names that contain the search term or are an exact match.
- networkIds (array): Optional parameter to filter items to switches in one of the provided networks.
- portProfileIds (array): Optional parameter to filter items to switches that contain switchports belonging to one of the specified port profiles.
- serial (string): Optional parameter to filter items to switches with serial number that contains the search term or are an exact match.
- serials (array): Optional parameter to filter items to switches that have one of the provided serials.
"""

kwargs.update(locals())

metadata = {
'tags': ['switch', 'monitor', 'ports', 'clients', 'overview', 'byDevice'],
'operation': 'getOrganizationSwitchPortsClientsOverviewByDevice'
}
organizationId = urllib.parse.quote(str(organizationId), safe='')
resource = f'/organizations/{organizationId}/switch/ports/clients/overview/byDevice'

query_params = ['t0', 'timespan', 'perPage', 'startingAfter', 'endingBefore', 'configurationUpdatedAfter', 'mac', 'macs', 'name', 'networkIds', 'portProfileIds', 'serial', 'serials', ]
params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}

array_params = ['macs', 'networkIds', 'portProfileIds', 'serials', ]
for k, v in kwargs.items():
if k.strip() in array_params:
params[f'{k.strip()}[]'] = kwargs[f'{k}']
params.pop(k.strip())

return self._session.get_pages(metadata, resource, params, total_pages, direction)



def getOrganizationSwitchPortsOverview(self, organizationId: str, **kwargs):
"""
**Returns the counts of all active ports for the requested timespan, grouped by speed**
Expand Down Expand Up @@ -2639,3 +2684,48 @@ def getOrganizationSwitchPortsStatusesBySwitch(self, organizationId: str, total_

return self._session.get_pages(metadata, resource, params, total_pages, direction)



def getOrganizationSwitchPortsTopologyDiscoveryByDevice(self, organizationId: str, total_pages=1, direction='next', **kwargs):
"""
**List most recently seen LLDP/CDP discovery and topology information per switch port in an organization.**
https://developer.cisco.com/meraki/api-v1/#!get-organization-switch-ports-topology-discovery-by-device
- organizationId (string): Organization ID
- 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" (default) or "prev" page
- 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.
- perPage (integer): The number of entries per page returned. Acceptable range is 3 - 20. Default is 10.
- 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.
- configurationUpdatedAfter (string): Optional parameter to filter items to switches where the configuration has been updated after the given timestamp.
- mac (string): Optional parameter to filter items to switches with MAC addresses that contain the search term or are an exact match.
- macs (array): Optional parameter to filter items to switches that have one of the provided MAC addresses.
- name (string): Optional parameter to filter items to switches with names that contain the search term or are an exact match.
- networkIds (array): Optional parameter to filter items to switches in one of the provided networks.
- portProfileIds (array): Optional parameter to filter items to switches that contain switchports belonging to one of the specified port profiles.
- serial (string): Optional parameter to filter items to switches with serial number that contains the search term or are an exact match.
- serials (array): Optional parameter to filter items to switches that have one of the provided serials.
"""

kwargs.update(locals())

metadata = {
'tags': ['switch', 'monitor', 'ports', 'topology', 'discovery', 'byDevice'],
'operation': 'getOrganizationSwitchPortsTopologyDiscoveryByDevice'
}
organizationId = urllib.parse.quote(str(organizationId), safe='')
resource = f'/organizations/{organizationId}/switch/ports/topology/discovery/byDevice'

query_params = ['t0', 'timespan', 'perPage', 'startingAfter', 'endingBefore', 'configurationUpdatedAfter', 'mac', 'macs', 'name', 'networkIds', 'portProfileIds', 'serial', 'serials', ]
params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}

array_params = ['macs', 'networkIds', 'portProfileIds', 'serials', ]
for k, v in kwargs.items():
if k.strip() in array_params:
params[f'{k.strip()}[]'] = kwargs[f'{k}']
params.pop(k.strip())

return self._session.get_pages(metadata, resource, params, total_pages, direction)

4 changes: 2 additions & 2 deletions meraki/aio/api/wireless.py
Original file line number Diff line number Diff line change
Expand Up @@ -2554,7 +2554,7 @@ def getOrganizationWirelessClientsOverviewByDevice(self, organizationId: str, to
kwargs.update(locals())

metadata = {
'tags': ['wireless', 'configure', 'clients', 'overview', 'byDevice'],
'tags': ['wireless', 'monitor', 'clients', 'overview', 'byDevice'],
'operation': 'getOrganizationWirelessClientsOverviewByDevice'
}
organizationId = urllib.parse.quote(str(organizationId), safe='')
Expand Down Expand Up @@ -2918,7 +2918,7 @@ def getOrganizationWirelessDevicesWirelessControllersByDevice(self, organization
kwargs.update(locals())

metadata = {
'tags': ['wireless', 'configure', 'devices', 'wirelessControllers', 'byDevice'],
'tags': ['wireless', 'monitor', 'devices', 'wirelessControllers', 'byDevice'],
'operation': 'getOrganizationWirelessDevicesWirelessControllersByDevice'
}
organizationId = urllib.parse.quote(str(organizationId), safe='')
Expand Down
Loading

0 comments on commit 5e7abed

Please sign in to comment.