text: # -*- coding: utf-8 -*-
  """Cisco DNA Center Clients API wrapper.
  
  Copyright (c) 2019-2021 Cisco Systems.
  
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
  
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
  """
  
  
  from __future__ import (
      absolute_import,
      division,
      print_function,
      unicode_literals,
  )
  
  from builtins import *
  
  from past.builtins import basestring
  
  from ...restsession import RestSession
  from ...utils import (
      check_type,
      dict_from_items_with_values,
      apply_path_params,
      dict_of_str,
  )
  
  
  class Clients(object):
      """Cisco DNA Center Clients API (version: 2.2.2.3).
  
      Wraps the DNA Center Clients
      API and exposes the API as native Python
      methods that return native Python objects.
  
      """
  
      def __init__(self, session, object_factory, request_validator):
          """Initialize a new Clients
          object with the provided RestSession.
  
          Args:
              session(RestSession): The RESTful session object to be used for
                  API calls to the DNA Center service.
  
          Raises:
              TypeError: If the parameter types are incorrect.
  
          """
          check_type(session, RestSession)
  
          super(Clients, self).__init__()
  
          self._session = session
          self._object_factory = object_factory
          self._request_validator = request_validator
  
      def get_client_detail(self,
                            mac_address,
                            timestamp=None,
                            headers=None,
                            **request_parameters):
          """Returns detailed Client information retrieved by Mac Address for any given point of time.  .
  
          Args:
              timestamp(basestring): timestamp query parameter. Epoch time(in milliseconds) when the Client health
                  data is required .
              mac_address(basestring): macAddress query parameter. MAC Address of the client .
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              MyDict: JSON response. Access the object's properties by using
              the dot notation or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          """
          check_type(headers, dict)
          check_type(timestamp, basestring)
          check_type(mac_address, basestring,
                     may_be_none=False)
          if headers is not None:
              if 'X-Auth-Token' in headers:
                  check_type(headers.get('X-Auth-Token'),
                             basestring, may_be_none=False)
  
          _params = {
              'timestamp':
                  timestamp,
              'macAddress':
                  mac_address,
          }
  
          if _params['timestamp'] is None:
              _params['timestamp'] = ''
          _params.update(request_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
  
          e_url = ('/dna/intent/api/v1/client-detail')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              json_data = self._session.get(endpoint_full_url, params=_params,
                                            headers=_headers)
          else:
              json_data = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_f2c6333d8eb05491a16c2d32095e4352_v2_2_2_3', json_data)
  
      def get_client_enrichment_details(self,
                                        headers=None,
                                        **request_parameters):
          """Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details
          about the user, the devices that the user is connected to and the assurance issues that the user is
          impacted by .
  
          Args:
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              list: JSON response. A list of MyDict objects.
              Access the object's properties by using the dot notation
              or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          """
          check_type(headers, dict)
          if headers is not None:
              if 'entity_type' in headers:
                  check_type(headers.get('entity_type'),
                             basestring, may_be_none=False)
              if 'entity_value' in headers:
                  check_type(headers.get('entity_value'),
                             basestring, may_be_none=False)
              if 'issueCategory' in headers:
                  check_type(headers.get('issueCategory'),
                             basestring)
              if 'X-Auth-Token' in headers:
                  check_type(headers.get('X-Auth-Token'),
                             basestring, may_be_none=False)
  
          _params = {
          }
          _params.update(request_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
  
          e_url = ('/dna/intent/api/v1/client-enrichment-details')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              json_data = self._session.get(endpoint_full_url, params=_params,
                                            headers=_headers)
          else:
              json_data = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_dfd2751065bfb8c2367dd726df316_v2_2_2_3', json_data)
  
      def get_overall_client_health(self,
                                    timestamp=None,
                                    headers=None,
                                    **request_parameters):
          """Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time .
  
          Args:
              timestamp(basestring): timestamp query parameter. Epoch time(in milliseconds) when the Client health
                  data is required .
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              MyDict: JSON response. Access the object's properties by using
              the dot notation or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          """
          check_type(headers, dict)
          check_type(timestamp, basestring)
          if headers is not None:
              if 'X-Auth-Token' in headers:
                  check_type(headers.get('X-Auth-Token'),
                             basestring, may_be_none=False)
  
          _params = {
              'timestamp':
                  timestamp,
          }
  
          if _params['timestamp'] is None:
              _params['timestamp'] = ''
          _params.update(request_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
  
          e_url = ('/dna/intent/api/v1/client-health')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              json_data = self._session.get(endpoint_full_url, params=_params,
                                            headers=_headers)
          else:
              json_data = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_f58ddf5cee095688aed79a9bb26e21e8_v2_2_2_3', json_data)
  
      def client_proximity(self,
                           username,
                           number_days=None,
                           time_resolution=None,
                           headers=None,
                           **request_parameters):
          """This intent API will provide client proximity information for a specific wireless user. Proximity is defined as
          presence on the same floor at the same time as the specified wireless user. The Proximity workflow
          requires the subscription to the following event (via the Event Notification workflow) prior to making
          this API call: NETWORK-CLIENTS-3-506 Client Proximity Report. .
  
          Args:
              username(basestring): username query parameter. Wireless client username for which proximity information
                  is required .
              number_days(int): number_days query parameter. Number of days to track proximity until current date.
                  Defaults and maximum up to 14 days. .
              time_resolution(int): time_resolution query parameter. Time interval (in minutes) to measure proximity.
                  Defaults to 15 minutes with a minimum 5 minutes. .
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              MyDict: JSON response. Access the object's properties by using
              the dot notation or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          """
          check_type(headers, dict)
          check_type(username, basestring,
                     may_be_none=False)
          check_type(number_days, int)
          check_type(time_resolution, int)
          if headers is not None:
              if 'X-Auth-Token' in headers:
                  check_type(headers.get('X-Auth-Token'),
                             basestring, may_be_none=False)
  
          _params = {
              'username':
                  username,
              'number_days':
                  number_days,
              'time_resolution':
                  time_resolution,
          }
          _params.update(request_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
  
          e_url = ('/dna/intent/api/v1/client-proximity')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              json_data = self._session.get(endpoint_full_url, params=_params,
                                            headers=_headers)
          else:
              json_data = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_c141467ea25ec0aa91cbcaff070354_v2_2_2_3', json_data)
  