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 v1_editions_edition_id_rois_roi_id_put_with_http_info(
self, edition_id, roi_id, **kwargs): # noqa: E501
"""Update an existing sign ROI in the given edition of a scroll # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.v1_editions_edition_id_rois_roi_id_put_with_http_info(edition_id, roi_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int edition_id: Id of the edition (required)
:param int roi_id: Id of the ROI to be updated (required)
:param SetInterpretationRoiDTO set_interpretation_roi_dto: A JSON object with the updated ROI details
: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(UpdatedInterpretationRoiDTO, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['edition_id', 'roi_id', 'set_interpretation_roi_dto']
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 v1_editions_edition_id_rois_roi_id_put" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'edition_id' is set
if self.api_client.client_side_validation and (
'edition_id' not in local_var_params or # noqa: E501
local_var_params['edition_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `edition_id` when calling `v1_editions_edition_id_rois_roi_id_put`"
) # noqa: E501
# verify the required parameter 'roi_id' is set
if self.api_client.client_side_validation and (
'roi_id' not in local_var_params or # noqa: E501
local_var_params['roi_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `roi_id` when calling `v1_editions_edition_id_rois_roi_id_put`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'edition_id' in local_var_params:
path_params['editionId'] = local_var_params[
'edition_id'] # noqa: E501
if 'roi_id' in local_var_params:
path_params['roiId'] = local_var_params['roi_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'set_interpretation_roi_dto' in local_var_params:
body_params = local_var_params['set_interpretation_roi_dto']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'application/json', 'text/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'text/json',
'application/*+json']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v1/editions/{editionId}/rois/{roiId}',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UpdatedInterpretationRoiDTO', # 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 v1_editions_edition_id_rois_roi_id_delete_with_http_info(
self, edition_id, roi_id, **kwargs): # noqa: E501
"""Deletes a sign ROI from the given edition of a scroll # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.v1_editions_edition_id_rois_roi_id_delete_with_http_info(edition_id, roi_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int edition_id: Id of the edition (required)
:param int roi_id: Id of the ROI to be deleted (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: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['edition_id', 'roi_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 v1_editions_edition_id_rois_roi_id_delete" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'edition_id' is set
if self.api_client.client_side_validation and (
'edition_id' not in local_var_params or # noqa: E501
local_var_params['edition_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `edition_id` when calling `v1_editions_edition_id_rois_roi_id_delete`"
) # noqa: E501
# verify the required parameter 'roi_id' is set
if self.api_client.client_side_validation and (
'roi_id' not in local_var_params or # noqa: E501
local_var_params['roi_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `roi_id` when calling `v1_editions_edition_id_rois_roi_id_delete`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'edition_id' in local_var_params:
path_params['editionId'] = local_var_params[
'edition_id'] # noqa: E501
if 'roi_id' in local_var_params:
path_params['roiId'] = local_var_params['roi_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v1/editions/{editionId}/rois/{roiId}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # 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 v1_imaged_objects_institutions_institution_name_get_with_http_info(
self, institution_name, **kwargs): # noqa: E501
"""Provides a list of all institutional image providers. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.v1_imaged_objects_institutions_institution_name_get_with_http_info(institution_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str institution_name: (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(InstitutionalImageListDTO, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['institution_name']
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 v1_imaged_objects_institutions_institution_name_get"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'institution_name' is set
if self.api_client.client_side_validation and (
'institution_name' not in local_var_params or # noqa: E501
local_var_params['institution_name'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `institution_name` when calling `v1_imaged_objects_institutions_institution_name_get`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'institution_name' in local_var_params:
path_params['institutionName'] = local_var_params[
'institution_name'] # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v1/imaged-objects/institutions/{institutionName}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InstitutionalImageListDTO', # 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 v1_editions_edition_id_imaged_objects_get_with_http_info(
self, edition_id, **kwargs): # noqa: E501
"""Provides a listing of imaged objects related to the specified edition, can include images and also their masks with optional. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.v1_editions_edition_id_imaged_objects_get_with_http_info(edition_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int edition_id: Unique Id of the desired edition (required)
:param list[str] optional: Set 'artefacts' to receive related artefact data and 'masks' to include the artefact masks
: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(ImagedObjectListDTO, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['edition_id', 'optional']
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 v1_editions_edition_id_imaged_objects_get" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'edition_id' is set
if self.api_client.client_side_validation and (
'edition_id' not in local_var_params or # noqa: E501
local_var_params['edition_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `edition_id` when calling `v1_editions_edition_id_imaged_objects_get`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'edition_id' in local_var_params:
path_params['editionId'] = local_var_params[
'edition_id'] # noqa: E501
query_params = []
if 'optional' in local_var_params and local_var_params[
'optional'] is not None: # noqa: E501
query_params.append(
('optional', local_var_params['optional'])) # noqa: E501
collection_formats['optional'] = 'multi' # 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 = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v1/editions/{editionId}/imaged-objects',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ImagedObjectListDTO', # 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 v1_catalogue_confirm_match_iaa_edition_catalog_to_text_fragment_id_delete_with_http_info(
self, iaa_edition_catalog_to_text_fragment_id,
**kwargs): # noqa: E501
"""Remove an existing imaged object and text fragment match, which is not correct # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.v1_catalogue_confirm_match_iaa_edition_catalog_to_text_fragment_id_delete_with_http_info(iaa_edition_catalog_to_text_fragment_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int iaa_edition_catalog_to_text_fragment_id: The unique id of the match to confirm (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: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['iaa_edition_catalog_to_text_fragment_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 v1_catalogue_confirm_match_iaa_edition_catalog_to_text_fragment_id_delete"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'iaa_edition_catalog_to_text_fragment_id' is set
if self.api_client.client_side_validation and (
'iaa_edition_catalog_to_text_fragment_id'
not in local_var_params or # noqa: E501
local_var_params['iaa_edition_catalog_to_text_fragment_id'] is
None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `iaa_edition_catalog_to_text_fragment_id` when calling `v1_catalogue_confirm_match_iaa_edition_catalog_to_text_fragment_id_delete`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'iaa_edition_catalog_to_text_fragment_id' in local_var_params:
path_params[
'iaaEditionCatalogToTextFragmentId'] = local_var_params[
'iaa_edition_catalog_to_text_fragment_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/v1/catalogue/confirm-match/{iaaEditionCatalogToTextFragmentId}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # 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,
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`.")