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, _preload_content=_preload_content, _request_timeout=_request_timeout) 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 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 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, 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) # In the python 3, the response.data is bytes. # we need to decode it to string. if six.PY3: r.data = r.data.decode('utf8') # 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_mosaic_address_restriction_with_http_info(self, mosaic_id, account_id, **kwargs): # noqa: E501 """Get mosaic address restrictions for a given mosaic and account identifier. # noqa: E501 Get mosaic address restriction. # 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_mosaic_address_restriction_with_http_info(mosaic_id, account_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str mosaic_id: Mosaic identifier. (required) :param str account_id: Account public key or address enconded using a 32-character set. (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(MosaicAddressRestrictionDTO, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['mosaic_id', 'account_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_mosaic_address_restriction" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'mosaic_id' is set if self.api_client.client_side_validation and ('mosaic_id' not in local_var_params or # noqa: E501 local_var_params['mosaic_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `mosaic_id` when calling `get_mosaic_address_restriction`") # noqa: E501 # verify the required parameter 'account_id' is set if self.api_client.client_side_validation and ('account_id' not in local_var_params or # noqa: E501 local_var_params['account_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `account_id` when calling `get_mosaic_address_restriction`") # noqa: E501 collection_formats = {} path_params = {} if 'mosaic_id' in local_var_params: path_params['mosaicId'] = local_var_params['mosaic_id'] # noqa: E501 if 'account_id' in local_var_params: path_params['accountId'] = local_var_params['account_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( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/restrictions/mosaic/{mosaicId}/address/{accountId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='MosaicAddressRestrictionDTO', # 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 get_mosaic_global_restrictions_with_http_info(self, mosaic_ids, **kwargs): # noqa: E501 """Get mosaic global restrictions for an array of mosaics. # noqa: E501 Get mosaic global restrictions. # 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_mosaic_global_restrictions_with_http_info(mosaic_ids, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param MosaicIds mosaic_ids: (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(list[MosaicGlobalRestrictionDTO], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['mosaic_ids'] # 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_mosaic_global_restrictions" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'mosaic_ids' is set if self.api_client.client_side_validation and ('mosaic_ids' not in local_var_params or # noqa: E501 local_var_params['mosaic_ids'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `mosaic_ids` when calling `get_mosaic_global_restrictions`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'mosaic_ids' in local_var_params: body_params = local_var_params['mosaic_ids'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/restrictions/mosaic', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[MosaicGlobalRestrictionDTO]', # 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 get_block_by_height_with_http_info(self, height, **kwargs): # noqa: E501 """Get block information # noqa: E501 Gets a block from the chain that has the given height. # 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_block_by_height_with_http_info(height, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int height: Block height. (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(BlockInfoDTO, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['height'] # 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_block_by_height" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'height' is set if self.api_client.client_side_validation and ( 'height' not in local_var_params or # noqa: E501 local_var_params['height'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `height` when calling `get_block_by_height`" ) # noqa: E501 collection_formats = {} path_params = {} if 'height' in local_var_params: path_params['height'] = local_var_params['height'] # 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( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/block/{height}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='BlockInfoDTO', # 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 get_merkle_transaction_with_http_info(self, height, hash, **kwargs): # noqa: E501 """Get the merkle path for a given a transaction and block # noqa: E501 Returns the merkle path for a transaction included in a block. The merkle path is the minimum number of nodes needed to calculate the merkle root. Steps to calculate the merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: * a) If item.position == left -> proofHash = sha_256(item.hash + proofHash). * b) If item.position == right -> proofHash = sha_256(proofHash+ item.hash). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the block header (block.transactionsHash) to verify if the transaction was included in the block. # 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_merkle_transaction_with_http_info(height, hash, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int height: Block height. (required) :param str hash: Transaction hash. (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(MerkleProofInfoDTO, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['height', 'hash'] # 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_merkle_transaction" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'height' is set if self.api_client.client_side_validation and ( 'height' not in local_var_params or # noqa: E501 local_var_params['height'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `height` when calling `get_merkle_transaction`" ) # noqa: E501 # verify the required parameter 'hash' is set if self.api_client.client_side_validation and ( 'hash' not in local_var_params or # noqa: E501 local_var_params['hash'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `hash` when calling `get_merkle_transaction`" ) # noqa: E501 collection_formats = {} path_params = {} if 'height' in local_var_params: path_params['height'] = local_var_params['height'] # noqa: E501 if 'hash' in local_var_params: path_params['hash'] = local_var_params['hash'] # 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( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/block/{height}/transaction/{hash}/merkle', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='MerkleProofInfoDTO', # 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 get_block_transactions_with_http_info(self, height, **kwargs): # noqa: E501 """Get transactions from a block # noqa: E501 Returns an array of transactions included in a block for a given block height. # 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_block_transactions_with_http_info(height, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int height: Block height. (required) :param int page_size: Number of entries to return. :param str id: Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. :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(list[TransactionInfoDTO], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['height', 'page_size', '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_block_transactions" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'height' is set if self.api_client.client_side_validation and ( 'height' not in local_var_params or # noqa: E501 local_var_params['height'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `height` when calling `get_block_transactions`" ) # noqa: E501 if self.api_client.client_side_validation and 'page_size' in local_var_params and local_var_params[ 'page_size'] > 100: # noqa: E501 raise ApiValueError( "Invalid value for parameter `page_size` when calling `get_block_transactions`, must be a value less than or equal to `100`" ) # noqa: E501 if self.api_client.client_side_validation and 'page_size' in local_var_params and local_var_params[ 'page_size'] < 10: # noqa: E501 raise ApiValueError( "Invalid value for parameter `page_size` when calling `get_block_transactions`, must be a value greater than or equal to `10`" ) # noqa: E501 collection_formats = {} path_params = {} if 'height' in local_var_params: path_params['height'] = local_var_params['height'] # noqa: E501 query_params = [] if 'page_size' in local_var_params and local_var_params[ 'page_size'] is not None: # noqa: E501 query_params.append( ('pageSize', local_var_params['page_size'])) # noqa: E501 if 'id' in local_var_params and local_var_params[ 'id'] is not None: # noqa: E501 query_params.append(('id', local_var_params['id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/block/{height}/transactions', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[TransactionInfoDTO]', # 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 announce_transaction_with_http_info(self, transaction_payload, **kwargs): # noqa: E501 """Announce a new transaction # noqa: E501 Announces a transaction to the network. We recommended to use the Symbol-SDKs to announce transactions because they should be serialized. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.announce_transaction_with_http_info(transaction_payload, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param TransactionPayload transaction_payload: (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(AnnounceTransactionInfoDTO, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['transaction_payload'] # 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 announce_transaction" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'transaction_payload' is set if self.api_client.client_side_validation and ('transaction_payload' not in local_var_params or # noqa: E501 local_var_params['transaction_payload'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `transaction_payload` when calling `announce_transaction`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'transaction_payload' in local_var_params: body_params = local_var_params['transaction_payload'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/transaction', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AnnounceTransactionInfoDTO', # 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)