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_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_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 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_users_put_with_http_info(self, **kwargs): # noqa: E501
"""Updates a user's registration details. Note that the if the email address has changed, the account will be set to inactive until the account is activated with the secret token. # 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_users_put_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param UserUpdateRequestDTO user_update_request_dto: A JSON object with all data necessary to update a user account. Null fields (but not empty strings!) will be populated with existing user data
: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(DetailedUserDTO, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['user_update_request_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_users_put" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'user_update_request_dto' in local_var_params:
body_params = local_var_params['user_update_request_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/users',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DetailedUserDTO', # 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_users_login_post_with_http_info(self, **kwargs): # noqa: E501
"""Provides a JWT bearer token for valid email and password # 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_users_login_post_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param LoginRequestDTO login_request_dto: JSON object with an email and password parameter
: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(DetailedUserTokenDTO, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['login_request_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_users_login_post" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'login_request_dto' in local_var_params:
body_params = local_var_params['login_request_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/users/login',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DetailedUserTokenDTO', # 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_users_change_forgotten_password_post_with_http_info(
self, **kwargs): # noqa: E501
"""Uses the secret token from /users/forgot-password to validate a reset of the user's password # 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_users_change_forgotten_password_post_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param ResetForgottenUserPasswordRequestDTO reset_forgotten_user_password_request_dto: A JSON object with the secret token and the new password
: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 = ['reset_forgotten_user_password_request_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_users_change_forgotten_password_post" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'reset_forgotten_user_password_request_dto' in local_var_params:
body_params = local_var_params[
'reset_forgotten_user_password_request_dto']
# 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/users/change-forgotten-password',
'POST',
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 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)
