elabapi-python 0.1.5__tar.gz → 0.1.7__tar.gz

{elabapi-python-0.1.5 → elabapi-python-0.1.7}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: elabapi-python
-Version: 0.1.5
+Version: 0.1.7
 Summary: eLabFTW REST API v2 Documentation
 Home-page: https://github.com/elabftw/elabapi-python
 Author-email: 
 Keywords: Swagger,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
     

{elabapi-python-0.1.5 → elabapi-python-0.1.7}/README.md

@@ -1,10 +1,10 @@
 # elabapi-python
-Some description of the api.
+This document describes all available endpoints and methods for eLabFTW's API version 2. 
 
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 0.1.5
+- Package version: 0.1.7
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -102,7 +102,7 @@ except ApiException as e:
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://eln.example.org/api/v2*
+All URIs are relative to *https://elab.local:3148/api/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -163,14 +163,15 @@ Class | Method | HTTP request | Description
 *StepsApi* | [**patch_step**](docs/StepsApi.md#patch_step) | **PATCH** /{entity_type}/{id}/steps/{subid} | Actions on a step. 
 *StepsApi* | [**post_step**](docs/StepsApi.md#post_step) | **POST** /{entity_type}/{id}/steps | Create a step.
 *StepsApi* | [**read_steps**](docs/StepsApi.md#read_steps) | **GET** /{entity_type}/{id}/steps | Read all steps of that entity.
-*TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /{entity_type}/{id}/tags/{subid} | Delete a tag.
-*TagsApi* | [**patch_tag**](docs/TagsApi.md#patch_tag) | **PATCH** /{entity_type}/{id}/tags/{subid} | Actions on a tag. 
+*TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /{entity_type}/{id}/tags/{subid} | Delete all tags.
+*TagsApi* | [**patch_tag**](docs/TagsApi.md#patch_tag) | **PATCH** /{entity_type}/{id}/tags/{subid} | Actions on a tag (like removing it from the entity). 
 *TagsApi* | [**post_tag**](docs/TagsApi.md#post_tag) | **POST** /{entity_type}/{id}/tags | Create a tag.
 *TagsApi* | [**read_tag**](docs/TagsApi.md#read_tag) | **GET** /{entity_type}/{id}/tags/{subid} | Read a tag.
 *TagsApi* | [**read_tags**](docs/TagsApi.md#read_tags) | **GET** /{entity_type}/{id}/tags | Read all tags of that entity.
 *TeamTagsApi* | [**delete_team_tag**](docs/TeamTagsApi.md#delete_team_tag) | **DELETE** /team_tags/{id} | Delete a tag.
 *TeamTagsApi* | [**patch_tags**](docs/TeamTagsApi.md#patch_tags) | **PATCH** /team_tags | Actions on tags. 
 *TeamTagsApi* | [**patch_team_tag**](docs/TeamTagsApi.md#patch_team_tag) | **PATCH** /team_tags/{id} | Actions on a tag. 
+*TeamTagsApi* | [**post_team_tag**](docs/TeamTagsApi.md#post_team_tag) | **POST** /team_tags | Create a tag in the team.
 *TeamTagsApi* | [**read_team_tag**](docs/TeamTagsApi.md#read_team_tag) | **GET** /team_tags/{id} | Read a tag.
 *TeamTagsApi* | [**read_team_tags**](docs/TeamTagsApi.md#read_team_tags) | **GET** /team_tags | Read all tags for the team.
 *TeamgroupsApi* | [**delete_teamgroup**](docs/TeamgroupsApi.md#delete_teamgroup) | **DELETE** /teams/{id}/teamgroups/{subid} | Delete a teamgroup.
@@ -194,6 +195,7 @@ Class | Method | HTTP request | Description
 *UploadsApi* | [**post_upload_replace**](docs/UploadsApi.md#post_upload_replace) | **POST** /{entity_type}/{id}/uploads/{subid} | Replace an existing uploaded file. The existing file will be archived and the new one will be added.
 *UploadsApi* | [**read_upload**](docs/UploadsApi.md#read_upload) | **GET** /{entity_type}/{id}/uploads/{subid} | Read an upload.
 *UploadsApi* | [**read_uploads**](docs/UploadsApi.md#read_uploads) | **GET** /{entity_type}/{id}/uploads | Read attached files of that entity.
+*UsersApi* | [**patch_user**](docs/UsersApi.md#patch_user) | **PATCH** /users/{id} | Modify a user.
 *UsersApi* | [**post_user**](docs/UsersApi.md#post_user) | **POST** /users | Create a new user.
 *UsersApi* | [**read_user**](docs/UsersApi.md#read_user) | **GET** /users/{id} | Read information of a user.
 *UsersApi* | [**read_users**](docs/UsersApi.md#read_users) | **GET** /users | Read users from instance.
@@ -215,6 +217,7 @@ Class | Method | HTTP request | Description
  - [ExperimentsIdBody](docs/ExperimentsIdBody.md)
  - [ExperimentsLinksSubidBody](docs/ExperimentsLinksSubidBody.md)
  - [ExperimentsTemplatesBody](docs/ExperimentsTemplatesBody.md)
+ - [ExperimentsTemplatesIdBody](docs/ExperimentsTemplatesIdBody.md)
  - [FavtagsBody](docs/FavtagsBody.md)
  - [Id](docs/Id.md)
  - [Id1](docs/Id1.md)
@@ -244,6 +247,7 @@ Class | Method | HTTP request | Description
  - [TagsSubidBody](docs/TagsSubidBody.md)
  - [Team](docs/Team.md)
  - [TeamTagsBody](docs/TeamTagsBody.md)
+ - [TeamTagsBody1](docs/TeamTagsBody1.md)
  - [TeamTagsIdBody](docs/TeamTagsIdBody.md)
  - [Teamgroup](docs/Teamgroup.md)
  - [TeamgroupUsers](docs/TeamgroupUsers.md)
@@ -258,6 +262,7 @@ Class | Method | HTTP request | Description
  - [UploadsSubidBody](docs/UploadsSubidBody.md)
  - [Users](docs/Users.md)
  - [UsersBody](docs/UsersBody.md)
+ - [UsersIdBody](docs/UsersIdBody.md)
 
 ## Documentation For Authorization
 

{elabapi-python-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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-0.1.5 → elabapi-python-0.1.7}/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