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'] == 'cookie': headers['Cookie'] = auth_setting['value'] 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 ApiValueError( 'Authentication token must be in `query` or `header`' )
def 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.""" 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 ApiValueError( "http method must be `GET`, `HEAD`, `OPTIONS`," " `POST`, `PATCH`, `PUT` or `DELETE`." )
def request(self, method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None): """Perform requests. :param method: http request method :param url: http request url :param query_params: query parameters in the url :param headers: http request headers :param body: request json body, for `application/json` :param post_params: request post parameters, `application/x-www-form-urlencoded` and `multipart/form-data` :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. """ method = method.upper() assert method in [ 'GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH', 'OPTIONS' ] if post_params and body: raise ApiValueError( "body parameter cannot be used with post_params parameter.") post_params = post_params or {} headers = headers or {} timeout = None if _request_timeout: if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)): # noqa: E501,F821 timeout = urllib3.Timeout(total=_request_timeout) elif (isinstance(_request_timeout, tuple) and len(_request_timeout) == 2): timeout = urllib3.Timeout(connect=_request_timeout[0], read=_request_timeout[1]) if 'Content-Type' not in headers: headers['Content-Type'] = 'application/json' try: # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: if query_params: url += '?' + urlencode(query_params) if re.search('json', headers['Content-Type'], re.IGNORECASE): request_body = None if body is not None: request_body = json.dumps(body) r = self.pool_manager.request( method, url, body=request_body, preload_content=_preload_content, timeout=timeout, headers=headers) elif headers[ 'Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 r = self.pool_manager.request( method, url, fields=post_params, encode_multipart=False, preload_content=_preload_content, timeout=timeout, headers=headers) elif headers['Content-Type'] == 'multipart/form-data': # must del headers['Content-Type'], or the correct # Content-Type which generated by urllib3 will be # overwritten. del headers['Content-Type'] r = self.pool_manager.request( method, url, fields=post_params, encode_multipart=True, preload_content=_preload_content, timeout=timeout, headers=headers) # Pass a `string` parameter directly in the body to support # other content types than Json when `body` argument is # provided in serialized form elif isinstance(body, str) or isinstance(body, bytes): request_body = body r = self.pool_manager.request( method, url, body=request_body, preload_content=_preload_content, timeout=timeout, headers=headers) else: # Cannot generate the request from given parameters msg = """Cannot prepare a request message for provided arguments. Please check that your arguments match declared content type.""" raise ApiException(status=0, reason=msg) # For `GET`, `HEAD` else: r = self.pool_manager.request(method, url, fields=query_params, preload_content=_preload_content, timeout=timeout, headers=headers) except urllib3.exceptions.SSLError as e: msg = "{0}\n{1}".format(type(e).__name__, str(e)) raise ApiException(status=0, reason=msg) if _preload_content: r = RESTResponse(r) # log response body logger.debug("response body: %s", r.data) if not 200 <= r.status <= 299: raise ApiException(http_resp=r) return r
def get_request_with_http_info(self, id, **kwargs): # noqa: E501 """[EXPERIMENTAL] Get the request content for a specific API request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_request_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: The identifier of the request to obtain the content for. (required) :param _return_http_data_only: response data without head status code and headers :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: tuple(Request, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method get_request" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError( "Missing the required parameter `id` when calling `get_request`" ) # noqa: E501 if ('id' in local_var_params and len(local_var_params['id']) > 64): raise ApiValueError( "Invalid value for parameter `id` when calling `get_request`, length must be less than or equal to `64`" ) # noqa: E501 if ('id' in local_var_params and len(local_var_params['id']) < 1): raise ApiValueError( "Invalid value for parameter `id` when calling `get_request`, length must be greater than or equal to `1`" ) # noqa: E501 if 'id' in local_var_params and not re.search( r'^[a-zA-Z0-9\-_:\+]+$', local_var_params['id']): # noqa: E501 raise ApiValueError( "Invalid value for parameter `id` when calling `get_request`, must conform to the pattern `/^[a-zA-Z0-9\-_:\+]+$/`" ) # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['text/plain', 'application/json', 'text/json']) # noqa: E501 # Authentication setting auth_settings = ['oauth2'] # noqa: E501 # set the LUSID header header_params['X-LUSID-SDK-Language'] = 'Python' header_params['X-LUSID-SDK-Version'] = '0.0.193' return self.api_client.call_api( '/api/requests/{id}/request', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Request', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def list_request_logs_with_http_info(self, **kwargs): # noqa: E501 """[EXPERIMENTAL] Get the logs for API requests. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_request_logs_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str filter: Expression to filter the result set. Read more about <see href=\"https://support.lusid.com/filtering-results-from-lusid\"> filtering results from LUSID</see>. :param str sort_by: Order the results by these fields. Use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName :param int limit: When paginating, only return this number of records. The minimum value is 0 and the maximum is 10000. :param str page: Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter and sortby fields should not be supplied. :param str histogram_interval: Optional interval to use in a histogram of the returned values. If not provided, no histogram will be generated. :param _return_http_data_only: response data without head status code and headers :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: tuple(ResourceListWithHistogramOfRequestLog, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'filter', 'sort_by', 'limit', 'page', 'histogram_interval' ] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method list_request_logs" % key) local_var_params[key] = val del local_var_params['kwargs'] if ('filter' in local_var_params and len(local_var_params['filter']) > 2147483647): raise ApiValueError( "Invalid value for parameter `filter` when calling `list_request_logs`, length must be less than or equal to `2147483647`" ) # noqa: E501 if ('filter' in local_var_params and len(local_var_params['filter']) < 0): raise ApiValueError( "Invalid value for parameter `filter` when calling `list_request_logs`, length must be greater than or equal to `0`" ) # noqa: E501 if 'filter' in local_var_params and not re.search( r'(?s).*', local_var_params['filter']): # noqa: E501 raise ApiValueError( "Invalid value for parameter `filter` when calling `list_request_logs`, must conform to the pattern `/(?s).*/`" ) # noqa: E501 if ('sort_by' in local_var_params and len(local_var_params['sort_by']) > 2147483647): raise ApiValueError( "Invalid value for parameter `sort_by` when calling `list_request_logs`, length must be less than or equal to `2147483647`" ) # noqa: E501 if ('sort_by' in local_var_params and len(local_var_params['sort_by']) < 1): raise ApiValueError( "Invalid value for parameter `sort_by` when calling `list_request_logs`, length must be greater than or equal to `1`" ) # noqa: E501 if 'sort_by' in local_var_params and not re.search( r'(?s).*', local_var_params['sort_by']): # noqa: E501 raise ApiValueError( "Invalid value for parameter `sort_by` when calling `list_request_logs`, must conform to the pattern `/(?s).*/`" ) # noqa: E501 if 'limit' in local_var_params and local_var_params[ 'limit'] > 10000: # noqa: E501 raise ApiValueError( "Invalid value for parameter `limit` when calling `list_request_logs`, must be a value less than or equal to `10000`" ) # noqa: E501 if 'limit' in local_var_params and local_var_params[ 'limit'] < 0: # noqa: E501 raise ApiValueError( "Invalid value for parameter `limit` when calling `list_request_logs`, must be a value greater than or equal to `0`" ) # noqa: E501 if ('page' in local_var_params and len(local_var_params['page']) > 500): raise ApiValueError( "Invalid value for parameter `page` when calling `list_request_logs`, length must be less than or equal to `500`" ) # noqa: E501 if ('page' in local_var_params and len(local_var_params['page']) < 1): raise ApiValueError( "Invalid value for parameter `page` when calling `list_request_logs`, length must be greater than or equal to `1`" ) # noqa: E501 if 'page' in local_var_params and not re.search( r'^[a-zA-Z0-9\+\/]*={0,3}$', local_var_params['page']): # noqa: E501 raise ApiValueError( "Invalid value for parameter `page` when calling `list_request_logs`, must conform to the pattern `/^[a-zA-Z0-9\+\/]*={0,3}$/`" ) # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'filter' in local_var_params: query_params.append( ('filter', local_var_params['filter'])) # noqa: E501 if 'sort_by' in local_var_params: query_params.append( ('sortBy', local_var_params['sort_by'])) # noqa: E501 if 'limit' in local_var_params: query_params.append( ('limit', local_var_params['limit'])) # noqa: E501 if 'page' in local_var_params: query_params.append( ('page', local_var_params['page'])) # noqa: E501 if 'histogram_interval' in local_var_params: query_params.append( ('histogramInterval', local_var_params['histogram_interval'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['text/plain', 'application/json', 'text/json']) # noqa: E501 # Authentication setting auth_settings = ['oauth2'] # noqa: E501 # set the LUSID header header_params['X-LUSID-SDK-Language'] = 'Python' header_params['X-LUSID-SDK-Version'] = '0.0.193' return self.api_client.call_api( '/api/requests', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ResourceListWithHistogramOfRequestLog', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)