Inheritance diagram for cFSPlib.python_api_client.swagger_client.api_client.ApiClient:

Collaboration diagram for cFSPlib.python_api_client.swagger_client.api_client.ApiClient:

Public Member Functions
def	__init__ (self, configuration=None, header_name=None, header_value=None, cookie=None)

def	__del__ (self)

def	user_agent (self)

def	user_agent (self, value)

def	set_default_header (self, header_name, header_value)

def	sanitize_for_serialization (self, obj)

def	deserialize (self, response, response_type)

def	call_api (self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)

def	request (self, method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

def	parameters_to_tuples (self, params, collection_formats)

def	prepare_post_parameters (self, post_params=None, files=None)

def	select_header_accept (self, accepts)

def	select_header_content_type (self, content_types)

def	update_params_for_auth (self, headers, querys, auth_settings)

Public Attributes
	configuration

	pool

	rest_client

	default_headers

	cookie

	user_agent

	last_response

Static Public Attributes
tuple	PRIMITIVE_TYPES = (float, bool, bytes, six.text_type) + six.integer_types

dictionary	NATIVE_TYPES_MAPPING

Detailed Description

Generic API client for Swagger client library builds.

Swagger generic API client. This client handles the client-
server communication, and is invariant across implementations. Specifics of
the methods and models for each application are generated from the Swagger
templates.

NOTE: This class is auto generated by the swagger code generator program.
Ref: https://github.com/swagger-api/swagger-codegen
Do not edit the class manually.

:param configuration: .Configuration object for this client
:param header_name: a header to pass when making calls to the API.
:param header_value: a header value to pass when making calls to
    the API.
:param cookie: a cookie to include in the header when making calls
    to the API

Definition at line 30 of file api_client.py.

Constructor & Destructor Documentation

◆ init()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.__init__	(	self,
		configuration = `None`,
		header_name = `None`,
		header_value = `None`,
		cookie = `None`
	)

Definition at line 62 of file api_client.py.

                  cookie=None):
         if configuration is None:
             configuration = Configuration()
         self.configuration = configuration
  
         self.pool = ThreadPool()
         self.rest_client = rest.RESTClientObject(configuration)
         self.default_headers = {}
         if header_name is not None:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
         self.user_agent = 'Swagger-Codegen/1.0.0/python'
  

◆ del()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.__del__ ( self )

Definition at line 77 of file api_client.py.

     def __del__(self):
         self.pool.close()
         self.pool.join()
  

Member Function Documentation

◆ call_api()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.call_api	(	self,
		resource_path,
		method,
		path_params = `None`,
		query_params = `None`,
		header_params = `None`,
		body = `None`,
		post_params = `None`,
		files = `None`,
		response_type = `None`,
		auth_settings = `None`,
		async_req = `None`,
		_return_http_data_only = `None`,
		collection_formats = `None`,
		_preload_content = `True`,
		_request_timeout = `None`
	)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async request, set the async_req parameter.

:param resource_path: Path to method endpoint.
:param method: Method to call.
:param path_params: Path parameters in the url.
:param query_params: Query parameters in the url.
:param header_params: Header parameters to be
    placed in the request header.
:param body: Request body.
:param post_params dict: Request post form parameters,
    for `application/x-www-form-urlencoded`, `multipart/form-data`.
:param auth_settings list: Auth Settings names for the request.
:param response: Response data type.
:param files dict: key -> filename, value -> filepath,
    for `multipart/form-data`.
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
                               and headers
:param collection_formats: dict of collection formats for path, query,
    header, and post parameters.
:param _preload_content: if False, the urllib3.HTTPResponse object will
                         be returned without reading/decoding response
                         data. Default is True.
:param _request_timeout: timeout setting for this request. If one
                         number provided, it will be total request
                         timeout. It can also be a pair (tuple) of
                         (connection, read) timeouts.
:return:
    If async_req parameter is True,
    the request will be called asynchronously.
    The method will return the request thread.
    If parameter async_req is False or missing,
    then the method will return the response directly.

Definition at line 273 of file api_client.py.

                  _preload_content=True, _request_timeout=None):
         """Makes the HTTP request (synchronous) and returns deserialized data.
  
         To make an async request, set the async_req parameter.
  
         :param resource_path: Path to method endpoint.
         :param method: Method to call.
         :param path_params: Path parameters in the url.
         :param query_params: Query parameters in the url.
         :param header_params: Header parameters to be
             placed in the request header.
         :param body: Request body.
         :param post_params dict: Request post form parameters,
             for `application/x-www-form-urlencoded`, `multipart/form-data`.
         :param auth_settings list: Auth Settings names for the request.
         :param response: Response data type.
         :param files dict: key -> filename, value -> filepath,
             for `multipart/form-data`.
         :param async_req bool: execute request asynchronously
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param collection_formats: dict of collection formats for path, query,
             header, and post parameters.
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
         :return:
             If async_req parameter is True,
             the request will be called asynchronously.
             The method will return the request thread.
             If parameter async_req is False or missing,
             then the method will return the response directly.
         """
         if not async_req:
             return self.__call_api(resource_path, method,
                                    path_params, query_params, header_params,
                                    body, post_params, files,
                                    response_type, auth_settings,
                                    _return_http_data_only, collection_formats,
                                    _preload_content, _request_timeout)
         else:
             thread = self.pool.apply_async(self.__call_api, (resource_path,
                                            method, path_params, query_params,
                                            header_params, body,
                                            post_params, files,
                                            response_type, auth_settings,
                                            _return_http_data_only,
                                            collection_formats,
                                            _preload_content, _request_timeout))
         return thread
  

Here is the call graph for this function:

◆ deserialize()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.deserialize	(	self,
		response,
		response_type
	)

Deserializes response into an object.

:param response: RESTResponse object to be deserialized.
:param response_type: class literal for
    deserialized object, or string of class name.

:return: deserialized object.

Definition at line 212 of file api_client.py.

     def deserialize(self, response, response_type):
         """Deserializes response into an object.
  
         :param response: RESTResponse object to be deserialized.
         :param response_type: class literal for
             deserialized object, or string of class name.
  
         :return: deserialized object.
         """
         # handle file downloading
         # save response body into a tmp file and return the instance
         if response_type == "file":
             return self.__deserialize_file(response)
  
         # fetch data from response object
         try:
             data = json.loads(response.data)
         except ValueError:
             data = response.data
  
         return self.__deserialize(data, response_type)
  

Here is the call graph for this function:

◆ parameters_to_tuples()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.parameters_to_tuples	(	self,
		params,
		collection_formats
	)

Get parameters as list of tuples, formatting collections.

:param params: Parameters as dict or list of two-tuples
:param dict collection_formats: Parameter collection formats
:return: Parameters as list of tuples, collections formatted

Definition at line 394 of file api_client.py.

     def parameters_to_tuples(self, params, collection_formats):
         """Get parameters as list of tuples, formatting collections.
  
         :param params: Parameters as dict or list of two-tuples
         :param dict collection_formats: Parameter collection formats
         :return: Parameters as list of tuples, collections formatted
         """
         new_params = []
         if collection_formats is None:
             collection_formats = {}
         for k, v in six.iteritems(params) if isinstance(params, dict) else params:  # noqa: E501
             if k in collection_formats:
                 collection_format = collection_formats[k]
                 if collection_format == 'multi':
                     new_params.extend((k, value) for value in v)
                 else:
                     if collection_format == 'ssv':
                         delimiter = ' '
                     elif collection_format == 'tsv':
                         delimiter = '\t'
                     elif collection_format == 'pipes':
                         delimiter = '|'
                     else:  # csv is the default
                         delimiter = ','
                     new_params.append(
                         (k, delimiter.join(str(value) for value in v)))
             else:
                 new_params.append((k, v))
         return new_params
  

Here is the caller graph for this function:

◆ prepare_post_parameters()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.prepare_post_parameters	(	self,
		post_params = `None`,
		files = `None`
	)

Builds form parameters.

:param post_params: Normal form parameters.
:param files: File parameters.
:return: Form parameters with files.

Definition at line 424 of file api_client.py.

     def prepare_post_parameters(self, post_params=None, files=None):
         """Builds form parameters.
  
         :param post_params: Normal form parameters.
         :param files: File parameters.
         :return: Form parameters with files.
         """
         params = []
  
         if post_params:
             params = post_params
  
         if files:
             for k, v in six.iteritems(files):
                 if not v:
                     continue
                 file_names = v if type(v) is list else [v]
                 for n in file_names:
                     with open(n, 'rb') as f:
                         filename = os.path.basename(f.name)
                         filedata = f.read()
                         mimetype = (mimetypes.guess_type(filename)[0] or
                                     'application/octet-stream')
                         params.append(
                             tuple([k, tuple([filename, filedata, mimetype])]))
  
         return params
  

Here is the caller graph for this function:

◆ request()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.request	(	self,
		method,
		url,
		query_params = `None`,
		headers = `None`,
		post_params = `None`,
		body = `None`,
		_preload_content = `True`,
		_request_timeout = `None`
	)

Makes the HTTP request using RESTClient.

Definition at line 333 of file api_client.py.

                 _request_timeout=None):
         """Makes the HTTP request using RESTClient."""
         if method == "GET":
             return self.rest_client.GET(url,
                                         query_params=query_params,
                                         _preload_content=_preload_content,
                                         _request_timeout=_request_timeout,
                                         headers=headers)
         elif method == "HEAD":
             return self.rest_client.HEAD(url,
                                          query_params=query_params,
                                          _preload_content=_preload_content,
                                          _request_timeout=_request_timeout,
                                          headers=headers)
         elif method == "OPTIONS":
             return self.rest_client.OPTIONS(url,
                                             query_params=query_params,
                                             headers=headers,
                                             post_params=post_params,
                                             _preload_content=_preload_content,
                                             _request_timeout=_request_timeout,
                                             body=body)
         elif method == "POST":
             return self.rest_client.POST(url,
                                          query_params=query_params,
                                          headers=headers,
                                          post_params=post_params,
                                          _preload_content=_preload_content,
                                          _request_timeout=_request_timeout,
                                          body=body)
         elif method == "PUT":
             return self.rest_client.PUT(url,
                                         query_params=query_params,
                                         headers=headers,
                                         post_params=post_params,
                                         _preload_content=_preload_content,
                                         _request_timeout=_request_timeout,
                                         body=body)
         elif method == "PATCH":
             return self.rest_client.PATCH(url,
                                           query_params=query_params,
                                           headers=headers,
                                           post_params=post_params,
                                           _preload_content=_preload_content,
                                           _request_timeout=_request_timeout,
                                           body=body)
         elif method == "DELETE":
             return self.rest_client.DELETE(url,
                                            query_params=query_params,
                                            headers=headers,
                                            _preload_content=_preload_content,
                                            _request_timeout=_request_timeout,
                                            body=body)
         else:
             raise ValueError(
                 "http method must be `GET`, `HEAD`, `OPTIONS`,"
                 " `POST`, `PATCH`, `PUT` or `DELETE`."
             )
  

Here is the caller graph for this function:

◆ sanitize_for_serialization()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.sanitize_for_serialization	(	self,
		obj
	)

Builds a JSON POST object.

If obj is None, return None.
If obj is str, int, long, float, bool, return directly.
If obj is datetime.datetime, datetime.date
    convert to string in iso8601 format.
If obj is list, sanitize each element in the list.
If obj is dict, return the dict.
If obj is swagger model, return the properties dict.

:param obj: The data to serialize.
:return: The serialized form of data.

Definition at line 170 of file api_client.py.

     def sanitize_for_serialization(self, obj):
         """Builds a JSON POST object.
  
         If obj is None, return None.
         If obj is str, int, long, float, bool, return directly.
         If obj is datetime.datetime, datetime.date
             convert to string in iso8601 format.
         If obj is list, sanitize each element in the list.
         If obj is dict, return the dict.
         If obj is swagger model, return the properties dict.
  
         :param obj: The data to serialize.
         :return: The serialized form of data.
         """
         if obj is None:
             return None
         elif isinstance(obj, self.PRIMITIVE_TYPES):
             return obj
         elif isinstance(obj, list):
             return [self.sanitize_for_serialization(sub_obj)
                     for sub_obj in obj]
         elif isinstance(obj, tuple):
             return tuple(self.sanitize_for_serialization(sub_obj)
                          for sub_obj in obj)
         elif isinstance(obj, (datetime.datetime, datetime.date)):
             return obj.isoformat()
  
         if isinstance(obj, dict):
             obj_dict = obj
         else:
             # Convert model obj to dict except
             # attributes `swagger_types`, `attribute_map`
             # and attributes which value is not None.
             # Convert attribute name to json key in
             # model definition for request.
             obj_dict = {obj.attribute_map[attr]: getattr(obj, attr)
                         for attr, _ in six.iteritems(obj.swagger_types)
                         if getattr(obj, attr) is not None}
  
         return {key: self.sanitize_for_serialization(val)
                 for key, val in six.iteritems(obj_dict)}
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ select_header_accept()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.select_header_accept	(	self,
		accepts
	)

Returns `Accept` based on an array of accepts provided.

:param accepts: List of headers.
:return: Accept (e.g. application/json).

Definition at line 452 of file api_client.py.

     def select_header_accept(self, accepts):
         """Returns `Accept` based on an array of accepts provided.
  
         :param accepts: List of headers.
         :return: Accept (e.g. application/json).
         """
         if not accepts:
             return
  
         accepts = [x.lower() for x in accepts]
  
         if 'application/json' in accepts:
             return 'application/json'
         else:
             return ', '.join(accepts)
  

◆ select_header_content_type()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.select_header_content_type	(	self,
		content_types
	)

Returns `Content-Type` based on an array of content_types provided.

:param content_types: List of content-types.
:return: Content-Type (e.g. application/json).

Definition at line 468 of file api_client.py.

     def select_header_content_type(self, content_types):
         """Returns `Content-Type` based on an array of content_types provided.
  
         :param content_types: List of content-types.
         :return: Content-Type (e.g. application/json).
         """
         if not content_types:
             return 'application/json'
  
         content_types = [x.lower() for x in content_types]
  
         if 'application/json' in content_types or '*/*' in content_types:
             return 'application/json'
         else:
             return content_types[0]
  

◆ set_default_header()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.set_default_header	(	self,
		header_name,
		header_value
	)

Definition at line 90 of file api_client.py.

     def set_default_header(self, header_name, header_value):
         self.default_headers[header_name] = header_value
  

Here is the call graph for this function:

◆ update_params_for_auth()

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.update_params_for_auth	(	self,
		headers,
		querys,
		auth_settings
	)

Updates header and query params based on authentication setting.

:param headers: Header parameters dict to be updated.
:param querys: Query parameters tuple list to be updated.
:param auth_settings: Authentication setting identifiers list.

Definition at line 484 of file api_client.py.

     def update_params_for_auth(self, headers, querys, auth_settings):
         """Updates header and query params based on authentication setting.
  
         :param headers: Header parameters dict to be updated.
         :param querys: Query parameters tuple list to be updated.
         :param auth_settings: Authentication setting identifiers list.
         """
         if not auth_settings:
             return
  
         for auth in auth_settings:
             auth_setting = self.configuration.auth_settings().get(auth)
             if auth_setting:
                 if not auth_setting['value']:
                     continue
                 elif auth_setting['in'] == 'header':
                     headers[auth_setting['key']] = auth_setting['value']
                 elif auth_setting['in'] == 'query':
                     querys.append((auth_setting['key'], auth_setting['value']))
                 else:
                     raise ValueError(
                         'Authentication token must be in `query` or `header`'
                     )
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ user_agent() [1/2]

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.user_agent ( self )

User agent for this API client

Definition at line 82 of file api_client.py.

     def user_agent(self):
         """User agent for this API client"""
         return self.default_headers['User-Agent']
  

◆ user_agent() [2/2]

def cFSPlib.python_api_client.swagger_client.api_client.ApiClient.user_agent	(	self,
		value
	)

Definition at line 87 of file api_client.py.

     def user_agent(self, value):
         self.default_headers['User-Agent'] = value
  

Member Data Documentation

◆ configuration

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.configuration

Definition at line 66 of file api_client.py.

◆ cookie

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.cookie

Definition at line 73 of file api_client.py.

◆ default_headers

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.default_headers

Definition at line 70 of file api_client.py.

◆ last_response

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.last_response

Definition at line 154 of file api_client.py.

◆ NATIVE_TYPES_MAPPING

dictionary cFSPlib.python_api_client.swagger_client.api_client.ApiClient.NATIVE_TYPES_MAPPING

static

Initial value:

=  {
        'int': int,
        'long': int if six.PY3 else long,  # noqa: F821
        'float': float,
        'str': str,
        'bool': bool,
        'date': datetime.date,
        'datetime': datetime.datetime,
        'object': object,
    }

Definition at line 51 of file api_client.py.

◆ pool

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.pool

Definition at line 68 of file api_client.py.

◆ PRIMITIVE_TYPES

tuple cFSPlib.python_api_client.swagger_client.api_client.ApiClient.PRIMITIVE_TYPES = (float, bool, bytes, six.text_type) + six.integer_types

static

Definition at line 50 of file api_client.py.

◆ rest_client

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.rest_client

Definition at line 69 of file api_client.py.

◆ user_agent

cFSPlib.python_api_client.swagger_client.api_client.ApiClient.user_agent

Definition at line 75 of file api_client.py.

The documentation for this class was generated from the following file:

repos_for_Dox/cFSP/cFSPlib/python_api_client/swagger_client/api_client.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

◆ __del__()

Member Function Documentation

◆ call_api()

◆ deserialize()

◆ parameters_to_tuples()

◆ prepare_post_parameters()

◆ request()

◆ sanitize_for_serialization()

◆ select_header_accept()

◆ select_header_content_type()

◆ set_default_header()

◆ update_params_for_auth()

◆ user_agent() [1/2]

◆ user_agent() [2/2]

Member Data Documentation

◆ configuration

◆ cookie

◆ default_headers

◆ last_response

◆ NATIVE_TYPES_MAPPING

◆ pool

◆ PRIMITIVE_TYPES

◆ rest_client

◆ user_agent

◆ init()

◆ del()