elabapi-python 5.1.0__tar.gz → 5.2.2__tar.gz

elabapi_python-5.2.2/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: elabapi-python
+Version: 5.2.2
+Summary: eLabFTW REST API v2 Documentation
+Home-page: https://github.com/elabftw/elabapi-python
+Author: OpenAPI Generator community
+Author-email: team@openapitools.org
+Keywords: OpenAPI,OpenAPI-Generator,eLabFTW REST API v2 Documentation
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+    This document describes all available endpoints and methods for eLabFTW&#39;s API version 2. 
+    

{elabapi_python-5.1.0 → elabapi_python-5.2.2}/README.md

@@ -1,20 +1,22 @@
 # elabapi-python
-This document describes all available endpoints and methods for eLabFTW's API version 2. 
+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:
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 5.1.0
-- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
+- Package version: 5.2.2
+- Generator version: 7.13.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ## Requirements.
 
-Python 2.7 and 3.4+
+Python 3.9+
 
 ## Installation & Usage
 ### pip install
 
-If the python package is hosted on Github, you can install directly from Github
+If the python package is hosted on a repository, you can install directly using:
 
 ```sh
 pip install git+https://github.com/elabftw/elabapi-python.git
@@ -23,7 +25,7 @@ pip install git+https://github.com/elabftw/elabapi-python.git
 
 Then import the package:
 ```python
-import elabapi_python 
+import elabapi_python
 ```
 
 ### Setuptools
@@ -40,64 +42,50 @@ Then import the package:
 import elabapi_python
 ```
 
+### Tests
+
+Execute `pytest` to run the tests.
+
 ## Getting Started
 
 Please follow the [installation procedure](#installation--usage) and then run the following:
 
 ```python
-from __future__ import print_function
-import time
+
 import elabapi_python
 from elabapi_python.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: token
-configuration = elabapi_python.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
-# create an instance of the API class
-api_instance = elabapi_python.ApiKeysApi(elabapi_python.ApiClient(configuration))
-id = 56 # int | ID of the API key
+# Defining the host is optional and defaults to https://elab.local:3148/api/v2
+# See configuration.py for a list of all supported configuration parameters.
+configuration = elabapi_python.Configuration(
+    host = "https://elab.local:3148/api/v2"
+)
 
-try:
-    # Delete an API key.
-    api_instance.delete_apikey(id)
-except ApiException as e:
-    print("Exception when calling ApiKeysApi->delete_apikey: %s\n" % e)
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
 
 # Configure API key authorization: token
-configuration = elabapi_python.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
+configuration.api_key['token'] = os.environ["API_KEY"]
 
-# create an instance of the API class
-api_instance = elabapi_python.ApiKeysApi(elabapi_python.ApiClient(configuration))
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['token'] = 'Bearer'
 
-try:
-    # Read API keys
-    api_response = api_instance.get_apikeys()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling ApiKeysApi->get_apikeys: %s\n" % e)
 
-# Configure API key authorization: token
-configuration = elabapi_python.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
+# Enter a context with an instance of the API client
+with elabapi_python.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = elabapi_python.ApiKeysApi(api_client)
+    id = 56 # int | ID of the API key
 
-# create an instance of the API class
-api_instance = elabapi_python.ApiKeysApi(elabapi_python.ApiClient(configuration))
-body = elabapi_python.ApikeysBody() # ApikeysBody |  (optional)
+    try:
+        # Delete an API key.
+        api_instance.delete_apikey(id)
+    except ApiException as e:
+        print("Exception when calling ApiKeysApi->delete_apikey: %s\n" % e)
 
-try:
-    # Create an API key
-    api_instance.post_apikeys(body=body)
-except ApiException as e:
-    print("Exception when calling ApiKeysApi->post_apikeys: %s\n" % e)
 ```
 
 ## Documentation for API Endpoints
@@ -114,6 +102,10 @@ Class | Method | HTTP request | Description
 *CommentsApi* | [**post_entity_comments**](docs/CommentsApi.md#post_entity_comments) | **POST** /{entity_type}/{id}/comments | Create a comment.
 *CommentsApi* | [**read_entity_comment**](docs/CommentsApi.md#read_entity_comment) | **GET** /{entity_type}/{id}/comments/{subid} | Read a comment of that entity.
 *CommentsApi* | [**read_entity_comments**](docs/CommentsApi.md#read_entity_comments) | **GET** /{entity_type}/{id}/comments | Read all comments of that entity.
+*CompoundsApi* | [**delete_compound**](docs/CompoundsApi.md#delete_compound) | **DELETE** /compounds/{id} | Soft-delete a compound
+*CompoundsApi* | [**get_compound**](docs/CompoundsApi.md#get_compound) | **GET** /compounds/{id} | Get a single compound
+*CompoundsApi* | [**get_compounds**](docs/CompoundsApi.md#get_compounds) | **GET** /compounds | Read compounds
+*CompoundsApi* | [**post_compounds**](docs/CompoundsApi.md#post_compounds) | **POST** /compounds | Create or import a compound
 *ConfigApi* | [**delete_config**](docs/ConfigApi.md#delete_config) | **DELETE** /config | Reset the config to default values
 *ConfigApi* | [**get_config**](docs/ConfigApi.md#get_config) | **GET** /config | Read the config
 *ConfigApi* | [**patch_config**](docs/ConfigApi.md#patch_config) | **PATCH** /config | Modify the config
@@ -126,6 +118,7 @@ Class | Method | HTTP request | Description
 *ExperimentsApi* | [**get_experiment**](docs/ExperimentsApi.md#get_experiment) | **GET** /experiments/{id} | Read an experiment
 *ExperimentsApi* | [**patch_experiment**](docs/ExperimentsApi.md#patch_experiment) | **PATCH** /experiments/{id} | Modify an experiment
 *ExperimentsApi* | [**post_experiment**](docs/ExperimentsApi.md#post_experiment) | **POST** /experiments | Create an experiment
+*ExperimentsApi* | [**post_experiment_by_id**](docs/ExperimentsApi.md#post_experiment_by_id) | **POST** /experiments/{id} | Duplicate an experiment with its ID
 *ExperimentsApi* | [**read_experiments**](docs/ExperimentsApi.md#read_experiments) | **GET** /experiments | Read all experiments that are accessible
 *ExperimentsCategoriesApi* | [**delete_expcat**](docs/ExperimentsCategoriesApi.md#delete_expcat) | **DELETE** /teams/{id}/experiments_categories/{subid} | Delete a category.
 *ExperimentsCategoriesApi* | [**patch_expcat**](docs/ExperimentsCategoriesApi.md#patch_expcat) | **PATCH** /teams/{id}/experiments_categories/{subid} | Modify a category.
@@ -141,6 +134,7 @@ Class | Method | HTTP request | Description
 *ExperimentsTemplatesApi* | [**get_experiment_template**](docs/ExperimentsTemplatesApi.md#get_experiment_template) | **GET** /experiments_templates/{id} | Read an experiment template
 *ExperimentsTemplatesApi* | [**patch_experiment_template**](docs/ExperimentsTemplatesApi.md#patch_experiment_template) | **PATCH** /experiments_templates/{id} | Modify an experiment template
 *ExperimentsTemplatesApi* | [**post_experiment_template**](docs/ExperimentsTemplatesApi.md#post_experiment_template) | **POST** /experiments_templates | Create an experiment template
+*ExperimentsTemplatesApi* | [**post_experiment_template_by_id**](docs/ExperimentsTemplatesApi.md#post_experiment_template_by_id) | **POST** /experiments_templates/{id} | Duplicate an experiment template with its ID
 *ExperimentsTemplatesApi* | [**read_experiments_templates**](docs/ExperimentsTemplatesApi.md#read_experiments_templates) | **GET** /experiments_templates | Read all experiments_templates that are accessible
 *ExportsApi* | [**delete_export**](docs/ExportsApi.md#delete_export) | **DELETE** /exports/{id} | Remove an export request and its associated file
 *ExportsApi* | [**post_export**](docs/ExportsApi.md#post_export) | **POST** /exports | Register an export request
@@ -162,6 +156,7 @@ Class | Method | HTTP request | Description
 *ItemsApi* | [**get_item**](docs/ItemsApi.md#get_item) | **GET** /items/{id} | Read an item
 *ItemsApi* | [**patch_item**](docs/ItemsApi.md#patch_item) | **PATCH** /items/{id} | Modify an item
 *ItemsApi* | [**post_item**](docs/ItemsApi.md#post_item) | **POST** /items | Create an item
+*ItemsApi* | [**post_item_by_id**](docs/ItemsApi.md#post_item_by_id) | **POST** /items/{id} | Duplicate an item with its ID
 *ItemsApi* | [**read_items**](docs/ItemsApi.md#read_items) | **GET** /items | Read all items that are accessible
 *ItemsTypesApi* | [**delete_items_type**](docs/ItemsTypesApi.md#delete_items_type) | **DELETE** /items_types/{id} | Delete a resource category.
 *ItemsTypesApi* | [**get_items_type**](docs/ItemsTypesApi.md#get_items_type) | **GET** /items_types/{id} | Read a resource category.
@@ -178,6 +173,7 @@ Class | Method | HTTP request | Description
 *NotificationsApi* | [**patch_notification**](docs/NotificationsApi.md#patch_notification) | **PATCH** /users/{id}/notifications/{subid} | Actions on a notification. Only changing `is_ack` column is possible. 
 *NotificationsApi* | [**read_notification**](docs/NotificationsApi.md#read_notification) | **GET** /users/{id}/notifications/{subid} | Read a notification.
 *NotificationsApi* | [**read_notifications**](docs/NotificationsApi.md#read_notifications) | **GET** /users/{id}/notifications | Read notifications of a user.
+*ReportsApi* | [**get_reports**](docs/ReportsApi.md#get_reports) | **GET** /reports | Get usage reports
 *ResourcesStatusApi* | [**delete_resstatus**](docs/ResourcesStatusApi.md#delete_resstatus) | **DELETE** /teams/{id}/items_status/{subid} | Delete a status.
 *ResourcesStatusApi* | [**patch_resstatus**](docs/ResourcesStatusApi.md#patch_resstatus) | **PATCH** /teams/{id}/items_status/{subid} | Modify a status.
 *ResourcesStatusApi* | [**post_team_one_resstat**](docs/ResourcesStatusApi.md#post_team_one_resstat) | **POST** /teams/{id}/items_status | Create a new status for resources.
@@ -196,7 +192,6 @@ Class | Method | HTTP request | Description
 *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** /teams/{id}/tags/{subid} | Delete a tag.
-*TeamTagsApi* | [**patch_tags**](docs/TeamTagsApi.md#patch_tags) | **PATCH** /teams/{id}/tags | Actions on tags. 
 *TeamTagsApi* | [**patch_team_tag**](docs/TeamTagsApi.md#patch_team_tag) | **PATCH** /teams/{id}/tags/{subid} | Actions on a tag. 
 *TeamTagsApi* | [**post_team_tag**](docs/TeamTagsApi.md#post_team_tag) | **POST** /teams/{id}/tags | Create a tag in the team.
 *TeamTagsApi* | [**read_team_tag**](docs/TeamTagsApi.md#read_team_tag) | **GET** /teams/{id}/tags/{subid} | Read a tag.
@@ -228,98 +223,118 @@ Class | Method | HTTP request | Description
 *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.
 
+
 ## Documentation For Models
 
- - [AnyOfuploadsSubidBody1](docs/AnyOfuploadsSubidBody1.md)
  - [Apikey](docs/Apikey.md)
- - [ApikeysBody](docs/ApikeysBody.md)
  - [Comment](docs/Comment.md)
+ - [Compound](docs/Compound.md)
+ - [CompoundCreateRequest](docs/CompoundCreateRequest.md)
+ - [CompoundDuplicateRequest](docs/CompoundDuplicateRequest.md)
  - [Config](docs/Config.md)
  - [Entity](docs/Entity.md)
+ - [EntityEditable](docs/EntityEditable.md)
+ - [EntityTemplate](docs/EntityTemplate.md)
+ - [EntityTemplateEditable](docs/EntityTemplateEditable.md)
  - [Event](docs/Event.md)
- - [EventIdBody](docs/EventIdBody.md)
- - [EventidDelta](docs/EventidDelta.md)
- - [EventsIdBody](docs/EventsIdBody.md)
  - [ExclusiveEditMode](docs/ExclusiveEditMode.md)
  - [Experiment](docs/Experiment.md)
- - [ExperimentTemplate](docs/ExperimentTemplate.md)
- - [ExperimentsBody](docs/ExperimentsBody.md)
- - [ExperimentsIdBody](docs/ExperimentsIdBody.md)
- - [ExperimentsLinksSubidBody](docs/ExperimentsLinksSubidBody.md)
- - [ExperimentsTemplatesBody](docs/ExperimentsTemplatesBody.md)
- - [ExperimentsTemplatesIdBody](docs/ExperimentsTemplatesIdBody.md)
  - [Export](docs/Export.md)
- - [ExportsBody](docs/ExportsBody.md)
  - [ExtraFieldsKeys](docs/ExtraFieldsKeys.md)
- - [FavtagsBody](docs/FavtagsBody.md)
- - [Id](docs/Id.md)
- - [Id1](docs/Id1.md)
- - [Id2](docs/Id2.md)
- - [Id3](docs/Id3.md)
- - [Id4](docs/Id4.md)
- - [IdCommentsBody](docs/IdCommentsBody.md)
- - [IdExperimentsCategoriesBody](docs/IdExperimentsCategoriesBody.md)
- - [IdExperimentsStatusBody](docs/IdExperimentsStatusBody.md)
- - [IdItemsStatusBody](docs/IdItemsStatusBody.md)
- - [IdStepsBody](docs/IdStepsBody.md)
- - [IdTagsBody](docs/IdTagsBody.md)
- - [IdTagsBody1](docs/IdTagsBody1.md)
- - [IdTagsBody2](docs/IdTagsBody2.md)
- - [IdTeamgroupsBody](docs/IdTeamgroupsBody.md)
- - [IdUploadsBody](docs/IdUploadsBody.md)
+ - [GetInfo200Response](docs/GetInfo200Response.md)
+ - [GetReports200Response](docs/GetReports200Response.md)
+ - [GetReports200ResponseQueryParameters](docs/GetReports200ResponseQueryParameters.md)
  - [Idp](docs/Idp.md)
- - [IdpsBody](docs/IdpsBody.md)
- - [IdpsIdBody](docs/IdpsIdBody.md)
- - [ImportBody](docs/ImportBody.md)
- - [InlineResponse200](docs/InlineResponse200.md)
- - [InlineResponse2001](docs/InlineResponse2001.md)
- - [InlineResponse2002](docs/InlineResponse2002.md)
- - [InlineResponse2003](docs/InlineResponse2003.md)
- - [InlineResponse2004](docs/InlineResponse2004.md)
- - [InlineResponse2005](docs/InlineResponse2005.md)
- - [InlineResponse2006](docs/InlineResponse2006.md)
- - [InlineResponse2007](docs/InlineResponse2007.md)
- - [InlineResponse2008](docs/InlineResponse2008.md)
- - [InlineResponse2009](docs/InlineResponse2009.md)
  - [Item](docs/Item.md)
- - [ItemsBody](docs/ItemsBody.md)
- - [ItemsIdBody](docs/ItemsIdBody.md)
- - [ItemsLinksSubidBody](docs/ItemsLinksSubidBody.md)
  - [ItemsType](docs/ItemsType.md)
- - [ItemsTypesBody](docs/ItemsTypesBody.md)
  - [Link](docs/Link.md)
+ - [Metadata](docs/Metadata.md)
+ - [MetadataElabftw](docs/MetadataElabftw.md)
+ - [MetadataElabftwExtraFieldsGroupsInner](docs/MetadataElabftwExtraFieldsGroupsInner.md)
+ - [MetadataExtraFieldsValue](docs/MetadataExtraFieldsValue.md)
  - [Notification](docs/Notification.md)
+ - [PatchEntityRevisionRequest](docs/PatchEntityRevisionRequest.md)
+ - [PatchEventRequest](docs/PatchEventRequest.md)
+ - [PatchEventRequestOneOf](docs/PatchEventRequestOneOf.md)
+ - [PatchEventRequestOneOf1](docs/PatchEventRequestOneOf1.md)
+ - [PatchEventRequestOneOf2](docs/PatchEventRequestOneOf2.md)
+ - [PatchEventRequestOneOf2Delta](docs/PatchEventRequestOneOf2Delta.md)
+ - [PatchExperimentRequest](docs/PatchExperimentRequest.md)
+ - [PatchExperimentRequestAnyOf](docs/PatchExperimentRequestAnyOf.md)
+ - [PatchExperimentTemplateRequest](docs/PatchExperimentTemplateRequest.md)
+ - [PatchExperimentTemplateRequestAnyOf](docs/PatchExperimentTemplateRequestAnyOf.md)
+ - [PatchIdpRequest](docs/PatchIdpRequest.md)
+ - [PatchItemRequest](docs/PatchItemRequest.md)
+ - [PatchItemRequestAnyOf](docs/PatchItemRequestAnyOf.md)
+ - [PatchStepRequest](docs/PatchStepRequest.md)
+ - [PatchTagRequest](docs/PatchTagRequest.md)
+ - [PatchTeamRequest](docs/PatchTeamRequest.md)
+ - [PatchTeamRequestOneOf](docs/PatchTeamRequestOneOf.md)
+ - [PatchTeamTagRequest](docs/PatchTeamTagRequest.md)
+ - [PatchTeamgroupRequest](docs/PatchTeamgroupRequest.md)
+ - [PatchTeamgroupRequestOneOf](docs/PatchTeamgroupRequestOneOf.md)
+ - [PatchTeamgroupRequestOneOf1](docs/PatchTeamgroupRequestOneOf1.md)
+ - [PatchTodoitemRequest](docs/PatchTodoitemRequest.md)
+ - [PatchUploadRequest](docs/PatchUploadRequest.md)
+ - [PatchUserRequest](docs/PatchUserRequest.md)
+ - [PatchUserRequestOneOf](docs/PatchUserRequestOneOf.md)
+ - [PatchUserRequestOneOf1](docs/PatchUserRequestOneOf1.md)
+ - [PatchUserRequestOneOf2](docs/PatchUserRequestOneOf2.md)
+ - [PatchUserRequestOneOf3](docs/PatchUserRequestOneOf3.md)
+ - [PatchUserRequestOneOf4](docs/PatchUserRequestOneOf4.md)
+ - [PostApikeysRequest](docs/PostApikeysRequest.md)
+ - [PostCompoundsRequest](docs/PostCompoundsRequest.md)
+ - [PostEntityCommentsRequest](docs/PostEntityCommentsRequest.md)
+ - [PostEntityItemsLinksRequest](docs/PostEntityItemsLinksRequest.md)
+ - [PostEventsRequest](docs/PostEventsRequest.md)
+ - [PostExperimentByIdRequest](docs/PostExperimentByIdRequest.md)
+ - [PostExperimentRequest](docs/PostExperimentRequest.md)
+ - [PostExperimentTemplateByIdRequest](docs/PostExperimentTemplateByIdRequest.md)
+ - [PostExportRequest](docs/PostExportRequest.md)
+ - [PostFavtagsRequest](docs/PostFavtagsRequest.md)
+ - [PostIdpRequest](docs/PostIdpRequest.md)
+ - [PostItemByIdRequest](docs/PostItemByIdRequest.md)
+ - [PostItemsTypesRequest](docs/PostItemsTypesRequest.md)
+ - [PostStepRequest](docs/PostStepRequest.md)
+ - [PostTagRequest](docs/PostTagRequest.md)
+ - [PostTeamOneExpcatRequest](docs/PostTeamOneExpcatRequest.md)
+ - [PostTeamOneExpstatusRequest](docs/PostTeamOneExpstatusRequest.md)
+ - [PostTeamTagRequest](docs/PostTeamTagRequest.md)
+ - [PostTeamgroupsRequest](docs/PostTeamgroupsRequest.md)
+ - [PostTeamsRequest](docs/PostTeamsRequest.md)
+ - [PostTodolistRequest](docs/PostTodolistRequest.md)
+ - [PostUserRequest](docs/PostUserRequest.md)
+ - [ReadEntityRevisions200ResponseInner](docs/ReadEntityRevisions200ResponseInner.md)
+ - [ReadFavtags200Response](docs/ReadFavtags200Response.md)
+ - [ReadImport200Response](docs/ReadImport200Response.md)
+ - [ReadNotifications200Response](docs/ReadNotifications200Response.md)
+ - [ReadTeamIdParameter](docs/ReadTeamIdParameter.md)
+ - [ReadTeamgroup200Response](docs/ReadTeamgroup200Response.md)
+ - [ReadUserIdParameter](docs/ReadUserIdParameter.md)
+ - [ReadUserUploads200ResponseInner](docs/ReadUserUploads200ResponseInner.md)
+ - [ReadUsers200ResponseInner](docs/ReadUsers200ResponseInner.md)
  - [Revision](docs/Revision.md)
- - [RevisionsSubidBody](docs/RevisionsSubidBody.md)
  - [Statuslike](docs/Statuslike.md)
  - [Step](docs/Step.md)
- - [StepsSubidBody](docs/StepsSubidBody.md)
  - [Tag](docs/Tag.md)
- - [TagsSubidBody](docs/TagsSubidBody.md)
- - [TagsSubidBody1](docs/TagsSubidBody1.md)
  - [Team](docs/Team.md)
  - [Teamgroup](docs/Teamgroup.md)
- - [TeamgroupUsers](docs/TeamgroupUsers.md)
- - [TeamgroupsSubidBody](docs/TeamgroupsSubidBody.md)
- - [TeamsBody](docs/TeamsBody.md)
- - [TeamsIdBody](docs/TeamsIdBody.md)
+ - [TeamgroupUsersInner](docs/TeamgroupUsersInner.md)
  - [Todoitem](docs/Todoitem.md)
- - [TodolistBody](docs/TodolistBody.md)
- - [TodolistIdBody](docs/TodolistIdBody.md)
  - [UnfinishedStep](docs/UnfinishedStep.md)
  - [UnfinishedSteps](docs/UnfinishedSteps.md)
  - [Upload](docs/Upload.md)
- - [UploadsSubidBody](docs/UploadsSubidBody.md)
- - [UploadsSubidBody1](docs/UploadsSubidBody1.md)
  - [Users](docs/Users.md)
- - [UsersBody](docs/UsersBody.md)
- - [UsersIdBody](docs/UsersIdBody.md)
- - [UsersTeams](docs/UsersTeams.md)
+ - [UsersTeamsInner](docs/UsersTeamsInner.md)
+
 
+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization
 
 
-## token
+Authentication schemes defined for the API:
+<a id="token"></a>
+### token
 
 - **Type**: API key
 - **API key parameter name**: Authorization
@@ -329,3 +344,5 @@ Class | Method | HTTP request | Description
 ## Author
 
 
+
+

elabapi_python-5.2.2/elabapi_python/__init__.py

@@ -0,0 +1,165 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    eLabFTW REST API v2 Documentation
+
+    This document describes all available endpoints and methods for eLabFTW's API version 2. 
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "5.2.2"
+
+# import apis into sdk package
+from elabapi_python.api.api_keys_api import ApiKeysApi
+from elabapi_python.api.comments_api import CommentsApi
+from elabapi_python.api.compounds_api import CompoundsApi
+from elabapi_python.api.config_api import ConfigApi
+from elabapi_python.api.events_api import EventsApi
+from elabapi_python.api.experiments_api import ExperimentsApi
+from elabapi_python.api.experiments_categories_api import ExperimentsCategoriesApi
+from elabapi_python.api.experiments_status_api import ExperimentsStatusApi
+from elabapi_python.api.experiments_templates_api import ExperimentsTemplatesApi
+from elabapi_python.api.exports_api import ExportsApi
+from elabapi_python.api.extra_fields_keys_api import ExtraFieldsKeysApi
+from elabapi_python.api.favorite_tags_api import FavoriteTagsApi
+from elabapi_python.api.idps_api import IdpsApi
+from elabapi_python.api.import_api import ImportApi
+from elabapi_python.api.info_api import InfoApi
+from elabapi_python.api.items_api import ItemsApi
+from elabapi_python.api.items_types_api import ItemsTypesApi
+from elabapi_python.api.links_to_experiments_api import LinksToExperimentsApi
+from elabapi_python.api.links_to_items_api import LinksToItemsApi
+from elabapi_python.api.notifications_api import NotificationsApi
+from elabapi_python.api.reports_api import ReportsApi
+from elabapi_python.api.resources_status_api import ResourcesStatusApi
+from elabapi_python.api.revisions_api import RevisionsApi
+from elabapi_python.api.steps_api import StepsApi
+from elabapi_python.api.tags_api import TagsApi
+from elabapi_python.api.team_tags_api import TeamTagsApi
+from elabapi_python.api.teamgroups_api import TeamgroupsApi
+from elabapi_python.api.teams_api import TeamsApi
+from elabapi_python.api.todolist_api import TodolistApi
+from elabapi_python.api.unfinished_steps_api import UnfinishedStepsApi
+from elabapi_python.api.uploads_api import UploadsApi
+from elabapi_python.api.user_uploads_api import UserUploadsApi
+from elabapi_python.api.users_api import UsersApi
+
+# import ApiClient
+from elabapi_python.api_response import ApiResponse
+from elabapi_python.api_client import ApiClient
+from elabapi_python.configuration import Configuration
+from elabapi_python.exceptions import OpenApiException
+from elabapi_python.exceptions import ApiTypeError
+from elabapi_python.exceptions import ApiValueError
+from elabapi_python.exceptions import ApiKeyError
+from elabapi_python.exceptions import ApiAttributeError
+from elabapi_python.exceptions import ApiException
+
+# import models into sdk package
+from elabapi_python.models.apikey import Apikey
+from elabapi_python.models.comment import Comment
+from elabapi_python.models.compound import Compound
+from elabapi_python.models.compound_create_request import CompoundCreateRequest
+from elabapi_python.models.compound_duplicate_request import CompoundDuplicateRequest
+from elabapi_python.models.config import Config
+from elabapi_python.models.entity import Entity
+from elabapi_python.models.entity_editable import EntityEditable
+from elabapi_python.models.entity_template import EntityTemplate
+from elabapi_python.models.entity_template_editable import EntityTemplateEditable
+from elabapi_python.models.event import Event
+from elabapi_python.models.exclusive_edit_mode import ExclusiveEditMode
+from elabapi_python.models.experiment import Experiment
+from elabapi_python.models.export import Export
+from elabapi_python.models.extra_fields_keys import ExtraFieldsKeys
+from elabapi_python.models.get_info200_response import GetInfo200Response
+from elabapi_python.models.get_reports200_response import GetReports200Response
+from elabapi_python.models.get_reports200_response_query_parameters import GetReports200ResponseQueryParameters
+from elabapi_python.models.idp import Idp
+from elabapi_python.models.item import Item
+from elabapi_python.models.items_type import ItemsType
+from elabapi_python.models.link import Link
+from elabapi_python.models.metadata import Metadata
+from elabapi_python.models.metadata_elabftw import MetadataElabftw
+from elabapi_python.models.metadata_elabftw_extra_fields_groups_inner import MetadataElabftwExtraFieldsGroupsInner
+from elabapi_python.models.metadata_extra_fields_value import MetadataExtraFieldsValue
+from elabapi_python.models.notification import Notification
+from elabapi_python.models.patch_entity_revision_request import PatchEntityRevisionRequest
+from elabapi_python.models.patch_event_request import PatchEventRequest
+from elabapi_python.models.patch_event_request_one_of import PatchEventRequestOneOf
+from elabapi_python.models.patch_event_request_one_of1 import PatchEventRequestOneOf1
+from elabapi_python.models.patch_event_request_one_of2 import PatchEventRequestOneOf2
+from elabapi_python.models.patch_event_request_one_of2_delta import PatchEventRequestOneOf2Delta
+from elabapi_python.models.patch_experiment_request import PatchExperimentRequest
+from elabapi_python.models.patch_experiment_request_any_of import PatchExperimentRequestAnyOf
+from elabapi_python.models.patch_experiment_template_request import PatchExperimentTemplateRequest
+from elabapi_python.models.patch_experiment_template_request_any_of import PatchExperimentTemplateRequestAnyOf
+from elabapi_python.models.patch_idp_request import PatchIdpRequest
+from elabapi_python.models.patch_item_request import PatchItemRequest
+from elabapi_python.models.patch_item_request_any_of import PatchItemRequestAnyOf
+from elabapi_python.models.patch_step_request import PatchStepRequest
+from elabapi_python.models.patch_tag_request import PatchTagRequest
+from elabapi_python.models.patch_team_request import PatchTeamRequest
+from elabapi_python.models.patch_team_request_one_of import PatchTeamRequestOneOf
+from elabapi_python.models.patch_team_tag_request import PatchTeamTagRequest
+from elabapi_python.models.patch_teamgroup_request import PatchTeamgroupRequest
+from elabapi_python.models.patch_teamgroup_request_one_of import PatchTeamgroupRequestOneOf
+from elabapi_python.models.patch_teamgroup_request_one_of1 import PatchTeamgroupRequestOneOf1
+from elabapi_python.models.patch_todoitem_request import PatchTodoitemRequest
+from elabapi_python.models.patch_upload_request import PatchUploadRequest
+from elabapi_python.models.patch_user_request import PatchUserRequest
+from elabapi_python.models.patch_user_request_one_of import PatchUserRequestOneOf
+from elabapi_python.models.patch_user_request_one_of1 import PatchUserRequestOneOf1
+from elabapi_python.models.patch_user_request_one_of2 import PatchUserRequestOneOf2
+from elabapi_python.models.patch_user_request_one_of3 import PatchUserRequestOneOf3
+from elabapi_python.models.patch_user_request_one_of4 import PatchUserRequestOneOf4
+from elabapi_python.models.post_apikeys_request import PostApikeysRequest
+from elabapi_python.models.post_compounds_request import PostCompoundsRequest
+from elabapi_python.models.post_entity_comments_request import PostEntityCommentsRequest
+from elabapi_python.models.post_entity_items_links_request import PostEntityItemsLinksRequest
+from elabapi_python.models.post_events_request import PostEventsRequest
+from elabapi_python.models.post_experiment_by_id_request import PostExperimentByIdRequest
+from elabapi_python.models.post_experiment_request import PostExperimentRequest
+from elabapi_python.models.post_experiment_template_by_id_request import PostExperimentTemplateByIdRequest
+from elabapi_python.models.post_export_request import PostExportRequest
+from elabapi_python.models.post_favtags_request import PostFavtagsRequest
+from elabapi_python.models.post_idp_request import PostIdpRequest
+from elabapi_python.models.post_item_by_id_request import PostItemByIdRequest
+from elabapi_python.models.post_items_types_request import PostItemsTypesRequest
+from elabapi_python.models.post_step_request import PostStepRequest
+from elabapi_python.models.post_tag_request import PostTagRequest
+from elabapi_python.models.post_team_one_expcat_request import PostTeamOneExpcatRequest
+from elabapi_python.models.post_team_one_expstatus_request import PostTeamOneExpstatusRequest
+from elabapi_python.models.post_team_tag_request import PostTeamTagRequest
+from elabapi_python.models.post_teamgroups_request import PostTeamgroupsRequest
+from elabapi_python.models.post_teams_request import PostTeamsRequest
+from elabapi_python.models.post_todolist_request import PostTodolistRequest
+from elabapi_python.models.post_user_request import PostUserRequest
+from elabapi_python.models.read_entity_revisions200_response_inner import ReadEntityRevisions200ResponseInner
+from elabapi_python.models.read_favtags200_response import ReadFavtags200Response
+from elabapi_python.models.read_import200_response import ReadImport200Response
+from elabapi_python.models.read_notifications200_response import ReadNotifications200Response
+from elabapi_python.models.read_team_id_parameter import ReadTeamIdParameter
+from elabapi_python.models.read_teamgroup200_response import ReadTeamgroup200Response
+from elabapi_python.models.read_user_id_parameter import ReadUserIdParameter
+from elabapi_python.models.read_user_uploads200_response_inner import ReadUserUploads200ResponseInner
+from elabapi_python.models.read_users200_response_inner import ReadUsers200ResponseInner
+from elabapi_python.models.revision import Revision
+from elabapi_python.models.statuslike import Statuslike
+from elabapi_python.models.step import Step
+from elabapi_python.models.tag import Tag
+from elabapi_python.models.team import Team
+from elabapi_python.models.teamgroup import Teamgroup
+from elabapi_python.models.teamgroup_users_inner import TeamgroupUsersInner
+from elabapi_python.models.todoitem import Todoitem
+from elabapi_python.models.unfinished_step import UnfinishedStep
+from elabapi_python.models.unfinished_steps import UnfinishedSteps
+from elabapi_python.models.upload import Upload
+from elabapi_python.models.users import Users
+from elabapi_python.models.users_teams_inner import UsersTeamsInner

{elabapi_python-5.1.0 → elabapi_python-5.2.2}/elabapi_python/api/__init__.py

@@ -1,10 +1,9 @@
-from __future__ import absolute_import
-
 # flake8: noqa
 
 # import apis into api package
 from elabapi_python.api.api_keys_api import ApiKeysApi
 from elabapi_python.api.comments_api import CommentsApi
+from elabapi_python.api.compounds_api import CompoundsApi
 from elabapi_python.api.config_api import ConfigApi
 from elabapi_python.api.events_api import EventsApi
 from elabapi_python.api.experiments_api import ExperimentsApi
@@ -22,6 +21,7 @@ from elabapi_python.api.items_types_api import ItemsTypesApi
 from elabapi_python.api.links_to_experiments_api import LinksToExperimentsApi
 from elabapi_python.api.links_to_items_api import LinksToItemsApi
 from elabapi_python.api.notifications_api import NotificationsApi
+from elabapi_python.api.reports_api import ReportsApi
 from elabapi_python.api.resources_status_api import ResourcesStatusApi
 from elabapi_python.api.revisions_api import RevisionsApi
 from elabapi_python.api.steps_api import StepsApi
@@ -34,3 +34,4 @@ from elabapi_python.api.unfinished_steps_api import UnfinishedStepsApi
 from elabapi_python.api.uploads_api import UploadsApi
 from elabapi_python.api.user_uploads_api import UserUploadsApi
 from elabapi_python.api.users_api import UsersApi
+