elabapi-python 5.4.2__tar.gz → 5.5.0__tar.gz

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/PKG-INFO

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

{elabapi_python-5.4.2 → elabapi_python-5.5.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.4.2
+- Package version: 5.5.0
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -169,6 +169,11 @@ 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.
+*IdpsSourcesApi* | [**delete_idps_source**](docs/IdpsSourcesApi.md#delete_idps_source) | **DELETE** /idps_sources/{id} | Delete an idp source.
+*IdpsSourcesApi* | [**patch_idps_source**](docs/IdpsSourcesApi.md#patch_idps_source) | **PATCH** /idps_sources/{id} | Patch an idp source.
+*IdpsSourcesApi* | [**post_idp_source**](docs/IdpsSourcesApi.md#post_idp_source) | **POST** /idps_sources | Create an idp source.
+*IdpsSourcesApi* | [**read_idps_source**](docs/IdpsSourcesApi.md#read_idps_source) | **GET** /idps_sources/{id} | Read an IdPs source
+*IdpsSourcesApi* | [**read_idps_sources**](docs/IdpsSourcesApi.md#read_idps_sources) | **GET** /idps_sources | Read all IDPs sources
 *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.
@@ -219,7 +224,7 @@ Class | Method | HTTP request | Description
 *StorageUnitsApi* | [**patch_storage_unit**](docs/StorageUnitsApi.md#patch_storage_unit) | **PATCH** /storage_units/{id} | Modify a storage unit.
 *StorageUnitsApi* | [**post_storage_unit**](docs/StorageUnitsApi.md#post_storage_unit) | **POST** /storage_units | Create a new storage unit.
 *StorageUnitsApi* | [**read_storage_unit**](docs/StorageUnitsApi.md#read_storage_unit) | **GET** /storage_units/{id} | Read a storage unit.
-*StorageUnitsApi* | [**read_storage_units**](docs/StorageUnitsApi.md#read_storage_units) | **GET** /storage_units | Read all containers. Yes, the name of this endpoint should be `containers`, but it's not, deal with it.
+*StorageUnitsApi* | [**read_storage_units**](docs/StorageUnitsApi.md#read_storage_units) | **GET** /storage_units | Read all containers, or the storage unit hierarchy when `?hierarchy=true`.
 *TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /{entity_type}/{id}/tags | Delete all tags.
 *TagsApi* | [**patch_tag**](docs/TagsApi.md#patch_tag) | **PATCH** /{entity_type}/{id}/tags/{subid} | Actions on a tag (like removing it from the entity). 
 *TagsApi* | [**post_tag**](docs/TagsApi.md#post_tag) | **POST** /{entity_type}/{id}/tags | Create a tag.
@@ -315,8 +320,11 @@ Class | Method | HTTP request | Description
  - [Idp](docs/Idp.md)
  - [IdpCert](docs/IdpCert.md)
  - [IdpEndpoint](docs/IdpEndpoint.md)
+ - [IdpSource](docs/IdpSource.md)
  - [IdpsBody](docs/IdpsBody.md)
  - [IdpsIdBody](docs/IdpsIdBody.md)
+ - [IdpsSourcesBody](docs/IdpsSourcesBody.md)
+ - [IdpsSourcesIdBody](docs/IdpsSourcesIdBody.md)
  - [ImportBody](docs/ImportBody.md)
  - [InlineResponse200](docs/InlineResponse200.md)
  - [InlineResponse2001](docs/InlineResponse2001.md)

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/elabapi_python/__init__.py

@@ -30,6 +30,7 @@ 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.idps_sources_api import IdpsSourcesApi
 from elabapi_python.api.import_api import ImportApi
 from elabapi_python.api.info_api import InfoApi
 from elabapi_python.api.items_api import ItemsApi
@@ -113,8 +114,11 @@ from elabapi_python.models.id_uploads_body import IdUploadsBody
 from elabapi_python.models.idp import Idp
 from elabapi_python.models.idp_cert import IdpCert
 from elabapi_python.models.idp_endpoint import IdpEndpoint
+from elabapi_python.models.idp_source import IdpSource
 from elabapi_python.models.idps_body import IdpsBody
 from elabapi_python.models.idps_id_body import IdpsIdBody
+from elabapi_python.models.idps_sources_body import IdpsSourcesBody
+from elabapi_python.models.idps_sources_id_body import IdpsSourcesIdBody
 from elabapi_python.models.import_body import ImportBody
 from elabapi_python.models.inline_response200 import InlineResponse200
 from elabapi_python.models.inline_response2001 import InlineResponse2001

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/elabapi_python/api/__init__.py

@@ -18,6 +18,7 @@ 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.idps_sources_api import IdpsSourcesApi
 from elabapi_python.api.import_api import ImportApi
 from elabapi_python.api.info_api import InfoApi
 from elabapi_python.api.items_api import ItemsApi

elabapi_python-5.5.0/elabapi_python/api/idps_sources_api.py

@@ -0,0 +1,500 @@
+# coding: utf-8
+
+"""
+    eLabFTW REST API v2 Documentation
+
+    This document describes all available endpoints and methods for eLabFTW's API version 2.   # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from elabapi_python.api_client import ApiClient
+
+
+class IdpsSourcesApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def delete_idps_source(self, id, **kwargs):  # noqa: E501
+        """Delete an idp source.  # noqa: E501
+
+        The idp source gets 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_idps_source(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the idps source (required)
+        :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.delete_idps_source_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_idps_source_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def delete_idps_source_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Delete an idp source.  # noqa: E501
+
+        The idp source gets 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_idps_source_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the idps source (required)
+        :return: None
+                 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 delete_idps_source" % 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 `delete_idps_source`")  # 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(
+            '/idps_sources/{id}', 'DELETE',
+            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 patch_idps_source(self, id, **kwargs):  # noqa: E501
+        """Patch an idp source.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.patch_idps_source(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the idps source (required)
+        :param IdpsSourcesIdBody body: Parameters for patching an idp source.
+        :return: IdpSource
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.patch_idps_source_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.patch_idps_source_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def patch_idps_source_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Patch an idp source.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.patch_idps_source_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the idps source (required)
+        :param IdpsSourcesIdBody body: Parameters for patching an idp source.
+        :return: IdpSource
+                 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 patch_idps_source" % 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 `patch_idps_source`")  # 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 `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/idps_sources/{id}', 'PATCH',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='IdpSource',  # 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 post_idp_source(self, **kwargs):  # noqa: E501
+        """Create an idp source.  # 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_idp_source(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param IdpsSourcesBody body: Parameters for creating an idp source.
+        :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_idp_source_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.post_idp_source_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def post_idp_source_with_http_info(self, **kwargs):  # noqa: E501
+        """Create an idp source.  # 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_idp_source_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param IdpsSourcesBody body: Parameters for creating an idp source.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['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_idp_source" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            body_params = params['body']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/idps_sources', '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_idps_source(self, id, **kwargs):  # noqa: E501
+        """Read an IdPs source  # 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_idps_source(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the idps source (required)
+        :return: IdpSource
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.read_idps_source_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.read_idps_source_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def read_idps_source_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Read an IdPs source  # 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_idps_source_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the idps source (required)
+        :return: IdpSource
+                 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_idps_source" % 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_idps_source`")  # 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(
+            '/idps_sources/{id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='IdpSource',  # 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_idps_sources(self, **kwargs):  # noqa: E501
+        """Read all IDPs sources  # 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_idps_sources(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: list[IdpSource]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.read_idps_sources_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.read_idps_sources_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def read_idps_sources_with_http_info(self, **kwargs):  # noqa: E501
+        """Read all IDPs sources  # 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_idps_sources_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: list[IdpSource]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = []  # 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_idps_sources" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        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(
+            '/idps_sources', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[IdpSource]',  # 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)

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/elabapi_python/api/storage_units_api.py

@@ -425,16 +425,17 @@ class StorageUnitsApi(object):
             collection_formats=collection_formats)
 
     def read_storage_units(self, **kwargs):  # noqa: E501
-        """Read all containers. Yes, the name of this endpoint should be `containers`, but it's not, deal with it.  # noqa: E501
+        """Read all containers, or the storage unit hierarchy when `?hierarchy=true`.  # noqa: E501
 
-        Get the full list of containers from entries you have access to.  # noqa: E501
+        Without parameters, returns the full list of containers (assignments of experiments or resources to storage locations) that you have access to.  With `?hierarchy=true`, returns a flat list of all storage units (freezers, boxes, positions, etc.) with their hierarchy metadata (`id`, `name`, `parent_id`, `full_path`, `level_depth`, `children_count`). This allows clients to discover, traverse, or display the storage unit tree.   # 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_storage_units(async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :return: list[InlineResponse200]
+        :param bool hierarchy: When true, returns a flat list of all storage units in the hierarchy (id, name, parent_id, full_path, level_depth, children_count) instead of the default container assignment list. 
+        :return: InlineResponse200
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -446,21 +447,22 @@ class StorageUnitsApi(object):
             return data
 
     def read_storage_units_with_http_info(self, **kwargs):  # noqa: E501
-        """Read all containers. Yes, the name of this endpoint should be `containers`, but it's not, deal with it.  # noqa: E501
+        """Read all containers, or the storage unit hierarchy when `?hierarchy=true`.  # noqa: E501
 
-        Get the full list of containers from entries you have access to.  # noqa: E501
+        Without parameters, returns the full list of containers (assignments of experiments or resources to storage locations) that you have access to.  With `?hierarchy=true`, returns a flat list of all storage units (freezers, boxes, positions, etc.) with their hierarchy metadata (`id`, `name`, `parent_id`, `full_path`, `level_depth`, `children_count`). This allows clients to discover, traverse, or display the storage unit tree.   # 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_storage_units_with_http_info(async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :return: list[InlineResponse200]
+        :param bool hierarchy: When true, returns a flat list of all storage units in the hierarchy (id, name, parent_id, full_path, level_depth, children_count) instead of the default container assignment list. 
+        :return: InlineResponse200
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = []  # noqa: E501
+        all_params = ['hierarchy']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -481,6 +483,8 @@ class StorageUnitsApi(object):
         path_params = {}
 
         query_params = []
+        if 'hierarchy' in params:
+            query_params.append(('hierarchy', params['hierarchy']))  # noqa: E501
 
         header_params = {}
 
@@ -503,7 +507,7 @@ class StorageUnitsApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='list[InlineResponse200]',  # noqa: E501
+            response_type='InlineResponse200',  # noqa: E501
             auth_settings=auth_settings,
             async_req=params.get('async_req'),
             _return_http_data_only=params.get('_return_http_data_only'),

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/elabapi_python/api_client.py

@@ -72,7 +72,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/5.4.2/python'
+        self.user_agent = 'Swagger-Codegen/5.5.0/python'
 
     def __del__(self):
         self.pool.close()

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/elabapi_python/configuration.py

@@ -250,5 +250,5 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 5.4.2".\
+               "SDK Package Version: 5.5.0".\
                format(env=sys.platform, pyversion=sys.version)

{elabapi_python-5.4.2 → elabapi_python-5.5.0}/elabapi_python/models/__init__.py

@@ -70,8 +70,11 @@ from elabapi_python.models.id_uploads_body import IdUploadsBody
 from elabapi_python.models.idp import Idp
 from elabapi_python.models.idp_cert import IdpCert
 from elabapi_python.models.idp_endpoint import IdpEndpoint
+from elabapi_python.models.idp_source import IdpSource
 from elabapi_python.models.idps_body import IdpsBody
 from elabapi_python.models.idps_id_body import IdpsIdBody
+from elabapi_python.models.idps_sources_body import IdpsSourcesBody
+from elabapi_python.models.idps_sources_id_body import IdpsSourcesIdBody
 from elabapi_python.models.import_body import ImportBody
 from elabapi_python.models.inline_response200 import InlineResponse200
 from elabapi_python.models.inline_response2001 import InlineResponse2001