diff options
| -rw-r--r-- | python_client/README.md | 8 | ||||
| -rw-r--r-- | python_client/fatcat_client/__init__.py | 1 | ||||
| -rw-r--r-- | python_client/fatcat_client/api/default_api.py | 603 | ||||
| -rw-r--r-- | python_client/fatcat_client/models/__init__.py | 1 | ||||
| -rw-r--r-- | python_client/fatcat_client/models/editgroup.py | 82 | ||||
| -rw-r--r-- | python_client/fatcat_client/models/editgroup_annotation.py | 294 | ||||
| -rw-r--r-- | python_client/tests/codegen/test_default_api.py | 34 | ||||
| -rw-r--r-- | python_client/tests/codegen/test_editgroup_annotation.py | 40 |
8 files changed, 1044 insertions, 19 deletions
diff --git a/python_client/README.md b/python_client/README.md index 8704641e..2f3c5843 100644 --- a/python_client/README.md +++ b/python_client/README.md @@ -81,6 +81,7 @@ Class | Method | HTTP request | Description *DefaultApi* | [**create_creator**](docs/DefaultApi.md#create_creator) | **POST** /creator | *DefaultApi* | [**create_creator_batch**](docs/DefaultApi.md#create_creator_batch) | **POST** /creator/batch | *DefaultApi* | [**create_editgroup**](docs/DefaultApi.md#create_editgroup) | **POST** /editgroup | +*DefaultApi* | [**create_editgroup_annotation**](docs/DefaultApi.md#create_editgroup_annotation) | **POST** /editgroup/{editgroup_id}/annotation | *DefaultApi* | [**create_file**](docs/DefaultApi.md#create_file) | **POST** /file | *DefaultApi* | [**create_file_batch**](docs/DefaultApi.md#create_file_batch) | **POST** /file/batch | *DefaultApi* | [**create_fileset**](docs/DefaultApi.md#create_fileset) | **POST** /fileset | @@ -119,8 +120,11 @@ Class | Method | HTTP request | Description *DefaultApi* | [**get_creator_releases**](docs/DefaultApi.md#get_creator_releases) | **GET** /creator/{ident}/releases | *DefaultApi* | [**get_creator_revision**](docs/DefaultApi.md#get_creator_revision) | **GET** /creator/rev/{rev_id} | *DefaultApi* | [**get_editgroup**](docs/DefaultApi.md#get_editgroup) | **GET** /editgroup/{editgroup_id} | +*DefaultApi* | [**get_editgroup_annotations**](docs/DefaultApi.md#get_editgroup_annotations) | **GET** /editgroup/{editgroup_id}/annotations | +*DefaultApi* | [**get_editgroups_reviewable**](docs/DefaultApi.md#get_editgroups_reviewable) | **GET** /editgroup/reviewable | *DefaultApi* | [**get_editor**](docs/DefaultApi.md#get_editor) | **GET** /editor/{editor_id} | -*DefaultApi* | [**get_editor_changelog**](docs/DefaultApi.md#get_editor_changelog) | **GET** /editor/{editor_id}/changelog | +*DefaultApi* | [**get_editor_annotations**](docs/DefaultApi.md#get_editor_annotations) | **GET** /editor/{editor_id}/annotations | +*DefaultApi* | [**get_editor_editgroups**](docs/DefaultApi.md#get_editor_editgroups) | **GET** /editor/{editor_id}/editgroups | *DefaultApi* | [**get_file**](docs/DefaultApi.md#get_file) | **GET** /file/{ident} | *DefaultApi* | [**get_file_edit**](docs/DefaultApi.md#get_file_edit) | **GET** /file/edit/{edit_id} | *DefaultApi* | [**get_file_history**](docs/DefaultApi.md#get_file_history) | **GET** /file/{ident}/history | @@ -156,6 +160,7 @@ Class | Method | HTTP request | Description *DefaultApi* | [**lookup_release**](docs/DefaultApi.md#lookup_release) | **GET** /release/lookup | *DefaultApi* | [**update_container**](docs/DefaultApi.md#update_container) | **PUT** /container/{ident} | *DefaultApi* | [**update_creator**](docs/DefaultApi.md#update_creator) | **PUT** /creator/{ident} | +*DefaultApi* | [**update_editgroup**](docs/DefaultApi.md#update_editgroup) | **PUT** /editgroup/{editgroup_id} | *DefaultApi* | [**update_editor**](docs/DefaultApi.md#update_editor) | **PUT** /editor/{editor_id} | *DefaultApi* | [**update_file**](docs/DefaultApi.md#update_file) | **PUT** /file/{ident} | *DefaultApi* | [**update_fileset**](docs/DefaultApi.md#update_fileset) | **PUT** /fileset/{ident} | @@ -172,6 +177,7 @@ Class | Method | HTTP request | Description - [ContainerEntity](docs/ContainerEntity.md) - [CreatorEntity](docs/CreatorEntity.md) - [Editgroup](docs/Editgroup.md) + - [EditgroupAnnotation](docs/EditgroupAnnotation.md) - [EditgroupEdits](docs/EditgroupEdits.md) - [Editor](docs/Editor.md) - [EntityEdit](docs/EntityEdit.md) diff --git a/python_client/fatcat_client/__init__.py b/python_client/fatcat_client/__init__.py index e9a04942..621ca67c 100644 --- a/python_client/fatcat_client/__init__.py +++ b/python_client/fatcat_client/__init__.py @@ -28,6 +28,7 @@ from fatcat_client.models.changelog_entry import ChangelogEntry from fatcat_client.models.container_entity import ContainerEntity from fatcat_client.models.creator_entity import CreatorEntity from fatcat_client.models.editgroup import Editgroup +from fatcat_client.models.editgroup_annotation import EditgroupAnnotation from fatcat_client.models.editgroup_edits import EditgroupEdits from fatcat_client.models.editor import Editor from fatcat_client.models.entity_edit import EntityEdit diff --git a/python_client/fatcat_client/api/default_api.py b/python_client/fatcat_client/api/default_api.py index 1dc79032..c5b99d8a 100644 --- a/python_client/fatcat_client/api/default_api.py +++ b/python_client/fatcat_client/api/default_api.py @@ -845,6 +845,119 @@ class DefaultApi(object): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def create_editgroup_annotation(self, editgroup_id, annotation, **kwargs): # noqa: E501 + """create_editgroup_annotation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.create_editgroup_annotation(editgroup_id, annotation, async=True) + >>> result = thread.get() + + :param async bool + :param str editgroup_id: base32-encoded unique identifier (required) + :param EditgroupAnnotation annotation: (required) + :return: EditgroupAnnotation + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async'): + return self.create_editgroup_annotation_with_http_info(editgroup_id, annotation, **kwargs) # noqa: E501 + else: + (data) = self.create_editgroup_annotation_with_http_info(editgroup_id, annotation, **kwargs) # noqa: E501 + return data + + def create_editgroup_annotation_with_http_info(self, editgroup_id, annotation, **kwargs): # noqa: E501 + """create_editgroup_annotation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.create_editgroup_annotation_with_http_info(editgroup_id, annotation, async=True) + >>> result = thread.get() + + :param async bool + :param str editgroup_id: base32-encoded unique identifier (required) + :param EditgroupAnnotation annotation: (required) + :return: EditgroupAnnotation + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['editgroup_id', 'annotation'] # noqa: E501 + all_params.append('async') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_editgroup_annotation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'editgroup_id' is set + if ('editgroup_id' not in params or + params['editgroup_id'] is None): + raise ValueError("Missing the required parameter `editgroup_id` when calling `create_editgroup_annotation`") # noqa: E501 + # verify the required parameter 'annotation' is set + if ('annotation' not in params or + params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `create_editgroup_annotation`") # noqa: E501 + + if ('editgroup_id' in params and + len(params['editgroup_id']) > 26): + raise ValueError("Invalid value for parameter `editgroup_id` when calling `create_editgroup_annotation`, length must be less than or equal to `26`") # noqa: E501 + if ('editgroup_id' in params and + len(params['editgroup_id']) < 26): + raise ValueError("Invalid value for parameter `editgroup_id` when calling `create_editgroup_annotation`, length must be greater than or equal to `26`") # noqa: E501 + if 'editgroup_id' in params and not re.search('[a-zA-Z2-7]{26}', params['editgroup_id']): # noqa: E501 + raise ValueError("Invalid value for parameter `editgroup_id` when calling `create_editgroup_annotation`, must conform to the pattern `/[a-zA-Z2-7]{26}/`") # noqa: E501 + collection_formats = {} + + path_params = {} + if 'editgroup_id' in params: + path_params['editgroup_id'] = params['editgroup_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'annotation' in params: + body_params = params['annotation'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/editgroup/{editgroup_id}/annotation', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='EditgroupAnnotation', # noqa: E501 + auth_settings=auth_settings, + async=params.get('async'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def create_file(self, entity, editgroup_id, **kwargs): # noqa: E501 """create_file # noqa: E501 @@ -4803,6 +4916,220 @@ class DefaultApi(object): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_editgroup_annotations(self, editgroup_id, **kwargs): # noqa: E501 + """get_editgroup_annotations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.get_editgroup_annotations(editgroup_id, async=True) + >>> result = thread.get() + + :param async bool + :param str editgroup_id: base32-encoded unique identifier (required) + :param str expand: List of sub-entities to expand in response. For editgroups: 'editors' + :return: list[EditgroupAnnotation] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async'): + return self.get_editgroup_annotations_with_http_info(editgroup_id, **kwargs) # noqa: E501 + else: + (data) = self.get_editgroup_annotations_with_http_info(editgroup_id, **kwargs) # noqa: E501 + return data + + def get_editgroup_annotations_with_http_info(self, editgroup_id, **kwargs): # noqa: E501 + """get_editgroup_annotations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.get_editgroup_annotations_with_http_info(editgroup_id, async=True) + >>> result = thread.get() + + :param async bool + :param str editgroup_id: base32-encoded unique identifier (required) + :param str expand: List of sub-entities to expand in response. For editgroups: 'editors' + :return: list[EditgroupAnnotation] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['editgroup_id', 'expand'] # noqa: E501 + all_params.append('async') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_editgroup_annotations" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'editgroup_id' is set + if ('editgroup_id' not in params or + params['editgroup_id'] is None): + raise ValueError("Missing the required parameter `editgroup_id` when calling `get_editgroup_annotations`") # noqa: E501 + + if ('editgroup_id' in params and + len(params['editgroup_id']) > 26): + raise ValueError("Invalid value for parameter `editgroup_id` when calling `get_editgroup_annotations`, length must be less than or equal to `26`") # noqa: E501 + if ('editgroup_id' in params and + len(params['editgroup_id']) < 26): + raise ValueError("Invalid value for parameter `editgroup_id` when calling `get_editgroup_annotations`, length must be greater than or equal to `26`") # noqa: E501 + if 'editgroup_id' in params and not re.search('[a-zA-Z2-7]{26}', params['editgroup_id']): # noqa: E501 + raise ValueError("Invalid value for parameter `editgroup_id` when calling `get_editgroup_annotations`, must conform to the pattern `/[a-zA-Z2-7]{26}/`") # noqa: E501 + collection_formats = {} + + path_params = {} + if 'editgroup_id' in params: + path_params['editgroup_id'] = params['editgroup_id'] # noqa: E501 + + query_params = [] + if 'expand' in params: + query_params.append(('expand', params['expand'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/editgroup/{editgroup_id}/annotations', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[EditgroupAnnotation]', # noqa: E501 + auth_settings=auth_settings, + async=params.get('async'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_editgroups_reviewable(self, **kwargs): # noqa: E501 + """get_editgroups_reviewable # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.get_editgroups_reviewable(async=True) + >>> result = thread.get() + + :param async bool + :param str expand: List of sub-entities to expand in response. For editgroups: 'editors' + :param int limit: + :param datetime before: + :param datetime since: + :return: list[Editgroup] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async'): + return self.get_editgroups_reviewable_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_editgroups_reviewable_with_http_info(**kwargs) # noqa: E501 + return data + + def get_editgroups_reviewable_with_http_info(self, **kwargs): # noqa: E501 + """get_editgroups_reviewable # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.get_editgroups_reviewable_with_http_info(async=True) + >>> result = thread.get() + + :param async bool + :param str expand: List of sub-entities to expand in response. For editgroups: 'editors' + :param int limit: + :param datetime before: + :param datetime since: + :return: list[Editgroup] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['expand', 'limit', 'before', 'since'] # noqa: E501 + all_params.append('async') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_editgroups_reviewable" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'expand' in params: + query_params.append(('expand', params['expand'])) # noqa: E501 + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'before' in params: + query_params.append(('before', params['before'])) # noqa: E501 + if 'since' in params: + query_params.append(('since', params['since'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/editgroup/reviewable', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[Editgroup]', # noqa: E501 + auth_settings=auth_settings, + async=params.get('async'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_editor(self, editor_id, **kwargs): # noqa: E501 """get_editor # noqa: E501 @@ -4900,43 +5227,166 @@ class DefaultApi(object): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_editor_changelog(self, editor_id, **kwargs): # noqa: E501 - """get_editor_changelog # noqa: E501 + def get_editor_annotations(self, editor_id, **kwargs): # noqa: E501 + """get_editor_annotations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.get_editor_annotations(editor_id, async=True) + >>> result = thread.get() + + :param async bool + :param str editor_id: base32-encoded unique identifier (required) + :param int limit: + :param datetime before: + :param datetime since: + :return: list[EditgroupAnnotation] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async'): + return self.get_editor_annotations_with_http_info(editor_id, **kwargs) # noqa: E501 + else: + (data) = self.get_editor_annotations_with_http_info(editor_id, **kwargs) # noqa: E501 + return data + + def get_editor_annotations_with_http_info(self, editor_id, **kwargs): # noqa: E501 + """get_editor_annotations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.get_editor_annotations_with_http_info(editor_id, async=True) + >>> result = thread.get() + + :param async bool + :param str editor_id: base32-encoded unique identifier (required) + :param int limit: + :param datetime before: + :param datetime since: + :return: list[EditgroupAnnotation] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['editor_id', 'limit', 'before', 'since'] # noqa: E501 + all_params.append('async') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_editor_annotations" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'editor_id' is set + if ('editor_id' not in params or + params['editor_id'] is None): + raise ValueError("Missing the required parameter `editor_id` when calling `get_editor_annotations`") # noqa: E501 + + if ('editor_id' in params and + len(params['editor_id']) > 26): + raise ValueError("Invalid value for parameter `editor_id` when calling `get_editor_annotations`, length must be less than or equal to `26`") # noqa: E501 + if ('editor_id' in params and + len(params['editor_id']) < 26): + raise ValueError("Invalid value for parameter `editor_id` when calling `get_editor_annotations`, length must be greater than or equal to `26`") # noqa: E501 + if 'editor_id' in params and not re.search('[a-zA-Z2-7]{26}', params['editor_id']): # noqa: E501 + raise ValueError("Invalid value for parameter `editor_id` when calling `get_editor_annotations`, must conform to the pattern `/[a-zA-Z2-7]{26}/`") # noqa: E501 + collection_formats = {} + + path_params = {} + if 'editor_id' in params: + path_params['editor_id'] = params['editor_id'] # noqa: E501 + + query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'before' in params: + query_params.append(('before', params['before'])) # noqa: E501 + if 'since' in params: + query_params.append(('since', params['since'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = [] # noqa: E501 + + return self.api_client.call_api( + '/editor/{editor_id}/annotations', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[EditgroupAnnotation]', # noqa: E501 + auth_settings=auth_settings, + async=params.get('async'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_editor_editgroups(self, editor_id, **kwargs): # noqa: E501 + """get_editor_editgroups # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True - >>> thread = api.get_editor_changelog(editor_id, async=True) + >>> thread = api.get_editor_editgroups(editor_id, async=True) >>> result = thread.get() :param async bool :param str editor_id: (required) - :return: list[ChangelogEntry] + :param int limit: + :param datetime before: + :param datetime since: + :return: list[Editgroup] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async'): - return self.get_editor_changelog_with_http_info(editor_id, **kwargs) # noqa: E501 + return self.get_editor_editgroups_with_http_info(editor_id, **kwargs) # noqa: E501 else: - (data) = self.get_editor_changelog_with_http_info(editor_id, **kwargs) # noqa: E501 + (data) = self.get_editor_editgroups_with_http_info(editor_id, **kwargs) # noqa: E501 return data - def get_editor_changelog_with_http_info(self, editor_id, **kwargs): # noqa: E501 - """get_editor_changelog # noqa: E501 + def get_editor_editgroups_with_http_info(self, editor_id, **kwargs): # noqa: E501 + """get_editor_editgroups # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True - >>> thread = api.get_editor_changelog_with_http_info(editor_id, async=True) + >>> thread = api.get_editor_editgroups_with_http_info(editor_id, async=True) >>> result = thread.get() :param async bool :param str editor_id: (required) - :return: list[ChangelogEntry] + :param int limit: + :param datetime before: + :param datetime since: + :return: list[Editgroup] If the method is called asynchronously, returns the request thread. """ - all_params = ['editor_id'] # noqa: E501 + all_params = ['editor_id', 'limit', 'before', 'since'] # noqa: E501 all_params.append('async') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4947,14 +5397,14 @@ class DefaultApi(object): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_editor_changelog" % key + " to method get_editor_editgroups" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'editor_id' is set if ('editor_id' not in params or params['editor_id'] is None): - raise ValueError("Missing the required parameter `editor_id` when calling `get_editor_changelog`") # noqa: E501 + raise ValueError("Missing the required parameter `editor_id` when calling `get_editor_editgroups`") # noqa: E501 collection_formats = {} @@ -4963,6 +5413,12 @@ class DefaultApi(object): path_params['editor_id'] = params['editor_id'] # noqa: E501 query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'before' in params: + query_params.append(('before', params['before'])) # noqa: E501 + if 'since' in params: + query_params.append(('since', params['since'])) # noqa: E501 header_params = {} @@ -4982,14 +5438,14 @@ class DefaultApi(object): auth_settings = [] # noqa: E501 return self.api_client.call_api( - '/editor/{editor_id}/changelog', 'GET', + '/editor/{editor_id}/editgroups', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[ChangelogEntry]', # noqa: E501 + response_type='list[Editgroup]', # noqa: E501 auth_settings=auth_settings, async=params.get('async'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8712,6 +9168,123 @@ class DefaultApi(object): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def update_editgroup(self, editgroup_id, editgroup, **kwargs): # noqa: E501 + """update_editgroup # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.update_editgroup(editgroup_id, editgroup, async=True) + >>> result = thread.get() + + :param async bool + :param str editgroup_id: base32-encoded unique identifier (required) + :param Editgroup editgroup: (required) + :param bool submit: + :return: Editgroup + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async'): + return self.update_editgroup_with_http_info(editgroup_id, editgroup, **kwargs) # noqa: E501 + else: + (data) = self.update_editgroup_with_http_info(editgroup_id, editgroup, **kwargs) # noqa: E501 + return data + + def update_editgroup_with_http_info(self, editgroup_id, editgroup, **kwargs): # noqa: E501 + """update_editgroup # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async=True + >>> thread = api.update_editgroup_with_http_info(editgroup_id, editgroup, async=True) + >>> result = thread.get() + + :param async bool + :param str editgroup_id: base32-encoded unique identifier (required) + :param Editgroup editgroup: (required) + :param bool submit: + :return: Editgroup + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['editgroup_id', 'editgroup', 'submit'] # noqa: E501 + all_params.append('async') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_editgroup" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'editgroup_id' is set + if ('editgroup_id' not in params or + params['editgroup_id'] is None): + raise ValueError("Missing the required parameter `editgroup_id` when calling `update_editgroup`") # noqa: E501 + # verify the required parameter 'editgroup' is set + if ('editgroup' not in params or + params['editgroup'] is None): + raise ValueError("Missing the required parameter `editgroup` when calling `update_editgroup`") # noqa: E501 + + if ('editgroup_id' in params and + len(params['editgroup_id']) > 26): + raise ValueError("Invalid value for parameter `editgroup_id` when calling `update_editgroup`, length must be less than or equal to `26`") # noqa: E501 + if ('editgroup_id' in params and + len(params['editgroup_id']) < 26): + raise ValueError("Invalid value for parameter `editgroup_id` when calling `update_editgroup`, length must be greater than or equal to `26`") # noqa: E501 + if 'editgroup_id' in params and not re.search('[a-zA-Z2-7]{26}', params['editgroup_id']): # noqa: E501 + raise ValueError("Invalid value for parameter `editgroup_id` when calling `update_editgroup`, must conform to the pattern `/[a-zA-Z2-7]{26}/`") # noqa: E501 + collection_formats = {} + + path_params = {} + if 'editgroup_id' in params: + path_params['editgroup_id'] = params['editgroup_id'] # noqa: E501 + + query_params = [] + if 'submit' in params: + query_params.append(('submit', params['submit'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'editgroup' in params: + body_params = params['editgroup'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/editgroup/{editgroup_id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Editgroup', # noqa: E501 + auth_settings=auth_settings, + async=params.get('async'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def update_editor(self, editor_id, editor, **kwargs): # noqa: E501 """update_editor # noqa: E501 diff --git a/python_client/fatcat_client/models/__init__.py b/python_client/fatcat_client/models/__init__.py index ef77b4fd..0d21ed7e 100644 --- a/python_client/fatcat_client/models/__init__.py +++ b/python_client/fatcat_client/models/__init__.py @@ -21,6 +21,7 @@ from fatcat_client.models.changelog_entry import ChangelogEntry from fatcat_client.models.container_entity import ContainerEntity from fatcat_client.models.creator_entity import CreatorEntity from fatcat_client.models.editgroup import Editgroup +from fatcat_client.models.editgroup_annotation import EditgroupAnnotation from fatcat_client.models.editgroup_edits import EditgroupEdits from fatcat_client.models.editor import Editor from fatcat_client.models.entity_edit import EntityEdit diff --git a/python_client/fatcat_client/models/editgroup.py b/python_client/fatcat_client/models/editgroup.py index 4c877685..8339f2e3 100644 --- a/python_client/fatcat_client/models/editgroup.py +++ b/python_client/fatcat_client/models/editgroup.py @@ -16,7 +16,9 @@ import re # noqa: F401 import six +from fatcat_client.models.editgroup_annotation import EditgroupAnnotation # noqa: F401,E501 from fatcat_client.models.editgroup_edits import EditgroupEdits # noqa: F401,E501 +from fatcat_client.models.editor import Editor # noqa: F401,E501 class Editgroup(object): @@ -35,26 +37,35 @@ class Editgroup(object): swagger_types = { 'editgroup_id': 'str', 'editor_id': 'str', + 'editor': 'Editor', + 'submitted': 'datetime', 'description': 'str', 'extra': 'object', + 'annotations': 'list[EditgroupAnnotation]', 'edits': 'EditgroupEdits' } attribute_map = { 'editgroup_id': 'editgroup_id', 'editor_id': 'editor_id', + 'editor': 'editor', + 'submitted': 'submitted', 'description': 'description', 'extra': 'extra', + 'annotations': 'annotations', 'edits': 'edits' } - def __init__(self, editgroup_id=None, editor_id=None, description=None, extra=None, edits=None): # noqa: E501 + def __init__(self, editgroup_id=None, editor_id=None, editor=None, submitted=None, description=None, extra=None, annotations=None, edits=None): # noqa: E501 """Editgroup - a model defined in Swagger""" # noqa: E501 self._editgroup_id = None self._editor_id = None + self._editor = None + self._submitted = None self._description = None self._extra = None + self._annotations = None self._edits = None self.discriminator = None @@ -62,10 +73,16 @@ class Editgroup(object): self.editgroup_id = editgroup_id if editor_id is not None: self.editor_id = editor_id + if editor is not None: + self.editor = editor + if submitted is not None: + self.submitted = submitted if description is not None: self.description = description if extra is not None: self.extra = extra + if annotations is not None: + self.annotations = annotations if edits is not None: self.edits = edits @@ -128,6 +145,48 @@ class Editgroup(object): self._editor_id = editor_id @property + def editor(self): + """Gets the editor of this Editgroup. # noqa: E501 + + + :return: The editor of this Editgroup. # noqa: E501 + :rtype: Editor + """ + return self._editor + + @editor.setter + def editor(self, editor): + """Sets the editor of this Editgroup. + + + :param editor: The editor of this Editgroup. # noqa: E501 + :type: Editor + """ + + self._editor = editor + + @property + def submitted(self): + """Gets the submitted of this Editgroup. # noqa: E501 + + + :return: The submitted of this Editgroup. # noqa: E501 + :rtype: datetime + """ + return self._submitted + + @submitted.setter + def submitted(self, submitted): + """Sets the submitted of this Editgroup. + + + :param submitted: The submitted of this Editgroup. # noqa: E501 + :type: datetime + """ + + self._submitted = submitted + + @property def description(self): """Gets the description of this Editgroup. # noqa: E501 @@ -170,6 +229,27 @@ class Editgroup(object): self._extra = extra @property + def annotations(self): + """Gets the annotations of this Editgroup. # noqa: E501 + + + :return: The annotations of this Editgroup. # noqa: E501 + :rtype: list[EditgroupAnnotation] + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """Sets the annotations of this Editgroup. + + + :param annotations: The annotations of this Editgroup. # noqa: E501 + :type: list[EditgroupAnnotation] + """ + + self._annotations = annotations + + @property def edits(self): """Gets the edits of this Editgroup. # noqa: E501 diff --git a/python_client/fatcat_client/models/editgroup_annotation.py b/python_client/fatcat_client/models/editgroup_annotation.py new file mode 100644 index 00000000..73e12e91 --- /dev/null +++ b/python_client/fatcat_client/models/editgroup_annotation.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + fatcat + + A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata # noqa: E501 + + OpenAPI spec version: 0.1.0 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + +from fatcat_client.models.editor import Editor # noqa: F401,E501 + + +class EditgroupAnnotation(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'annotation_id': 'str', + 'editgroup_id': 'str', + 'editor_id': 'str', + 'editor': 'Editor', + 'created': 'datetime', + 'comment_markdown': 'str', + 'extra': 'object' + } + + attribute_map = { + 'annotation_id': 'annotation_id', + 'editgroup_id': 'editgroup_id', + 'editor_id': 'editor_id', + 'editor': 'editor', + 'created': 'created', + 'comment_markdown': 'comment_markdown', + 'extra': 'extra' + } + + def __init__(self, annotation_id=None, editgroup_id=None, editor_id=None, editor=None, created=None, comment_markdown=None, extra=None): # noqa: E501 + """EditgroupAnnotation - a model defined in Swagger""" # noqa: E501 + + self._annotation_id = None + self._editgroup_id = None + self._editor_id = None + self._editor = None + self._created = None + self._comment_markdown = None + self._extra = None + self.discriminator = None + + if annotation_id is not None: + self.annotation_id = annotation_id + if editgroup_id is not None: + self.editgroup_id = editgroup_id + if editor_id is not None: + self.editor_id = editor_id + if editor is not None: + self.editor = editor + if created is not None: + self.created = created + if comment_markdown is not None: + self.comment_markdown = comment_markdown + if extra is not None: + self.extra = extra + + @property + def annotation_id(self): + """Gets the annotation_id of this EditgroupAnnotation. # noqa: E501 + + UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501 + + :return: The annotation_id of this EditgroupAnnotation. # noqa: E501 + :rtype: str + """ + return self._annotation_id + + @annotation_id.setter + def annotation_id(self, annotation_id): + """Sets the annotation_id of this EditgroupAnnotation. + + UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501 + + :param annotation_id: The annotation_id of this EditgroupAnnotation. # noqa: E501 + :type: str + """ + if annotation_id is not None and len(annotation_id) > 36: + raise ValueError("Invalid value for `annotation_id`, length must be less than or equal to `36`") # noqa: E501 + if annotation_id is not None and len(annotation_id) < 36: + raise ValueError("Invalid value for `annotation_id`, length must be greater than or equal to `36`") # noqa: E501 + if annotation_id is not None and not re.search('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', annotation_id): # noqa: E501 + raise ValueError("Invalid value for `annotation_id`, must be a follow pattern or equal to `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`") # noqa: E501 + + self._annotation_id = annotation_id + + @property + def editgroup_id(self): + """Gets the editgroup_id of this EditgroupAnnotation. # noqa: E501 + + base32-encoded unique identifier # noqa: E501 + + :return: The editgroup_id of this EditgroupAnnotation. # noqa: E501 + :rtype: str + """ + return self._editgroup_id + + @editgroup_id.setter + def editgroup_id(self, editgroup_id): + """Sets the editgroup_id of this EditgroupAnnotation. + + base32-encoded unique identifier # noqa: E501 + + :param editgroup_id: The editgroup_id of this EditgroupAnnotation. # noqa: E501 + :type: str + """ + if editgroup_id is not None and len(editgroup_id) > 26: + raise ValueError("Invalid value for `editgroup_id`, length must be less than or equal to `26`") # noqa: E501 + if editgroup_id is not None and len(editgroup_id) < 26: + raise ValueError("Invalid value for `editgroup_id`, length must be greater than or equal to `26`") # noqa: E501 + if editgroup_id is not None and not re.search('[a-zA-Z2-7]{26}', editgroup_id): # noqa: E501 + raise ValueError("Invalid value for `editgroup_id`, must be a follow pattern or equal to `/[a-zA-Z2-7]{26}/`") # noqa: E501 + + self._editgroup_id = editgroup_id + + @property + def editor_id(self): + """Gets the editor_id of this EditgroupAnnotation. # noqa: E501 + + base32-encoded unique identifier # noqa: E501 + + :return: The editor_id of this EditgroupAnnotation. # noqa: E501 + :rtype: str + """ + return self._editor_id + + @editor_id.setter + def editor_id(self, editor_id): + """Sets the editor_id of this EditgroupAnnotation. + + base32-encoded unique identifier # noqa: E501 + + :param editor_id: The editor_id of this EditgroupAnnotation. # noqa: E501 + :type: str + """ + if editor_id is not None and len(editor_id) > 26: + raise ValueError("Invalid value for `editor_id`, length must be less than or equal to `26`") # noqa: E501 + if editor_id is not None and len(editor_id) < 26: + raise ValueError("Invalid value for `editor_id`, length must be greater than or equal to `26`") # noqa: E501 + if editor_id is not None and not re.search('[a-zA-Z2-7]{26}', editor_id): # noqa: E501 + raise ValueError("Invalid value for `editor_id`, must be a follow pattern or equal to `/[a-zA-Z2-7]{26}/`") # noqa: E501 + + self._editor_id = editor_id + + @property + def editor(self): + """Gets the editor of this EditgroupAnnotation. # noqa: E501 + + + :return: The editor of this EditgroupAnnotation. # noqa: E501 + :rtype: Editor + """ + return self._editor + + @editor.setter + def editor(self, editor): + """Sets the editor of this EditgroupAnnotation. + + + :param editor: The editor of this EditgroupAnnotation. # noqa: E501 + :type: Editor + """ + + self._editor = editor + + @property + def created(self): + """Gets the created of this EditgroupAnnotation. # noqa: E501 + + + :return: The created of this EditgroupAnnotation. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this EditgroupAnnotation. + + + :param created: The created of this EditgroupAnnotation. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def comment_markdown(self): + """Gets the comment_markdown of this EditgroupAnnotation. # noqa: E501 + + + :return: The comment_markdown of this EditgroupAnnotation. # noqa: E501 + :rtype: str + """ + return self._comment_markdown + + @comment_markdown.setter + def comment_markdown(self, comment_markdown): + """Sets the comment_markdown of this EditgroupAnnotation. + + + :param comment_markdown: The comment_markdown of this EditgroupAnnotation. # noqa: E501 + :type: str + """ + + self._comment_markdown = comment_markdown + + @property + def extra(self): + """Gets the extra of this EditgroupAnnotation. # noqa: E501 + + + :return: The extra of this EditgroupAnnotation. # noqa: E501 + :rtype: object + """ + return self._extra + + @extra.setter + def extra(self, extra): + """Sets the extra of this EditgroupAnnotation. + + + :param extra: The extra of this EditgroupAnnotation. # noqa: E501 + :type: object + """ + + self._extra = extra + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EditgroupAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/python_client/tests/codegen/test_default_api.py b/python_client/tests/codegen/test_default_api.py index 9a632824..baec7dfd 100644 --- a/python_client/tests/codegen/test_default_api.py +++ b/python_client/tests/codegen/test_default_api.py @@ -77,6 +77,12 @@ class TestDefaultApi(unittest.TestCase): """ pass + def test_create_editgroup_annotation(self): + """Test case for create_editgroup_annotation + + """ + pass + def test_create_file(self): """Test case for create_file @@ -305,14 +311,32 @@ class TestDefaultApi(unittest.TestCase): """ pass + def test_get_editgroup_annotations(self): + """Test case for get_editgroup_annotations + + """ + pass + + def test_get_editgroups_reviewable(self): + """Test case for get_editgroups_reviewable + + """ + pass + def test_get_editor(self): """Test case for get_editor """ pass - def test_get_editor_changelog(self): - """Test case for get_editor_changelog + def test_get_editor_annotations(self): + """Test case for get_editor_annotations + + """ + pass + + def test_get_editor_editgroups(self): + """Test case for get_editor_editgroups """ pass @@ -527,6 +551,12 @@ class TestDefaultApi(unittest.TestCase): """ pass + def test_update_editgroup(self): + """Test case for update_editgroup + + """ + pass + def test_update_editor(self): """Test case for update_editor diff --git a/python_client/tests/codegen/test_editgroup_annotation.py b/python_client/tests/codegen/test_editgroup_annotation.py new file mode 100644 index 00000000..2cd8f4cc --- /dev/null +++ b/python_client/tests/codegen/test_editgroup_annotation.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + fatcat + + A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata # noqa: E501 + + OpenAPI spec version: 0.1.0 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import fatcat_client +from fatcat_client.models.editgroup_annotation import EditgroupAnnotation # noqa: E501 +from fatcat_client.rest import ApiException + + +class TestEditgroupAnnotation(unittest.TestCase): + """EditgroupAnnotation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEditgroupAnnotation(self): + """Test EditgroupAnnotation""" + # FIXME: construct object with mandatory attributes with example values + # model = fatcat_client.models.editgroup_annotation.EditgroupAnnotation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() |