elabapi-python 5.3.0__tar.gz → 5.3.1__tar.gz

{elabapi_python-5.3.0 → elabapi_python-5.3.1}/PKG-INFO

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

{elabapi_python-5.3.0 → elabapi_python-5.3.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: 5.3.0
+- Package version: 5.3.1
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -170,11 +170,12 @@ Class | Method | HTTP request | Description
 *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.
-*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.
+*ItemsTypesResourcesTemplatesApi* | [**delete_items_type**](docs/ItemsTypesResourcesTemplatesApi.md#delete_items_type) | **DELETE** /items_types/{id} | Delete a resource template.
+*ItemsTypesResourcesTemplatesApi* | [**get_items_type**](docs/ItemsTypesResourcesTemplatesApi.md#get_items_type) | **GET** /items_types/{id} | Read a resource template
+*ItemsTypesResourcesTemplatesApi* | [**patch_items_type**](docs/ItemsTypesResourcesTemplatesApi.md#patch_items_type) | **PATCH** /items_types/{id} | Modify a resource template
+*ItemsTypesResourcesTemplatesApi* | [**post_items_types**](docs/ItemsTypesResourcesTemplatesApi.md#post_items_types) | **POST** /items_types | Create a resource template
+*ItemsTypesResourcesTemplatesApi* | [**post_items_types_by_id**](docs/ItemsTypesResourcesTemplatesApi.md#post_items_types_by_id) | **POST** /items_types/{id} | Duplicate a resource template with its ID
+*ItemsTypesResourcesTemplatesApi* | [**read_items_types**](docs/ItemsTypesResourcesTemplatesApi.md#read_items_types) | **GET** /items_types | Read all resources templates 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.
@@ -186,6 +187,11 @@ Class | Method | HTTP request | Description
 *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
+*ResourcesCategoriesApi* | [**delete_rescat**](docs/ResourcesCategoriesApi.md#delete_rescat) | **DELETE** /teams/{id}/resources_categories/{subid} | Delete a category.
+*ResourcesCategoriesApi* | [**patch_rescat**](docs/ResourcesCategoriesApi.md#patch_rescat) | **PATCH** /teams/{id}/resources_categories/{subid} | Modify a category.
+*ResourcesCategoriesApi* | [**post_team_one_rescat**](docs/ResourcesCategoriesApi.md#post_team_one_rescat) | **POST** /teams/{id}/resources_categories | Create a new category for resources.
+*ResourcesCategoriesApi* | [**read_team_one_rescat**](docs/ResourcesCategoriesApi.md#read_team_one_rescat) | **GET** /teams/{id}/resources_categories/{subid} | Read a category.
+*ResourcesCategoriesApi* | [**read_team_resources_categories**](docs/ResourcesCategoriesApi.md#read_team_resources_categories) | **GET** /teams/{id}/resources_categories | Read resources categories of a team.
 *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.
@@ -275,6 +281,7 @@ Class | Method | HTTP request | Description
  - [IdExperimentsCategoriesBody](docs/IdExperimentsCategoriesBody.md)
  - [IdExperimentsStatusBody](docs/IdExperimentsStatusBody.md)
  - [IdItemsStatusBody](docs/IdItemsStatusBody.md)
+ - [IdResourcesCategoriesBody](docs/IdResourcesCategoriesBody.md)
  - [IdStepsBody](docs/IdStepsBody.md)
  - [IdTagsBody](docs/IdTagsBody.md)
  - [IdTagsBody1](docs/IdTagsBody1.md)
@@ -297,8 +304,8 @@ Class | Method | HTTP request | Description
  - [ItemsIdBody](docs/ItemsIdBody.md)
  - [ItemsIdBody1](docs/ItemsIdBody1.md)
  - [ItemsLinksSubidBody](docs/ItemsLinksSubidBody.md)
- - [ItemsType](docs/ItemsType.md)
- - [ItemsTypesBody](docs/ItemsTypesBody.md)
+ - [ItemsTypesIdBody](docs/ItemsTypesIdBody.md)
+ - [ItemsTypesIdBody1](docs/ItemsTypesIdBody1.md)
  - [Link](docs/Link.md)
  - [Metadata](docs/Metadata.md)
  - [MetadataElabftw](docs/MetadataElabftw.md)

{elabapi_python-5.3.0 → elabapi_python-5.3.1}/elabapi_python/__init__.py

@@ -31,11 +31,12 @@ 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.items_types__resources_templates_api import ItemsTypesResourcesTemplatesApi
 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_categories_api import ResourcesCategoriesApi
 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
@@ -90,6 +91,7 @@ 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_resources_categories_body import IdResourcesCategoriesBody
 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
@@ -112,8 +114,8 @@ from elabapi_python.models.item import Item
 from elabapi_python.models.items_id_body import ItemsIdBody
 from elabapi_python.models.items_id_body1 import ItemsIdBody1
 from elabapi_python.models.items_links_subid_body import ItemsLinksSubidBody
-from elabapi_python.models.items_type import ItemsType
-from elabapi_python.models.items_types_body import ItemsTypesBody
+from elabapi_python.models.items_types_id_body import ItemsTypesIdBody
+from elabapi_python.models.items_types_id_body1 import ItemsTypesIdBody1
 from elabapi_python.models.link import Link
 from elabapi_python.models.metadata import Metadata
 from elabapi_python.models.metadata_elabftw import MetadataElabftw

{elabapi_python-5.3.0 → elabapi_python-5.3.1}/elabapi_python/api/__init__.py

@@ -19,11 +19,12 @@ 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.items_types__resources_templates_api import ItemsTypesResourcesTemplatesApi
 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_categories_api import ResourcesCategoriesApi
 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

elabapi_python-5.3.0/elabapi_python/api/items_types_api.py → elabapi_python-5.3.1/elabapi_python/api/items_types__resources_templates_api.py

@@ -20,7 +20,7 @@ import six
 from elabapi_python.api_client import ApiClient
 
 
-class ItemsTypesApi(object):
+class ItemsTypesResourcesTemplatesApi(object):
     """NOTE: This class is auto generated by the swagger code generator program.
 
     Do not edit the class manually.
@@ -33,16 +33,16 @@ class ItemsTypesApi(object):
         self.api_client = api_client
 
     def delete_items_type(self, id, **kwargs):  # noqa: E501
-        """Delete a resource category.  # noqa: E501
+        """Delete a resource template.  # noqa: E501
 
-        The resource category gets soft-deleted.  # noqa: E501
+        The resource template gets soft-deleted.  # 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_items_type(id, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the resource category. (required)
+        :param int id: ID of the resource template (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -55,16 +55,16 @@ class ItemsTypesApi(object):
             return data
 
     def delete_items_type_with_http_info(self, id, **kwargs):  # noqa: E501
-        """Delete a resource category.  # noqa: E501
+        """Delete a resource template.  # noqa: E501
 
-        The resource category gets soft-deleted.  # noqa: E501
+        The resource template gets soft-deleted.  # 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_items_type_with_http_info(id, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the resource category. (required)
+        :param int id: ID of the resource template (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -124,7 +124,7 @@ class ItemsTypesApi(object):
             collection_formats=collection_formats)
 
     def get_items_type(self, id, **kwargs):  # noqa: E501
-        """Read a resource category.  # noqa: E501
+        """Read a resource template  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -132,8 +132,8 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the resource category. (required)
-        :return: ItemsType
+        :param int id: ID of the resource template (required)
+        :return: EntityTemplate
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -145,7 +145,7 @@ class ItemsTypesApi(object):
             return data
 
     def get_items_type_with_http_info(self, id, **kwargs):  # noqa: E501
-        """Read a resource category.  # noqa: E501
+        """Read a resource template  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -153,8 +153,8 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the resource category. (required)
-        :return: ItemsType
+        :param int id: ID of the resource template (required)
+        :return: EntityTemplate
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -208,7 +208,7 @@ class ItemsTypesApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='ItemsType',  # noqa: E501
+            response_type='EntityTemplate',  # noqa: E501
             auth_settings=auth_settings,
             async_req=params.get('async_req'),
             _return_http_data_only=params.get('_return_http_data_only'),
@@ -217,7 +217,7 @@ class ItemsTypesApi(object):
             collection_formats=collection_formats)
 
     def patch_items_type(self, id, **kwargs):  # noqa: E501
-        """Modify a resource category.  # noqa: E501
+        """Modify a resource template  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -225,9 +225,9 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the resource category. (required)
-        :param ItemsType body:
-        :return: ItemsType
+        :param int id: ID of the resource template (required)
+        :param ItemsTypesIdBody1 body: Parameters for modifying a resource template
+        :return: EntityTemplate
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -239,7 +239,7 @@ class ItemsTypesApi(object):
             return data
 
     def patch_items_type_with_http_info(self, id, **kwargs):  # noqa: E501
-        """Modify a resource category.  # noqa: E501
+        """Modify a resource template  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -247,9 +247,9 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the resource category. (required)
-        :param ItemsType body:
-        :return: ItemsType
+        :param int id: ID of the resource template (required)
+        :param ItemsTypesIdBody1 body: Parameters for modifying a resource template
+        :return: EntityTemplate
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -309,7 +309,7 @@ class ItemsTypesApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='ItemsType',  # noqa: E501
+            response_type='EntityTemplate',  # noqa: E501
             auth_settings=auth_settings,
             async_req=params.get('async_req'),
             _return_http_data_only=params.get('_return_http_data_only'),
@@ -318,7 +318,7 @@ class ItemsTypesApi(object):
             collection_formats=collection_formats)
 
     def post_items_types(self, **kwargs):  # noqa: E501
-        """Create a resource category  # noqa: E501
+        """Create a resource template  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -326,7 +326,7 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param ItemsTypesBody body: Parameters for creating a resource category
+        :param EntityTemplateEditable body: Parameters for creating a resource template
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -339,7 +339,7 @@ class ItemsTypesApi(object):
             return data
 
     def post_items_types_with_http_info(self, **kwargs):  # noqa: E501
-        """Create a resource category  # noqa: E501
+        """Create a resource template  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -347,7 +347,7 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param ItemsTypesBody body: Parameters for creating a resource category
+        :param EntityTemplateEditable body: Parameters for creating a resource template
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -406,8 +406,105 @@ class ItemsTypesApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def post_items_types_by_id(self, id, **kwargs):  # noqa: E501
+        """Duplicate a resource template with its ID  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.post_items_types_by_id(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: The unique identifier of the resource template to duplicate. (required)
+        :param ItemsTypesIdBody body: Parameters for duplicating a resource template
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.post_items_types_by_id_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.post_items_types_by_id_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def post_items_types_by_id_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Duplicate a resource template with its ID  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.post_items_types_by_id_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: The unique identifier of the resource template to duplicate. (required)
+        :param ItemsTypesIdBody body: Parameters for duplicating a resource template
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['id', 'body']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method post_items_types_by_id" % 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 `post_items_types_by_id`")  # 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
+        if 'body' in params:
+            body_params = params['body']
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/items_types/{id}', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def read_items_types(self, **kwargs):  # noqa: E501
-        """Read all resources categories that are accessible.  # noqa: E501
+        """Read all resources templates that are accessible  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -415,7 +512,7 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :return: list[ItemsType]
+        :return: list[EntityTemplate]
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -427,7 +524,7 @@ class ItemsTypesApi(object):
             return data
 
     def read_items_types_with_http_info(self, **kwargs):  # noqa: E501
-        """Read all resources categories that are accessible.  # noqa: E501
+        """Read all resources templates that are accessible  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -435,7 +532,7 @@ class ItemsTypesApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :return: list[ItemsType]
+        :return: list[EntityTemplate]
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -483,7 +580,7 @@ class ItemsTypesApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='list[ItemsType]',  # noqa: E501
+            response_type='list[EntityTemplate]',  # noqa: E501
             auth_settings=auth_settings,
             async_req=params.get('async_req'),
             _return_http_data_only=params.get('_return_http_data_only'),