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

{elabapi-python-5.0.2 → elabapi_python-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: elabapi-python
-Version: 5.0.2
+Version: 5.1.0
 Summary: eLabFTW REST API v2 Documentation
 Home-page: https://github.com/elabftw/elabapi-python
 Author-email: 

{elabapi-python-5.0.2 → elabapi_python-5.1.0}/README.md

@@ -4,7 +4,7 @@ This document describes all available endpoints and methods for eLabFTW's API ve
 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: 5.0.2
+- Package version: 5.1.0
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -129,9 +129,9 @@ Class | Method | HTTP request | Description
 *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.
-*ExperimentsCategoriesApi* | [**post_team_one_expcat**](docs/ExperimentsCategoriesApi.md#post_team_one_expcat) | **POST** /teams/{id}/experiments_categories | Create a new experiments status.
+*ExperimentsCategoriesApi* | [**post_team_one_expcat**](docs/ExperimentsCategoriesApi.md#post_team_one_expcat) | **POST** /teams/{id}/experiments_categories | Create a new category for experiments.
 *ExperimentsCategoriesApi* | [**read_team_experiments_categories**](docs/ExperimentsCategoriesApi.md#read_team_experiments_categories) | **GET** /teams/{id}/experiments_categories | Read experiments categories of a team.
-*ExperimentsCategoriesApi* | [**read_team_one_expcat**](docs/ExperimentsCategoriesApi.md#read_team_one_expcat) | **GET** /teams/{id}/experiments_categories/{subid} | Read a status.
+*ExperimentsCategoriesApi* | [**read_team_one_expcat**](docs/ExperimentsCategoriesApi.md#read_team_one_expcat) | **GET** /teams/{id}/experiments_categories/{subid} | Read a category.
 *ExperimentsStatusApi* | [**delete_expstatus**](docs/ExperimentsStatusApi.md#delete_expstatus) | **DELETE** /teams/{id}/experiments_status/{subid} | Delete a status.
 *ExperimentsStatusApi* | [**patch_expstatus**](docs/ExperimentsStatusApi.md#patch_expstatus) | **PATCH** /teams/{id}/experiments_status/{subid} | Modify a status.
 *ExperimentsStatusApi* | [**post_team_one_expstatus**](docs/ExperimentsStatusApi.md#post_team_one_expstatus) | **POST** /teams/{id}/experiments_status | Create a new experiments status.
@@ -142,6 +142,10 @@ Class | Method | HTTP request | Description
 *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* | [**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
+*ExportsApi* | [**read_export**](docs/ExportsApi.md#read_export) | **GET** /exports/{id} | Get export
+*ExportsApi* | [**readall_exports**](docs/ExportsApi.md#readall_exports) | **GET** /exports | List exports
 *ExtraFieldsKeysApi* | [**extra_fields_keys**](docs/ExtraFieldsKeysApi.md#extra_fields_keys) | **GET** /extra_fields_keys | Read extra fields keys.
 *FavoriteTagsApi* | [**delete_favtag**](docs/FavoriteTagsApi.md#delete_favtag) | **DELETE** /favtags/{id} | Unfavorite a tag.
 *FavoriteTagsApi* | [**post_favtags**](docs/FavoriteTagsApi.md#post_favtags) | **POST** /favtags | Add a tag as favorite.
@@ -151,6 +155,8 @@ Class | Method | HTTP request | Description
 *IdpsApi* | [**post_idp**](docs/IdpsApi.md#post_idp) | **POST** /idps | Create an idp.
 *IdpsApi* | [**read_idp**](docs/IdpsApi.md#read_idp) | **GET** /idps/{id} | Read an idp.
 *IdpsApi* | [**read_idps**](docs/IdpsApi.md#read_idps) | **GET** /idps | Read all IDPs.
+*ImportApi* | [**post_import**](docs/ImportApi.md#post_import) | **POST** /import | Send a file to import
+*ImportApi* | [**read_import**](docs/ImportApi.md#read_import) | **GET** /import | Get information about this endpoint
 *InfoApi* | [**get_info**](docs/InfoApi.md#get_info) | **GET** /info | Get information about the instance.
 *ItemsApi* | [**delete_item**](docs/ItemsApi.md#delete_item) | **DELETE** /items/{id} | Delete an item.
 *ItemsApi* | [**get_item**](docs/ItemsApi.md#get_item) | **GET** /items/{id} | Read an item
@@ -174,11 +180,10 @@ Class | Method | HTTP request | Description
 *NotificationsApi* | [**read_notifications**](docs/NotificationsApi.md#read_notifications) | **GET** /users/{id}/notifications | Read notifications of a user.
 *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 experiments status.
+*ResourcesStatusApi* | [**post_team_one_resstat**](docs/ResourcesStatusApi.md#post_team_one_resstat) | **POST** /teams/{id}/items_status | Create a new status for resources.
 *ResourcesStatusApi* | [**read_team_items_status**](docs/ResourcesStatusApi.md#read_team_items_status) | **GET** /teams/{id}/items_status | Read resources status of a team.
 *ResourcesStatusApi* | [**read_team_one_resstatus**](docs/ResourcesStatusApi.md#read_team_one_resstatus) | **GET** /teams/{id}/items_status/{subid} | Read a status.
 *RevisionsApi* | [**patch_entity_revision**](docs/RevisionsApi.md#patch_entity_revision) | **PATCH** /{entity_type}/{id}/revisions/{subid} | Restore a revision.
-*RevisionsApi* | [**post_entity_revisions**](docs/RevisionsApi.md#post_entity_revisions) | **POST** /{entity_type}/{id}/revisions | Create a revision.
 *RevisionsApi* | [**read_entity_revision**](docs/RevisionsApi.md#read_entity_revision) | **GET** /{entity_type}/{id}/revisions/{subid} | Read a revision of that entity.
 *RevisionsApi* | [**read_entity_revisions**](docs/RevisionsApi.md#read_entity_revisions) | **GET** /{entity_type}/{id}/revisions | Read all revisions of that entity.
 *StepsApi* | [**delete_step**](docs/StepsApi.md#delete_step) | **DELETE** /{entity_type}/{id}/steps/{subid} | Delete a step.
@@ -190,12 +195,12 @@ Class | Method | HTTP request | Description
 *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.
+*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.
+*TeamTagsApi* | [**read_team_tags**](docs/TeamTagsApi.md#read_team_tags) | **GET** /teams/{id}/tags | Read all tags for the team.
 *TeamgroupsApi* | [**delete_teamgroup**](docs/TeamgroupsApi.md#delete_teamgroup) | **DELETE** /teams/{id}/teamgroups/{subid} | Delete a teamgroup.
 *TeamgroupsApi* | [**patch_teamgroup**](docs/TeamgroupsApi.md#patch_teamgroup) | **PATCH** /teams/{id}/teamgroups/{subid} | Modify a teamgroup.
 *TeamgroupsApi* | [**post_teamgroups**](docs/TeamgroupsApi.md#post_teamgroups) | **POST** /teams/{id}/teamgroups | Create a new teamgroup.
@@ -217,6 +222,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.
+*UserUploadsApi* | [**read_user_uploads**](docs/UserUploadsApi.md#read_user_uploads) | **GET** /users/{id}/uploads | Read attached files from a user
 *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.
@@ -224,6 +230,7 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [AnyOfuploadsSubidBody1](docs/AnyOfuploadsSubidBody1.md)
  - [Apikey](docs/Apikey.md)
  - [ApikeysBody](docs/ApikeysBody.md)
  - [Comment](docs/Comment.md)
@@ -233,6 +240,7 @@ Class | Method | HTTP request | Description
  - [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)
@@ -240,24 +248,29 @@ Class | Method | HTTP request | Description
  - [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)
- - [IdRevisionsBody](docs/IdRevisionsBody.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)
  - [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)
@@ -266,6 +279,8 @@ Class | Method | HTTP request | Description
  - [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)
@@ -281,14 +296,13 @@ Class | Method | HTTP request | Description
  - [StepsSubidBody](docs/StepsSubidBody.md)
  - [Tag](docs/Tag.md)
  - [TagsSubidBody](docs/TagsSubidBody.md)
+ - [TagsSubidBody1](docs/TagsSubidBody1.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)
  - [TeamgroupsSubidBody](docs/TeamgroupsSubidBody.md)
  - [TeamsBody](docs/TeamsBody.md)
+ - [TeamsIdBody](docs/TeamsIdBody.md)
  - [Todoitem](docs/Todoitem.md)
  - [TodolistBody](docs/TodolistBody.md)
  - [TodolistIdBody](docs/TodolistIdBody.md)

{elabapi-python-5.0.2 → elabapi_python-5.1.0}/elabapi_python/__init__.py

@@ -23,9 +23,11 @@ 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
@@ -42,11 +44,13 @@ 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_client import ApiClient
 from elabapi_python.configuration import Configuration
 # import models into sdk package
+from elabapi_python.models.any_ofuploads_subid_body1 import AnyOfuploadsSubidBody1
 from elabapi_python.models.apikey import Apikey
 from elabapi_python.models.apikeys_body import ApikeysBody
 from elabapi_python.models.comment import Comment
@@ -56,6 +60,7 @@ from elabapi_python.models.event import Event
 from elabapi_python.models.event_id_body import EventIdBody
 from elabapi_python.models.eventid_delta import EventidDelta
 from elabapi_python.models.events_id_body import EventsIdBody
+from elabapi_python.models.exclusive_edit_mode import ExclusiveEditMode
 from elabapi_python.models.experiment import Experiment
 from elabapi_python.models.experiment_template import ExperimentTemplate
 from elabapi_python.models.experiments_body import ExperimentsBody
@@ -63,24 +68,29 @@ 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.export import Export
+from elabapi_python.models.exports_body import ExportsBody
 from elabapi_python.models.extra_fields_keys import ExtraFieldsKeys
 from elabapi_python.models.favtags_body import FavtagsBody
 from elabapi_python.models.id import Id
 from elabapi_python.models.id1 import Id1
 from elabapi_python.models.id2 import Id2
 from elabapi_python.models.id3 import Id3
+from elabapi_python.models.id4 import Id4
 from elabapi_python.models.id_comments_body import IdCommentsBody
 from elabapi_python.models.id_experiments_categories_body import IdExperimentsCategoriesBody
 from elabapi_python.models.id_experiments_status_body import IdExperimentsStatusBody
 from elabapi_python.models.id_items_status_body import IdItemsStatusBody
-from elabapi_python.models.id_revisions_body import IdRevisionsBody
 from elabapi_python.models.id_steps_body import IdStepsBody
 from elabapi_python.models.id_tags_body import IdTagsBody
+from elabapi_python.models.id_tags_body1 import IdTagsBody1
+from elabapi_python.models.id_tags_body2 import IdTagsBody2
 from elabapi_python.models.id_teamgroups_body import IdTeamgroupsBody
 from elabapi_python.models.id_uploads_body import IdUploadsBody
 from elabapi_python.models.idp import Idp
 from elabapi_python.models.idps_body import IdpsBody
 from elabapi_python.models.idps_id_body import IdpsIdBody
+from elabapi_python.models.import_body import ImportBody
 from elabapi_python.models.inline_response200 import InlineResponse200
 from elabapi_python.models.inline_response2001 import InlineResponse2001
 from elabapi_python.models.inline_response2002 import InlineResponse2002
@@ -89,6 +99,8 @@ from elabapi_python.models.inline_response2004 import InlineResponse2004
 from elabapi_python.models.inline_response2005 import InlineResponse2005
 from elabapi_python.models.inline_response2006 import InlineResponse2006
 from elabapi_python.models.inline_response2007 import InlineResponse2007
+from elabapi_python.models.inline_response2008 import InlineResponse2008
+from elabapi_python.models.inline_response2009 import InlineResponse2009
 from elabapi_python.models.item import Item
 from elabapi_python.models.items_body import ItemsBody
 from elabapi_python.models.items_id_body import ItemsIdBody
@@ -104,14 +116,13 @@ from elabapi_python.models.step import Step
 from elabapi_python.models.steps_subid_body import StepsSubidBody
 from elabapi_python.models.tag import Tag
 from elabapi_python.models.tags_subid_body import TagsSubidBody
+from elabapi_python.models.tags_subid_body1 import TagsSubidBody1
 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
 from elabapi_python.models.teamgroups_subid_body import TeamgroupsSubidBody
 from elabapi_python.models.teams_body import TeamsBody
+from elabapi_python.models.teams_id_body import TeamsIdBody
 from elabapi_python.models.todoitem import Todoitem
 from elabapi_python.models.todolist_body import TodolistBody
 from elabapi_python.models.todolist_id_body import TodolistIdBody

{elabapi-python-5.0.2 → elabapi_python-5.1.0}/elabapi_python/api/__init__.py

@@ -11,9 +11,11 @@ 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
@@ -30,4 +32,5 @@ 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

{elabapi-python-5.0.2 → elabapi_python-5.1.0}/elabapi_python/api/experiments_api.py

@@ -138,6 +138,10 @@ class ExperimentsApi(object):
         :param async_req bool
         :param int id: ID of the experiment (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\". 
+        :param bool json: Include a full JSON export in the ZIP archive. Only applicable if format is zip(a). 
+        :param bool with_title: Include the title in the QR code. Only applicable if format is qrpng. 
+        :param int size: Specify the size of the QR code in pixels. Only applicable if format is qrpng. 
+        :param bool changelog: Toggles if the changelog should be included in PDF exports (pdf, pdfa, zip, zipa). Changelog is by default included if the export provides PDF/A, otherwise not. 
         :return: Experiment
                  If the method is called asynchronously,
                  returns the request thread.
@@ -160,12 +164,16 @@ class ExperimentsApi(object):
         :param async_req bool
         :param int id: ID of the experiment (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\". 
+        :param bool json: Include a full JSON export in the ZIP archive. Only applicable if format is zip(a). 
+        :param bool with_title: Include the title in the QR code. Only applicable if format is qrpng. 
+        :param int size: Specify the size of the QR code in pixels. Only applicable if format is qrpng. 
+        :param bool changelog: Toggles if the changelog should be included in PDF exports (pdf, pdfa, zip, zipa). Changelog is by default included if the export provides PDF/A, otherwise not. 
         :return: Experiment
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['id', 'format']  # noqa: E501
+        all_params = ['id', 'format', 'json', 'with_title', 'size', 'changelog']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -194,6 +202,14 @@ class ExperimentsApi(object):
         query_params = []
         if 'format' in params:
             query_params.append(('format', params['format']))  # noqa: E501
+        if 'json' in params:
+            query_params.append(('json', params['json']))  # noqa: E501
+        if 'with_title' in params:
+            query_params.append(('withTitle', params['with_title']))  # noqa: E501
+        if 'size' in params:
+            query_params.append(('size', params['size']))  # noqa: E501
+        if 'changelog' in params:
+            query_params.append(('changelog', params['changelog']))  # noqa: E501
 
         header_params = {}
 
@@ -426,11 +442,15 @@ class ExperimentsApi(object):
         :param str q: Search for a term in title, body or elabid. 
         :param str extended: Extended search (advanced query). 
         :param int related: Look only for entries linked to this item id. 
+        :param str related_origin: When using the \"related\" query parameter, select the type of the related ID (experiments or items) 
         :param int cat: The status id of the experiments. 
         :param list[str] tags: An array of tags for filtering results containing all of these tags. 
         :param int limit: Limit the number of results. 
         :param int offset: Skip a number of results. Use with limit to work the pagination. 
         :param int owner: Filter results by author (user id) 
+        :param int scope: Set the scope for the results. 1: self, 2: team, 3: everything. It defaults to the user value stored in preferences. 
+        :param str order: Change the ordering of the results. 
+        :param str sort: Change the sorting of results: ascending or descending. 
         :return: list[Experiment]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -454,17 +474,21 @@ class ExperimentsApi(object):
         :param str q: Search for a term in title, body or elabid. 
         :param str extended: Extended search (advanced query). 
         :param int related: Look only for entries linked to this item id. 
+        :param str related_origin: When using the \"related\" query parameter, select the type of the related ID (experiments or items) 
         :param int cat: The status id of the experiments. 
         :param list[str] tags: An array of tags for filtering results containing all of these tags. 
         :param int limit: Limit the number of results. 
         :param int offset: Skip a number of results. Use with limit to work the pagination. 
         :param int owner: Filter results by author (user id) 
+        :param int scope: Set the scope for the results. 1: self, 2: team, 3: everything. It defaults to the user value stored in preferences. 
+        :param str order: Change the ordering of the results. 
+        :param str sort: Change the sorting of results: ascending or descending. 
         :return: list[Experiment]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['q', 'extended', 'related', 'cat', 'tags', 'limit', 'offset', 'owner']  # noqa: E501
+        all_params = ['q', 'extended', 'related', 'related_origin', 'cat', 'tags', 'limit', 'offset', 'owner', 'scope', 'order', 'sort']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -491,6 +515,8 @@ class ExperimentsApi(object):
             query_params.append(('extended', params['extended']))  # noqa: E501
         if 'related' in params:
             query_params.append(('related', params['related']))  # noqa: E501
+        if 'related_origin' in params:
+            query_params.append(('related_origin', params['related_origin']))  # noqa: E501
         if 'cat' in params:
             query_params.append(('cat', params['cat']))  # noqa: E501
         if 'tags' in params:
@@ -502,6 +528,12 @@ class ExperimentsApi(object):
             query_params.append(('offset', params['offset']))  # noqa: E501
         if 'owner' in params:
             query_params.append(('owner', params['owner']))  # noqa: E501
+        if 'scope' in params:
+            query_params.append(('scope', params['scope']))  # noqa: E501
+        if 'order' in params:
+            query_params.append(('order', params['order']))  # noqa: E501
+        if 'sort' in params:
+            query_params.append(('sort', params['sort']))  # noqa: E501
 
         header_params = {}
 

{elabapi-python-5.0.2 → elabapi_python-5.1.0}/elabapi_python/api/experiments_categories_api.py

@@ -42,7 +42,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param int subid: ID of the status (required)
+        :param int subid: ID of the category. (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -64,7 +64,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param int subid: ID of the status (required)
+        :param int subid: ID of the category. (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -143,7 +143,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param int subid: ID of the status (required)
+        :param int subid: ID of the category. (required)
         :param Statuslike body: Parameters for modifying a category.
         :return: Statuslike
                  If the method is called asynchronously,
@@ -166,7 +166,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param int subid: ID of the status (required)
+        :param int subid: ID of the category. (required)
         :param Statuslike body: Parameters for modifying a category.
         :return: Statuslike
                  If the method is called asynchronously,
@@ -243,7 +243,7 @@ class ExperimentsCategoriesApi(object):
             collection_formats=collection_formats)
 
     def post_team_one_expcat(self, id, **kwargs):  # noqa: E501
-        """Create a new experiments status.  # noqa: E501
+        """Create a new category for experiments.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -252,7 +252,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param IdExperimentsCategoriesBody body: Parameters for creating a status.
+        :param IdExperimentsCategoriesBody body: Parameters for creating a category.
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -265,7 +265,7 @@ class ExperimentsCategoriesApi(object):
             return data
 
     def post_team_one_expcat_with_http_info(self, id, **kwargs):  # noqa: E501
-        """Create a new experiments status.  # noqa: E501
+        """Create a new category for experiments.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -274,7 +274,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param IdExperimentsCategoriesBody body: Parameters for creating a status.
+        :param IdExperimentsCategoriesBody body: Parameters for creating a category.
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -433,7 +433,7 @@ class ExperimentsCategoriesApi(object):
             collection_formats=collection_formats)
 
     def read_team_one_expcat(self, id, subid, **kwargs):  # noqa: E501
-        """Read a status.  # noqa: E501
+        """Read a category.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -442,7 +442,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param int subid: ID of the status (required)
+        :param int subid: ID of the category. (required)
         :return: Statuslike
                  If the method is called asynchronously,
                  returns the request thread.
@@ -455,7 +455,7 @@ class ExperimentsCategoriesApi(object):
             return data
 
     def read_team_one_expcat_with_http_info(self, id, subid, **kwargs):  # noqa: E501
-        """Read a status.  # noqa: E501
+        """Read a category.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -464,7 +464,7 @@ class ExperimentsCategoriesApi(object):
 
         :param async_req bool
         :param int id: ID of the team. (required)
-        :param int subid: ID of the status (required)
+        :param int subid: ID of the category. (required)
         :return: Statuslike
                  If the method is called asynchronously,
                  returns the request thread.