From 0008e98aa776dd7f6a5749e33e20a176563ade4b Mon Sep 17 00:00:00 2001 From: Andrew Schenck Date: Tue, 5 Mar 2024 12:19:53 -0800 Subject: [PATCH 1/8] Injection for requests.Session This commit enables the optional injection of the requests.Session object wrapped by RestSession. Operations teams have use cases for modifying the underlying Session behavior, chief of which is to tweak the HTTP retry policy. Currently, we're monkey-patching our own Session object into the RestSession instance; with this PR, we (and other teams) would be able to perform the same thing without violating software contracts.I can share code examples of how and why we need to do this. Author: Andrew Schenck --- dnacentersdk/api/__init__.py | 6 +++++- dnacentersdk/restsession.py | 7 +++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/dnacentersdk/api/__init__.py b/dnacentersdk/api/__init__.py index e00e4fc7..3862e96b 100644 --- a/dnacentersdk/api/__init__.py +++ b/dnacentersdk/api/__init__.py @@ -654,6 +654,7 @@ def __init__(self, username=None, base_url=None, single_request_timeout=None, wait_on_rate_limit=None, + session=None, verify=None, version=None, debug=None, @@ -702,10 +703,12 @@ def __init__(self, username=None, if the environment variable is not set. verify(bool,basestring): Controls whether we verify the server's TLS certificate, or a string, in which case it must be a path - to a CA bundle to use. Defaults to the DNA_CENTER_VERIFY + to a CA bundle to use. Defaults to the DNA_CENTER_VERIFY environment variable or dnacentersdk.config.DEFAULT_VERIFY if the environment variables are not set. + session(requests.Session): Optionally inject a `requests.Session` + instance to use for HTTP operations. version(basestring): Controls which version of DNA_CENTER to use. Defaults to the DNA_CENTER_VERSION environment variable or dnacentersdk.config.DEFAULT_VERSION @@ -813,6 +816,7 @@ def get_access_token(): base_url=base_url, single_request_timeout=single_request_timeout, wait_on_rate_limit=wait_on_rate_limit, + session=session, verify=verify, version=version, debug=debug, diff --git a/dnacentersdk/restsession.py b/dnacentersdk/restsession.py index bfaa5805..eed7b805 100644 --- a/dnacentersdk/restsession.py +++ b/dnacentersdk/restsession.py @@ -140,6 +140,7 @@ class RestSession(object): def __init__(self, get_access_token, access_token, base_url, single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT, wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT, + session=None, verify=DEFAULT_VERIFY, version=None, debug=False): @@ -156,6 +157,8 @@ def __init__(self, get_access_token, access_token, base_url, HTTP REST API request. wait_on_rate_limit(bool): Enable or disable automatic rate-limit handling. + session(requests.Session): Optionally inject a `requests.Session` + object to be used for HTTP operations. verify(bool,basestring): Controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use. @@ -199,8 +202,8 @@ def __init__(self, get_access_token, access_token, base_url, if verify is False: requests.packages.urllib3.disable_warnings() - # Initialize a new `requests` session - self._req_session = requests.session() + # Use the injected `requests` session, build a new one if not provided + self._req_session = session or requests.session() # Update the headers of the `requests` session self.update_headers({'X-Auth-Token': access_token, From 410d0d4683d706f948441ee53a17a226e6ba608c Mon Sep 17 00:00:00 2001 From: bvargasre Date: Wed, 14 Aug 2024 14:07:41 -0600 Subject: [PATCH 2/8] chore: Refactor error message construction in ApiError class ##164 --- dnacentersdk/exceptions.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/dnacentersdk/exceptions.py b/dnacentersdk/exceptions.py index 514e7f4c..d071b56f 100644 --- a/dnacentersdk/exceptions.py +++ b/dnacentersdk/exceptions.py @@ -126,10 +126,14 @@ def __init__(self, response): except ValueError: logger.warning("Error parsing JSON response body") - self.message = self.details.get("message") or\ - self.details.get("response", {}).get("message")\ - or self.details.get("description")\ - if self.details and isinstance(self.details, dict) else None + # Extract detailed error information + error_code = self.details.get("response", {}).get("errorCode") if self.details else None + message = self.details.get("response", {}).get("message") if self.details else None + detail = self.details.get("response", {}).get("detail") if self.details else None + + # Construct the error message + self.message = f"{error_code} - {message}: {detail}" if error_code and message and detail else \ + message or self.details.get("description") if self.details and isinstance(self.details, dict) else None """The error message from the parsed API response.""" self.description = RESPONSE_CODES.get(self.status_code) From 575d4bbce6ca47424f40b04b6327935c1d587327 Mon Sep 17 00:00:00 2001 From: bvargasre Date: Wed, 14 Aug 2024 18:29:54 -0600 Subject: [PATCH 3/8] chore: Update offset and limit parameter type to support int and str value --- .../api/v2_2_2_3/application_policy.py | 16 +-- dnacentersdk/api/v2_2_2_3/applications.py | 8 +- dnacentersdk/api/v2_2_2_3/compliance.py | 20 +-- .../api/v2_2_2_3/device_onboarding_pnp.py | 16 +-- .../api/v2_2_2_3/device_replacement.py | 8 +- dnacentersdk/api/v2_2_2_3/devices.py | 48 +++---- dnacentersdk/api/v2_2_2_3/discovery.py | 16 +-- dnacentersdk/api/v2_2_2_3/event_management.py | 72 +++++------ .../api/v2_2_2_3/health_and_performance.py | 8 +- dnacentersdk/api/v2_2_2_3/licenses.py | 2 +- dnacentersdk/api/v2_2_2_3/network_settings.py | 16 +-- dnacentersdk/api/v2_2_2_3/path_trace.py | 8 +- dnacentersdk/api/v2_2_2_3/site_design.py | 8 +- dnacentersdk/api/v2_2_2_3/sites.py | 16 +-- .../software_image_management_swim.py | 8 +- dnacentersdk/api/v2_2_2_3/tag.py | 16 +-- dnacentersdk/api/v2_2_2_3/task.py | 12 +- .../api/v2_2_3_3/application_policy.py | 16 +-- dnacentersdk/api/v2_2_3_3/applications.py | 8 +- dnacentersdk/api/v2_2_3_3/compliance.py | 20 +-- .../api/v2_2_3_3/configuration_templates.py | 16 +-- .../api/v2_2_3_3/device_onboarding_pnp.py | 16 +-- .../api/v2_2_3_3/device_replacement.py | 8 +- dnacentersdk/api/v2_2_3_3/devices.py | 48 +++---- dnacentersdk/api/v2_2_3_3/discovery.py | 16 +-- dnacentersdk/api/v2_2_3_3/event_management.py | 72 +++++------ .../api/v2_2_3_3/health_and_performance.py | 8 +- dnacentersdk/api/v2_2_3_3/licenses.py | 2 +- dnacentersdk/api/v2_2_3_3/network_settings.py | 16 +-- dnacentersdk/api/v2_2_3_3/path_trace.py | 8 +- dnacentersdk/api/v2_2_3_3/policy.py | 8 +- dnacentersdk/api/v2_2_3_3/site_design.py | 8 +- dnacentersdk/api/v2_2_3_3/sites.py | 24 ++-- .../software_image_management_swim.py | 8 +- dnacentersdk/api/v2_2_3_3/tag.py | 16 +-- dnacentersdk/api/v2_2_3_3/task.py | 12 +- .../api/v2_3_5_3/application_policy.py | 16 +-- dnacentersdk/api/v2_3_5_3/applications.py | 8 +- dnacentersdk/api/v2_3_5_3/compliance.py | 20 +-- .../api/v2_3_5_3/configuration_templates.py | 16 +-- .../api/v2_3_5_3/device_onboarding_pnp.py | 16 +-- .../api/v2_3_5_3/device_replacement.py | 8 +- dnacentersdk/api/v2_3_5_3/devices.py | 72 +++++------ dnacentersdk/api/v2_3_5_3/discovery.py | 16 +-- dnacentersdk/api/v2_3_5_3/event_management.py | 120 +++++++++--------- .../api/v2_3_5_3/health_and_performance.py | 8 +- dnacentersdk/api/v2_3_5_3/lan_automation.py | 16 +-- dnacentersdk/api/v2_3_5_3/licenses.py | 2 +- dnacentersdk/api/v2_3_5_3/network_settings.py | 16 +-- dnacentersdk/api/v2_3_5_3/path_trace.py | 8 +- dnacentersdk/api/v2_3_5_3/site_design.py | 8 +- dnacentersdk/api/v2_3_5_3/sites.py | 24 ++-- .../software_image_management_swim.py | 8 +- dnacentersdk/api/v2_3_5_3/tag.py | 16 +-- dnacentersdk/api/v2_3_5_3/task.py | 12 +- .../api/v2_3_7_6/application_policy.py | 24 ++-- dnacentersdk/api/v2_3_7_6/applications.py | 8 +- dnacentersdk/api/v2_3_7_6/compliance.py | 8 +- .../api/v2_3_7_6/configuration_archive.py | 8 +- .../api/v2_3_7_6/configuration_templates.py | 16 +-- .../api/v2_3_7_6/device_onboarding_pnp.py | 16 +-- .../api/v2_3_7_6/device_replacement.py | 8 +- dnacentersdk/api/v2_3_7_6/devices.py | 64 +++++----- dnacentersdk/api/v2_3_7_6/discovery.py | 16 +-- dnacentersdk/api/v2_3_7_6/event_management.py | 120 +++++++++--------- .../api/v2_3_7_6/health_and_performance.py | 8 +- dnacentersdk/api/v2_3_7_6/lan_automation.py | 16 +-- dnacentersdk/api/v2_3_7_6/licenses.py | 2 +- dnacentersdk/api/v2_3_7_6/network_settings.py | 16 +-- dnacentersdk/api/v2_3_7_6/path_trace.py | 8 +- dnacentersdk/api/v2_3_7_6/sda.py | 80 ++++++------ dnacentersdk/api/v2_3_7_6/sites.py | 40 +++--- .../software_image_management_swim.py | 8 +- dnacentersdk/api/v2_3_7_6/tag.py | 16 +-- dnacentersdk/api/v2_3_7_6/task.py | 12 +- 75 files changed, 766 insertions(+), 766 deletions(-) diff --git a/dnacentersdk/api/v2_2_2_3/application_policy.py b/dnacentersdk/api/v2_2_2_3/application_policy.py index 081eb586..06131449 100644 --- a/dnacentersdk/api/v2_2_2_3/application_policy.py +++ b/dnacentersdk/api/v2_2_2_3/application_policy.py @@ -73,8 +73,8 @@ def get_application_sets(self, """Get appllication-sets by offset/limit or by name . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -91,8 +91,8 @@ def get_application_sets(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -490,8 +490,8 @@ def get_applications(self, """Get applications by offset/limit or by name . Args: - offset(int): offset query parameter. The offset of the first application to be returned . - limit(int): limit query parameter. The maximum number of applications to be returned . + offset(int,str): offset query parameter. The offset of the first application to be returned . + limit(int,str): limit query parameter. The maximum number of applications to be returned . name(str): name query parameter. Application's name . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -509,8 +509,8 @@ def get_applications(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: diff --git a/dnacentersdk/api/v2_2_2_3/applications.py b/dnacentersdk/api/v2_2_2_3/applications.py index ea52df42..f386d364 100644 --- a/dnacentersdk/api/v2_2_2_3/applications.py +++ b/dnacentersdk/api/v2_2_2_3/applications.py @@ -88,9 +88,9 @@ def applications(self, end_time(int): endTime query parameter. Ending epoch time in milliseconds of time window . application_health(str): applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) . - offset(int): offset query parameter. The offset of the first application in the returned data + offset(int,str): offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) . - limit(int): limit query parameter. The max number of application entries in returned data [1, 1000] + limit(int,str): limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -113,8 +113,8 @@ def applications(self, check_type(start_time, int) check_type(end_time, int) check_type(application_health, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_2_3/compliance.py b/dnacentersdk/api/v2_2_2_3/compliance.py index 44fdac26..d1955e29 100644 --- a/dnacentersdk/api/v2_2_2_3/compliance.py +++ b/dnacentersdk/api/v2_2_2_3/compliance.py @@ -77,8 +77,8 @@ def get_compliance_status_(self, compliance_status(str): complianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -113,8 +113,8 @@ def get_compliance_status(self, compliance_status(str): complianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -132,8 +132,8 @@ def get_compliance_status(self, check_type(headers, dict) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -327,8 +327,8 @@ def get_compliance_detail(self, 'COMPLIANT', 'NON_COMPLIANT', 'IN_PROGRESS', 'NOT_AVAILABLE', 'NOT_APPLICABLE', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of records to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -347,8 +347,8 @@ def get_compliance_detail(self, check_type(compliance_type, str) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_2_3/device_onboarding_pnp.py b/dnacentersdk/api/v2_2_2_3/device_onboarding_pnp.py index d607dfd9..cf7b02fb 100644 --- a/dnacentersdk/api/v2_2_2_3/device_onboarding_pnp.py +++ b/dnacentersdk/api/v2_2_2_3/device_onboarding_pnp.py @@ -197,8 +197,8 @@ def get_device_list(self, devices. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated list of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . serial_number(str, list, set, tuple): serialNumber query parameter. Device Serial Number . @@ -234,8 +234,8 @@ def get_device_list(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(serial_number, (str, list, set, tuple)) @@ -1989,8 +1989,8 @@ def get_workflows(self, 50 workflows. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated lost of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . type(str, list, set, tuple): type query parameter. Workflow Type . @@ -2011,8 +2011,8 @@ def get_workflows(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(type, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_2_2_3/device_replacement.py b/dnacentersdk/api/v2_2_2_3/device_replacement.py index abf98ea4..c3909c29 100644 --- a/dnacentersdk/api/v2_2_2_3/device_replacement.py +++ b/dnacentersdk/api/v2_2_2_3/device_replacement.py @@ -99,8 +99,8 @@ def return_replacement_devices_with_details(self, sort_by(str): sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. . sort_order(str): sortOrder query parameter. Order on displayName[ASC,DESC] . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -125,8 +125,8 @@ def return_replacement_devices_with_details(self, check_type(family, (str, list, set, tuple)) check_type(sort_by, str) check_type(sort_order, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_2_3/devices.py b/dnacentersdk/api/v2_2_2_3/devices.py index ce04993b..97d69d9d 100644 --- a/dnacentersdk/api/v2_2_2_3/devices.py +++ b/dnacentersdk/api/v2_2_2_3/devices.py @@ -216,9 +216,9 @@ def devices(self, health(str): health query parameter. The device overall health (One of POOR, FAIR, GOOD) . start_time(int): startTime query parameter. UTC epoch time in milliseconds . end_time(int): endTime query parameter. UTC epoch time in miliseconds . - limit(int): limit query parameter. Max number of device entries in the response (default to 50. Max at + limit(int,str): limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) . - offset(int): offset query parameter. The offset of the first device in the returned data . + offset(int,str): offset query parameter. The offset of the first device in the returned data . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -239,8 +239,8 @@ def devices(self, check_type(health, str) check_type(start_time, int) check_type(end_time, int) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -292,8 +292,8 @@ def get_all_interfaces(self, """Returns all available interfaces. This endpoint can return a maximum of 500 interfaces . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -309,8 +309,8 @@ def get_all_interfaces(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -1461,8 +1461,8 @@ def retrieves_all_network_devices(self, role(str): role query parameter. role_source(str): roleSource query parameter. associated_wlc_ip(str): associatedWlcIp query parameter. - offset(str): offset query parameter. - limit(str): limit query parameter. + offset(str,int): offset query parameter. + limit(str,int): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -1498,8 +1498,8 @@ def retrieves_all_network_devices(self, check_type(role, str) check_type(role_source, str) check_type(associated_wlc_ip, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -2078,8 +2078,8 @@ def inventory_insight_device_link_mismatch(self, Args: site_id(str): siteId path parameter. - offset(str): offset query parameter. Row Number. Default value is 1 . - limit(str): limit query parameter. Default value is 500 . + offset(str,int): offset query parameter. Row Number. Default value is 1 . + limit(str,int): limit query parameter. Default value is 500 . category(str): category query parameter. Links mismatch category. Value can be speed-duplex or vlan. . sort_by(str): sortBy query parameter. Sort By . @@ -2099,8 +2099,8 @@ def inventory_insight_device_link_mismatch(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(category, str, may_be_none=False) check_type(sort_by, str) @@ -2161,8 +2161,8 @@ def get_devices_with_snmpv3_des(self, Args: site_id(str): siteId path parameter. - offset(str): offset query parameter. Row Number. Default value is 1 . - limit(str): limit query parameter. Default value is 500 . + offset(str,int): offset query parameter. Row Number. Default value is 1 . + limit(str,int): limit query parameter. Default value is 500 . sort_by(str): sortBy query parameter. Sort By . order(str): order query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -2180,8 +2180,8 @@ def get_devices_with_snmpv3_des(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(site_id, str, @@ -2294,8 +2294,8 @@ def get_modules(self, Args: device_id(str): deviceId query parameter. - limit(str): limit query parameter. - offset(str): offset query parameter. + limit(str,int): limit query parameter. + offset(str,int): offset query parameter. name_list(str, list, set, tuple): nameList query parameter. vendor_equipment_type_list(str, list, set, tuple): vendorEquipmentTypeList query parameter. part_number_list(str, list, set, tuple): partNumberList query parameter. @@ -2317,8 +2317,8 @@ def get_modules(self, check_type(headers, dict) check_type(device_id, str, may_be_none=False) - check_type(limit, str) - check_type(offset, str) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(name_list, (str, list, set, tuple)) check_type(vendor_equipment_type_list, (str, list, set, tuple)) check_type(part_number_list, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_2_2_3/discovery.py b/dnacentersdk/api/v2_2_2_3/discovery.py index ed4d33b6..fac8ed0c 100644 --- a/dnacentersdk/api/v2_2_2_3/discovery.py +++ b/dnacentersdk/api/v2_2_2_3/discovery.py @@ -569,8 +569,8 @@ def get_discovery_jobs_by_ip(self, """Returns the list of discovery jobs for the given IP . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -588,8 +588,8 @@ def get_discovery_jobs_by_ip(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str, may_be_none=False) check_type(name, str) @@ -753,8 +753,8 @@ def get_list_of_discoveries_by_discovery_id(self, Args: id(str): id path parameter. Discovery ID . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -771,8 +771,8 @@ def get_list_of_discoveries_by_discovery_id(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_2_2_3/event_management.py b/dnacentersdk/api/v2_2_2_3/event_management.py index 78831d30..c3daf19d 100644 --- a/dnacentersdk/api/v2_2_2_3/event_management.py +++ b/dnacentersdk/api/v2_2_2_3/event_management.py @@ -113,8 +113,8 @@ def get_auditlog_parent_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -154,8 +154,8 @@ def get_auditlog_parent_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -440,8 +440,8 @@ def get_auditlog_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -482,8 +482,8 @@ def get_auditlog_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -644,8 +644,8 @@ def get_notifications(self, domain(str): domain query parameter. sub_domain(str): subDomain query parameter. Sub Domain . source(str): source query parameter. - offset(int): offset query parameter. Start Offset . - limit(int): limit query parameter. # of records . + offset(int,str): offset query parameter. Start Offset . + limit(int,str): limit query parameter. # of records . sort_by(str): sortBy query parameter. Sort By column . order(str): order query parameter. Ascending/Descending order [asc/desc] . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -673,8 +673,8 @@ def get_notifications(self, check_type(domain, str) check_type(sub_domain, str) check_type(source, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -840,9 +840,9 @@ def get_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -863,8 +863,8 @@ def get_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1488,9 +1488,9 @@ def get_email_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1511,8 +1511,8 @@ def get_email_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1633,9 +1633,9 @@ def get_rest_webhook_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1656,8 +1656,8 @@ def get_rest_webhook_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1904,9 +1904,9 @@ def get_syslog_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1927,8 +1927,8 @@ def get_syslog_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1984,9 +1984,9 @@ def get_events(self, Args: event_id(str): eventId query parameter. The registered EventId should be provided . tags(str): tags query parameter. The registered Tags should be provided . - offset(int): offset query parameter. The number of Registries to offset in the resultset whose default + offset(int,str): offset query parameter. The number of Registries to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Registries to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Registries to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2009,8 +2009,8 @@ def get_events(self, check_type(event_id, str) check_type(tags, str, may_be_none=False) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -2130,8 +2130,8 @@ def get_eventartifacts(self, Args: event_ids(str): eventIds query parameter. List of eventIds . tags(str): tags query parameter. Tags defined . - offset(int): offset query parameter. Record start offset . - limit(int): limit query parameter. # of records to return in result set . + offset(int,str): offset query parameter. Record start offset . + limit(int,str): limit query parameter. # of records to return in result set . sort_by(str): sortBy query parameter. Sort by field . order(str): order query parameter. sorting order (asc/desc) . search(str): search query parameter. findd matches in name, description, eventId, type, category @@ -2154,8 +2154,8 @@ def get_eventartifacts(self, check_type(headers, dict) check_type(event_ids, str) check_type(tags, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(search, str) diff --git a/dnacentersdk/api/v2_2_2_3/health_and_performance.py b/dnacentersdk/api/v2_2_2_3/health_and_performance.py index edecbd1c..5407a560 100644 --- a/dnacentersdk/api/v2_2_2_3/health_and_performance.py +++ b/dnacentersdk/api/v2_2_2_3/health_and_performance.py @@ -81,8 +81,8 @@ def system_health(self, subdomain(str): subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -101,8 +101,8 @@ def system_health(self, check_type(summary, bool) check_type(domain, str) check_type(subdomain, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'Content-Type' in headers: check_type(headers.get('Content-Type'), diff --git a/dnacentersdk/api/v2_2_2_3/licenses.py b/dnacentersdk/api/v2_2_2_3/licenses.py index 3335cfe0..7c281c27 100644 --- a/dnacentersdk/api/v2_2_2_3/licenses.py +++ b/dnacentersdk/api/v2_2_2_3/licenses.py @@ -161,7 +161,7 @@ def device_license_summary(self, sort_by(str): sort_by query parameter. Sort result by field . dna_level(str): dna_level query parameter. Device Cisco DNA license level . device_type(str): device_type query parameter. Type of device . - limit(int): limit query parameter. + limit(int,str): limit query parameter. registration_status(str): registration_status query parameter. Smart license registration status of device . virtual_account_name(str): virtual_account_name query parameter. Name of virtual account . diff --git a/dnacentersdk/api/v2_2_2_3/network_settings.py b/dnacentersdk/api/v2_2_2_3/network_settings.py index 593a63b4..bb0b5d03 100644 --- a/dnacentersdk/api/v2_2_2_3/network_settings.py +++ b/dnacentersdk/api/v2_2_2_3/network_settings.py @@ -421,8 +421,8 @@ def get_global_pool(self, """API to get global pool. . Args: - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. No of Global Pools to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -438,8 +438,8 @@ def get_global_pool(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -889,8 +889,8 @@ def get_reserve_ip_subpool(self, Args: site_id(str): siteId query parameter. site id to get the reserve ip associated with the site . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. No of Global Pools to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -907,8 +907,8 @@ def get_reserve_ip_subpool(self, """ check_type(headers, dict) check_type(site_id, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_2_3/path_trace.py b/dnacentersdk/api/v2_2_2_3/path_trace.py index b1d9c94f..317687ea 100644 --- a/dnacentersdk/api/v2_2_2_3/path_trace.py +++ b/dnacentersdk/api/v2_2_2_3/path_trace.py @@ -96,8 +96,8 @@ def retrives_all_previous_pathtraces_summary(self, status(str): status query parameter. task_id(str): taskId query parameter. Task ID . last_update_time(str): lastUpdateTime query parameter. Last update time . - limit(str): limit query parameter. Number of resources returned . - offset(str): offset query parameter. Start index of resources returned (1-based) . + limit(str,int): limit query parameter. Number of resources returned . + offset(str,int): offset query parameter. Start index of resources returned (1-based) . order(str): order query parameter. Order by this field . sort_by(str): sortBy query parameter. Sort by this field . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -126,8 +126,8 @@ def retrives_all_previous_pathtraces_summary(self, check_type(status, str) check_type(task_id, str) check_type(last_update_time, str) - check_type(limit, str) - check_type(offset, str) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(order, str) check_type(sort_by, str) if headers is not None: diff --git a/dnacentersdk/api/v2_2_2_3/site_design.py b/dnacentersdk/api/v2_2_2_3/site_design.py index c92e32af..53974656 100644 --- a/dnacentersdk/api/v2_2_2_3/site_design.py +++ b/dnacentersdk/api/v2_2_2_3/site_design.py @@ -448,8 +448,8 @@ def get_nfv_profile(self, Args: id(str): id path parameter. ID of network profile to retrieve. . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of profile to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of profile to be retrieved . name(str): name query parameter. Name of network profile to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -466,8 +466,8 @@ def get_nfv_profile(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_2_2_3/sites.py b/dnacentersdk/api/v2_2_2_3/sites.py index e723a575..4f25aa7d 100644 --- a/dnacentersdk/api/v2_2_2_3/sites.py +++ b/dnacentersdk/api/v2_2_2_3/sites.py @@ -76,8 +76,8 @@ def get_membership(self, Args: site_id(str): siteId path parameter. Site id to retrieve device associated with the site. . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of sites to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of sites to be retrieved . device_family(str): deviceFamily query parameter. Device family name . serial_number(str): serialNumber query parameter. Device serial number . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -95,8 +95,8 @@ def get_membership(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(device_family, str) check_type(serial_number, str) check_type(site_id, str, @@ -237,8 +237,8 @@ def get_site(self, name(str): name query parameter. siteNameHierarchy (ex: global/groupName) . site_id(str): siteId query parameter. Site id to which site details to retrieve. . type(str): type query parameter. type (ex: area, building, floor) . - offset(str): offset query parameter. offset/starting row. The default value is 1 . - limit(str): limit query parameter. Number of sites to be retrieved. The default value is 500 . + offset(str,int): offset query parameter. offset/starting row. The default value is 1 . + limit(str,int): limit query parameter. Number of sites to be retrieved. The default value is 500 . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -257,8 +257,8 @@ def get_site(self, check_type(name, str) check_type(site_id, str) check_type(type, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_2_3/software_image_management_swim.py b/dnacentersdk/api/v2_2_2_3/software_image_management_swim.py index 5a331ce4..25a3608e 100644 --- a/dnacentersdk/api/v2_2_2_3/software_image_management_swim.py +++ b/dnacentersdk/api/v2_2_2_3/software_image_management_swim.py @@ -250,8 +250,8 @@ def get_software_image_details(self, image_size_lesser_than(int): imageSizeLesserThan query parameter. size in bytes . sort_by(str): sortBy query parameter. sort results by this field . sort_order(str): sortOrder query parameter. sort order 'asc' or 'des'. Default is asc . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -283,8 +283,8 @@ def get_software_image_details(self, check_type(image_size_lesser_than, int) check_type(sort_by, str) check_type(sort_order, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_2_3/tag.py b/dnacentersdk/api/v2_2_2_3/tag.py index 652c47fa..9127b0c5 100644 --- a/dnacentersdk/api/v2_2_2_3/tag.py +++ b/dnacentersdk/api/v2_2_2_3/tag.py @@ -178,8 +178,8 @@ def get_tag(self, additional_info_name_space(str): additionalInfo.nameSpace query parameter. additional_info_attributes(str): additionalInfo.attributes query parameter. level(str): level query parameter. - offset(str): offset query parameter. - limit(str): limit query parameter. + offset(str,int): offset query parameter. + limit(str,int): limit query parameter. size(str): size query parameter. size in kilobytes(KB) . field(str): field query parameter. Available field names are :'name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes' . @@ -206,8 +206,8 @@ def get_tag(self, check_type(additional_info_name_space, str) check_type(additional_info_attributes, str) check_type(level, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(size, str) check_type(field, str) check_type(sort_by, str) @@ -688,9 +688,9 @@ def get_tag_members_by_id(self, id(str): id path parameter. Tag ID . member_type(str): memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API . - offset(str): offset query parameter. Used for pagination. It indicates the starting row number + offset(str,int): offset query parameter. Used for pagination. It indicates the starting row number out of available member records . - limit(str): limit query parameter. Used to Number of maximum members to return in the result . + limit(str,int): limit query parameter. Used to Number of maximum members to return in the result . member_association_type(str): memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag @@ -714,8 +714,8 @@ def get_tag_members_by_id(self, check_type(headers, dict) check_type(member_type, str, may_be_none=False) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(member_association_type, str) check_type(level, str) check_type(id, str, diff --git a/dnacentersdk/api/v2_2_2_3/task.py b/dnacentersdk/api/v2_2_2_3/task.py index 8b5ee759..5605d561 100644 --- a/dnacentersdk/api/v2_2_2_3/task.py +++ b/dnacentersdk/api/v2_2_2_3/task.py @@ -98,8 +98,8 @@ def get_tasks(self, failure_reason(str): failureReason query parameter. Fetch tasks that contains this failure reason . parent_id(str): parentId query parameter. Fetch tasks that have this parent Id . - offset(str): offset query parameter. - limit(str): limit query parameter. + offset(str,int): offset query parameter. + limit(str,int): limit query parameter. sort_by(str): sortBy query parameter. Sort results by this field . order(str): order query parameter. Sort order asc or dsc . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -127,8 +127,8 @@ def get_tasks(self, check_type(is_error, str) check_type(failure_reason, str) check_type(parent_id, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -302,8 +302,8 @@ def get_task_by_operationid(self, Args: operation_id(str): operationId path parameter. - offset(int): offset path parameter. Index, minimum value is 0 . - limit(int): limit path parameter. The maximum value of {limit} supported is 500. Base 1 + offset(int,str): offset path parameter. Index, minimum value is 0 . + limit(int,str): limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 . headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_2_3_3/application_policy.py b/dnacentersdk/api/v2_2_3_3/application_policy.py index c4308156..03a5c73e 100644 --- a/dnacentersdk/api/v2_2_3_3/application_policy.py +++ b/dnacentersdk/api/v2_2_3_3/application_policy.py @@ -545,8 +545,8 @@ def get_application_sets(self, """Get appllication-sets by offset/limit or by name . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -563,8 +563,8 @@ def get_application_sets(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -962,8 +962,8 @@ def get_applications(self, """Get applications by offset/limit or by name . Args: - offset(int): offset query parameter. The offset of the first application to be returned . - limit(int): limit query parameter. The maximum number of applications to be returned . + offset(int,str): offset query parameter. The offset of the first application to be returned . + limit(int,str): limit query parameter. The maximum number of applications to be returned . name(str): name query parameter. Application's name . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -980,8 +980,8 @@ def get_applications(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: diff --git a/dnacentersdk/api/v2_2_3_3/applications.py b/dnacentersdk/api/v2_2_3_3/applications.py index 9cc5bb18..96284711 100644 --- a/dnacentersdk/api/v2_2_3_3/applications.py +++ b/dnacentersdk/api/v2_2_3_3/applications.py @@ -91,9 +91,9 @@ def applications(self, end_time(int): endTime query parameter. Ending epoch time in milliseconds of time window . application_health(str): applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) . - offset(int): offset query parameter. The offset of the first application in the returned data + offset(int,str): offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) . - limit(int): limit query parameter. The max number of application entries in returned data [1, 1000] + limit(int,str): limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) . application_name(str): applicationName query parameter. The name of the application to get information on . @@ -118,8 +118,8 @@ def applications(self, check_type(start_time, int) check_type(end_time, int) check_type(application_health, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(application_name, str) if headers is not None: if 'X-Auth-Token' in headers: diff --git a/dnacentersdk/api/v2_2_3_3/compliance.py b/dnacentersdk/api/v2_2_3_3/compliance.py index b787c6fa..a06b8547 100644 --- a/dnacentersdk/api/v2_2_3_3/compliance.py +++ b/dnacentersdk/api/v2_2_3_3/compliance.py @@ -77,8 +77,8 @@ def get_compliance_status_(self, compliance_status(str): complianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -113,8 +113,8 @@ def get_compliance_status(self, compliance_status(str): complianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -132,8 +132,8 @@ def get_compliance_status(self, check_type(headers, dict) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -327,8 +327,8 @@ def get_compliance_detail(self, 'COMPLIANT', 'NON_COMPLIANT', 'IN_PROGRESS', 'NOT_AVAILABLE', 'NOT_APPLICABLE', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of records to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -347,8 +347,8 @@ def get_compliance_detail(self, check_type(compliance_type, str) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_3_3/configuration_templates.py b/dnacentersdk/api/v2_2_3_3/configuration_templates.py index c371d378..7f0bbf53 100644 --- a/dnacentersdk/api/v2_2_3_3/configuration_templates.py +++ b/dnacentersdk/api/v2_2_3_3/configuration_templates.py @@ -1743,8 +1743,8 @@ def get_projects_details(self, Args: id(str): id query parameter. Id of project to be searched . name(str): name query parameter. Name of project to be searched . - offset(int): offset query parameter. Index of first result . - limit(int): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1763,8 +1763,8 @@ def get_projects_details(self, check_type(headers, dict) check_type(id, str) check_type(name, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_order, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -1845,8 +1845,8 @@ def get_templates_details(self, sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) . all_template_attributes(bool): allTemplateAttributes query parameter. Return all template attributes . include_version_details(bool): includeVersionDetails query parameter. Include template version details . - offset(int): offset query parameter. Index of first result . - limit(int): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -1877,8 +1877,8 @@ def get_templates_details(self, check_type(sort_order, str) check_type(all_template_attributes, bool) check_type(include_version_details, bool) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_3_3/device_onboarding_pnp.py b/dnacentersdk/api/v2_2_3_3/device_onboarding_pnp.py index 58cc7129..047a16b3 100644 --- a/dnacentersdk/api/v2_2_3_3/device_onboarding_pnp.py +++ b/dnacentersdk/api/v2_2_3_3/device_onboarding_pnp.py @@ -197,8 +197,8 @@ def get_device_list(self, devices. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated list of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . serial_number(str, list, set, tuple): serialNumber query parameter. Device Serial Number . @@ -235,8 +235,8 @@ def get_device_list(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(serial_number, (str, list, set, tuple)) @@ -2030,8 +2030,8 @@ def get_workflows(self, 50 workflows. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated lost of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . type(str, list, set, tuple): type query parameter. Workflow Type . @@ -2052,8 +2052,8 @@ def get_workflows(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(type, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_2_3_3/device_replacement.py b/dnacentersdk/api/v2_2_3_3/device_replacement.py index 3d0721d2..c2f555b1 100644 --- a/dnacentersdk/api/v2_2_3_3/device_replacement.py +++ b/dnacentersdk/api/v2_2_3_3/device_replacement.py @@ -99,8 +99,8 @@ def return_replacement_devices_with_details(self, sort_by(str): sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. . sort_order(str): sortOrder query parameter. Order on displayName[ASC,DESC] . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -125,8 +125,8 @@ def return_replacement_devices_with_details(self, check_type(family, (str, list, set, tuple)) check_type(sort_by, str) check_type(sort_order, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_3_3/devices.py b/dnacentersdk/api/v2_2_3_3/devices.py index 8ee4d6d0..463969d1 100644 --- a/dnacentersdk/api/v2_2_3_3/devices.py +++ b/dnacentersdk/api/v2_2_3_3/devices.py @@ -216,9 +216,9 @@ def devices(self, health(str): health query parameter. The device overall health (One of POOR, FAIR, GOOD) . start_time(int): startTime query parameter. UTC epoch time in milliseconds . end_time(int): endTime query parameter. UTC epoch time in miliseconds . - limit(int): limit query parameter. Max number of device entries in the response (default to 50. Max at + limit(int,str): limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) . - offset(int): offset query parameter. The offset of the first device in the returned data . + offset(int,str): offset query parameter. The offset of the first device in the returned data . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -239,8 +239,8 @@ def devices(self, check_type(health, str) check_type(start_time, int) check_type(end_time, int) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -292,8 +292,8 @@ def get_all_interfaces(self, """Returns all available interfaces. This endpoint can return a maximum of 500 interfaces . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -309,8 +309,8 @@ def get_all_interfaces(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -1466,8 +1466,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, role(str): role query parameter. role_source(str): roleSource query parameter. associated_wlc_ip(str): associatedWlcIp query parameter. - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -1503,8 +1503,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, check_type(role, str) check_type(role_source, str) check_type(associated_wlc_ip, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -2083,8 +2083,8 @@ def inventory_insight_device_link_mismatch(self, Args: site_id(str): siteId path parameter. - offset(str): offset query parameter. Row Number. Default value is 1 . - limit(str): limit query parameter. Default value is 500 . + offset(str,int): offset query parameter. Row Number. Default value is 1 . + limit(str,int): limit query parameter. Default value is 500 . category(str): category query parameter. Links mismatch category. Value can be speed-duplex or vlan. . sort_by(str): sortBy query parameter. Sort By . @@ -2104,8 +2104,8 @@ def inventory_insight_device_link_mismatch(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(category, str, may_be_none=False) check_type(sort_by, str) @@ -2166,8 +2166,8 @@ def get_devices_with_snmpv3_des(self, Args: site_id(str): siteId path parameter. - offset(str): offset query parameter. Row Number. Default value is 1 . - limit(str): limit query parameter. Default value is 500 . + offset(str,int): offset query parameter. Row Number. Default value is 1 . + limit(str,int): limit query parameter. Default value is 500 . sort_by(str): sortBy query parameter. Sort By . order(str): order query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -2185,8 +2185,8 @@ def get_devices_with_snmpv3_des(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(site_id, str, @@ -2299,8 +2299,8 @@ def get_modules(self, Args: device_id(str): deviceId query parameter. - limit(str): limit query parameter. - offset(str): offset query parameter. + limit(str,int): limit query parameter. + offset(str,int): offset query parameter. name_list(str, list, set, tuple): nameList query parameter. vendor_equipment_type_list(str, list, set, tuple): vendorEquipmentTypeList query parameter. part_number_list(str, list, set, tuple): partNumberList query parameter. @@ -2322,8 +2322,8 @@ def get_modules(self, check_type(headers, dict) check_type(device_id, str, may_be_none=False) - check_type(limit, str) - check_type(offset, str) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(name_list, (str, list, set, tuple)) check_type(vendor_equipment_type_list, (str, list, set, tuple)) check_type(part_number_list, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_2_3_3/discovery.py b/dnacentersdk/api/v2_2_3_3/discovery.py index 59e7ff69..efdcb07a 100644 --- a/dnacentersdk/api/v2_2_3_3/discovery.py +++ b/dnacentersdk/api/v2_2_3_3/discovery.py @@ -569,8 +569,8 @@ def get_discovery_jobs_by_ip(self, """Returns the list of discovery jobs for the given IP . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -588,8 +588,8 @@ def get_discovery_jobs_by_ip(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str, may_be_none=False) check_type(name, str) @@ -753,8 +753,8 @@ def get_list_of_discoveries_by_discovery_id(self, Args: id(str): id path parameter. Discovery ID . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -771,8 +771,8 @@ def get_list_of_discoveries_by_discovery_id(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_2_3_3/event_management.py b/dnacentersdk/api/v2_2_3_3/event_management.py index 9f039b6c..651cd46b 100644 --- a/dnacentersdk/api/v2_2_3_3/event_management.py +++ b/dnacentersdk/api/v2_2_3_3/event_management.py @@ -113,8 +113,8 @@ def get_auditlog_parent_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -154,8 +154,8 @@ def get_auditlog_parent_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -440,8 +440,8 @@ def get_auditlog_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -482,8 +482,8 @@ def get_auditlog_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -644,8 +644,8 @@ def get_notifications(self, domain(str): domain query parameter. sub_domain(str): subDomain query parameter. Sub Domain . source(str): source query parameter. - offset(int): offset query parameter. Start Offset . - limit(int): limit query parameter. # of records . + offset(int,str): offset query parameter. Start Offset . + limit(int,str): limit query parameter. # of records . sort_by(str): sortBy query parameter. Sort By column . order(str): order query parameter. Ascending/Descending order [asc/desc] . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -673,8 +673,8 @@ def get_notifications(self, check_type(domain, str) check_type(sub_domain, str) check_type(source, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -840,9 +840,9 @@ def get_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -863,8 +863,8 @@ def get_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1488,9 +1488,9 @@ def get_email_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1511,8 +1511,8 @@ def get_email_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1633,9 +1633,9 @@ def get_rest_webhook_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1656,8 +1656,8 @@ def get_rest_webhook_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1904,9 +1904,9 @@ def get_syslog_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1927,8 +1927,8 @@ def get_syslog_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1984,9 +1984,9 @@ def get_events(self, Args: event_id(str): eventId query parameter. The registered EventId should be provided . tags(str): tags query parameter. The registered Tags should be provided . - offset(int): offset query parameter. The number of Registries to offset in the resultset whose default + offset(int,str): offset query parameter. The number of Registries to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Registries to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Registries to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2009,8 +2009,8 @@ def get_events(self, check_type(event_id, str) check_type(tags, str, may_be_none=False) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -2130,8 +2130,8 @@ def get_eventartifacts(self, Args: event_ids(str): eventIds query parameter. List of eventIds . tags(str): tags query parameter. Tags defined . - offset(int): offset query parameter. Record start offset . - limit(int): limit query parameter. # of records to return in result set . + offset(int,str): offset query parameter. Record start offset . + limit(int,str): limit query parameter. # of records to return in result set . sort_by(str): sortBy query parameter. Sort by field . order(str): order query parameter. sorting order (asc/desc) . search(str): search query parameter. findd matches in name, description, eventId, type, category @@ -2154,8 +2154,8 @@ def get_eventartifacts(self, check_type(headers, dict) check_type(event_ids, str) check_type(tags, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(search, str) diff --git a/dnacentersdk/api/v2_2_3_3/health_and_performance.py b/dnacentersdk/api/v2_2_3_3/health_and_performance.py index e1efd9a5..3a378f7b 100644 --- a/dnacentersdk/api/v2_2_3_3/health_and_performance.py +++ b/dnacentersdk/api/v2_2_3_3/health_and_performance.py @@ -81,8 +81,8 @@ def system_health(self, subdomain(str): subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -101,8 +101,8 @@ def system_health(self, check_type(summary, bool) check_type(domain, str) check_type(subdomain, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'Content-Type' in headers: check_type(headers.get('Content-Type'), diff --git a/dnacentersdk/api/v2_2_3_3/licenses.py b/dnacentersdk/api/v2_2_3_3/licenses.py index 99363e24..fed6e7f4 100644 --- a/dnacentersdk/api/v2_2_3_3/licenses.py +++ b/dnacentersdk/api/v2_2_3_3/licenses.py @@ -161,7 +161,7 @@ def device_license_summary(self, sort_by(str): sort_by query parameter. Sort result by field . dna_level(str): dna_level query parameter. Device Cisco DNA license level . device_type(str): device_type query parameter. Type of device . - limit(int): limit query parameter. + limit(int,str): limit query parameter. registration_status(str): registration_status query parameter. Smart license registration status of device . virtual_account_name(str): virtual_account_name query parameter. Name of virtual account . diff --git a/dnacentersdk/api/v2_2_3_3/network_settings.py b/dnacentersdk/api/v2_2_3_3/network_settings.py index 759adc3f..534775e2 100644 --- a/dnacentersdk/api/v2_2_3_3/network_settings.py +++ b/dnacentersdk/api/v2_2_3_3/network_settings.py @@ -421,8 +421,8 @@ def get_global_pool(self, """API to get global pool. . Args: - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. No of Global Pools to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -438,8 +438,8 @@ def get_global_pool(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -889,8 +889,8 @@ def get_reserve_ip_subpool(self, Args: site_id(str): siteId query parameter. site id to get the reserve ip associated with the site . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. No of Global Pools to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -907,8 +907,8 @@ def get_reserve_ip_subpool(self, """ check_type(headers, dict) check_type(site_id, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_3_3/path_trace.py b/dnacentersdk/api/v2_2_3_3/path_trace.py index b11a8fc0..ba82c85a 100644 --- a/dnacentersdk/api/v2_2_3_3/path_trace.py +++ b/dnacentersdk/api/v2_2_3_3/path_trace.py @@ -96,8 +96,8 @@ def retrives_all_previous_pathtraces_summary(self, status(str): status query parameter. task_id(str): taskId query parameter. Task ID . last_update_time(str): lastUpdateTime query parameter. Last update time . - limit(str): limit query parameter. Number of resources returned . - offset(str): offset query parameter. Start index of resources returned (1-based) . + limit(str,int): limit query parameter. Number of resources returned . + offset(str,int): offset query parameter. Start index of resources returned (1-based) . order(str): order query parameter. Order by this field . sort_by(str): sortBy query parameter. Sort by this field . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -126,8 +126,8 @@ def retrives_all_previous_pathtraces_summary(self, check_type(status, str) check_type(task_id, str) check_type(last_update_time, str) - check_type(limit, str) - check_type(offset, str) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(order, str) check_type(sort_by, str) if headers is not None: diff --git a/dnacentersdk/api/v2_2_3_3/policy.py b/dnacentersdk/api/v2_2_3_3/policy.py index 7918fdee..9a80b0ca 100644 --- a/dnacentersdk/api/v2_2_3_3/policy.py +++ b/dnacentersdk/api/v2_2_3_3/policy.py @@ -222,10 +222,10 @@ def get_list_of_profiling_rules(self, data. Defaults to 'Custom Rule'. . include_deleted(bool): includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. . - limit(int): limit query parameter. Maximum number of records to be fetched. If not provided, 500 records + limit(int,str): limit query parameter. Maximum number of records to be fetched. If not provided, 500 records will be fetched by default. To fetch all the records in the system, provide a large value for this parameter. . - offset(int): offset query parameter. Record offset to start data fetch at. Offset starts at zero. . + offset(int,str): offset query parameter. Record offset to start data fetch at. Offset starts at zero. . sort_by(str): sortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. . order(str): order query parameter. Order to be used for sorting. . @@ -246,8 +246,8 @@ def get_list_of_profiling_rules(self, check_type(headers, dict) check_type(rule_type, str) check_type(include_deleted, bool) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: diff --git a/dnacentersdk/api/v2_2_3_3/site_design.py b/dnacentersdk/api/v2_2_3_3/site_design.py index 5f36bc8f..179de967 100644 --- a/dnacentersdk/api/v2_2_3_3/site_design.py +++ b/dnacentersdk/api/v2_2_3_3/site_design.py @@ -573,8 +573,8 @@ def get_nfv_profile(self, Args: id(str): id path parameter. ID of network profile to retrieve. . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of profile to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of profile to be retrieved . name(str): name query parameter. Name of network profile to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -591,8 +591,8 @@ def get_nfv_profile(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_2_3_3/sites.py b/dnacentersdk/api/v2_2_3_3/sites.py index 9518f53d..a72fca89 100644 --- a/dnacentersdk/api/v2_2_3_3/sites.py +++ b/dnacentersdk/api/v2_2_3_3/sites.py @@ -76,8 +76,8 @@ def get_membership(self, Args: site_id(str): siteId path parameter. Site id to retrieve device associated with the site. . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of sites to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of sites to be retrieved . device_family(str): deviceFamily query parameter. Device family name . serial_number(str): serialNumber query parameter. Device serial number . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -95,8 +95,8 @@ def get_membership(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(device_family, str) check_type(serial_number, str) check_type(site_id, str, @@ -237,8 +237,8 @@ def get_site(self, name(str): name query parameter. siteNameHierarchy (ex: global/groupName) . site_id(str): siteId query parameter. Site id to which site details to retrieve. . type(str): type query parameter. type (ex: area, building, floor) . - offset(str): offset query parameter. offset/starting row . - limit(str): limit query parameter. Number of sites to be retrieved . + offset(str,int): offset query parameter. offset/starting row . + limit(str,int): limit query parameter. Number of sites to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -257,8 +257,8 @@ def get_site(self, check_type(name, str) check_type(site_id, str) check_type(type, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -312,9 +312,9 @@ def get_site_health(self, data is required . site_type(str): siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA . - offset(int): offset query parameter. The offset value, starting from 1, of the first returned site + offset(int,str): offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. . - limit(int): limit query parameter. The max number of sites in the returned data set. Default is 25, and + limit(int,str): limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -333,8 +333,8 @@ def get_site_health(self, check_type(headers, dict) check_type(timestamp, str) check_type(site_type, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_3_3/software_image_management_swim.py b/dnacentersdk/api/v2_2_3_3/software_image_management_swim.py index 844934cb..864572b5 100644 --- a/dnacentersdk/api/v2_2_3_3/software_image_management_swim.py +++ b/dnacentersdk/api/v2_2_3_3/software_image_management_swim.py @@ -250,8 +250,8 @@ def get_software_image_details(self, image_size_lesser_than(int): imageSizeLesserThan query parameter. size in bytes . sort_by(str): sortBy query parameter. sort results by this field . sort_order(str): sortOrder query parameter. sort order 'asc' or 'des'. Default is asc . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -283,8 +283,8 @@ def get_software_image_details(self, check_type(image_size_lesser_than, int) check_type(sort_by, str) check_type(sort_order, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_2_3_3/tag.py b/dnacentersdk/api/v2_2_3_3/tag.py index 48cb02e5..f1ef9c3e 100644 --- a/dnacentersdk/api/v2_2_3_3/tag.py +++ b/dnacentersdk/api/v2_2_3_3/tag.py @@ -178,8 +178,8 @@ def get_tag(self, additional_info_name_space(str): additionalInfo.nameSpace query parameter. additional_info_attributes(str): additionalInfo.attributes query parameter. level(str): level query parameter. - offset(str): offset query parameter. - limit(str): limit query parameter. + offset(str,int): offset query parameter. + limit(str,int): limit query parameter. size(str): size query parameter. size in kilobytes(KB) . field(str): field query parameter. Available field names are :'name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes' . @@ -206,8 +206,8 @@ def get_tag(self, check_type(additional_info_name_space, str) check_type(additional_info_attributes, str) check_type(level, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(size, str) check_type(field, str) check_type(sort_by, str) @@ -688,9 +688,9 @@ def get_tag_members_by_id(self, id(str): id path parameter. Tag ID . member_type(str): memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API . - offset(str): offset query parameter. Used for pagination. It indicates the starting row number + offset(str,int): offset query parameter. Used for pagination. It indicates the starting row number out of available member records . - limit(str): limit query parameter. Used to Number of maximum members to return in the result . + limit(str,int): limit query parameter. Used to Number of maximum members to return in the result . member_association_type(str): memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag @@ -714,8 +714,8 @@ def get_tag_members_by_id(self, check_type(headers, dict) check_type(member_type, str, may_be_none=False) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(member_association_type, str) check_type(level, str) check_type(id, str, diff --git a/dnacentersdk/api/v2_2_3_3/task.py b/dnacentersdk/api/v2_2_3_3/task.py index 42c9fda5..2e78c5c3 100644 --- a/dnacentersdk/api/v2_2_3_3/task.py +++ b/dnacentersdk/api/v2_2_3_3/task.py @@ -154,8 +154,8 @@ def get_tasks(self, failure_reason(str): failureReason query parameter. Fetch tasks that contains this failure reason . parent_id(str): parentId query parameter. Fetch tasks that have this parent Id . - offset(str): offset query parameter. - limit(str): limit query parameter. + offset(str,int): offset query parameter. + limit(str,int): limit query parameter. sort_by(str): sortBy query parameter. Sort results by this field . order(str): order query parameter. Sort order asc or dsc . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -183,8 +183,8 @@ def get_tasks(self, check_type(is_error, str) check_type(failure_reason, str) check_type(parent_id, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -358,8 +358,8 @@ def get_task_by_operationid(self, Args: operation_id(str): operationId path parameter. - offset(int): offset path parameter. Index, minimum value is 0 . - limit(int): limit path parameter. The maximum value of {limit} supported is 500. Base 1 + offset(int,str): offset path parameter. Index, minimum value is 0 . + limit(int,str): limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 . headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_3_5_3/application_policy.py b/dnacentersdk/api/v2_3_5_3/application_policy.py index d63ecd48..4356330c 100644 --- a/dnacentersdk/api/v2_3_5_3/application_policy.py +++ b/dnacentersdk/api/v2_3_5_3/application_policy.py @@ -561,8 +561,8 @@ def get_application_sets(self, """Get appllication-sets by offset/limit or by name . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -581,8 +581,8 @@ def get_application_sets(self, https://developer.cisco.com/docs/dna-center/#!get-application-sets """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -992,8 +992,8 @@ def get_applications(self, """Get applications by offset/limit or by name . Args: - offset(int): offset query parameter. The offset of the first application to be returned . - limit(int): limit query parameter. The maximum number of applications to be returned . + offset(int,str): offset query parameter. The offset of the first application to be returned . + limit(int,str): limit query parameter. The maximum number of applications to be returned . name(str): name query parameter. Application's name . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1012,8 +1012,8 @@ def get_applications(self, https://developer.cisco.com/docs/dna-center/#!get-applications """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: diff --git a/dnacentersdk/api/v2_3_5_3/applications.py b/dnacentersdk/api/v2_3_5_3/applications.py index 67c2ba3b..5fae5f09 100644 --- a/dnacentersdk/api/v2_3_5_3/applications.py +++ b/dnacentersdk/api/v2_3_5_3/applications.py @@ -91,9 +91,9 @@ def applications(self, end_time(int): endTime query parameter. Ending epoch time in milliseconds of time window . application_health(str): applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) . - offset(int): offset query parameter. The offset of the first application in the returned data + offset(int,str): offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) . - limit(int): limit query parameter. The max number of application entries in returned data [1, 1000] + limit(int,str): limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) . application_name(str): applicationName query parameter. The name of the application to get information on . @@ -120,8 +120,8 @@ def applications(self, check_type(start_time, int) check_type(end_time, int) check_type(application_health, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(application_name, str) if headers is not None: if 'X-Auth-Token' in headers: diff --git a/dnacentersdk/api/v2_3_5_3/compliance.py b/dnacentersdk/api/v2_3_5_3/compliance.py index ede683d9..28945db6 100644 --- a/dnacentersdk/api/v2_3_5_3/compliance.py +++ b/dnacentersdk/api/v2_3_5_3/compliance.py @@ -77,8 +77,8 @@ def get_compliance_status_(self, compliance_status(str): complianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -116,8 +116,8 @@ def get_compliance_status(self, compliance_status(str): complianceStatus query parameter. Compliance status can be have value among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -137,8 +137,8 @@ def get_compliance_status(self, check_type(headers, dict) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -336,8 +336,8 @@ def get_compliance_detail(self, 'COMPLIANT', 'NON_COMPLIANT', 'IN_PROGRESS', 'NOT_AVAILABLE', 'NOT_APPLICABLE', 'ERROR' . device_uuid(str): deviceUuid query parameter. Comma separated deviceUuids . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -358,8 +358,8 @@ def get_compliance_detail(self, check_type(compliance_type, str) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/configuration_templates.py b/dnacentersdk/api/v2_3_5_3/configuration_templates.py index e4471732..b0b03599 100644 --- a/dnacentersdk/api/v2_3_5_3/configuration_templates.py +++ b/dnacentersdk/api/v2_3_5_3/configuration_templates.py @@ -1902,8 +1902,8 @@ def get_projects_details(self, Args: id(str): id query parameter. Id of project to be searched . name(str): name query parameter. Name of project to be searched . - offset(int): offset query parameter. Index of first result . - limit(int): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1924,8 +1924,8 @@ def get_projects_details(self, check_type(headers, dict) check_type(id, str) check_type(name, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_order, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -2006,8 +2006,8 @@ def get_templates_details(self, sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) . all_template_attributes(bool): allTemplateAttributes query parameter. Return all template attributes . include_version_details(bool): includeVersionDetails query parameter. Include template version details . - offset(int): offset query parameter. Index of first result . - limit(int): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -2040,8 +2040,8 @@ def get_templates_details(self, check_type(sort_order, str) check_type(all_template_attributes, bool) check_type(include_version_details, bool) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/device_onboarding_pnp.py b/dnacentersdk/api/v2_3_5_3/device_onboarding_pnp.py index 69541f93..9e467e2f 100644 --- a/dnacentersdk/api/v2_3_5_3/device_onboarding_pnp.py +++ b/dnacentersdk/api/v2_3_5_3/device_onboarding_pnp.py @@ -199,8 +199,8 @@ def get_device_list(self, devices. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated list of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . serial_number(str, list, set, tuple): serialNumber query parameter. Device Serial Number . @@ -239,8 +239,8 @@ def get_device_list(self, https://developer.cisco.com/docs/dna-center/#!get-device-list """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(serial_number, (str, list, set, tuple)) @@ -2072,8 +2072,8 @@ def get_workflows(self, 50 workflows. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated lost of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . type(str, list, set, tuple): type query parameter. Workflow Type . @@ -2096,8 +2096,8 @@ def get_workflows(self, https://developer.cisco.com/docs/dna-center/#!get-workflows """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(type, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_3_5_3/device_replacement.py b/dnacentersdk/api/v2_3_5_3/device_replacement.py index 3dd7ef99..9c0f1bb2 100644 --- a/dnacentersdk/api/v2_3_5_3/device_replacement.py +++ b/dnacentersdk/api/v2_3_5_3/device_replacement.py @@ -99,8 +99,8 @@ def return_replacement_devices_with_details(self, sort_by(str): sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. . sort_order(str): sortOrder query parameter. Order on displayName[ASC,DESC] . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -127,8 +127,8 @@ def return_replacement_devices_with_details(self, check_type(family, (str, list, set, tuple)) check_type(sort_by, str) check_type(sort_order, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/devices.py b/dnacentersdk/api/v2_3_5_3/devices.py index acb77ed6..f76fdeb7 100644 --- a/dnacentersdk/api/v2_3_5_3/devices.py +++ b/dnacentersdk/api/v2_3_5_3/devices.py @@ -75,8 +75,8 @@ def get_planned_access_points_for_building(self, Args: building_id(str): buildingId path parameter. Building Id . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. radios(bool): radios query parameter. inlcude planned radio details . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -95,8 +95,8 @@ def get_planned_access_points_for_building(self, https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-building """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(radios, bool) check_type(building_id, str, may_be_none=False) @@ -293,9 +293,9 @@ def devices(self, health(str): health query parameter. The device overall health (One of POOR, FAIR, GOOD) . start_time(int): startTime query parameter. UTC epoch time in milliseconds . end_time(int): endTime query parameter. UTC epoch time in miliseconds . - limit(int): limit query parameter. Max number of device entries in the response (default to 50. Max at + limit(int,str): limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) . - offset(int): offset query parameter. The offset of the first device in the returned data . + offset(int,str): offset query parameter. The offset of the first device in the returned data . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -318,8 +318,8 @@ def devices(self, check_type(health, str) check_type(start_time, int) check_type(end_time, int) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -374,8 +374,8 @@ def get_planned_access_points_for_floor(self, Args: floor_id(str): floorId path parameter. Floor Id . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. radios(bool): radios query parameter. inlcude planned radio details . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -394,8 +394,8 @@ def get_planned_access_points_for_floor(self, https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-floor """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(radios, bool) check_type(floor_id, str, may_be_none=False) @@ -446,8 +446,8 @@ def get_all_interfaces(self, """Returns all available interfaces. This endpoint can return a maximum of 500 interfaces . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. last_input_time(str): lastInputTime query parameter. Last Input Time . last_output_time(str): lastOutputTime query parameter. Last Output Time . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -467,8 +467,8 @@ def get_all_interfaces(self, https://developer.cisco.com/docs/dna-center/#!get-all-interfaces """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(last_input_time, str) check_type(last_output_time, str) if headers is not None: @@ -1353,8 +1353,8 @@ def get_device_list(self, the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. . device_support_level(str): deviceSupportLevel query parameter. - offset(int): offset query parameter. offset >= 1 [X gives results from Xth device onwards] . - limit(int): limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] + offset(int,str): offset query parameter. offset >= 1 [X gives results from Xth device onwards] . + limit(int,str): limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1405,8 +1405,8 @@ def get_device_list(self, check_type(module_operationstatecode, (str, list, set, tuple)) check_type(id, str) check_type(device_support_level, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -1910,8 +1910,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, role(str): role query parameter. role_source(str): roleSource query parameter. associated_wlc_ip(str): associatedWlcIp query parameter. - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -1949,8 +1949,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, check_type(role, str) check_type(role_source, str) check_type(associated_wlc_ip, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -2545,8 +2545,8 @@ def inventory_insight_device_link_mismatch(self, Args: site_id(str): siteId path parameter. - offset(int): offset query parameter. Row Number. Default value is 1 . - limit(int): limit query parameter. Default value is 500 . + offset(int,str): offset query parameter. Row Number. Default value is 1 . + limit(int,str): limit query parameter. Default value is 500 . category(str): category query parameter. Links mismatch category. Value can be speed-duplex or vlan. . sort_by(str): sortBy query parameter. Sort By . @@ -2568,8 +2568,8 @@ def inventory_insight_device_link_mismatch(self, https://developer.cisco.com/docs/dna-center/#!inventory-insight-device-link-mismatch """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(category, str, may_be_none=False) check_type(sort_by, str) @@ -2630,8 +2630,8 @@ def get_devices_with_snmpv3_des(self, Args: site_id(str): siteId path parameter. - offset(int): offset query parameter. Row Number. Default value is 1 . - limit(int): limit query parameter. Default value is 500 . + offset(int,str): offset query parameter. Row Number. Default value is 1 . + limit(int,str): limit query parameter. Default value is 500 . sort_by(str): sortBy query parameter. Sort By . order(str): order query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -2651,8 +2651,8 @@ def get_devices_with_snmpv3_des(self, https://developer.cisco.com/docs/dna-center/#!get-devices-with-snmpv3-des """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(site_id, str, @@ -2767,8 +2767,8 @@ def get_modules(self, Args: device_id(str): deviceId query parameter. - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. name_list(str, list, set, tuple): nameList query parameter. vendor_equipment_type_list(str, list, set, tuple): vendorEquipmentTypeList query parameter. part_number_list(str, list, set, tuple): partNumberList query parameter. @@ -2792,8 +2792,8 @@ def get_modules(self, check_type(headers, dict) check_type(device_id, str, may_be_none=False) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(name_list, (str, list, set, tuple)) check_type(vendor_equipment_type_list, (str, list, set, tuple)) check_type(part_number_list, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_3_5_3/discovery.py b/dnacentersdk/api/v2_3_5_3/discovery.py index 5bb8c0d2..5af50b33 100644 --- a/dnacentersdk/api/v2_3_5_3/discovery.py +++ b/dnacentersdk/api/v2_3_5_3/discovery.py @@ -578,8 +578,8 @@ def get_discovery_jobs_by_ip(self, """Returns the list of discovery jobs for the given IP . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -599,8 +599,8 @@ def get_discovery_jobs_by_ip(self, https://developer.cisco.com/docs/dna-center/#!get-discovery-jobs-by-ip """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str, may_be_none=False) check_type(name, str) @@ -768,8 +768,8 @@ def get_list_of_discoveries_by_discovery_id(self, Args: id(str): id path parameter. Discovery ID . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -788,8 +788,8 @@ def get_list_of_discoveries_by_discovery_id(self, https://developer.cisco.com/docs/dna-center/#!get-list-of-discoveries-by-discovery-id """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_3_5_3/event_management.py b/dnacentersdk/api/v2_3_5_3/event_management.py index 1f2b4f16..4e3de54a 100644 --- a/dnacentersdk/api/v2_3_5_3/event_management.py +++ b/dnacentersdk/api/v2_3_5_3/event_management.py @@ -113,8 +113,8 @@ def get_auditlog_parent_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -156,8 +156,8 @@ def get_auditlog_parent_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -444,8 +444,8 @@ def get_auditlog_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -488,8 +488,8 @@ def get_auditlog_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -895,8 +895,8 @@ def get_notifications(self, domain(str): domain query parameter. sub_domain(str): subDomain query parameter. Sub Domain . source(str): source query parameter. - offset(int): offset query parameter. Start Offset . - limit(int): limit query parameter. # of records . + offset(int,str): offset query parameter. Start Offset . + limit(int,str): limit query parameter. # of records . sort_by(str): sortBy query parameter. Sort By column . order(str): order query parameter. Ascending/Descending order [asc/desc] . tags(str): tags query parameter. @@ -929,8 +929,8 @@ def get_notifications(self, check_type(domain, str) check_type(sub_domain, str) check_type(source, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(tags, str) @@ -1106,9 +1106,9 @@ def get_snmp_destination(self, Args: config_id(str): configId query parameter. List of SNMP configurations . - offset(int): offset query parameter. The number of SNMP configuration's to offset in the resultset whose + offset(int,str): offset query parameter. The number of SNMP configuration's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of SNMP configuration's to limit in the resultset whose + limit(int,str): limit query parameter. The number of SNMP configuration's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1130,8 +1130,8 @@ def get_snmp_destination(self, """ check_type(headers, dict) check_type(config_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1186,9 +1186,9 @@ def get_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1211,8 +1211,8 @@ def get_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1456,9 +1456,9 @@ def get_email_subscription_details(self, Args: name(str): name query parameter. Name of the specific configuration . instance_id(str): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Email Subscription detail's to offset in the + offset(int,str): offset query parameter. The number of Email Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Email Subscription detail's to limit in the resultset + limit(int,str): limit query parameter. The number of Email Subscription detail's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1482,8 +1482,8 @@ def get_email_subscription_details(self, check_type(headers, dict) check_type(name, str) check_type(instance_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1541,9 +1541,9 @@ def get_rest_webhook_subscription_details(self, Args: name(str): name query parameter. Name of the specific configuration . instance_id(str): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Rest/Webhook Subscription detail's to offset in the + offset(int,str): offset query parameter. The number of Rest/Webhook Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Rest/Webhook Subscription detail's to limit in the + limit(int,str): limit query parameter. The number of Rest/Webhook Subscription detail's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1567,8 +1567,8 @@ def get_rest_webhook_subscription_details(self, check_type(headers, dict) check_type(name, str) check_type(instance_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1626,9 +1626,9 @@ def get_syslog_subscription_details(self, Args: name(str): name query parameter. Name of the specific configuration . instance_id(str): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Syslog Subscription detail's to offset in the + offset(int,str): offset query parameter. The number of Syslog Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Syslog Subscription detail's to limit in the resultset + limit(int,str): limit query parameter. The number of Syslog Subscription detail's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1652,8 +1652,8 @@ def get_syslog_subscription_details(self, check_type(headers, dict) check_type(name, str) check_type(instance_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1907,9 +1907,9 @@ def get_email_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1940,8 +1940,8 @@ def get_email_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(domain, str) @@ -2084,9 +2084,9 @@ def get_rest_webhook_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2116,8 +2116,8 @@ def get_rest_webhook_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(domain, str) @@ -2390,9 +2390,9 @@ def get_syslog_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2422,8 +2422,8 @@ def get_syslog_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(domain, str) @@ -2591,9 +2591,9 @@ def get_syslog_destination(self, config_id(str): configId query parameter. Config id of syslog server . name(str): name query parameter. Name of syslog server . protocol(str): protocol query parameter. Protocol of syslog server . - offset(int): offset query parameter. The number of syslog configuration's to offset in the resultset + offset(int,str): offset query parameter. The number of syslog configuration's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of syslog configuration's to limit in the resultset whose + limit(int,str): limit query parameter. The number of syslog configuration's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2617,8 +2617,8 @@ def get_syslog_destination(self, check_type(config_id, str) check_type(name, str) check_type(protocol, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -2959,9 +2959,9 @@ def get_webhook_destination(self, Args: webhook_ids(str): webhookIds query parameter. List of webhook configurations . - offset(int): offset query parameter. The number of webhook configuration's to offset in the resultset + offset(int,str): offset query parameter. The number of webhook configuration's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of webhook configuration's to limit in the resultset whose + limit(int,str): limit query parameter. The number of webhook configuration's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2983,8 +2983,8 @@ def get_webhook_destination(self, """ check_type(headers, dict) check_type(webhook_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -3040,9 +3040,9 @@ def get_events(self, Args: event_id(str): eventId query parameter. The registered EventId should be provided . tags(str): tags query parameter. The registered Tags should be provided . - offset(int): offset query parameter. The number of Registries to offset in the resultset whose default + offset(int,str): offset query parameter. The number of Registries to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Registries to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Registries to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -3067,8 +3067,8 @@ def get_events(self, check_type(event_id, str) check_type(tags, str, may_be_none=False) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -3190,8 +3190,8 @@ def get_eventartifacts(self, Args: event_ids(str): eventIds query parameter. List of eventIds . tags(str): tags query parameter. Tags defined . - offset(int): offset query parameter. Record start offset . - limit(int): limit query parameter. # of records to return in result set . + offset(int,str): offset query parameter. Record start offset . + limit(int,str): limit query parameter. # of records to return in result set . sort_by(str): sortBy query parameter. Sort by field . order(str): order query parameter. sorting order (asc/desc) . search(str): search query parameter. findd matches in name, description, eventId, type, category @@ -3216,8 +3216,8 @@ def get_eventartifacts(self, check_type(headers, dict) check_type(event_ids, str) check_type(tags, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(search, str) diff --git a/dnacentersdk/api/v2_3_5_3/health_and_performance.py b/dnacentersdk/api/v2_3_5_3/health_and_performance.py index 64421df6..d405e4da 100644 --- a/dnacentersdk/api/v2_3_5_3/health_and_performance.py +++ b/dnacentersdk/api/v2_3_5_3/health_and_performance.py @@ -81,8 +81,8 @@ def system_health(self, subdomain(str): subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -103,8 +103,8 @@ def system_health(self, check_type(summary, bool) check_type(domain, str) check_type(subdomain, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/lan_automation.py b/dnacentersdk/api/v2_3_5_3/lan_automation.py index 33fc7bdd..d69e46b7 100644 --- a/dnacentersdk/api/v2_3_5_3/lan_automation.py +++ b/dnacentersdk/api/v2_3_5_3/lan_automation.py @@ -220,8 +220,8 @@ def lan_automation_log(self, """Invoke this API to get the LAN Automation session logs. . Args: - offset(int): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . - limit(int): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can + offset(int,str): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . + limit(int,str): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -240,8 +240,8 @@ def lan_automation_log(self, https://developer.cisco.com/docs/dna-center/#!lan-automation-log """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -494,8 +494,8 @@ def lan_automation_status(self, """Invoke this API to get the LAN Automation session status. . Args: - offset(int): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . - limit(int): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can + offset(int,str): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . + limit(int,str): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -514,8 +514,8 @@ def lan_automation_status(self, https://developer.cisco.com/docs/dna-center/#!lan-automation-status """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/licenses.py b/dnacentersdk/api/v2_3_5_3/licenses.py index e9f88841..f7d963f1 100644 --- a/dnacentersdk/api/v2_3_5_3/licenses.py +++ b/dnacentersdk/api/v2_3_5_3/licenses.py @@ -180,7 +180,7 @@ def device_license_summary2(self, sort_by(str): sort_by query parameter. Sort result by field . dna_level(str): dna_level query parameter. Device Cisco DNA license level . device_type(str): device_type query parameter. Type of device . - limit(int): limit query parameter. + limit(int,str): limit query parameter. registration_status(str): registration_status query parameter. Smart license registration status of device . virtual_account_name(str): virtual_account_name query parameter. Name of virtual account . diff --git a/dnacentersdk/api/v2_3_5_3/network_settings.py b/dnacentersdk/api/v2_3_5_3/network_settings.py index 3dc35fe0..6931e319 100644 --- a/dnacentersdk/api/v2_3_5_3/network_settings.py +++ b/dnacentersdk/api/v2_3_5_3/network_settings.py @@ -455,8 +455,8 @@ def get_global_pool(self, """API to get global pool. . Args: - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. No of Global Pools to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -474,8 +474,8 @@ def get_global_pool(self, https://developer.cisco.com/docs/dna-center/#!get-global-pool """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -939,8 +939,8 @@ def get_reserve_ip_subpool(self, Args: site_id(str): siteId query parameter. site id to get the reserve ip associated with the site . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. No of Global Pools to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -959,8 +959,8 @@ def get_reserve_ip_subpool(self, """ check_type(headers, dict) check_type(site_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/path_trace.py b/dnacentersdk/api/v2_3_5_3/path_trace.py index 354c3e4e..3a3d65b2 100644 --- a/dnacentersdk/api/v2_3_5_3/path_trace.py +++ b/dnacentersdk/api/v2_3_5_3/path_trace.py @@ -96,8 +96,8 @@ def retrives_all_previous_pathtraces_summary(self, status(str): status query parameter. task_id(str): taskId query parameter. Task ID . last_update_time(str): lastUpdateTime query parameter. Last update time . - limit(int): limit query parameter. Number of resources returned . - offset(int): offset query parameter. Start index of resources returned (1-based) . + limit(int,str): limit query parameter. Number of resources returned . + offset(int,str): offset query parameter. Start index of resources returned (1-based) . order(str): order query parameter. Order by this field . sort_by(str): sortBy query parameter. Sort by this field . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -128,8 +128,8 @@ def retrives_all_previous_pathtraces_summary(self, check_type(status, str) check_type(task_id, str) check_type(last_update_time, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(order, str) check_type(sort_by, str) if headers is not None: diff --git a/dnacentersdk/api/v2_3_5_3/site_design.py b/dnacentersdk/api/v2_3_5_3/site_design.py index d28dc674..bffc55b0 100644 --- a/dnacentersdk/api/v2_3_5_3/site_design.py +++ b/dnacentersdk/api/v2_3_5_3/site_design.py @@ -587,8 +587,8 @@ def get_nfv_profile(self, Args: id(str): id path parameter. ID of network profile to retrieve. . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of profile to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of profile to be retrieved . name(str): name query parameter. Name of network profile to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -607,8 +607,8 @@ def get_nfv_profile(self, https://developer.cisco.com/docs/dna-center/#!get-nfv-profile """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_3_5_3/sites.py b/dnacentersdk/api/v2_3_5_3/sites.py index 9888b1c1..78fb9717 100644 --- a/dnacentersdk/api/v2_3_5_3/sites.py +++ b/dnacentersdk/api/v2_3_5_3/sites.py @@ -162,8 +162,8 @@ def get_membership(self, Args: site_id(str): siteId path parameter. Site id to retrieve device associated with the site. . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of sites to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of sites to be retrieved . device_family(str): deviceFamily query parameter. Device family name . serial_number(str): serialNumber query parameter. Device serial number . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -183,8 +183,8 @@ def get_membership(self, https://developer.cisco.com/docs/dna-center/#!get-membership """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(device_family, str) check_type(serial_number, str) check_type(site_id, str, @@ -327,8 +327,8 @@ def get_site(self, name(str): name query parameter. siteNameHierarchy (ex: global/groupName) . site_id(str): siteId query parameter. Site id to which site details to retrieve. . type(str): type query parameter. type (ex: area, building, floor) . - offset(int): offset query parameter. offset/starting row. The default value is 1 . - limit(int): limit query parameter. Number of sites to be retrieved. The default value is 500 . + offset(int,str): offset query parameter. offset/starting row. The default value is 1 . + limit(int,str): limit query parameter. Number of sites to be retrieved. The default value is 500 . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -349,8 +349,8 @@ def get_site(self, check_type(name, str) check_type(site_id, str) check_type(type, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -404,9 +404,9 @@ def get_site_health(self, data is required . site_type(str): siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA . - offset(int): offset query parameter. The offset value, starting from 1, of the first returned site + offset(int,str): offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. . - limit(int): limit query parameter. The max number of sites in the returned data set. Default is 25, and + limit(int,str): limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -427,8 +427,8 @@ def get_site_health(self, check_type(headers, dict) check_type(timestamp, str) check_type(site_type, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/software_image_management_swim.py b/dnacentersdk/api/v2_3_5_3/software_image_management_swim.py index 72d944e4..48ee5f35 100644 --- a/dnacentersdk/api/v2_3_5_3/software_image_management_swim.py +++ b/dnacentersdk/api/v2_3_5_3/software_image_management_swim.py @@ -254,8 +254,8 @@ def get_software_image_details(self, image_size_lesser_than(int): imageSizeLesserThan query parameter. size in bytes . sort_by(str): sortBy query parameter. sort results by this field . sort_order(str): sortOrder query parameter. sort order 'asc' or 'des'. Default is asc . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -289,8 +289,8 @@ def get_software_image_details(self, check_type(image_size_lesser_than, int) check_type(sort_by, str) check_type(sort_order, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_5_3/tag.py b/dnacentersdk/api/v2_3_5_3/tag.py index 9f289f53..021af346 100644 --- a/dnacentersdk/api/v2_3_5_3/tag.py +++ b/dnacentersdk/api/v2_3_5_3/tag.py @@ -180,8 +180,8 @@ def get_tag(self, additional_info_name_space(str): additionalInfo.nameSpace query parameter. additional_info_attributes(str): additionalInfo.attributes query parameter. level(str): level query parameter. - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. size(str): size query parameter. size in kilobytes(KB) . field(str): field query parameter. Available field names are :'name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes' . @@ -210,8 +210,8 @@ def get_tag(self, check_type(additional_info_name_space, str) check_type(additional_info_attributes, str) check_type(level, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(size, str) check_type(field, str) check_type(sort_by, str) @@ -704,9 +704,9 @@ def get_tag_members_by_id(self, id(str): id path parameter. Tag ID . member_type(str): memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API . - offset(str): offset query parameter. Used for pagination. It indicates the starting row number + offset(str,int): offset query parameter. Used for pagination. It indicates the starting row number out of available member records . - limit(str): limit query parameter. Used to Number of maximum members to return in the result . + limit(str,int): limit query parameter. Used to Number of maximum members to return in the result . member_association_type(str): memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag @@ -732,8 +732,8 @@ def get_tag_members_by_id(self, check_type(headers, dict) check_type(member_type, str, may_be_none=False) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(member_association_type, str) check_type(level, str) check_type(id, str, diff --git a/dnacentersdk/api/v2_3_5_3/task.py b/dnacentersdk/api/v2_3_5_3/task.py index bf40fecf..abbd3445 100644 --- a/dnacentersdk/api/v2_3_5_3/task.py +++ b/dnacentersdk/api/v2_3_5_3/task.py @@ -156,8 +156,8 @@ def get_tasks(self, failure_reason(str): failureReason query parameter. Fetch tasks that contains this failure reason . parent_id(str): parentId query parameter. Fetch tasks that have this parent Id . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. sort_by(str): sortBy query parameter. Sort results by this field . order(str): order query parameter. Sort order asc or dsc . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -187,8 +187,8 @@ def get_tasks(self, check_type(is_error, str) check_type(failure_reason, str) check_type(parent_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -364,8 +364,8 @@ def get_task_by_operationid(self, Args: operation_id(str): operationId path parameter. - offset(int): offset path parameter. Index, minimum value is 0 . - limit(int): limit path parameter. The maximum value of {limit} supported is 500. Base 1 + offset(int,str): offset path parameter. Index, minimum value is 0 . + limit(int,str): limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 . headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_3_7_6/application_policy.py b/dnacentersdk/api/v2_3_7_6/application_policy.py index 2e507f62..4dfad023 100644 --- a/dnacentersdk/api/v2_3_7_6/application_policy.py +++ b/dnacentersdk/api/v2_3_7_6/application_policy.py @@ -545,8 +545,8 @@ def get_application_sets(self, """Get appllication-sets by offset/limit or by name . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -563,8 +563,8 @@ def get_application_sets(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -962,8 +962,8 @@ def get_applications2(self, """Get applications by offset/limit or by name . Args: - offset(int): offset query parameter. The offset of the first application to be returned . - limit(int): limit query parameter. The maximum number of applications to be returned . + offset(int,str): offset query parameter. The offset of the first application to be returned . + limit(int,str): limit query parameter. The maximum number of applications to be returned . name(str): name query parameter. Application's name . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -981,8 +981,8 @@ def get_applications2(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(name, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -1436,9 +1436,9 @@ def get_application_sets2(self, Args: attributes(str): attributes query parameter. Attributes to retrieve, valid value applicationSet . name(str): name query parameter. Application set name . - offset(int): offset query parameter. The starting point or index from where the paginated results should + offset(int,str): offset query parameter. The starting point or index from where the paginated results should begin. . - limit(int): limit query parameter. The limit which is the maximum number of items to include in a single + limit(int,str): limit query parameter. The limit which is the maximum number of items to include in a single page of results, max value 500 . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1754,9 +1754,9 @@ def get_applications(self, Args: attributes(str): attributes query parameter. Attributes to retrieve, valid value application . name(str): name query parameter. The application name . - offset(int): offset query parameter. The starting point or index from where the paginated results should + offset(int,str): offset query parameter. The starting point or index from where the paginated results should begin. . - limit(int): limit query parameter. The limit which is the maximum number of items to include in a single + limit(int,str): limit query parameter. The limit which is the maximum number of items to include in a single page of results, max value 500 . headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_3_7_6/applications.py b/dnacentersdk/api/v2_3_7_6/applications.py index 6a00033f..e6e6caa5 100644 --- a/dnacentersdk/api/v2_3_7_6/applications.py +++ b/dnacentersdk/api/v2_3_7_6/applications.py @@ -91,9 +91,9 @@ def applications(self, end_time(int): endTime query parameter. Ending epoch time in milliseconds of time window . application_health(str): applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) . - offset(int): offset query parameter. The offset of the first application in the returned data + offset(int,str): offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) . - limit(int): limit query parameter. The max number of application entries in returned data [1, 1000] + limit(int,str): limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) . application_name(str): applicationName query parameter. The name of the application to get information on . @@ -118,8 +118,8 @@ def applications(self, check_type(start_time, int) check_type(end_time, int) check_type(application_health, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(application_name, str) if headers is not None: if 'X-Auth-Token' in headers: diff --git a/dnacentersdk/api/v2_3_7_6/compliance.py b/dnacentersdk/api/v2_3_7_6/compliance.py index 4fab4066..db013bec 100644 --- a/dnacentersdk/api/v2_3_7_6/compliance.py +++ b/dnacentersdk/api/v2_3_7_6/compliance.py @@ -317,8 +317,8 @@ def get_compliance_detail(self, commas. The Compliance status can be 'COMPLIANT', 'NON_COMPLIANT', 'IN_PROGRESS', 'NOT_AVAILABLE', 'NOT_APPLICABLE', 'ERROR'. . device_uuid(str): deviceUuid query parameter. Comma separated "Device Id(s)" . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of records to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of records to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -337,8 +337,8 @@ def get_compliance_detail(self, check_type(compliance_type, str) check_type(compliance_status, str) check_type(device_uuid, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/configuration_archive.py b/dnacentersdk/api/v2_3_7_6/configuration_archive.py index bed36919..2088ed54 100644 --- a/dnacentersdk/api/v2_3_7_6/configuration_archive.py +++ b/dnacentersdk/api/v2_3_7_6/configuration_archive.py @@ -167,8 +167,8 @@ def get_configuration_archive_details(self, : time in milliseconds (epoc format) . created_by(str): createdBy query parameter. Comma separated values for createdBy SCHEDULED, USER, CONFIG_CHANGE_EVENT, SCHEDULED_FIRST_TIME, DR_CALL_BACK, PRE_DEPLOY . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -189,8 +189,8 @@ def get_configuration_archive_details(self, check_type(file_type, str) check_type(created_time, str) check_type(created_by, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/configuration_templates.py b/dnacentersdk/api/v2_3_7_6/configuration_templates.py index bf2a418b..3512f66c 100644 --- a/dnacentersdk/api/v2_3_7_6/configuration_templates.py +++ b/dnacentersdk/api/v2_3_7_6/configuration_templates.py @@ -1754,8 +1754,8 @@ def get_projects_details(self, Args: id(str): id query parameter. Id of project to be searched . name(str): name query parameter. Name of project to be searched . - offset(int): offset query parameter. Index of first result . - limit(int): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1774,8 +1774,8 @@ def get_projects_details(self, check_type(headers, dict) check_type(id, str) check_type(name, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_order, str) if headers is not None: if 'X-Auth-Token' in headers: @@ -1856,8 +1856,8 @@ def get_templates_details(self, sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) . all_template_attributes(bool): allTemplateAttributes query parameter. Return all template attributes . include_version_details(bool): includeVersionDetails query parameter. Include template version details . - offset(int): offset query parameter. Index of first result . - limit(int): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -1888,8 +1888,8 @@ def get_templates_details(self, check_type(sort_order, str) check_type(all_template_attributes, bool) check_type(include_version_details, bool) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/device_onboarding_pnp.py b/dnacentersdk/api/v2_3_7_6/device_onboarding_pnp.py index 0051e465..60de63bf 100644 --- a/dnacentersdk/api/v2_3_7_6/device_onboarding_pnp.py +++ b/dnacentersdk/api/v2_3_7_6/device_onboarding_pnp.py @@ -235,8 +235,8 @@ def get_device_list(self, supports Pagination and Sorting. . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated list of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . serial_number(str, list, set, tuple): serialNumber query parameter. Device Serial Number . @@ -270,8 +270,8 @@ def get_device_list(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(serial_number, (str, list, set, tuple)) @@ -1957,8 +1957,8 @@ def get_workflows(self, 50 workflows. Pagination and sorting are also supported by this endpoint . Args: - limit(int): limit query parameter. Limits number of results . - offset(int): offset query parameter. Index of first result . + limit(int,str): limit query parameter. Limits number of results . + offset(int,str): offset query parameter. Index of first result . sort(str, list, set, tuple): sort query parameter. Comma seperated lost of fields to sort on . sort_order(str): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) . type(str, list, set, tuple): type query parameter. Workflow Type . @@ -1979,8 +1979,8 @@ def get_workflows(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(sort, (str, list, set, tuple)) check_type(sort_order, str) check_type(type, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_3_7_6/device_replacement.py b/dnacentersdk/api/v2_3_7_6/device_replacement.py index f2134eb1..b75c1630 100644 --- a/dnacentersdk/api/v2_3_7_6/device_replacement.py +++ b/dnacentersdk/api/v2_3_7_6/device_replacement.py @@ -99,8 +99,8 @@ def return_replacement_devices_with_details(self, sort_by(str): sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. . sort_order(str): sortOrder query parameter. Order on displayName[ASC,DESC] . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -125,8 +125,8 @@ def return_replacement_devices_with_details(self, check_type(family, (str, list, set, tuple)) check_type(sort_by, str) check_type(sort_order, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/devices.py b/dnacentersdk/api/v2_3_7_6/devices.py index f7d2d308..bfb518de 100644 --- a/dnacentersdk/api/v2_3_7_6/devices.py +++ b/dnacentersdk/api/v2_3_7_6/devices.py @@ -75,8 +75,8 @@ def get_planned_access_points_for_building(self, Args: building_id(str): buildingId path parameter. Building Id . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. radios(bool): radios query parameter. inlcude planned radio details . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -93,8 +93,8 @@ def get_planned_access_points_for_building(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(radios, bool) check_type(building_id, str, may_be_none=False) @@ -287,9 +287,9 @@ def devices(self, . start_time(int): startTime query parameter. UTC epoch time in milliseconds . end_time(int): endTime query parameter. UTC epoch time in milliseconds . - limit(int): limit query parameter. Max number of device entries in the response (default to 50. Max at + limit(int,str): limit query parameter. Max number of device entries in the response (default to 50. Max at 500) . - offset(int): offset query parameter. The offset of the first device in the returned data (Mutiple of + offset(int,str): offset query parameter. The offset of the first device in the returned data (Mutiple of 'limit' + 1) . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -311,8 +311,8 @@ def devices(self, check_type(health, str) check_type(start_time, int) check_type(end_time, int) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -568,8 +568,8 @@ def get_planned_access_points_for_floor(self, Args: floor_id(str): floorId path parameter. Floor Id . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. radios(bool): radios query parameter. inlcude planned radio details . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -586,8 +586,8 @@ def get_planned_access_points_for_floor(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(radios, bool) check_type(floor_id, str, may_be_none=False) @@ -703,8 +703,8 @@ def get_all_interfaces(self, """Returns all available interfaces. This endpoint can return a maximum of 500 interfaces . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. last_input_time(str): lastInputTime query parameter. Last Input Time . last_output_time(str): lastOutputTime query parameter. Last Output Time . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -722,8 +722,8 @@ def get_all_interfaces(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(last_input_time, str) check_type(last_output_time, str) if headers is not None: @@ -1584,8 +1584,8 @@ def get_device_list(self, the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. . device_support_level(str): deviceSupportLevel query parameter. - offset(int): offset query parameter. offset >= 1 [X gives results from Xth device onwards] . - limit(int): limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] + offset(int,str): offset query parameter. offset >= 1 [X gives results from Xth device onwards] . + limit(int,str): limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1634,8 +1634,8 @@ def get_device_list(self, check_type(module_operationstatecode, (str, list, set, tuple)) check_type(id, str) check_type(device_support_level, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -2143,8 +2143,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, role(str): role query parameter. role_source(str): roleSource query parameter. associated_wlc_ip(str): associatedWlcIp query parameter. - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -2180,8 +2180,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, check_type(role, str) check_type(role_source, str) check_type(associated_wlc_ip, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -2778,8 +2778,8 @@ def inventory_insight_device_link_mismatch(self, Args: site_id(str): siteId path parameter. - offset(int): offset query parameter. Row Number. Default value is 1 . - limit(int): limit query parameter. Default value is 500 . + offset(int,str): offset query parameter. Row Number. Default value is 1 . + limit(int,str): limit query parameter. Default value is 500 . category(str): category query parameter. Links mismatch category. Value can be speed-duplex or vlan. . sort_by(str): sortBy query parameter. Sort By . @@ -2799,8 +2799,8 @@ def inventory_insight_device_link_mismatch(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(category, str, may_be_none=False) check_type(sort_by, str) @@ -2917,8 +2917,8 @@ def get_modules(self, Args: device_id(str): deviceId query parameter. - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. name_list(str, list, set, tuple): nameList query parameter. vendor_equipment_type_list(str, list, set, tuple): vendorEquipmentTypeList query parameter. part_number_list(str, list, set, tuple): partNumberList query parameter. @@ -2940,8 +2940,8 @@ def get_modules(self, check_type(headers, dict) check_type(device_id, str, may_be_none=False) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(name_list, (str, list, set, tuple)) check_type(vendor_equipment_type_list, (str, list, set, tuple)) check_type(part_number_list, (str, list, set, tuple)) diff --git a/dnacentersdk/api/v2_3_7_6/discovery.py b/dnacentersdk/api/v2_3_7_6/discovery.py index 86950274..0ad8073c 100644 --- a/dnacentersdk/api/v2_3_7_6/discovery.py +++ b/dnacentersdk/api/v2_3_7_6/discovery.py @@ -578,8 +578,8 @@ def get_discovery_jobs_by_ip(self, """Returns the list of discovery jobs for the given IP . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. ip_address(str): ipAddress query parameter. name(str): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -597,8 +597,8 @@ def get_discovery_jobs_by_ip(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str, may_be_none=False) check_type(name, str) @@ -762,8 +762,8 @@ def get_list_of_discoveries_by_discovery_id(self, Args: id(str): id path parameter. Discovery ID . - offset(int): offset query parameter. Starting index for the records . - limit(int): limit query parameter. Number of records to fetch from the starting index . + offset(int,str): offset query parameter. Starting index for the records . + limit(int,str): limit query parameter. Number of records to fetch from the starting index . ip_address(str): ipAddress query parameter. Filter records based on IP address . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -780,8 +780,8 @@ def get_list_of_discoveries_by_discovery_id(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ip_address, str) check_type(id, str, may_be_none=False) diff --git a/dnacentersdk/api/v2_3_7_6/event_management.py b/dnacentersdk/api/v2_3_7_6/event_management.py index dc1f84bd..ba73aca3 100644 --- a/dnacentersdk/api/v2_3_7_6/event_management.py +++ b/dnacentersdk/api/v2_3_7_6/event_management.py @@ -113,8 +113,8 @@ def get_auditlog_parent_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -154,8 +154,8 @@ def get_auditlog_parent_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -440,8 +440,8 @@ def get_auditlog_records(self, . description(str): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(int,str): offset query parameter. Position of a particular Audit Log record in the data. . + limit(int,str): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -482,8 +482,8 @@ def get_auditlog_records(self, check_type(device_id, str) check_type(is_system_events, bool) check_type(description, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, str) @@ -573,9 +573,9 @@ def get_snmp_destination(self, Args: config_id(str): configId query parameter. List of SNMP configurations . - offset(int): offset query parameter. The number of SNMP configuration's to offset in the resultset whose + offset(int,str): offset query parameter. The number of SNMP configuration's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of SNMP configuration's to limit in the resultset whose + limit(int,str): limit query parameter. The number of SNMP configuration's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -596,8 +596,8 @@ def get_snmp_destination(self, """ check_type(headers, dict) check_type(config_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -959,8 +959,8 @@ def get_notifications(self, domain(str): domain query parameter. sub_domain(str): subDomain query parameter. Sub Domain . source(str): source query parameter. - offset(int): offset query parameter. Start Offset . - limit(int): limit query parameter. # of records . + offset(int,str): offset query parameter. Start Offset . + limit(int,str): limit query parameter. # of records . sort_by(str): sortBy query parameter. Sort By column . order(str): order query parameter. Ascending/Descending order [asc/desc] . tags(str): tags query parameter. @@ -991,8 +991,8 @@ def get_notifications(self, check_type(domain, str) check_type(sub_domain, str) check_type(source, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(tags, str) @@ -1406,9 +1406,9 @@ def get_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1429,8 +1429,8 @@ def get_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1668,9 +1668,9 @@ def get_email_subscription_details(self, Args: name(str): name query parameter. Name of the specific configuration . instance_id(str): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Email Subscription detail's to offset in the + offset(int,str): offset query parameter. The number of Email Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Email Subscription detail's to limit in the resultset + limit(int,str): limit query parameter. The number of Email Subscription detail's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1692,8 +1692,8 @@ def get_email_subscription_details(self, check_type(headers, dict) check_type(name, str) check_type(instance_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1751,9 +1751,9 @@ def get_rest_webhook_subscription_details(self, Args: name(str): name query parameter. Name of the specific configuration . instance_id(str): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Rest/Webhook Subscription detail's to offset in the + offset(int,str): offset query parameter. The number of Rest/Webhook Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Rest/Webhook Subscription detail's to limit in the + limit(int,str): limit query parameter. The number of Rest/Webhook Subscription detail's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1775,8 +1775,8 @@ def get_rest_webhook_subscription_details(self, check_type(headers, dict) check_type(name, str) check_type(instance_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -1834,9 +1834,9 @@ def get_syslog_subscription_details(self, Args: name(str): name query parameter. Name of the specific configuration . instance_id(str): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Syslog Subscription detail's to offset in the + offset(int,str): offset query parameter. The number of Syslog Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Syslog Subscription detail's to limit in the resultset + limit(int,str): limit query parameter. The number of Syslog Subscription detail's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -1858,8 +1858,8 @@ def get_syslog_subscription_details(self, check_type(headers, dict) check_type(name, str) check_type(instance_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -2107,9 +2107,9 @@ def get_email_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2138,8 +2138,8 @@ def get_email_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(domain, str) @@ -2280,9 +2280,9 @@ def get_rest_webhook_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2310,8 +2310,8 @@ def get_rest_webhook_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(domain, str) @@ -2578,9 +2578,9 @@ def get_syslog_event_subscriptions(self, Args: event_ids(str): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(int,str): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2608,8 +2608,8 @@ def get_syslog_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(domain, str) @@ -2775,9 +2775,9 @@ def get_syslog_destination(self, config_id(str): configId query parameter. Config id of syslog server . name(str): name query parameter. Name of syslog server . protocol(str): protocol query parameter. Protocol of syslog server . - offset(int): offset query parameter. The number of syslog configuration's to offset in the resultset + offset(int,str): offset query parameter. The number of syslog configuration's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of syslog configuration's to limit in the resultset whose + limit(int,str): limit query parameter. The number of syslog configuration's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -2799,8 +2799,8 @@ def get_syslog_destination(self, check_type(config_id, str) check_type(name, str) check_type(protocol, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -3147,9 +3147,9 @@ def get_webhook_destination(self, Args: webhook_ids(str): webhookIds query parameter. List of webhook configurations . - offset(int): offset query parameter. The number of webhook configuration's to offset in the resultset + offset(int,str): offset query parameter. The number of webhook configuration's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of webhook configuration's to limit in the resultset whose + limit(int,str): limit query parameter. The number of webhook configuration's to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -3169,8 +3169,8 @@ def get_webhook_destination(self, """ check_type(customHeaders, dict) check_type(webhook_ids, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if customHeaders is not None: @@ -3226,9 +3226,9 @@ def get_events(self, Args: event_id(str): eventId query parameter. The registered EventId should be provided . tags(str): tags query parameter. The registered Tags should be provided . - offset(int): offset query parameter. The number of Registries to offset in the resultset whose default + offset(int,str): offset query parameter. The number of Registries to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Registries to limit in the resultset whose default + limit(int,str): limit query parameter. The number of Registries to limit in the resultset whose default value 10 . sort_by(str): sortBy query parameter. SortBy field name . order(str): order query parameter. @@ -3251,8 +3251,8 @@ def get_events(self, check_type(event_id, str) check_type(tags, str, may_be_none=False) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -3372,8 +3372,8 @@ def get_eventartifacts(self, Args: event_ids(str): eventIds query parameter. List of eventIds . tags(str): tags query parameter. Tags defined . - offset(int): offset query parameter. Record start offset . - limit(int): limit query parameter. # of records to return in result set . + offset(int,str): offset query parameter. Record start offset . + limit(int,str): limit query parameter. # of records to return in result set . sort_by(str): sortBy query parameter. Sort by field . order(str): order query parameter. sorting order (asc/desc) . search(str): search query parameter. findd matches in name, description, eventId, type, category @@ -3396,8 +3396,8 @@ def get_eventartifacts(self, check_type(headers, dict) check_type(event_ids, str) check_type(tags, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) check_type(search, str) diff --git a/dnacentersdk/api/v2_3_7_6/health_and_performance.py b/dnacentersdk/api/v2_3_7_6/health_and_performance.py index af70ca40..1e5a738e 100644 --- a/dnacentersdk/api/v2_3_7_6/health_and_performance.py +++ b/dnacentersdk/api/v2_3_7_6/health_and_performance.py @@ -81,8 +81,8 @@ def system_health(self, subdomain(str): subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -101,8 +101,8 @@ def system_health(self, check_type(summary, bool) check_type(domain, str) check_type(subdomain, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/lan_automation.py b/dnacentersdk/api/v2_3_7_6/lan_automation.py index 94023d09..5c625849 100644 --- a/dnacentersdk/api/v2_3_7_6/lan_automation.py +++ b/dnacentersdk/api/v2_3_7_6/lan_automation.py @@ -188,8 +188,8 @@ def lan_automation_log(self, """Invoke this API to get the LAN Automation session logs. . Args: - offset(int): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . - limit(int): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can + offset(int,str): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . + limit(int,str): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -206,8 +206,8 @@ def lan_automation_log(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -424,8 +424,8 @@ def lan_automation_status(self, """Invoke this API to get the LAN Automation session status. . Args: - offset(int): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . - limit(int): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can + offset(int,str): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . + limit(int,str): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -442,8 +442,8 @@ def lan_automation_status(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/licenses.py b/dnacentersdk/api/v2_3_7_6/licenses.py index a6e8eae4..8b381fa6 100644 --- a/dnacentersdk/api/v2_3_7_6/licenses.py +++ b/dnacentersdk/api/v2_3_7_6/licenses.py @@ -163,7 +163,7 @@ def device_license_summary(self, Advantage, Essentials . device_type(str): device_type query parameter. Type of device. The valid values are Routers, Switches and Hubs, Wireless Controller . - limit(int): limit query parameter. + limit(int,str): limit query parameter. registration_status(str): registration_status query parameter. Smart license registration status of device. The valid values are Unknown, NA, Unregistered, Registered, Registration_expired, Reservation_in_progress, Registered_slr, Registered_plr, diff --git a/dnacentersdk/api/v2_3_7_6/network_settings.py b/dnacentersdk/api/v2_3_7_6/network_settings.py index 0fd07c3c..a16b5c51 100644 --- a/dnacentersdk/api/v2_3_7_6/network_settings.py +++ b/dnacentersdk/api/v2_3_7_6/network_settings.py @@ -426,8 +426,8 @@ def get_global_pool(self, """API to get the global pool. . Args: - offset(int): offset query parameter. Offset/starting row. Indexed from 1. Default value of 1. . - limit(int): limit query parameter. Number of Global Pools to be retrieved. Default is 25 if not + offset(int,str): offset query parameter. Offset/starting row. Indexed from 1. Default value of 1. . + limit(int,str): limit query parameter. Number of Global Pools to be retrieved. Default is 25 if not specified. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -444,8 +444,8 @@ def get_global_pool(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -902,8 +902,8 @@ def get_reserve_ip_subpool(self, site_id(str): siteId query parameter. site id of site from which to retrieve associated reserve pools. Either siteId (per site queries) or ignoreInheritedGroups must be used. They can also be used together. . - offset(int): offset query parameter. offset/starting row. Indexed from 1. . - limit(int): limit query parameter. Number of reserve pools to be retrieved. Default is 25 if not + offset(int,str): offset query parameter. offset/starting row. Indexed from 1. . + limit(int,str): limit query parameter. Number of reserve pools to be retrieved. Default is 25 if not specified. Maximum allowed limit is 500. . ignore_inherited_groups(str): ignoreInheritedGroups query parameter. Ignores pools inherited from parent site. Either siteId or ignoreInheritedGroups must be passed. They can also be @@ -927,8 +927,8 @@ def get_reserve_ip_subpool(self, """ check_type(headers, dict) check_type(site_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(ignore_inherited_groups, str) check_type(pool_usage, str) check_type(group_name, str) diff --git a/dnacentersdk/api/v2_3_7_6/path_trace.py b/dnacentersdk/api/v2_3_7_6/path_trace.py index de4657e6..a952479c 100644 --- a/dnacentersdk/api/v2_3_7_6/path_trace.py +++ b/dnacentersdk/api/v2_3_7_6/path_trace.py @@ -96,8 +96,8 @@ def retrieves_all_previous_pathtraces_summary(self, status(str): status query parameter. task_id(str): taskId query parameter. Task ID . last_update_time(int): lastUpdateTime query parameter. Last update time . - limit(int): limit query parameter. Number of resources returned . - offset(int): offset query parameter. Start index of resources returned (1-based) . + limit(int,str): limit query parameter. Number of resources returned . + offset(int,str): offset query parameter. Start index of resources returned (1-based) . order(str): order query parameter. Order by this field . sort_by(str): sortBy query parameter. Sort by this field . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -126,8 +126,8 @@ def retrieves_all_previous_pathtraces_summary(self, check_type(status, str) check_type(task_id, str) check_type(last_update_time, int) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) check_type(order, str) check_type(sort_by, str) if headers is not None: diff --git a/dnacentersdk/api/v2_3_7_6/sda.py b/dnacentersdk/api/v2_3_7_6/sda.py index 322bbe27..cf306694 100644 --- a/dnacentersdk/api/v2_3_7_6/sda.py +++ b/dnacentersdk/api/v2_3_7_6/sda.py @@ -2959,8 +2959,8 @@ def get_anycast_gateways(self, . vlan_name(str): vlanName query parameter. Get anycast gateways associated with this VLAN name. . vlan_id(int): vlanId query parameter. Get anycast gateways associated with this VLAN ID. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -2982,8 +2982,8 @@ def get_anycast_gateways(self, check_type(ip_pool_name, str) check_type(vlan_name, str) check_type(vlan_id, int) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -3427,8 +3427,8 @@ def get_extranet_policies(self, Args: extranet_policy_name(str): extranetPolicyName query parameter. Name of the extranet policy. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -3445,8 +3445,8 @@ def get_extranet_policies(self, """ check_type(headers, dict) check_type(extranet_policy_name, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -3602,8 +3602,8 @@ def get_fabric_devices(self, network_device_id(str): networkDeviceId query parameter. Network device ID of the fabric device. . device_roles(str): deviceRoles query parameter. Device roles of the fabric device. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -3623,8 +3623,8 @@ def get_fabric_devices(self, may_be_none=False) check_type(network_device_id, str) check_type(device_roles, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -4000,8 +4000,8 @@ def get_fabric_devices_layer2_handoffs(self, fabric_id(str): fabricId query parameter. ID of the fabric this device belongs to. . network_device_id(str): networkDeviceId query parameter. Network device ID of the fabric device. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -4020,8 +4020,8 @@ def get_fabric_devices_layer2_handoffs(self, check_type(fabric_id, str, may_be_none=False) check_type(network_device_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -4448,8 +4448,8 @@ def get_fabric_devices_layer3_handoffs_with_ip_transit(self, fabric_id(str): fabricId query parameter. ID of the fabric this device belongs to. . network_device_id(str): networkDeviceId query parameter. Network device ID of the fabric device. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -4468,8 +4468,8 @@ def get_fabric_devices_layer3_handoffs_with_ip_transit(self, check_type(fabric_id, str, may_be_none=False) check_type(network_device_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -4710,8 +4710,8 @@ def get_fabric_devices_layer3_handoffs_with_sda_transit(self, fabric_id(str): fabricId query parameter. ID of the fabric this device belongs to. . network_device_id(str): networkDeviceId query parameter. Network device ID of the fabric device. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -4730,8 +4730,8 @@ def get_fabric_devices_layer3_handoffs_with_sda_transit(self, check_type(fabric_id, str, may_be_none=False) check_type(network_device_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -5030,8 +5030,8 @@ def get_fabric_sites(self, id(str): id query parameter. ID of the fabric site to search for in the database. . site_id(str): siteId query parameter. Get the fabric site associated with this network hierarchy. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -5049,8 +5049,8 @@ def get_fabric_sites(self, check_type(headers, dict) check_type(id, str) check_type(site_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -5332,8 +5332,8 @@ def get_fabric_zones(self, id(str): id query parameter. ID of the fabric zone to search for in the database. . site_id(str): siteId query parameter. get the fabric zone associated with this network hierarchy. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of records to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of records to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -5351,8 +5351,8 @@ def get_fabric_zones(self, check_type(headers, dict) check_type(id, str) check_type(site_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -5706,8 +5706,8 @@ def get_port_assignments(self, interface_name(str): interfaceName query parameter. Interface Name of the port assignment . data_vlan_name(str): dataVlanName query parameter. Data VLAN name of the port assignment . voice_vlan_name(str): voiceVlanName query parameter. Voice VLAN name of the port assignment . - offset(int): offset query parameter. Starting record for pagination . - limit(int): limit query parameter. Maximum number of records to return . + offset(int,str): offset query parameter. Starting record for pagination . + limit(int,str): limit query parameter. Maximum number of records to return . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -5728,8 +5728,8 @@ def get_port_assignments(self, check_type(interface_name, str) check_type(data_vlan_name, str) check_type(voice_vlan_name, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -6182,8 +6182,8 @@ def get_provisioned_devices(self, id(str): id query parameter. ID of the provisioned device. . network_device_id(str): networkDeviceId query parameter. ID of the network device. . site_id(str): siteId query parameter. ID of the site hierarchy. . - offset(int): offset query parameter. Starting record for pagination. . - limit(int): limit query parameter. Maximum number of devices to return. . + offset(int,str): offset query parameter. Starting record for pagination. . + limit(int,str): limit query parameter. Maximum number of devices to return. . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -6202,8 +6202,8 @@ def get_provisioned_devices(self, check_type(id, str) check_type(network_device_id, str) check_type(site_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/sites.py b/dnacentersdk/api/v2_3_7_6/sites.py index 601385ae..14406e31 100644 --- a/dnacentersdk/api/v2_3_7_6/sites.py +++ b/dnacentersdk/api/v2_3_7_6/sites.py @@ -520,8 +520,8 @@ def get_membership(self, Args: site_id(str): siteId path parameter. Site id to retrieve device associated with the site. . - offset(int): offset query parameter. offset/starting row . - limit(int): limit query parameter. Number of sites to be retrieved . + offset(int,str): offset query parameter. offset/starting row . + limit(int,str): limit query parameter. Number of sites to be retrieved . device_family(str): deviceFamily query parameter. Device family name . serial_number(str): serialNumber query parameter. Device serial number . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -539,8 +539,8 @@ def get_membership(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(device_family, str) check_type(serial_number, str) check_type(site_id, str, @@ -682,8 +682,8 @@ def get_site(self, name(str): name query parameter. Site name hierarchy (E.g Global/USA/CA) . site_id(str): siteId query parameter. Site Id . type(str): type query parameter. Site type (Ex: area, building, floor) . - offset(int): offset query parameter. Offset/starting index for pagination. Indexed from 1. . - limit(int): limit query parameter. Number of sites to be listed . + offset(int,str): offset query parameter. Offset/starting index for pagination. Indexed from 1. . + limit(int,str): limit query parameter. Number of sites to be listed . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -702,8 +702,8 @@ def get_site(self, check_type(name, str) check_type(site_id, str) check_type(type, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -754,9 +754,9 @@ def get_site_health(self, Args: site_type(str): siteType query parameter. site type: AREA or BUILDING (case insensitive) . - offset(int): offset query parameter. Offset of the first returned data set entry (Multiple of 'limit' + + offset(int,str): offset query parameter. Offset of the first returned data set entry (Multiple of 'limit' + 1) . - limit(int): limit query parameter. Max number of data entries in the returned data set [1,50]. Default + limit(int,str): limit query parameter. Max number of data entries in the returned data set [1,50]. Default is 25 . timestamp(int): timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required . @@ -776,8 +776,8 @@ def get_site_health(self, """ check_type(headers, dict) check_type(site_type, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(timestamp, int) if headers is not None: if 'X-Auth-Token' in headers: @@ -831,8 +831,8 @@ def get_devices_that_are_assigned_to_a_site(self, Args: id(str): id path parameter. Site Id . - offset(str): offset query parameter. Offset/starting index for pagination . - limit(str): limit query parameter. Number of devices to be listed. Default and max supported + offset(str,int): offset query parameter. Offset/starting index for pagination . + limit(str,int): limit query parameter. Number of devices to be listed. Default and max supported value is 500 . member_type(str): memberType query parameter. Member type (This API only supports the 'networkdevice' type) . @@ -853,8 +853,8 @@ def get_devices_that_are_assigned_to_a_site(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(member_type, str, may_be_none=False) check_type(level, str) @@ -1112,8 +1112,8 @@ def get_site_v2(self, Global/USA/CA) . id(str): id query parameter. Site Id . type(str): type query parameter. Site type (Acceptable values: area, building, floor) . - offset(str): offset query parameter. Offset/starting index for pagination . - limit(str): limit query parameter. Number of sites to be listed. Default and max supported value + offset(str,int): offset query parameter. Offset/starting index for pagination . + limit(str,int): limit query parameter. Number of sites to be listed. Default and max supported value is 500 . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1133,8 +1133,8 @@ def get_site_v2(self, check_type(group_name_hierarchy, str) check_type(id, str) check_type(type, str) - check_type(offset, str) - check_type(limit, str) + check_type(offset, (int, str)) + check_type(limit, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/software_image_management_swim.py b/dnacentersdk/api/v2_3_7_6/software_image_management_swim.py index b259e8f7..23fc60c2 100644 --- a/dnacentersdk/api/v2_3_7_6/software_image_management_swim.py +++ b/dnacentersdk/api/v2_3_7_6/software_image_management_swim.py @@ -250,8 +250,8 @@ def get_software_image_details(self, image_size_lesser_than(int): imageSizeLesserThan query parameter. size in bytes . sort_by(str): sortBy query parameter. sort results by this field . sort_order(str): sortOrder query parameter. sort order 'asc' or 'des'. Default is asc . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(int,str): limit query parameter. + offset(int,str): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -283,8 +283,8 @@ def get_software_image_details(self, check_type(image_size_lesser_than, int) check_type(sort_by, str) check_type(sort_order, str) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (int, str)) + check_type(offset, (int, str)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_7_6/tag.py b/dnacentersdk/api/v2_3_7_6/tag.py index 91a202e1..4a2465fe 100644 --- a/dnacentersdk/api/v2_3_7_6/tag.py +++ b/dnacentersdk/api/v2_3_7_6/tag.py @@ -178,8 +178,8 @@ def get_tag(self, additional_info_name_space(str): additionalInfo.nameSpace query parameter. additional_info_attributes(str): additionalInfo.attributes query parameter. level(str): level query parameter. - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. size(str): size query parameter. size in kilobytes(KB) . field(str): field query parameter. Available field names are :'name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes' . @@ -206,8 +206,8 @@ def get_tag(self, check_type(additional_info_name_space, str) check_type(additional_info_attributes, str) check_type(level, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(size, str) check_type(field, str) check_type(sort_by, str) @@ -683,9 +683,9 @@ def get_tag_members_by_id(self, id(str): id path parameter. Tag ID . member_type(str): memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API . - offset(int): offset query parameter. Used for pagination. It indicates the starting row number out of + offset(int,str): offset query parameter. Used for pagination. It indicates the starting row number out of available member records . - limit(int): limit query parameter. Used to Number of maximum members to return in the result . + limit(int,str): limit query parameter. Used to Number of maximum members to return in the result . member_association_type(str): memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag @@ -709,8 +709,8 @@ def get_tag_members_by_id(self, check_type(headers, dict) check_type(member_type, str, may_be_none=False) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(member_association_type, str) check_type(level, str) check_type(id, str, diff --git a/dnacentersdk/api/v2_3_7_6/task.py b/dnacentersdk/api/v2_3_7_6/task.py index 5217976f..fdf2f8a5 100644 --- a/dnacentersdk/api/v2_3_7_6/task.py +++ b/dnacentersdk/api/v2_3_7_6/task.py @@ -154,8 +154,8 @@ def get_tasks(self, failure_reason(str): failureReason query parameter. Fetch tasks that contains this failure reason . parent_id(str): parentId query parameter. Fetch tasks that have this parent Id . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(int,str): offset query parameter. + limit(int,str): limit query parameter. sort_by(str): sortBy query parameter. Sort results by this field . order(str): order query parameter. Sort order asc or dsc . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -183,8 +183,8 @@ def get_tasks(self, check_type(is_error, str) check_type(failure_reason, str) check_type(parent_id, str) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (int, str)) + check_type(limit, (int, str)) check_type(sort_by, str) check_type(order, str) if headers is not None: @@ -358,8 +358,8 @@ def get_task_by_operationid(self, Args: operation_id(str): operationId path parameter. - offset(int): offset path parameter. Index, minimum value is 0 . - limit(int): limit path parameter. The maximum value of {limit} supported is 500. Base 1 + offset(int,str): offset path parameter. Index, minimum value is 0 . + limit(int,str): limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 . headers(dict): Dictionary of HTTP Headers to send with the Request . From 5b8ee391ca9a2e7f8f3a1ec0ea6f88eec1d811bf Mon Sep 17 00:00:00 2001 From: bvargasre Date: Wed, 14 Aug 2024 21:43:45 -0600 Subject: [PATCH 4/8] chore: Update memberToTags from list to object --- dnacentersdk/api/v2_2_2_3/tag.py | 2 +- dnacentersdk/api/v2_2_3_3/tag.py | 2 +- dnacentersdk/api/v2_3_3_0/tag.py | 2 +- dnacentersdk/api/v2_3_5_3/tag.py | 2 +- .../v2_2_2_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py | 3 --- .../v2_2_3_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py | 3 --- .../v2_3_3_0/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py | 3 --- .../v2_3_5_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py | 3 --- 8 files changed, 4 insertions(+), 16 deletions(-) diff --git a/dnacentersdk/api/v2_2_2_3/tag.py b/dnacentersdk/api/v2_2_2_3/tag.py index 9127b0c5..88660556 100644 --- a/dnacentersdk/api/v2_2_2_3/tag.py +++ b/dnacentersdk/api/v2_2_2_3/tag.py @@ -446,7 +446,7 @@ def updates_tag_membership(self, queried by using the /tag/member/type API . Args: - memberToTags(list): Tag's memberToTags (list of objects). + memberToTags(object): Tag's memberToTags. memberType(string): Tag's memberType. headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_2_3_3/tag.py b/dnacentersdk/api/v2_2_3_3/tag.py index f1ef9c3e..90926e96 100644 --- a/dnacentersdk/api/v2_2_3_3/tag.py +++ b/dnacentersdk/api/v2_2_3_3/tag.py @@ -446,7 +446,7 @@ def updates_tag_membership(self, queried by using the /tag/member/type API . Args: - memberToTags(list): Tag's memberToTags (list of objects). + memberToTags(object): Tag's memberToTags. memberType(string): Tag's memberType. headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_3_3_0/tag.py b/dnacentersdk/api/v2_3_3_0/tag.py index a8b486fc..284e71c9 100644 --- a/dnacentersdk/api/v2_3_3_0/tag.py +++ b/dnacentersdk/api/v2_3_3_0/tag.py @@ -446,7 +446,7 @@ def updates_tag_membership(self, queried by using the /tag/member/type API . Args: - memberToTags(list): Tag's memberToTags (list of objects). + memberToTags(object): Tag's memberToTags. memberType(string): Tag's memberType. headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/api/v2_3_5_3/tag.py b/dnacentersdk/api/v2_3_5_3/tag.py index 021af346..ff5c9092 100644 --- a/dnacentersdk/api/v2_3_5_3/tag.py +++ b/dnacentersdk/api/v2_3_5_3/tag.py @@ -454,7 +454,7 @@ def updates_tag_membership(self, queried by using the /tag/member/type API . Args: - memberToTags(list): Tag's memberToTags (list of objects). + memberToTags(object): Tag's memberToTags. memberType(string): Tag's memberType. headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/dnacentersdk/models/validators/v2_2_2_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py b/dnacentersdk/models/validators/v2_2_2_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py index 78f48fa5..6cdcc0c8 100644 --- a/dnacentersdk/models/validators/v2_2_2_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py +++ b/dnacentersdk/models/validators/v2_2_2_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py @@ -40,7 +40,6 @@ def __init__(self): "$schema": "http://json-schema.org/draft-04/schema#", "properties": { "memberToTags": { - "items": { "properties": { "key": { "items": { @@ -51,8 +50,6 @@ def __init__(self): }, "type": "object" }, - "type": "array" - }, "memberType": { "type": "string" } diff --git a/dnacentersdk/models/validators/v2_2_3_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py b/dnacentersdk/models/validators/v2_2_3_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py index 78f48fa5..6cdcc0c8 100644 --- a/dnacentersdk/models/validators/v2_2_3_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py +++ b/dnacentersdk/models/validators/v2_2_3_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py @@ -40,7 +40,6 @@ def __init__(self): "$schema": "http://json-schema.org/draft-04/schema#", "properties": { "memberToTags": { - "items": { "properties": { "key": { "items": { @@ -51,8 +50,6 @@ def __init__(self): }, "type": "object" }, - "type": "array" - }, "memberType": { "type": "string" } diff --git a/dnacentersdk/models/validators/v2_3_3_0/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py b/dnacentersdk/models/validators/v2_3_3_0/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py index 78f48fa5..6cdcc0c8 100644 --- a/dnacentersdk/models/validators/v2_3_3_0/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py +++ b/dnacentersdk/models/validators/v2_3_3_0/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py @@ -40,7 +40,6 @@ def __init__(self): "$schema": "http://json-schema.org/draft-04/schema#", "properties": { "memberToTags": { - "items": { "properties": { "key": { "items": { @@ -51,8 +50,6 @@ def __init__(self): }, "type": "object" }, - "type": "array" - }, "memberType": { "type": "string" } diff --git a/dnacentersdk/models/validators/v2_3_5_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py b/dnacentersdk/models/validators/v2_3_5_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py index 78f48fa5..6cdcc0c8 100644 --- a/dnacentersdk/models/validators/v2_3_5_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py +++ b/dnacentersdk/models/validators/v2_3_5_3/jsd_e3934b0fb68a5ff787e65e9b7c8e6296.py @@ -40,7 +40,6 @@ def __init__(self): "$schema": "http://json-schema.org/draft-04/schema#", "properties": { "memberToTags": { - "items": { "properties": { "key": { "items": { @@ -51,8 +50,6 @@ def __init__(self): }, "type": "object" }, - "type": "array" - }, "memberType": { "type": "string" } From de6347f2a89d581f162033b5ec48d23aeef06627 Mon Sep 17 00:00:00 2001 From: bvargasre Date: Mon, 19 Aug 2024 16:02:32 -0600 Subject: [PATCH 5/8] chore: accept_cisco_ise_server_certificate_for_cisco_ise_server_integration accept empty payload {} to retry --- dnacentersdk/api/v2_3_7_6/system_settings.py | 32 +++++++++++--------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/dnacentersdk/api/v2_3_7_6/system_settings.py b/dnacentersdk/api/v2_3_7_6/system_settings.py index cb15fc41..8dd09bff 100644 --- a/dnacentersdk/api/v2_3_7_6/system_settings.py +++ b/dnacentersdk/api/v2_3_7_6/system_settings.py @@ -527,30 +527,32 @@ def accept_cisco_ise_server_certificate_for_cisco_ise_server_integration(self, """ check_type(headers, dict) check_type(payload, dict) - check_type(id, str, - may_be_none=False) + check_type(id, str, may_be_none=False) if headers is not None: if 'X-Auth-Token' in headers: - check_type(headers.get('X-Auth-Token'), - str, may_be_none=False) + check_type(headers.get('X-Auth-Token'), str, may_be_none=False) - _params = { - } + _params = {} _params.update(request_parameters) _params = dict_from_items_with_values(_params) path_params = { 'id': id, } - _payload = { - 'isCertAcceptedByUser': - isCertAcceptedByUser, - } - _payload.update(payload or {}) - _payload = dict_from_items_with_values(_payload) - if active_validation: - self._request_validator('jsd_e0ed6b9a530ea05d77a199ded4e3_v2_3_7_6')\ - .validate(_payload) + + valide = False + if isCertAcceptedByUser is None and (payload is None or payload == {}): + _payload = {} + else: + _payload = { + 'isCertAcceptedByUser': isCertAcceptedByUser, + } + _payload.update(payload or {}) + _payload = dict_from_items_with_values(_payload) + valide = True + + if active_validation and valide: + self._request_validator('jsd_e0ed6b9a530ea05d77a199ded4e3_v2_3_7_6').validate(_payload) with_custom_headers = False _headers = self._session.headers or {} From c8cee32f5608ce35ffc8c90877f8d0cd12691117 Mon Sep 17 00:00:00 2001 From: bvargasre Date: Mon, 19 Aug 2024 16:02:51 -0600 Subject: [PATCH 6/8] chore: Update default value for verify in DNACenterAPI --- dnacentersdk/api/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dnacentersdk/api/__init__.py b/dnacentersdk/api/__init__.py index 78ee130e..1bf033fb 100644 --- a/dnacentersdk/api/__init__.py +++ b/dnacentersdk/api/__init__.py @@ -521,7 +521,9 @@ def __init__(self, username=None, wait_on_rate_limit = dnacenter_environment.get_env_wait_on_rate_limit() or DEFAULT_WAIT_ON_RATE_LIMIT if verify is None: - verify = dnacenter_environment.get_env_verify() or DEFAULT_VERIFY + verify = dnacenter_environment.get_env_verify() + if verify is None: + verify = DEFAULT_VERIFY version = version or dnacenter_environment.get_env_version() or DEFAULT_VERSION From fa75f0c04d5e957b270c7cf34fb33d49c98ef72d Mon Sep 17 00:00:00 2001 From: bvargasre Date: Mon, 19 Aug 2024 16:12:35 -0600 Subject: [PATCH 7/8] chore: Update version to 2.7.3 --- CHANGELOG.md | 13 +++++- docs/CHANGELOG.rst | 106 +++++++++++++++++++++++++-------------------- pyproject.toml | 2 +- 3 files changed, 73 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9073d369..d09dfc89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [2.7.3] - 2024-08-19 +- Refactor error message construction in ApiError class +- Injection for requests.Session +### Fixed +- Fixed a problem when exporting the environment variable verify +- Update offset and limit parameter type to support int and str value +- `accept_cisco_ise_server_certificate_for_cisco_ise_server_integration` accept empty payload {} to retry +- Update memberToTags from list to object in `updates_tag_membership` +- Update offset and limit parameter type to support int and str value + ## [2.7.2] - 2024-08-09 - Update User-Agent header in RestSession - Update requirements: @@ -515,4 +525,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 [2.7.0]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.6.11...v2.7.0 [2.7.1]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.7.0...v2.7.1 [2.7.2]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.7.1...v2.7.2 -[Unreleased]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.7.2...develop +[2.7.3]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.7.2...v2.7.3 +[Unreleased]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.7.3...develop diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index e1fd3979..1eb0fbad 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -8,9 +8,23 @@ Changelog `__, and this project adheres to `Semantic Versioning `__. -`Unreleased `__ +`Unreleased `__ -------------------------------------------------------------------------------------------------- +`2.7.3 `__ - 2024-08-19 +--------------------------------------------------------------------------------------------------------- + +- Refactor error message construction in ApiError class +- Injection for requests.Session ### Fixed +- Fixed a problem when exporting the environment variable verify +- Update offset and limit parameter type to support int and str value +- ``accept_cisco_ise_server_certificate_for_cisco_ise_server_integration`` + accept empty payload {} to retry +- Update memberToTags from list to object in ``updates_tag_membership`` +- Update offset and limit parameter type to support int and str value + +.. _section-1: + `2.7.2 `__ - 2024-08-09 --------------------------------------------------------------------------------------------------------- @@ -43,7 +57,7 @@ Versioning `__. - From delete_a_a_a_attribute_ap_i to delete_aaa_attribute_api - From get_a_a_a_attribute_ap_i to get_aaa_attribute_api -.. _section-1: +.. _section-2: `2.7.1 `__ - 2024-05-31 --------------------------------------------------------------------------------------------------------- @@ -54,7 +68,7 @@ Fixed - Updated package version retrieval method from pkg_resources to importlib.metadata. -.. _section-2: +.. _section-3: `2.7.0 `__ - 2024-05-31 ---------------------------------------------------------------------------------------------------------- @@ -71,7 +85,7 @@ Added - Fix headers in ``create_webhook_destination`` and ``update_webhook_destination`` -.. _section-3: +.. _section-4: `2.6.11 `__ - 2023-01-10 ------------------------------------------------------------------------------------------------------------ @@ -85,7 +99,7 @@ Fixed Fixing required schema. - Updating request version. Issue #132 -.. _section-4: +.. _section-5: `2.6.10 `__ - 2023-11-10 ----------------------------------------------------------------------------------------------------------- @@ -100,7 +114,7 @@ Fixed - Fixed params in 2.3.5.3 claim_a_device_to_a_site from vlanID to vlanId -.. _section-5: +.. _section-6: `2.6.9 `__ - 2023-09-20 --------------------------------------------------------------------------------------------------------- @@ -111,7 +125,7 @@ Changed - AP port assignment API not working with DNAC APIs of 2.3.3.0 #126, Documetion bug, extra-space in enum. -.. _section-6: +.. _section-7: `2.6.8 `__ - 2023-09-12 --------------------------------------------------------------------------------------------------------- @@ -123,7 +137,7 @@ Changed - 2_3_3_0 sda sevice ``add_vn`` method update. -.. _section-7: +.. _section-8: `2.6.7 `__ - 2023-08-25 --------------------------------------------------------------------------------------------------------- @@ -135,7 +149,7 @@ Changed - Update readthedocs settings -.. _section-8: +.. _section-9: `2.6.6 `__ - 2023-07-10 --------------------------------------------------------------------------------------------------------- @@ -147,7 +161,7 @@ Changed - Change requests-toolbelt minimum version #101 -.. _section-9: +.. _section-10: `2.6.5 `__ - 2023-05-29 --------------------------------------------------------------------------------------------------------- @@ -159,7 +173,7 @@ Changed - user_and_roles::Unable to use user and roles module. #112 -.. _section-10: +.. _section-11: `2.6.4 `__ - 2023-05-25 --------------------------------------------------------------------------------------------------------- @@ -188,7 +202,7 @@ Changed - Poor naming of function: v2_3_5_3/authentication_management.py : ``authentication_ap_i( #102`` -.. _section-11: +.. _section-12: `2.6.3 `__ - 2023-04-28 --------------------------------------------------------------------------------------------------------- @@ -216,14 +230,14 @@ Changed .. rubric:: `2.6.2 `__ - 2023-04-25 - :name: section-12 + :name: section-13 .. rubric:: Changed :name: changed-7 - Add ``issue`` family on 2.3.3.0 -.. _section-13: +.. _section-14: `2.6.1 `__ - 2023-04-12 --------------------------------------------------------------------------------------------------------- @@ -237,7 +251,7 @@ Changed - Correct families names in 2.3.5.3 - Removing duplicate params -.. _section-14: +.. _section-15: `2.6.0 `__ - 2023-04-12 --------------------------------------------------------------------------------------------------------- @@ -250,7 +264,7 @@ Added - Add support of DNA Center versions (‘2.3.5.3’) - Adds modules for v2_3_5_3 -.. _section-15: +.. _section-16: `2.5.6 `__ - 2023-01-10 --------------------------------------------------------------------------------------------------------- @@ -289,7 +303,7 @@ Fixed - dnacentersdk.api.v2_3_3_0.tag - dnacentersdk.api.v2_3_3_0.task -.. _section-16: +.. _section-17: `2.5.5 `__ - 2022-11-17 --------------------------------------------------------------------------------------------------------- @@ -306,7 +320,7 @@ Fixed - Added Dict_of_str function call in custom_caller headers -.. _section-17: +.. _section-18: `2.5.4 `__ - 2022-08-11 --------------------------------------------------------------------------------------------------------- @@ -320,7 +334,7 @@ Added - ``add_ssid_to_ip_pool_mapping`` -.. _section-18: +.. _section-19: `2.5.3 `__ - 2022-08-09 --------------------------------------------------------------------------------------------------------- @@ -336,7 +350,7 @@ Fixed ``connectedToInternet`` on ``sda.adds_border_device`` comes from ``boolean`` to ``string``. -.. _section-19: +.. _section-20: `2.5.2 `__ - 2022-07-29 --------------------------------------------------------------------------------------------------------- @@ -373,7 +387,7 @@ Fixed - network - servers -.. _section-20: +.. _section-21: `2.5.1 `__ - 2022-07-12 --------------------------------------------------------------------------------------------------------- @@ -387,7 +401,7 @@ Fixed - IpAddressSpace -.. _section-21: +.. _section-22: `2.5.0 `__ - 2022-06-20 ---------------------------------------------------------------------------------------------------------- @@ -400,7 +414,7 @@ Added - Add support of DNA Center versions (‘2.3.3.0’) - Adds modules for v2_3_3_0 -.. _section-22: +.. _section-23: `2.4.11 `__ - 2022-06-15 ------------------------------------------------------------------------------------------------------------ @@ -416,7 +430,7 @@ Fixed - verify - debug -.. _section-23: +.. _section-24: `2.4.10 `__ - 2022-05-12 ----------------------------------------------------------------------------------------------------------- @@ -432,7 +446,7 @@ Added - site_name_hierarchy -.. _section-24: +.. _section-25: `2.4.9 `__ - 2022-04-20 --------------------------------------------------------------------------------------------------------- @@ -452,7 +466,7 @@ Added - subnetMask - vlanId -.. _section-25: +.. _section-26: `2.4.8 `__ - 2022-03-23 --------------------------------------------------------------------------------------------------------- @@ -498,7 +512,7 @@ Changed - dnacentersdk.api.v2_2_3_3.file.File.download_a_file_by_fileid - dnacentersdk.api.v2_2_3_3.reports.Reports.download_report_content -.. _section-26: +.. _section-27: `2.4.7 `__ - 2022-03-22 --------------------------------------------------------------------------------------------------------- @@ -511,7 +525,7 @@ Added - Add ``rfProfile`` parameter for request body struct of ``claim_a_device_to_a_site``. -.. _section-27: +.. _section-28: `2.4.6 `__ - 2022-03-14 --------------------------------------------------------------------------------------------------------- @@ -542,7 +556,7 @@ Changed - sda.adds_border_device -.. _section-28: +.. _section-29: `2.4.5 `__ - 2022-02-01 --------------------------------------------------------------------------------------------------------- @@ -568,7 +582,7 @@ Changed - devices.sync_devices -.. _section-29: +.. _section-30: `2.4.4 `__ - 2022-01-31 --------------------------------------------------------------------------------------------------------- @@ -612,7 +626,7 @@ Added - Adds parameters ``hostname``, ``imageInfo`` and ``configInfo`` to device_onboarding_pnp.pnp_device_claim_to_site -.. _section-30: +.. _section-31: `2.4.3 `__ - 2022-01-19 --------------------------------------------------------------------------------------------------------- @@ -635,7 +649,7 @@ Changed DNACenterAPI - Adds tests for env variables before/after DNACenterAPI import -.. _section-31: +.. _section-32: `2.4.2 `__ - 2021-12-14 --------------------------------------------------------------------------------------------------------- @@ -650,7 +664,7 @@ Fixed - Update json schemas for models/validators and tests/models/models/validators -.. _section-32: +.. _section-33: `2.4.1 `__ - 2021-12-01 --------------------------------------------------------------------------------------------------------- @@ -662,7 +676,7 @@ Changed - Update to match checksum -.. _section-33: +.. _section-34: `2.4.0 `__ - 2021-12-01 --------------------------------------------------------------------------------------------------------- @@ -693,7 +707,7 @@ Changed - Update missing dnac 2.2.3.3 files -.. _section-34: +.. _section-35: `2.3.3 `__ - 2021-11-24 --------------------------------------------------------------------------------------------------------- @@ -725,7 +739,7 @@ Changed - Add ``isGuestVirtualNetwork`` parameter to ``update_virtual_network_with_scalable_groups`` function -.. _section-35: +.. _section-36: `2.3.2 `__ - 2021-09-14 --------------------------------------------------------------------------------------------------------- @@ -737,7 +751,7 @@ Changed - Disable verify=False warnings of urllib3 -.. _section-36: +.. _section-37: `2.3.1 `__ - 2021-08-10 --------------------------------------------------------------------------------------------------------- @@ -750,7 +764,7 @@ Fixed - Fix devices param definition & schemas [``aba32f3``] - Remove unnecesary path_params [``25c4e99``] -.. _section-37: +.. _section-38: `2.3.0 `__ - 2021-08-09 --------------------------------------------------------------------------------------------------------- @@ -775,7 +789,7 @@ Changed - Updates restsession.py to handle downloads using Content-Disposition header rather than custom fileName header -.. _section-38: +.. _section-39: `2.2.5 `__ - 2021-08-05 --------------------------------------------------------------------------------------------------------- @@ -794,7 +808,7 @@ Changed - Removes minus char from docstrings. - Adds check_type conditions for ‘X-Auth-Token’ for v2_2_1 operations. -.. _section-39: +.. _section-40: `2.2.4 `__ - 2021-06-08 --------------------------------------------------------------------------------------------------------- @@ -807,7 +821,7 @@ Fixed - Fixes download_a_file_by_fileid and import_local_software_image for v2_2_1 -.. _section-40: +.. _section-41: `2.2.3 `__ - 2021-06-08 --------------------------------------------------------------------------------------------------------- @@ -830,7 +844,7 @@ Changed - Patch adds one function that was missing from previous release - Patch adds models/validators for v2_2_1 with new ids -.. _section-41: +.. _section-42: `2.2.2 `__ - 2021-05-10 --------------------------------------------------------------------------------------------------------- @@ -849,7 +863,7 @@ Changed - Updates requirements files -.. _section-42: +.. _section-43: `2.0.2 `__ - 2020-11-01 --------------------------------------------------------------------------------------------------------- @@ -878,7 +892,7 @@ Removed - Removed requirements.lock -.. _section-43: +.. _section-44: `2.0.0 `__ - 2020-07-17 --------------------------------------------------------------------------------------------------------- @@ -918,7 +932,7 @@ Removed - Removed Webex Teams Space Community reference from README - Removed Token refresh when changing base_url -.. _section-44: +.. _section-45: `1.3.0 `__ - 2019-08-19 ---------------------------------------------------------------------------------------------------------- @@ -939,7 +953,7 @@ Fixed - Fix error in setter in ``api/__init__.py`` - Fix errors for readthedocs -.. _section-45: +.. _section-46: `1.2.10 `__ - 2019-07-18 --------------------------------------------------------------------------------------------------- diff --git a/pyproject.toml b/pyproject.toml index 770b94be..76a85366 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dnacentersdk" -version = "2.7.2" +version = "2.7.3" description = "Cisco DNA Center Platform SDK" authors = ["Jose Bogarin Solano ", "William Astorga ", "Francisco Muñoz ", "Francisco Muñoz ", "Bryan Vargas "] license = "MIT" From 8bd39271c2a4e053f8b19c1473b7857b398836bf Mon Sep 17 00:00:00 2001 From: bvargasre Date: Mon, 19 Aug 2024 16:13:03 -0600 Subject: [PATCH 8/8] chore: Update supported version to 2.7.3 --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c88cf567..5721e221 100755 --- a/README.rst +++ b/README.rst @@ -158,7 +158,7 @@ The following table shows the supported versions. * - 2.3.5.3 - 2.6.11 * - 2.3.7.6 - - 2.7.2 + - 2.7.3