diff options
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/api/editors_api.py')
| -rw-r--r-- | python_openapi_client/fatcat_openapi_client/api/editors_api.py | 750 |
1 files changed, 750 insertions, 0 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/api/editors_api.py b/python_openapi_client/fatcat_openapi_client/api/editors_api.py new file mode 100644 index 00000000..00c99c93 --- /dev/null +++ b/python_openapi_client/fatcat_openapi_client/api/editors_api.py @@ -0,0 +1,750 @@ +""" + fatcat + + Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata. # noqa: E501 + + The version of the OpenAPI document: 0.5.0 + Contact: webservices@archive.org + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fatcat_openapi_client.api_client import ApiClient, Endpoint as _Endpoint +from fatcat_openapi_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fatcat_openapi_client.model.editgroup import Editgroup +from fatcat_openapi_client.model.editgroup_annotation import EditgroupAnnotation +from fatcat_openapi_client.model.editor import Editor +from fatcat_openapi_client.model.error_response import ErrorResponse + + +class EditorsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_editor_endpoint = _Endpoint( + settings={ + 'response_type': (Editor,), + 'auth': [], + 'endpoint_path': '/editor/{editor_id}', + 'operation_id': 'get_editor', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'editor_id', + ], + 'required': [ + 'editor_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'editor_id': + (str,), + }, + 'attribute_map': { + 'editor_id': 'editor_id', + }, + 'location_map': { + 'editor_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_editor_annotations_endpoint = _Endpoint( + settings={ + 'response_type': ([EditgroupAnnotation],), + 'auth': [], + 'endpoint_path': '/editor/{editor_id}/annotations', + 'operation_id': 'get_editor_annotations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'editor_id', + 'limit', + 'before', + 'since', + ], + 'required': [ + 'editor_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'editor_id', + ] + }, + root_map={ + 'validations': { + ('editor_id',): { + 'max_length': 26, + 'min_length': 26, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'editor_id': + (str,), + 'limit': + (int,), + 'before': + (datetime,), + 'since': + (datetime,), + }, + 'attribute_map': { + 'editor_id': 'editor_id', + 'limit': 'limit', + 'before': 'before', + 'since': 'since', + }, + 'location_map': { + 'editor_id': 'path', + 'limit': 'query', + 'before': 'query', + 'since': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_editor_editgroups_endpoint = _Endpoint( + settings={ + 'response_type': ([Editgroup],), + 'auth': [], + 'endpoint_path': '/editor/{editor_id}/editgroups', + 'operation_id': 'get_editor_editgroups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'editor_id', + 'limit', + 'before', + 'since', + ], + 'required': [ + 'editor_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'editor_id': + (str,), + 'limit': + (int,), + 'before': + (datetime,), + 'since': + (datetime,), + }, + 'attribute_map': { + 'editor_id': 'editor_id', + 'limit': 'limit', + 'before': 'before', + 'since': 'since', + }, + 'location_map': { + 'editor_id': 'path', + 'limit': 'query', + 'before': 'query', + 'since': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.lookup_editor_endpoint = _Endpoint( + settings={ + 'response_type': (Editor,), + 'auth': [], + 'endpoint_path': '/editor/lookup', + 'operation_id': 'lookup_editor', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'username', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'username': + (str,), + }, + 'attribute_map': { + 'username': 'username', + }, + 'location_map': { + 'username': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.update_editor_endpoint = _Endpoint( + settings={ + 'response_type': (Editor,), + 'auth': [ + 'Bearer' + ], + 'endpoint_path': '/editor/{editor_id}', + 'operation_id': 'update_editor', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'editor_id', + 'editor', + ], + 'required': [ + 'editor_id', + 'editor', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'editor_id': + (str,), + 'editor': + (Editor,), + }, + 'attribute_map': { + 'editor_id': 'editor_id', + }, + 'location_map': { + 'editor_id': 'path', + 'editor': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def get_editor( + self, + editor_id, + **kwargs + ): + """get_editor # noqa: E501 + + Returns an editor object, including metadata such as the username, type, and role of editor. # 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_editor(editor_id, async_req=True) + >>> result = thread.get() + + Args: + editor_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): 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. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + Editor + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['editor_id'] = \ + editor_id + return self.get_editor_endpoint.call_with_http_info(**kwargs) + + def get_editor_annotations( + self, + editor_id, + **kwargs + ): + """get_editor_annotations # noqa: E501 + + Fetches a list of annotations made by a particular editor. # 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_editor_annotations(editor_id, async_req=True) + >>> result = thread.get() + + Args: + editor_id (str): base32-encoded unique identifier + + Keyword Args: + limit (int): Maximum number (count) of annotations to return in response. [optional] + before (datetime): Return only annotations made *before* the given timestamp (not inclusive). Annotations will be sorted by creation time in descending order (most recent first). For use in pagination. . [optional] + since (datetime): Return only annotations made *after* the given timestamp (not inclusive). Annotations will be sorted by creation time in ascending order (most recent last). For use in pagination. . [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): 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. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [EditgroupAnnotation] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['editor_id'] = \ + editor_id + return self.get_editor_annotations_endpoint.call_with_http_info(**kwargs) + + def get_editor_editgroups( + self, + editor_id, + **kwargs + ): + """get_editor_editgroups # noqa: E501 + + Returns a set of editgroups created by the given editor, regardless of the status (accepted/submitted) of the editgroups. # 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_editor_editgroups(editor_id, async_req=True) + >>> result = thread.get() + + Args: + editor_id (str): + + Keyword Args: + limit (int): [optional] + before (datetime): Return only editgroups created *before* the given timestamp (not inclusive). Editgroups will be sorted by creation time in descending order (most recent first). For use in pagination. . [optional] + since (datetime): Return only editgroups created *after* the given timestamp (not inclusive). Editgroups will be sorted by creation time in ascending order (most recent last). For use in pagination. . [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): 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. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [Editgroup] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['editor_id'] = \ + editor_id + return self.get_editor_editgroups_endpoint.call_with_http_info(**kwargs) + + def lookup_editor( + self, + **kwargs + ): + """lookup_editor # noqa: E501 + + Fetches editor by, eg, username. One (and only one) lookup identifier should be specified per request. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.lookup_editor(async_req=True) + >>> result = thread.get() + + + Keyword Args: + username (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): 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. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + Editor + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.lookup_editor_endpoint.call_with_http_info(**kwargs) + + def update_editor( + self, + editor_id, + editor, + **kwargs + ): + """update_editor # noqa: E501 + + Allows metadata changes to some editor fields, such as the username. Changes require authentication and permissions. An editor can change their own username; changes to role flags require the `admin` role by the editor making the request. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_editor(editor_id, editor, async_req=True) + >>> result = thread.get() + + Args: + editor_id (str): + editor (Editor): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): 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. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + Editor + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['editor_id'] = \ + editor_id + kwargs['editor'] = \ + editor + return self.update_editor_endpoint.call_with_http_info(**kwargs) + |