text: # -*- coding: utf-8 -*-
  """Cisco Identity Services Engine SGT API wrapper.
  
  Copyright (c) 2021 Cisco and/or its affiliates.
  
  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,
      get_next_page,
  )
  import urllib.parse
  
  
  class Sgt(object):
      """Identity Services Engine SGT API (version: 3.0.0).
  
      Wraps the Identity Services Engine SGT
      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 Sgt
          object with the provided RestSession.
  
          Args:
              session(RestSession): The RESTful session object to be used for
                  API calls to the Identity Services Engine service.
  
          Raises:
              TypeError: If the parameter types are incorrect.
  
          """
          check_type(session, RestSession)
  
          super(Sgt, self).__init__()
  
          self._session = session
          self._object_factory = object_factory
          self._request_validator = request_validator
  
      def get_all_security_groups(self,
                                  filter=None,
                                  filter_type=None,
                                  page=None,
                                  size=None,
                                  sortasc=None,
                                  sortdsc=None,
                                  headers=None,
                                  **query_parameters):
          """Get all SGT.
  
          Args:
              page(int): page query parameter. Page number.
              size(int): size query parameter. Number of objects
                  returned per page.
              filter(basestring, list, set, tuple): filter query
                  parameter.               **Simple
                  filtering** should be available through
                  the filter query string parameter. The
                  structure of a filter is a triplet of
                  field operator and value separated with
                  dots. More than one filter can be sent.
                  The logical operator common to ALL
                  filter criteria will be by default AND,
                  and can be changed by using the
                  "filterType=or" query string parameter.
                  Each resource Data model description
                  should specify if an attribute is a
                  filtered field.              (Operator:
                  Description),
                  (EQ: Equals),               (NEQ: Not
                  Equals),               (GT: Greater
                  Than),               (LT: Less Then),
                  (STARTSW: Starts With),
                  (NSTARTSW: Not Starts With),
                  (ENDSW: Ends With),
                  (NENDSW: Not Ends With),
                  (CONTAINS: Contains),
                  (NCONTAINS: Not Contains),
                  .
              filter_type(basestring): filterType query parameter. The
                  logical operator common to ALL filter
                  criteria will be by default AND, and can
                  be changed by using the parameter.
              sortasc(basestring): sortasc query parameter. sort asc.
              sortdsc(basestring): sortdsc query parameter. sort desc.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          check_type(page, (int, basestring, list))
          check_type(size, (int, basestring, list))
          check_type(filter, (basestring, list, set, tuple))
          check_type(filter_type, basestring)
          check_type(sortasc, basestring)
          check_type(sortdsc, basestring)
  
          _params = {
              'page':
                  page,
              'size':
                  size,
              'filter':
                  filter,
              'filterType':
                  filter_type,
              'sortasc':
                  sortasc,
              'sortdsc':
                  sortdsc,
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
  
          e_url = ('/ers/config/sgt')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              _api_response = self._session.get(endpoint_full_url, params=_params,
                                                headers=_headers)
          else:
              _api_response = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_b3c356cfc48a5da4b13b8ecbae5748b7_v3_0_0', _api_response)
  
      def get_all_security_groups_generator(self,
                                            filter=None,
                                            filter_type=None,
                                            page=None,
                                            size=None,
                                            sortasc=None,
                                            sortdsc=None,
                                            headers=None,
                                            **query_parameters):
          """Get all SGT.
  
          Args:
              page(int): page query parameter. Page number.
              size(int): size query parameter. Number of objects
                  returned per page.
              filter(basestring, list, set, tuple): filter query
                  parameter.               **Simple
                  filtering** should be available through
                  the filter query string parameter. The
                  structure of a filter is a triplet of
                  field operator and value separated with
                  dots. More than one filter can be sent.
                  The logical operator common to ALL
                  filter criteria will be by default AND,
                  and can be changed by using the
                  "filterType=or" query string parameter.
                  Each resource Data model description
                  should specify if an attribute is a
                  filtered field.              (Operator:
                  Description),
                  (EQ: Equals),               (NEQ: Not
                  Equals),               (GT: Greater
                  Than),               (LT: Less Then),
                  (STARTSW: Starts With),
                  (NSTARTSW: Not Starts With),
                  (ENDSW: Ends With),
                  (NENDSW: Not Ends With),
                  (CONTAINS: Contains),
                  (NCONTAINS: Not Contains),
                  .
              filter_type(basestring): filterType query parameter. The
                  logical operator common to ALL filter
                  criteria will be by default AND, and can
                  be changed by using the parameter.
              sortasc(basestring): sortasc query parameter. sort asc.
              sortdsc(basestring): sortdsc query parameter. sort desc.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              Generator: A generator object containing the following object.
                + RestResponse: REST response with following properties:
                    - headers(MyDict): response headers.
                    - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                          or the bracket notation.
                    - content(bytes): representation of the request's response
                    - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
  
          yield from get_next_page(self.get_all_security_groups, dict(
              filter=filter,
              filter_type=filter_type,
              page=page,
              size=size,
              sortasc=sortasc,
              sortdsc=sortdsc,
              **query_parameters
          ), access_next_list=["SearchResult", "nextPage", "href"])
  
      def create_security_group(self,
                                description=None,
                                generation_id=None,
                                name=None,
                                propogate_to_apic=None,
                                value=None,
                                headers=None,
                                payload=None,
                                active_validation=True,
                                **query_parameters):
          """Create SGT.
  
          Args:
              description(string): description, property of the
                  request body.
              generation_id(string): generationId, property of the
                  request body.
              name(string): name, property of the request body.
              propogate_to_apic(boolean): propogateToApic, property of
                  the request body.
              value(integer): value, property of the request body.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              payload(dict): A JSON serializable Python object to send in the
                  body of the Request.
              active_validation(bool): Enable/Disable payload validation.
                  Defaults to True.
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
          if active_validation and is_xml_payload:
              check_type(payload, basestring)
          if active_validation and not is_xml_payload:
              check_type(payload, dict)
  
          _params = {
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
          if is_xml_payload:
              _payload = payload
          else:
              _tmp_payload = {
                  'name':
                      name,
                  'description':
                      description,
                  'value':
                      value,
                  'generationId':
                      generation_id,
                  'propogateToApic':
                      propogate_to_apic,
              }
              _payload = {
                  'Sgt': dict_from_items_with_values(_tmp_payload)
              }
              _payload.update(payload or {})
              _payload = dict_from_items_with_values(_payload)
          if active_validation and not is_xml_payload:
              self._request_validator('jsd_d0290eb241f5bd79221afc8d6cb32da_v3_0_0')\
                  .validate(_payload)
  
          e_url = ('/ers/config/sgt')
          endpoint_full_url = apply_path_params(e_url, path_params)
  
          request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
          if with_custom_headers:
              _api_response = self._session.post(endpoint_full_url, params=_params,
                                                 headers=_headers,
                                                 **request_params)
          else:
              _api_response = self._session.post(endpoint_full_url, params=_params,
                                                 **request_params)
  
          return self._object_factory('bpm_d0290eb241f5bd79221afc8d6cb32da_v3_0_0', _api_response)
  
      def get_security_group_by_id(self,
                                   id,
                                   headers=None,
                                   **query_parameters):
          """Get SGT by Id.
  
          Args:
              id(basestring): id path parameter.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          check_type(id, basestring,
                     may_be_none=False)
  
          _params = {
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
              'id': id,
          }
  
          e_url = ('/ers/config/sgt/{id}')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              _api_response = self._session.get(endpoint_full_url, params=_params,
                                                headers=_headers)
          else:
              _api_response = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_ea658190e73c5ce1b27e7def4aea28e3_v3_0_0', _api_response)
  
      def update_security_group_by_id(self,
                                      id,
                                      description=None,
                                      generation_id=None,
                                      name=None,
                                      propogate_to_apic=None,
                                      value=None,
                                      headers=None,
                                      payload=None,
                                      active_validation=True,
                                      **query_parameters):
          """Update SGT.
  
          Args:
              description(string): description, property of the
                  request body.
              generation_id(string): generationId, property of the
                  request body.
              name(string): name, property of the request body.
              propogate_to_apic(boolean): propogateToApic, property of
                  the request body.
              value(integer): value, property of the request body.
              id(basestring): id path parameter.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              payload(dict): A JSON serializable Python object to send in the
                  body of the Request.
              active_validation(bool): Enable/Disable payload validation.
                  Defaults to True.
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
          if active_validation and is_xml_payload:
              check_type(payload, basestring)
          if active_validation and not is_xml_payload:
              check_type(payload, dict)
          check_type(id, basestring,
                     may_be_none=False)
  
          _params = {
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
              'id': id,
          }
          if is_xml_payload:
              _payload = payload
          else:
              _tmp_payload = {
                  'name':
                      name,
                  'description':
                      description,
                  'value':
                      value,
                  'generationId':
                      generation_id,
                  'propogateToApic':
                      propogate_to_apic,
              }
              _payload = {
                  'Sgt': dict_from_items_with_values(_tmp_payload)
              }
              _payload.update(payload or {})
              _payload = dict_from_items_with_values(_payload)
          if active_validation and not is_xml_payload:
              self._request_validator('jsd_ce666e64a958229cfd8da70945935e_v3_0_0')\
                  .validate(_payload)
  
          e_url = ('/ers/config/sgt/{id}')
          endpoint_full_url = apply_path_params(e_url, path_params)
  
          request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
          if with_custom_headers:
              _api_response = self._session.put(endpoint_full_url, params=_params,
                                                headers=_headers,
                                                **request_params)
  
          else:
              _api_response = self._session.put(endpoint_full_url, params=_params,
                                                **request_params)
  
          return self._object_factory('bpm_ce666e64a958229cfd8da70945935e_v3_0_0', _api_response)
  
      def delete_security_group_by_id(self,
                                      id,
                                      headers=None,
                                      **query_parameters):
          """Delete SGT.
  
          Args:
              id(basestring): id path parameter.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          check_type(id, basestring,
                     may_be_none=False)
  
          _params = {
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
              'id': id,
          }
  
          e_url = ('/ers/config/sgt/{id}')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              _api_response = self._session.delete(endpoint_full_url, params=_params,
                                                   headers=_headers)
          else:
              _api_response = self._session.delete(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_ed2c0f81f4ea5299840089761bfd4f62_v3_0_0', _api_response)
  
      def bulk_request_for_security_group(self,
                                          operation_type=None,
                                          resource_media_type=None,
                                          headers=None,
                                          payload=None,
                                          active_validation=True,
                                          **query_parameters):
          """Bulk request for SGT.
  
          Args:
              operation_type(string): operationType, property of the
                  request body.
              resource_media_type(string): resourceMediaType, property
                  of the request body.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              payload(dict): A JSON serializable Python object to send in the
                  body of the Request.
              active_validation(bool): Enable/Disable payload validation.
                  Defaults to True.
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          is_xml_payload = 'application/xml' in _headers.get('Content-Type', [])
          if active_validation and is_xml_payload:
              check_type(payload, basestring)
          if active_validation and not is_xml_payload:
              check_type(payload, dict)
  
          _params = {
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
          if is_xml_payload:
              _payload = payload
          else:
              _tmp_payload = {
                  'operationType':
                      operation_type,
                  'resourceMediaType':
                      resource_media_type,
              }
              _payload = {
                  'SgtBulkRequest': dict_from_items_with_values(_tmp_payload)
              }
              _payload.update(payload or {})
              _payload = dict_from_items_with_values(_payload)
          if active_validation and not is_xml_payload:
              self._request_validator('jsd_f7bd03a835c95b7a759b39ce7f680_v3_0_0')\
                  .validate(_payload)
  
          e_url = ('/ers/config/sgt/bulk/submit')
          endpoint_full_url = apply_path_params(e_url, path_params)
  
          request_params = {'data': _payload} if is_xml_payload else {'json': _payload}
          if with_custom_headers:
              _api_response = self._session.put(endpoint_full_url, params=_params,
                                                headers=_headers,
                                                **request_params)
  
          else:
              _api_response = self._session.put(endpoint_full_url, params=_params,
                                                **request_params)
  
          return self._object_factory('bpm_f7bd03a835c95b7a759b39ce7f680_v3_0_0', _api_response)
  
      def monitor_bulk_status_security_group(self,
                                             bulkid,
                                             headers=None,
                                             **query_parameters):
          """Monitor bulk status for SGT.
  
          Args:
              bulkid(basestring): bulkid path parameter.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              **query_parameters: Additional query parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              RestResponse: REST response with following properties:
                - headers(MyDict): response headers.
                - response(MyDict): response body as a MyDict object. Access the object's properties by using the dot notation
                      or the bracket notation.
                - content(bytes): representation of the request's response
                - text(str): representation of the request's response
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the Identity Services Engine cloud returns an error.
          """
          check_type(headers, dict)
  
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'Accept' in headers:
                  check_type(headers.get('Accept'),
                             basestring, may_be_none=False)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
          check_type(bulkid, basestring,
                     may_be_none=False)
  
          _params = {
          }
          _params.update(query_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
              'bulkid': bulkid,
          }
  
          e_url = ('/ers/config/sgt/bulk/{bulkid}')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              _api_response = self._session.get(endpoint_full_url, params=_params,
                                                headers=_headers)
          else:
              _api_response = self._session.get(endpoint_full_url, params=_params)
  
          return self._object_factory('bpm_a3148b789a935070b99caed1e99592cf_v3_0_0', _api_response)
  