elabapi-python 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

elabapi_python/__init__.py

@@ -5,7 +5,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -56,6 +56,7 @@ from elabapi_python.models.experiments_body import ExperimentsBody
 from elabapi_python.models.experiments_id_body import ExperimentsIdBody
 from elabapi_python.models.experiments_links_subid_body import ExperimentsLinksSubidBody
 from elabapi_python.models.experiments_templates_body import ExperimentsTemplatesBody
+from elabapi_python.models.experiments_templates_id_body import ExperimentsTemplatesIdBody
 from elabapi_python.models.favtags_body import FavtagsBody
 from elabapi_python.models.id import Id
 from elabapi_python.models.id1 import Id1
@@ -85,6 +86,7 @@ from elabapi_python.models.tag import Tag
 from elabapi_python.models.tags_subid_body import TagsSubidBody
 from elabapi_python.models.team import Team
 from elabapi_python.models.team_tags_body import TeamTagsBody
+from elabapi_python.models.team_tags_body1 import TeamTagsBody1
 from elabapi_python.models.team_tags_id_body import TeamTagsIdBody
 from elabapi_python.models.teamgroup import Teamgroup
 from elabapi_python.models.teamgroup_users import TeamgroupUsers
@@ -99,3 +101,4 @@ from elabapi_python.models.upload import Upload
 from elabapi_python.models.uploads_subid_body import UploadsSubidBody
 from elabapi_python.models.users import Users
 from elabapi_python.models.users_body import UsersBody
+from elabapi_python.models.users_id_body import UsersIdBody

elabapi_python/api/api_keys_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -104,6 +104,10 @@ class ApiKeysApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/comments_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -120,6 +120,10 @@ class CommentsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/config_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -94,6 +94,10 @@ class ConfigApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/events_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -102,6 +102,10 @@ class EventsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/experiments_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -104,6 +104,10 @@ class ExperimentsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/experiments_templates_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -104,6 +104,10 @@ class ExperimentsTemplatesApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 
@@ -226,6 +230,7 @@ class ExperimentsTemplatesApi(object):
 
         :param async_req bool
         :param int id: ID of the experiment template (required)
+        :param ExperimentsTemplatesIdBody body: Parameters for modifying an experiment template
         :return: ExperimentTemplate
                  If the method is called asynchronously,
                  returns the request thread.
@@ -247,12 +252,13 @@ class ExperimentsTemplatesApi(object):
 
         :param async_req bool
         :param int id: ID of the experiment template (required)
+        :param ExperimentsTemplatesIdBody body: Parameters for modifying an experiment template
         :return: ExperimentTemplate
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['id']  # noqa: E501
+        all_params = ['id', 'body']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -286,10 +292,16 @@ class ExperimentsTemplatesApi(object):
         local_var_files = {}
 
         body_params = None
+        if 'body' in params:
+            body_params = params['body']
         # 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 = ['token']  # noqa: E501
 

elabapi_python/api/favorite_tags_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -102,6 +102,10 @@ class FavoriteTagsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/items_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -104,6 +104,10 @@ class ItemsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 
@@ -133,6 +137,7 @@ class ItemsApi(object):
 
         :param async_req bool
         :param int id: ID of the item (required)
+        :param str format: Get the entity in a different format like csv, pdf, eln or zip. \"pdfa\" means archive pdf (PDF/A), same with \"zipa\". 
         :return: Item
                  If the method is called asynchronously,
                  returns the request thread.
@@ -154,12 +159,13 @@ class ItemsApi(object):
 
         :param async_req bool
         :param int id: ID of the item (required)
+        :param str format: Get the entity in a different format like csv, pdf, eln or zip. \"pdfa\" means archive pdf (PDF/A), same with \"zipa\". 
         :return: Item
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['id']  # noqa: E501
+        all_params = ['id', 'format']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -186,6 +192,8 @@ class ItemsApi(object):
             path_params['id'] = params['id']  # noqa: E501
 
         query_params = []
+        if 'format' in params:
+            query_params.append(('format', params['format']))  # noqa: E501
 
         header_params = {}
 

elabapi_python/api/items_types_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -104,6 +104,10 @@ class ItemsTypesApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/links_to_experiments_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -120,6 +120,10 @@ class LinksToExperimentsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/links_to_items_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -120,6 +120,10 @@ class LinksToItemsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/notifications_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -104,6 +104,10 @@ class NotificationsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/status_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -110,6 +110,10 @@ class StatusApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/steps_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -120,6 +120,10 @@ class StepsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/tags_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -33,9 +33,9 @@ class TagsApi(object):
         self.api_client = api_client
 
     def delete_tag(self, entity_type, id, subid, **kwargs):  # noqa: E501
-        """Delete a tag.  # noqa: E501
+        """Delete all tags.  # noqa: E501
 
-        The tag gets deleted.  # noqa: E501
+        All the tags from that entity get removed.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.delete_tag(entity_type, id, subid, async_req=True)
@@ -57,9 +57,9 @@ class TagsApi(object):
             return data
 
     def delete_tag_with_http_info(self, entity_type, id, subid, **kwargs):  # noqa: E501
-        """Delete a tag.  # noqa: E501
+        """Delete all tags.  # noqa: E501
 
-        The tag gets deleted.  # noqa: E501
+        All the tags from that entity get removed.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.delete_tag_with_http_info(entity_type, id, subid, async_req=True)
@@ -120,6 +120,10 @@ class TagsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 
@@ -140,7 +144,7 @@ class TagsApi(object):
             collection_formats=collection_formats)
 
     def patch_tag(self, entity_type, id, subid, **kwargs):  # noqa: E501
-        """Actions on a tag.   # noqa: E501
+        """Actions on a tag (like removing it from the entity).   # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -164,7 +168,7 @@ class TagsApi(object):
             return data
 
     def patch_tag_with_http_info(self, entity_type, id, subid, **kwargs):  # noqa: E501
-        """Actions on a tag.   # noqa: E501
+        """Actions on a tag (like removing it from the entity).   # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True

elabapi_python/api/team_tags_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -102,6 +102,10 @@ class TeamTagsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 
@@ -130,7 +134,7 @@ class TeamTagsApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param TeamTagsBody body: Parameters for modifying team tags.
+        :param TeamTagsBody1 body: Parameters for modifying team tags.
         :return: list[Tag]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -151,7 +155,7 @@ class TeamTagsApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param TeamTagsBody body: Parameters for modifying team tags.
+        :param TeamTagsBody1 body: Parameters for modifying team tags.
         :return: list[Tag]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -315,6 +319,95 @@ class TeamTagsApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def post_team_tag(self, **kwargs):  # noqa: E501
+        """Create a tag in the team.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.post_team_tag(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param TeamTagsBody body: Parameters for adding a tag in the team.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.post_team_tag_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.post_team_tag_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def post_team_tag_with_http_info(self, **kwargs):  # noqa: E501
+        """Create a tag in the team.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.post_team_tag_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param TeamTagsBody body: Parameters for adding a tag in the team.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['body']  # noqa: E501
+        all_params.append('async_req')
+        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 post_team_tag" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            body_params = params['body']
+        # 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 = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/team_tags', '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=params.get('async_req'),
+            _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 read_team_tag(self, id, **kwargs):  # noqa: E501
         """Read a tag.  # noqa: E501
 

elabapi_python/api/teamgroups_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -110,6 +110,10 @@ class TeamgroupsApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/teams_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     

elabapi_python/api/todolist_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0
     
@@ -102,6 +102,10 @@ class TodolistApi(object):
         local_var_files = {}
 
         body_params = None
+        # 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 = ['token']  # noqa: E501
 

elabapi_python/api/unfinished_steps_api.py

@@ -3,7 +3,7 @@
 """
     eLabFTW REST API v2 Documentation
 
-    Some description of the api.  # noqa: E501
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
 
     OpenAPI spec version: 2.0.0