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 delete_file_with_http_info(self, file_id, **kwargs): # noqa: E501
"""Delete a file # noqa: E501
Delete a specific file. Note that every file belongs to a project and only users subscribed to that project are authorized to request deletions on it. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_file_with_http_info(file_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str file_id: ID assigned to the file once it is uploaded. (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(GenericResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'file_id'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_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 delete_file" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'file_id' is set
if self.api_client.client_side_validation and ('file_id' not in local_var_params or # noqa: E501
local_var_params['file_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `file_id` when calling `delete_file`") # noqa: E501
if self.api_client.client_side_validation and ('file_id' in local_var_params and # noqa: E501
len(local_var_params['file_id']) > 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `file_id` when calling `delete_file`, length must be less than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and ('file_id' in local_var_params and # noqa: E501
len(local_var_params['file_id']) < 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `file_id` when calling `delete_file`, length must be greater than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and 'file_id' in local_var_params and not re.search(r'^fle_[0-9a-f]{32}$', local_var_params['file_id']): # noqa: E501
raise ApiValueError("Invalid value for parameter `file_id` when calling `delete_file`, must conform to the pattern `/^fle_[0-9a-f]{32}$/`") # noqa: E501
collection_formats = {}
path_params = {}
if 'file_id' in local_var_params:
path_params['file_id'] = local_var_params['file_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 = ['api_key', 'tokens'] # noqa: E501
return self.api_client.call_api(
'/Files/{file_id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GenericResponse', # 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 upload_file_with_http_info(self, project_id, group_type, **kwargs): # noqa: E501
"""Upload a file under a project # noqa: E501
Upload a file under a specific project. Note that only users subscribed to the project can upload files to it. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_file_with_http_info(project_id, group_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project_id: ID assigned to the project once created in Atinary™ Nexus. (required)
:param str group_type: String indicating how the file is classified. Available values are *parameters*, *properties* or *other*. (required)
:param InlineObject inline_object:
: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(UploadResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'project_id',
'group_type',
'inline_object'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_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 upload_file" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'project_id' is set
if self.api_client.client_side_validation and ('project_id' not in local_var_params or # noqa: E501
local_var_params['project_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `project_id` when calling `upload_file`") # noqa: E501
# verify the required parameter 'group_type' is set
if self.api_client.client_side_validation and ('group_type' not in local_var_params or # noqa: E501
local_var_params['group_type'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `group_type` when calling `upload_file`") # noqa: E501
if self.api_client.client_side_validation and ('project_id' in local_var_params and # noqa: E501
len(local_var_params['project_id']) > 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `upload_file`, length must be less than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and ('project_id' in local_var_params and # noqa: E501
len(local_var_params['project_id']) < 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `upload_file`, length must be greater than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and 'project_id' in local_var_params and not re.search(r'^prj_[0-9a-f]{32}$', local_var_params['project_id']): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `upload_file`, must conform to the pattern `/^prj_[0-9a-f]{32}$/`") # noqa: E501
if self.api_client.client_side_validation and ('group_type' in local_var_params and # noqa: E501
len(local_var_params['group_type']) > 50): # noqa: E501
raise ApiValueError("Invalid value for parameter `group_type` when calling `upload_file`, length must be less than or equal to `50`") # noqa: E501
if self.api_client.client_side_validation and 'group_type' in local_var_params and not re.search(r'(parameters|properties|other)', local_var_params['group_type']): # noqa: E501
raise ApiValueError("Invalid value for parameter `group_type` when calling `upload_file`, must conform to the pattern `/(parameters|properties|other)/`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'project_id' in local_var_params and local_var_params['project_id'] is not None: # noqa: E501
query_params.append(('project_id', local_var_params['project_id'])) # noqa: E501
if 'group_type' in local_var_params and local_var_params['group_type'] is not None: # noqa: E501
query_params.append(('group_type', local_var_params['group_type'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'inline_object' in local_var_params:
# Note: Customization required as the SDK generated didn't detected a file inside a multipart-form request body
if 'file' in local_var_params['inline_object'].to_dict(): # Added line
local_var_files = local_var_params['inline_object'].to_dict() # Added line
else: # Added line
body_params = local_var_params['inline_object']
# 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
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['api_key', 'tokens'] # noqa: E501
return self.api_client.call_api(
'/Files', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UploadResponse', # 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_files_with_http_info(self, **kwargs): # noqa: E501
"""List available files for a project # noqa: E501
List available files for a specific project. Note that only users subscribed to the project can list its files. # 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_files_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project_id: **Required** ID assigned to the project once created in Atinary™ Nexus.
:param str group_type: String indicating how the file is classified. Available values are *parameters*, *properties* or *other*.
: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(ListFilesResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'project_id',
'group_type'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_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_files" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and ('project_id' in local_var_params and # noqa: E501
len(local_var_params['project_id']) > 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `list_files`, length must be less than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and ('project_id' in local_var_params and # noqa: E501
len(local_var_params['project_id']) < 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `list_files`, length must be greater than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and 'project_id' in local_var_params and not re.search(r'^prj_[0-9a-f]{32}$', local_var_params['project_id']): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `list_files`, must conform to the pattern `/^prj_[0-9a-f]{32}$/`") # noqa: E501
if self.api_client.client_side_validation and ('group_type' in local_var_params and # noqa: E501
len(local_var_params['group_type']) > 50): # noqa: E501
raise ApiValueError("Invalid value for parameter `group_type` when calling `list_files`, length must be less than or equal to `50`") # noqa: E501
if self.api_client.client_side_validation and 'group_type' in local_var_params and not re.search(r'(parameters|properties|other)', local_var_params['group_type']): # noqa: E501
raise ApiValueError("Invalid value for parameter `group_type` when calling `list_files`, must conform to the pattern `/(parameters|properties|other)/`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'project_id' in local_var_params:
header_params['project-id'] = local_var_params['project_id'] # noqa: E501
if 'group_type' in local_var_params:
header_params['group-type'] = local_var_params['group_type'] # noqa: E501
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 = ['api_key', 'tokens'] # noqa: E501
return self.api_client.call_api(
'/Files', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ListFilesResponse', # 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 delete_files_with_http_info(self, **kwargs): # noqa: E501
"""delete_files # noqa: E501
Delete several files in a project. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_files_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project_id: **Required** ID assigned to the project once created in Atinary™ Nexus.
:param list[str] file_ids: List of file identifiers to query
: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(GenericResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'project_id',
'file_ids'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_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 delete_files" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and ('project_id' in local_var_params and # noqa: E501
len(local_var_params['project_id']) > 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `delete_files`, length must be less than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and ('project_id' in local_var_params and # noqa: E501
len(local_var_params['project_id']) < 36): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `delete_files`, length must be greater than or equal to `36`") # noqa: E501
if self.api_client.client_side_validation and 'project_id' in local_var_params and not re.search(r'^prj_[0-9a-f]{32}$', local_var_params['project_id']): # noqa: E501
raise ApiValueError("Invalid value for parameter `project_id` when calling `delete_files`, must conform to the pattern `/^prj_[0-9a-f]{32}$/`") # noqa: E501
if self.api_client.client_side_validation and ('file_ids' in local_var_params and # noqa: E501
len(local_var_params['file_ids']) > 99): # noqa: E501
raise ApiValueError("Invalid value for parameter `file_ids` when calling `delete_files`, number of items must be less than or equal to `99`") # noqa: E501
if self.api_client.client_side_validation and ('file_ids' in local_var_params and # noqa: E501
len(local_var_params['file_ids']) < 1): # noqa: E501
raise ApiValueError("Invalid value for parameter `file_ids` when calling `delete_files`, number of items must be greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'project_id' in local_var_params:
header_params['project-id'] = local_var_params['project_id'] # noqa: E501
if 'file_ids' in local_var_params:
header_params['file-ids'] = local_var_params['file_ids'] # noqa: E501
collection_formats['file-ids'] = 'csv' # noqa: E501
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 = ['api_key', 'tokens'] # noqa: E501
return self.api_client.call_api(
'/Files', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='GenericResponse', # 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 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 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`.")