elabapi-python 0.3.1__tar.gz → 0.4.1__tar.gz

{elabapi-python-0.3.1 → elabapi-python-0.4.1}/PKG-INFO

@@ -1,10 +1,14 @@
 Metadata-Version: 2.1
 Name: elabapi-python
-Version: 0.3.1
+Version: 0.4.1
 Summary: eLabFTW REST API v2 Documentation
 Home-page: https://github.com/elabftw/elabapi-python
 Author-email: 
 Keywords: Swagger,eLabFTW REST API v2 Documentation
+Requires-Dist: urllib3>=1.15
+Requires-Dist: six>=1.10
+Requires-Dist: certifi
+Requires-Dist: python-dateutil
 
     This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
     

{elabapi-python-0.3.1 → elabapi-python-0.4.1}/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: 0.3.1
+- Package version: 0.4.1
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -118,14 +118,25 @@ Class | Method | HTTP request | Description
 *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
 *EventsApi* | [**delete_event**](docs/EventsApi.md#delete_event) | **DELETE** /event/{id} | Delete a booking slot.
-*EventsApi* | [**patch_event**](docs/EventsApi.md#patch_event) | **PATCH** /events/{id} | Modify a booking slot. Warning: only one value (target) can be edited at a time. 
+*EventsApi* | [**patch_event**](docs/EventsApi.md#patch_event) | **PATCH** /event/{id} | Modify a booking slot. Warning: only one value (target) can be edited at a time. 
 *EventsApi* | [**post_events**](docs/EventsApi.md#post_events) | **POST** /events/{id} | Create an event for the item specified as id.
+*EventsApi* | [**read_event**](docs/EventsApi.md#read_event) | **GET** /event/{id} | Read a booking slot.
 *EventsApi* | [**read_events**](docs/EventsApi.md#read_events) | **GET** /events | Read all events in the team.
 *ExperimentsApi* | [**delete_experiment**](docs/ExperimentsApi.md#delete_experiment) | **DELETE** /experiments/{id} | Delete an experiment.
 *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* | [**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* | [**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.
+*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.
+*ExperimentsStatusApi* | [**read_team_experiments_status**](docs/ExperimentsStatusApi.md#read_team_experiments_status) | **GET** /teams/{id}/experiments_status | Read experiments status of a team.
+*ExperimentsStatusApi* | [**read_team_one_expstatus**](docs/ExperimentsStatusApi.md#read_team_one_expstatus) | **GET** /teams/{id}/experiments_status/{subid} | Read a status.
 *ExperimentsTemplatesApi* | [**delete_experiment_template**](docs/ExperimentsTemplatesApi.md#delete_experiment_template) | **DELETE** /experiments_templates/{id} | Delete an experiment template.
 *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
@@ -145,11 +156,11 @@ Class | Method | HTTP request | Description
 *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* | [**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 an item type.
-*ItemsTypesApi* | [**get_items_type**](docs/ItemsTypesApi.md#get_items_type) | **GET** /items_types/{id} | Read an items type
-*ItemsTypesApi* | [**patch_items_type**](docs/ItemsTypesApi.md#patch_items_type) | **PATCH** /items_types/{id} | Modify an item type
-*ItemsTypesApi* | [**post_items_types**](docs/ItemsTypesApi.md#post_items_types) | **POST** /items_types | Create an item
-*ItemsTypesApi* | [**read_items_types**](docs/ItemsTypesApi.md#read_items_types) | **GET** /items_types | Read all items_types 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.
+*ItemsTypesApi* | [**patch_items_type**](docs/ItemsTypesApi.md#patch_items_type) | **PATCH** /items_types/{id} | Modify a resource category.
+*ItemsTypesApi* | [**post_items_types**](docs/ItemsTypesApi.md#post_items_types) | **POST** /items_types | Create a resource category
+*ItemsTypesApi* | [**read_items_types**](docs/ItemsTypesApi.md#read_items_types) | **GET** /items_types | Read all resources categories that are accessible.
 *LinksToExperimentsApi* | [**delete_entity_experiments_link**](docs/LinksToExperimentsApi.md#delete_entity_experiments_link) | **DELETE** /{entity_type}/{id}/experiments_links/{subid} | Delete an experiment link.
 *LinksToExperimentsApi* | [**post_entity_experiments_links**](docs/LinksToExperimentsApi.md#post_entity_experiments_links) | **POST** /{entity_type}/{id}/experiments_links/{subid} | Create or import a link.
 *LinksToExperimentsApi* | [**read_entity_experiments_links**](docs/LinksToExperimentsApi.md#read_entity_experiments_links) | **GET** /{entity_type}/{id}/experiments_links | Read all experiments links of that entity.
@@ -160,15 +171,15 @@ 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.
+*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* | [**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.
-*StatusApi* | [**delete_status**](docs/StatusApi.md#delete_status) | **DELETE** /teams/{id}/status/{subid} | Delete a status.
-*StatusApi* | [**patch_status**](docs/StatusApi.md#patch_status) | **PATCH** /teams/{id}/status/{subid} | Modify a status.
-*StatusApi* | [**post_team_one_status**](docs/StatusApi.md#post_team_one_status) | **POST** /teams/{id}/status | Create a new status.
-*StatusApi* | [**read_team_one_status**](docs/StatusApi.md#read_team_one_status) | **GET** /teams/{id}/status/{subid} | Read a status.
-*StatusApi* | [**read_team_status**](docs/StatusApi.md#read_team_status) | **GET** /teams/{id}/status | Read status of a team.
 *StepsApi* | [**delete_step**](docs/StepsApi.md#delete_step) | **DELETE** /{entity_type}/{id}/steps/{subid} | Delete a step.
 *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.
@@ -218,9 +229,9 @@ Class | Method | HTTP request | Description
  - [Config](docs/Config.md)
  - [Entity](docs/Entity.md)
  - [Event](docs/Event.md)
+ - [EventIdBody](docs/EventIdBody.md)
+ - [EventidDelta](docs/EventidDelta.md)
  - [EventsIdBody](docs/EventsIdBody.md)
- - [EventsIdBody1](docs/EventsIdBody1.md)
- - [EventsidDelta](docs/EventsidDelta.md)
  - [Experiment](docs/Experiment.md)
  - [ExperimentTemplate](docs/ExperimentTemplate.md)
  - [ExperimentsBody](docs/ExperimentsBody.md)
@@ -234,8 +245,10 @@ Class | Method | HTTP request | Description
  - [Id2](docs/Id2.md)
  - [Id3](docs/Id3.md)
  - [IdCommentsBody](docs/IdCommentsBody.md)
+ - [IdExperimentsCategoriesBody](docs/IdExperimentsCategoriesBody.md)
+ - [IdExperimentsStatusBody](docs/IdExperimentsStatusBody.md)
+ - [IdItemsStatusBody](docs/IdItemsStatusBody.md)
  - [IdRevisionsBody](docs/IdRevisionsBody.md)
- - [IdStatusBody](docs/IdStatusBody.md)
  - [IdStepsBody](docs/IdStepsBody.md)
  - [IdTagsBody](docs/IdTagsBody.md)
  - [IdTeamgroupsBody](docs/IdTeamgroupsBody.md)
@@ -261,7 +274,7 @@ Class | Method | HTTP request | Description
  - [Notification](docs/Notification.md)
  - [Revision](docs/Revision.md)
  - [RevisionsSubidBody](docs/RevisionsSubidBody.md)
- - [Status](docs/Status.md)
+ - [Statuslike](docs/Statuslike.md)
  - [Step](docs/Step.md)
  - [StepsSubidBody](docs/StepsSubidBody.md)
  - [Tag](docs/Tag.md)

{elabapi-python-0.3.1 → elabapi-python-0.4.1}/elabapi_python/__init__.py

@@ -20,6 +20,8 @@ from elabapi_python.api.comments_api import CommentsApi
 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.favorite_tags_api import FavoriteTagsApi
 from elabapi_python.api.idps_api import IdpsApi
@@ -29,8 +31,8 @@ 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.resources_status_api import ResourcesStatusApi
 from elabapi_python.api.revisions_api import RevisionsApi
-from elabapi_python.api.status_api import StatusApi
 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
@@ -50,9 +52,9 @@ from elabapi_python.models.comment import Comment
 from elabapi_python.models.config import Config
 from elabapi_python.models.entity import Entity
 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.events_id_body1 import EventsIdBody1
-from elabapi_python.models.eventsid_delta import EventsidDelta
 from elabapi_python.models.experiment import Experiment
 from elabapi_python.models.experiment_template import ExperimentTemplate
 from elabapi_python.models.experiments_body import ExperimentsBody
@@ -66,8 +68,10 @@ 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.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_status_body import IdStatusBody
 from elabapi_python.models.id_steps_body import IdStepsBody
 from elabapi_python.models.id_tags_body import IdTagsBody
 from elabapi_python.models.id_teamgroups_body import IdTeamgroupsBody
@@ -93,7 +97,7 @@ from elabapi_python.models.link import Link
 from elabapi_python.models.notification import Notification
 from elabapi_python.models.revision import Revision
 from elabapi_python.models.revisions_subid_body import RevisionsSubidBody
-from elabapi_python.models.status import Status
+from elabapi_python.models.statuslike import Statuslike
 from elabapi_python.models.step import Step
 from elabapi_python.models.steps_subid_body import StepsSubidBody
 from elabapi_python.models.tag import Tag

{elabapi-python-0.3.1 → elabapi-python-0.4.1}/elabapi_python/api/__init__.py

@@ -8,6 +8,8 @@ from elabapi_python.api.comments_api import CommentsApi
 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.favorite_tags_api import FavoriteTagsApi
 from elabapi_python.api.idps_api import IdpsApi
@@ -17,8 +19,8 @@ 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.resources_status_api import ResourcesStatusApi
 from elabapi_python.api.revisions_api import RevisionsApi
-from elabapi_python.api.status_api import StatusApi
 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

{elabapi-python-0.3.1 → elabapi-python-0.4.1}/elabapi_python/api/events_api.py

@@ -134,8 +134,8 @@ class EventsApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the item to book. (required)
-        :param EventsIdBody1 body: Parameters for modifying an event.
+        :param int id: ID of the event to modify. (required)
+        :param EventIdBody body: Parameters for modifying an event.
         :return: Event
                  If the method is called asynchronously,
                  returns the request thread.
@@ -156,8 +156,8 @@ class EventsApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the item to book. (required)
-        :param EventsIdBody1 body: Parameters for modifying an event.
+        :param int id: ID of the event to modify. (required)
+        :param EventIdBody body: Parameters for modifying an event.
         :return: Event
                  If the method is called asynchronously,
                  returns the request thread.
@@ -211,7 +211,7 @@ class EventsApi(object):
         auth_settings = ['token']  # noqa: E501
 
         return self.api_client.call_api(
-            '/events/{id}', 'PATCH',
+            '/event/{id}', 'PATCH',
             path_params,
             query_params,
             header_params,
@@ -323,6 +323,99 @@ class EventsApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def read_event(self, id, **kwargs):  # noqa: E501
+        """Read a booking slot.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.read_event(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the event to modify. (required)
+        :return: Event
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.read_event_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.read_event_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def read_event_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Read a booking slot.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.read_event_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the event to modify. (required)
+        :return: Event
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['id']  # 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 read_event" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'id' is set
+        if ('id' not in params or
+                params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `read_event`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/event/{id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Event',  # 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_events(self, **kwargs):  # noqa: E501
         """Read all events in the team.  # noqa: E501