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

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

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

{elabapi_python-5.4.1 → elabapi_python-5.4.2}/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.1
+- Package version: 5.4.2
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -219,7 +219,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, or the storage unit hierarchy when `?hierarchy=true`.
+*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.
 *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.

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

@@ -425,17 +425,16 @@ class StorageUnitsApi(object):
             collection_formats=collection_formats)
 
     def read_storage_units(self, **kwargs):  # noqa: E501
-        """Read all containers, or the storage unit hierarchy when `?hierarchy=true`.  # noqa: E501
+        """Read all containers. Yes, the name of this endpoint should be `containers`, but it's not, deal with it.  # 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
+        Get the full list of containers from entries you have access to.  # 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
-        :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
+        :return: list[InlineResponse200]
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -447,22 +446,21 @@ class StorageUnitsApi(object):
             return data
 
     def read_storage_units_with_http_info(self, **kwargs):  # noqa: E501
-        """Read all containers, or the storage unit hierarchy when `?hierarchy=true`.  # noqa: E501
+        """Read all containers. Yes, the name of this endpoint should be `containers`, but it's not, deal with it.  # 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
+        Get the full list of containers from entries you have access to.  # 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
-        :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
+        :return: list[InlineResponse200]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['hierarchy']  # noqa: E501
+        all_params = []  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -483,8 +481,6 @@ class StorageUnitsApi(object):
         path_params = {}
 
         query_params = []
-        if 'hierarchy' in params:
-            query_params.append(('hierarchy', params['hierarchy']))  # noqa: E501
 
         header_params = {}
 
@@ -507,7 +503,7 @@ class StorageUnitsApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='InlineResponse200',  # noqa: E501
+            response_type='list[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.1 → elabapi_python-5.4.2}/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.1/python'
+        self.user_agent = 'Swagger-Codegen/5.4.2/python'
 
     def __del__(self):
         self.pool.close()

{elabapi_python-5.4.1 → elabapi_python-5.4.2}/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.1".\
+               "SDK Package Version: 5.4.2".\
                format(env=sys.platform, pyversion=sys.version)

{elabapi_python-5.4.1 → elabapi_python-5.4.2}/elabapi_python/models/entity.py

@@ -37,9 +37,6 @@ class Entity(EntityEditable):
         'comments': 'list[Comment]',
         'compounds_links': 'list[Compound]',
         'created_at': 'str',
-        'created_from_id': 'int',
-        'created_from_type': 'int',
-        'created_from_type_human': 'str',
         'elabid': 'str',
         'exclusive_edit_mode': 'ExclusiveEditMode',
         'experiments_links': 'list[Link]',
@@ -85,9 +82,6 @@ class Entity(EntityEditable):
         'comments': 'comments',
         'compounds_links': 'compounds_links',
         'created_at': 'created_at',
-        'created_from_id': 'created_from_id',
-        'created_from_type': 'created_from_type',
-        'created_from_type_human': 'created_from_type_human',
         'elabid': 'elabid',
         'exclusive_edit_mode': 'exclusive_edit_mode',
         'experiments_links': 'experiments_links',
@@ -124,7 +118,7 @@ class Entity(EntityEditable):
     if hasattr(EntityEditable, "attribute_map"):
         attribute_map.update(EntityEditable.attribute_map)
 
-    def __init__(self, access_key=None, body_html=None, category_color=None, category_title=None, changelog=None, comments=None, compounds_links=None, created_at=None, created_from_id=None, created_from_type=None, created_from_type_human=None, elabid=None, exclusive_edit_mode=None, experiments_links=None, firstname=None, fullname=None, hide_main_text=None, id=None, items_links=None, lastchangeby=None, lastname=None, locked=None, lockedby=None, locked_at=None, modified_at=None, next_step=None, orcid=None, page=None, recent_comment=None, related_experiments_links=None, related_items_links=None, sharelink=None, status_color=None, status_title=None, steps=None, tags=None, tags_id=None, team=None, timestamped=None, timestampedby=None, timestamped_at=None, type=None, uploads=None, *args, **kwargs):  # noqa: E501
+    def __init__(self, access_key=None, body_html=None, category_color=None, category_title=None, changelog=None, comments=None, compounds_links=None, created_at=None, elabid=None, exclusive_edit_mode=None, experiments_links=None, firstname=None, fullname=None, hide_main_text=None, id=None, items_links=None, lastchangeby=None, lastname=None, locked=None, lockedby=None, locked_at=None, modified_at=None, next_step=None, orcid=None, page=None, recent_comment=None, related_experiments_links=None, related_items_links=None, sharelink=None, status_color=None, status_title=None, steps=None, tags=None, tags_id=None, team=None, timestamped=None, timestampedby=None, timestamped_at=None, type=None, uploads=None, *args, **kwargs):  # noqa: E501
         """Entity - a model defined in Swagger"""  # noqa: E501
         self._access_key = None
         self._body_html = None
@@ -134,9 +128,6 @@ class Entity(EntityEditable):
         self._comments = None
         self._compounds_links = None
         self._created_at = None
-        self._created_from_id = None
-        self._created_from_type = None
-        self._created_from_type_human = None
         self._elabid = None
         self._exclusive_edit_mode = None
         self._experiments_links = None
@@ -186,12 +177,6 @@ class Entity(EntityEditable):
             self.compounds_links = compounds_links
         if created_at is not None:
             self.created_at = created_at
-        if created_from_id is not None:
-            self.created_from_id = created_from_id
-        if created_from_type is not None:
-            self.created_from_type = created_from_type
-        if created_from_type_human is not None:
-            self.created_from_type_human = created_from_type_human
         if elabid is not None:
             self.elabid = elabid
         if exclusive_edit_mode is not None:
@@ -426,75 +411,6 @@ class Entity(EntityEditable):
 
         self._created_at = created_at
 
-    @property
-    def created_from_id(self):
-        """Gets the created_from_id of this Entity.  # noqa: E501
-
-        Id of the template used to create this entry.  # noqa: E501
-
-        :return: The created_from_id of this Entity.  # noqa: E501
-        :rtype: int
-        """
-        return self._created_from_id
-
-    @created_from_id.setter
-    def created_from_id(self, created_from_id):
-        """Sets the created_from_id of this Entity.
-
-        Id of the template used to create this entry.  # noqa: E501
-
-        :param created_from_id: The created_from_id of this Entity.  # noqa: E501
-        :type: int
-        """
-
-        self._created_from_id = created_from_id
-
-    @property
-    def created_from_type(self):
-        """Gets the created_from_type of this Entity.  # noqa: E501
-
-        Type of the entity used to create this entry: template or concrete type if duplicate   # noqa: E501
-
-        :return: The created_from_type of this Entity.  # noqa: E501
-        :rtype: int
-        """
-        return self._created_from_type
-
-    @created_from_type.setter
-    def created_from_type(self, created_from_type):
-        """Sets the created_from_type of this Entity.
-
-        Type of the entity used to create this entry: template or concrete type if duplicate   # noqa: E501
-
-        :param created_from_type: The created_from_type of this Entity.  # noqa: E501
-        :type: int
-        """
-
-        self._created_from_type = created_from_type
-
-    @property
-    def created_from_type_human(self):
-        """Gets the created_from_type_human of this Entity.  # noqa: E501
-
-        Human readable version of created_from_type integer.  # noqa: E501
-
-        :return: The created_from_type_human of this Entity.  # noqa: E501
-        :rtype: str
-        """
-        return self._created_from_type_human
-
-    @created_from_type_human.setter
-    def created_from_type_human(self, created_from_type_human):
-        """Sets the created_from_type_human of this Entity.
-
-        Human readable version of created_from_type integer.  # noqa: E501
-
-        :param created_from_type_human: The created_from_type_human of this Entity.  # noqa: E501
-        :type: str
-        """
-
-        self._created_from_type_human = created_from_type_human
-
     @property
     def elabid(self):
         """Gets the elabid of this Entity.  # noqa: E501

{elabapi_python-5.4.1 → elabapi_python-5.4.2}/elabapi_python/models/entity_and_item_editable.py

@@ -37,8 +37,7 @@ class EntityAndItemEditable(EntityEditable):
         'book_can_overlap': 'int',
         'book_users_can_in_past': 'int',
         'book_is_cancellable': 'int',
-        'book_cancel_minutes': 'int',
-        'booking_window_days': 'int'
+        'book_cancel_minutes': 'int'
     }
     if hasattr(EntityEditable, "swagger_types"):
         swagger_types.update(EntityEditable.swagger_types)
@@ -52,13 +51,12 @@ class EntityAndItemEditable(EntityEditable):
         'book_can_overlap': 'book_can_overlap',
         'book_users_can_in_past': 'book_users_can_in_past',
         'book_is_cancellable': 'book_is_cancellable',
-        'book_cancel_minutes': 'book_cancel_minutes',
-        'booking_window_days': 'booking_window_days'
+        'book_cancel_minutes': 'book_cancel_minutes'
     }
     if hasattr(EntityEditable, "attribute_map"):
         attribute_map.update(EntityEditable.attribute_map)
 
-    def __init__(self, is_bookable=None, canbook_base=None, canbook=None, book_max_minutes=None, book_max_slots=None, book_can_overlap=None, book_users_can_in_past=None, book_is_cancellable=None, book_cancel_minutes=None, booking_window_days=None, *args, **kwargs):  # noqa: E501
+    def __init__(self, is_bookable=None, canbook_base=None, canbook=None, book_max_minutes=None, book_max_slots=None, book_can_overlap=None, book_users_can_in_past=None, book_is_cancellable=None, book_cancel_minutes=None, *args, **kwargs):  # noqa: E501
         """EntityAndItemEditable - a model defined in Swagger"""  # noqa: E501
         self._is_bookable = None
         self._canbook_base = None
@@ -69,7 +67,6 @@ class EntityAndItemEditable(EntityEditable):
         self._book_users_can_in_past = None
         self._book_is_cancellable = None
         self._book_cancel_minutes = None
-        self._booking_window_days = None
         self.discriminator = None
         if is_bookable is not None:
             self.is_bookable = is_bookable
@@ -89,8 +86,6 @@ class EntityAndItemEditable(EntityEditable):
             self.book_is_cancellable = book_is_cancellable
         if book_cancel_minutes is not None:
             self.book_cancel_minutes = book_cancel_minutes
-        if booking_window_days is not None:
-            self.booking_window_days = booking_window_days
         EntityEditable.__init__(self, *args, **kwargs)
 
     @property
@@ -290,29 +285,6 @@ class EntityAndItemEditable(EntityEditable):
 
         self._book_cancel_minutes = book_cancel_minutes
 
-    @property
-    def booking_window_days(self):
-        """Gets the booking_window_days of this EntityAndItemEditable.  # noqa: E501
-
-        How many days in advance users can book an item. 0 means no limit.  # noqa: E501
-
-        :return: The booking_window_days of this EntityAndItemEditable.  # noqa: E501
-        :rtype: int
-        """
-        return self._booking_window_days
-
-    @booking_window_days.setter
-    def booking_window_days(self, booking_window_days):
-        """Sets the booking_window_days of this EntityAndItemEditable.
-
-        How many days in advance users can book an item. 0 means no limit.  # noqa: E501
-
-        :param booking_window_days: The booking_window_days of this EntityAndItemEditable.  # noqa: E501
-        :type: int
-        """
-
-        self._booking_window_days = booking_window_days
-
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}

{elabapi_python-5.4.1 → elabapi_python-5.4.2}/elabapi_python/models/entity_template.py

@@ -37,9 +37,6 @@ class EntityTemplate(EntityTemplateEditable):
         'comments': 'list[Comment]',
         'compounds_links': 'list[Compound]',
         'created_at': 'str',
-        'created_from_id': 'int',
-        'created_from_type': 'int',
-        'created_from_type_human': 'str',
         'elabid': 'str',
         'exclusive_edit_mode': 'ExclusiveEditMode',
         'experiments_links': 'list[Link]',
@@ -85,9 +82,6 @@ class EntityTemplate(EntityTemplateEditable):
         'comments': 'comments',
         'compounds_links': 'compounds_links',
         'created_at': 'created_at',
-        'created_from_id': 'created_from_id',
-        'created_from_type': 'created_from_type',
-        'created_from_type_human': 'created_from_type_human',
         'elabid': 'elabid',
         'exclusive_edit_mode': 'exclusive_edit_mode',
         'experiments_links': 'experiments_links',
@@ -124,7 +118,7 @@ class EntityTemplate(EntityTemplateEditable):
     if hasattr(EntityTemplateEditable, "attribute_map"):
         attribute_map.update(EntityTemplateEditable.attribute_map)
 
-    def __init__(self, access_key=None, body_html=None, category_color=None, category_title=None, changelog=None, comments=None, compounds_links=None, created_at=None, created_from_id=None, created_from_type=None, created_from_type_human=None, elabid=None, exclusive_edit_mode=None, experiments_links=None, firstname=None, fullname=None, hide_main_text=None, id=None, items_links=None, lastchangeby=None, lastname=None, locked=None, lockedby=None, locked_at=None, modified_at=None, next_step=None, orcid=None, page=None, recent_comment=None, related_experiments_links=None, related_items_links=None, sharelink=None, status_color=None, status_title=None, steps=None, tags=None, tags_id=None, team=None, timestamped=None, timestampedby=None, timestamped_at=None, type=None, uploads=None, *args, **kwargs):  # noqa: E501
+    def __init__(self, access_key=None, body_html=None, category_color=None, category_title=None, changelog=None, comments=None, compounds_links=None, created_at=None, elabid=None, exclusive_edit_mode=None, experiments_links=None, firstname=None, fullname=None, hide_main_text=None, id=None, items_links=None, lastchangeby=None, lastname=None, locked=None, lockedby=None, locked_at=None, modified_at=None, next_step=None, orcid=None, page=None, recent_comment=None, related_experiments_links=None, related_items_links=None, sharelink=None, status_color=None, status_title=None, steps=None, tags=None, tags_id=None, team=None, timestamped=None, timestampedby=None, timestamped_at=None, type=None, uploads=None, *args, **kwargs):  # noqa: E501
         """EntityTemplate - a model defined in Swagger"""  # noqa: E501
         self._access_key = None
         self._body_html = None
@@ -134,9 +128,6 @@ class EntityTemplate(EntityTemplateEditable):
         self._comments = None
         self._compounds_links = None
         self._created_at = None
-        self._created_from_id = None
-        self._created_from_type = None
-        self._created_from_type_human = None
         self._elabid = None
         self._exclusive_edit_mode = None
         self._experiments_links = None
@@ -186,12 +177,6 @@ class EntityTemplate(EntityTemplateEditable):
             self.compounds_links = compounds_links
         if created_at is not None:
             self.created_at = created_at
-        if created_from_id is not None:
-            self.created_from_id = created_from_id
-        if created_from_type is not None:
-            self.created_from_type = created_from_type
-        if created_from_type_human is not None:
-            self.created_from_type_human = created_from_type_human
         if elabid is not None:
             self.elabid = elabid
         if exclusive_edit_mode is not None:
@@ -426,75 +411,6 @@ class EntityTemplate(EntityTemplateEditable):
 
         self._created_at = created_at
 
-    @property
-    def created_from_id(self):
-        """Gets the created_from_id of this EntityTemplate.  # noqa: E501
-
-        Id of the template used to create this entry.  # noqa: E501
-
-        :return: The created_from_id of this EntityTemplate.  # noqa: E501
-        :rtype: int
-        """
-        return self._created_from_id
-
-    @created_from_id.setter
-    def created_from_id(self, created_from_id):
-        """Sets the created_from_id of this EntityTemplate.
-
-        Id of the template used to create this entry.  # noqa: E501
-
-        :param created_from_id: The created_from_id of this EntityTemplate.  # noqa: E501
-        :type: int
-        """
-
-        self._created_from_id = created_from_id
-
-    @property
-    def created_from_type(self):
-        """Gets the created_from_type of this EntityTemplate.  # noqa: E501
-
-        Type of the entity used to create this entry: template or concrete type if duplicate   # noqa: E501
-
-        :return: The created_from_type of this EntityTemplate.  # noqa: E501
-        :rtype: int
-        """
-        return self._created_from_type
-
-    @created_from_type.setter
-    def created_from_type(self, created_from_type):
-        """Sets the created_from_type of this EntityTemplate.
-
-        Type of the entity used to create this entry: template or concrete type if duplicate   # noqa: E501
-
-        :param created_from_type: The created_from_type of this EntityTemplate.  # noqa: E501
-        :type: int
-        """
-
-        self._created_from_type = created_from_type
-
-    @property
-    def created_from_type_human(self):
-        """Gets the created_from_type_human of this EntityTemplate.  # noqa: E501
-
-        Human readable version of created_from_type integer.  # noqa: E501
-
-        :return: The created_from_type_human of this EntityTemplate.  # noqa: E501
-        :rtype: str
-        """
-        return self._created_from_type_human
-
-    @created_from_type_human.setter
-    def created_from_type_human(self, created_from_type_human):
-        """Sets the created_from_type_human of this EntityTemplate.
-
-        Human readable version of created_from_type integer.  # noqa: E501
-
-        :param created_from_type_human: The created_from_type_human of this EntityTemplate.  # noqa: E501
-        :type: str
-        """
-
-        self._created_from_type_human = created_from_type_human
-
     @property
     def elabid(self):
         """Gets the elabid of this EntityTemplate.  # noqa: E501