elabapi-python 5.5.11__tar.gz → 5.6.1__tar.gz

{elabapi_python-5.5.11 → elabapi_python-5.6.1}/PKG-INFO

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

{elabapi_python-5.5.11 → elabapi_python-5.6.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.5.11
+- Package version: 5.6.1
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -109,6 +109,8 @@ Class | Method | HTTP request | Description
 *ApiKeysApi* | [**delete_apikey**](docs/ApiKeysApi.md#delete_apikey) | **DELETE** /apikeys/{id} | Delete an API key.
 *ApiKeysApi* | [**get_apikeys**](docs/ApiKeysApi.md#get_apikeys) | **GET** /apikeys | Read API keys
 *ApiKeysApi* | [**post_apikeys**](docs/ApiKeysApi.md#post_apikeys) | **POST** /apikeys | Create an API key
+*BrandingApi* | [**get_instance_branding**](docs/BrandingApi.md#get_instance_branding) | **GET** /instance/branding/{id} | Read a branding asset as a binary file.
+*BrandingApi* | [**post_instance_branding**](docs/BrandingApi.md#post_instance_branding) | **POST** /instance/branding/{id} | Update a branding asset.
 *CommentsApi* | [**delete_entity_comment**](docs/CommentsApi.md#delete_entity_comment) | **DELETE** /{entity_type}/{id}/comments/{subid} | Delete an entity comment.
 *CommentsApi* | [**patch_entity_comment**](docs/CommentsApi.md#patch_entity_comment) | **PATCH** /{entity_type}/{id}/comments/{subid} | Modify an entity comment.
 *CommentsApi* | [**post_entity_comments**](docs/CommentsApi.md#post_entity_comments) | **POST** /{entity_type}/{id}/comments | Create a comment.
@@ -126,6 +128,7 @@ Class | Method | HTTP request | Description
 *ContainersApi* | [**post_container**](docs/ContainersApi.md#post_container) | **POST** /{entity_type}/{id}/containers/{subid} | Create a container for this entity.
 *ContainersApi* | [**read_container**](docs/ContainersApi.md#read_container) | **GET** /{entity_type}/{id}/containers/{subid} | Read a container.
 *ContainersApi* | [**read_containers**](docs/ContainersApi.md#read_containers) | **GET** /{entity_type}/{id}/containers | Read all containers for this entity.
+*CustomFieldsKeysApi* | [**custom_fields_keys**](docs/CustomFieldsKeysApi.md#custom_fields_keys) | **GET** /extra_fields_keys | Read custom fields keys.
 *DSpaceApi* | [**dspace_create**](docs/DSpaceApi.md#dspace_create) | **POST** /dspace | Create a new DSpace workspace item.
 *DSpaceApi* | [**dspace_read**](docs/DSpaceApi.md#dspace_read) | **GET** /dspace | Read DSpace information.
 *DSpaceApi* | [**dspace_submit**](docs/DSpaceApi.md#dspace_submit) | **PATCH** /dspace | Submit an eLabFTW entry to DSpace.
@@ -160,7 +163,6 @@ Class | Method | HTTP request | Description
 *ExportsApi* | [**post_export**](docs/ExportsApi.md#post_export) | **POST** /exports | Register an export request
 *ExportsApi* | [**read_export**](docs/ExportsApi.md#read_export) | **GET** /exports/{id} | Get export
 *ExportsApi* | [**readall_exports**](docs/ExportsApi.md#readall_exports) | **GET** /exports | List exports
-*ExtraFieldsKeysApi* | [**extra_fields_keys**](docs/ExtraFieldsKeysApi.md#extra_fields_keys) | **GET** /extra_fields_keys | Read extra fields keys.
 *FavoriteTagsApi* | [**delete_favtag**](docs/FavoriteTagsApi.md#delete_favtag) | **DELETE** /favtags/{id} | Unfavorite a tag.
 *FavoriteTagsApi* | [**post_favtags**](docs/FavoriteTagsApi.md#post_favtags) | **POST** /favtags | Add a tag as favorite.
 *FavoriteTagsApi* | [**read_favtags**](docs/FavoriteTagsApi.md#read_favtags) | **GET** /favtags | Read all favorite tags for the user.
@@ -185,6 +187,7 @@ Class | Method | HTTP request | Description
 *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.
+*InstanceApi* | [**post_instance**](docs/InstanceApi.md#post_instance) | **POST** /instance | Run an instance level action.
 *ItemsApi* | [**delete_item**](docs/ItemsApi.md#delete_item) | **DELETE** /items/{id} | Delete an item.
 *ItemsApi* | [**get_item**](docs/ItemsApi.md#get_item) | **GET** /items/{id} | Read an item
 *ItemsApi* | [**patch_item**](docs/ItemsApi.md#patch_item) | **PATCH** /items/{id} | Modify an item
@@ -207,7 +210,7 @@ Class | Method | HTTP request | Description
 *LinksToItemsApi* | [**post_entity_items_links**](docs/LinksToItemsApi.md#post_entity_items_links) | **POST** /{entity_type}/{id}/items_links/{subid} | Create or import a link.
 *LinksToItemsApi* | [**read_entity_items_links**](docs/LinksToItemsApi.md#read_entity_items_links) | **GET** /{entity_type}/{id}/items_links | Read all items links of that entity.
 *NotificationsApi* | [**delete_notifications**](docs/NotificationsApi.md#delete_notifications) | **DELETE** /users/{id}/notifications | Delete all notifications of the user.
-*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* | [**patch_notification**](docs/NotificationsApi.md#patch_notification) | **PATCH** /users/{id}/notifications/{subid} | Update the acknowledgment status of a notification.
 *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
@@ -272,9 +275,11 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [AllOfentityEditableMetadatamerge](docs/AllOfentityEditableMetadatamerge.md)
  - [AnyOfuploadsSubidBody1](docs/AnyOfuploadsSubidBody1.md)
  - [Apikey](docs/Apikey.md)
  - [ApikeysBody](docs/ApikeysBody.md)
+ - [BrandingIdBody](docs/BrandingIdBody.md)
  - [Changelog](docs/Changelog.md)
  - [Comment](docs/Comment.md)
  - [Compound](docs/Compound.md)
@@ -353,6 +358,7 @@ Class | Method | HTTP request | Description
  - [InlineResponse2009](docs/InlineResponse2009.md)
  - [InlineResponse2009Embedded](docs/InlineResponse2009Embedded.md)
  - [InlineResponse2009EmbeddedEntries](docs/InlineResponse2009EmbeddedEntries.md)
+ - [InstanceBody](docs/InstanceBody.md)
  - [Item](docs/Item.md)
  - [ItemEditable](docs/ItemEditable.md)
  - [ItemsLinksSubidBody](docs/ItemsLinksSubidBody.md)
@@ -363,6 +369,7 @@ Class | Method | HTTP request | Description
  - [MetadataElabftwExtraFieldsGroups](docs/MetadataElabftwExtraFieldsGroups.md)
  - [MetadataExtraFields](docs/MetadataExtraFields.md)
  - [Notification](docs/Notification.md)
+ - [NotificationsSubidBody](docs/NotificationsSubidBody.md)
  - [PatchAction](docs/PatchAction.md)
  - [Revision](docs/Revision.md)
  - [RevisionsSubidBody](docs/RevisionsSubidBody.md)

{elabapi_python-5.5.11 → elabapi_python-5.6.1}/elabapi_python/__init__.py

@@ -16,10 +16,12 @@ from __future__ import absolute_import
 
 # import apis into sdk package
 from elabapi_python.api.api_keys_api import ApiKeysApi
+from elabapi_python.api.branding_api import BrandingApi
 from elabapi_python.api.comments_api import CommentsApi
 from elabapi_python.api.compounds_api import CompoundsApi
 from elabapi_python.api.config_api import ConfigApi
 from elabapi_python.api.containers_api import ContainersApi
+from elabapi_python.api.custom_fields_keys_api import CustomFieldsKeysApi
 from elabapi_python.api.d_space_api import DSpaceApi
 from elabapi_python.api.events_api import EventsApi
 from elabapi_python.api.experiments_api import ExperimentsApi
@@ -27,12 +29,12 @@ from elabapi_python.api.experiments_categories_api import ExperimentsCategoriesA
 from elabapi_python.api.experiments_status_api import ExperimentsStatusApi
 from elabapi_python.api.experiments_templates_api import ExperimentsTemplatesApi
 from elabapi_python.api.exports_api import ExportsApi
-from elabapi_python.api.extra_fields_keys_api import ExtraFieldsKeysApi
 from elabapi_python.api.favorite_tags_api import FavoriteTagsApi
 from elabapi_python.api.idps_api import IdpsApi
 from elabapi_python.api.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.instance_api import InstanceApi
 from elabapi_python.api.items_api import ItemsApi
 from elabapi_python.api.items_types__resources_templates_api import ItemsTypesResourcesTemplatesApi
 from elabapi_python.api.links_to_compounds_api import LinksToCompoundsApi
@@ -58,9 +60,11 @@ from elabapi_python.api.users_api import UsersApi
 from elabapi_python.api_client import ApiClient
 from elabapi_python.configuration import Configuration
 # import models into sdk package
+from elabapi_python.models.all_ofentity_editable_metadatamerge import AllOfentityEditableMetadatamerge
 from elabapi_python.models.any_ofuploads_subid_body1 import AnyOfuploadsSubidBody1
 from elabapi_python.models.apikey import Apikey
 from elabapi_python.models.apikeys_body import ApikeysBody
+from elabapi_python.models.branding_id_body import BrandingIdBody
 from elabapi_python.models.changelog import Changelog
 from elabapi_python.models.comment import Comment
 from elabapi_python.models.compound import Compound
@@ -139,6 +143,7 @@ from elabapi_python.models.inline_response2008 import InlineResponse2008
 from elabapi_python.models.inline_response2009 import InlineResponse2009
 from elabapi_python.models.inline_response2009_embedded import InlineResponse2009Embedded
 from elabapi_python.models.inline_response2009_embedded_entries import InlineResponse2009EmbeddedEntries
+from elabapi_python.models.instance_body import InstanceBody
 from elabapi_python.models.item import Item
 from elabapi_python.models.item_editable import ItemEditable
 from elabapi_python.models.items_links_subid_body import ItemsLinksSubidBody
@@ -149,6 +154,7 @@ from elabapi_python.models.metadata_elabftw import MetadataElabftw
 from elabapi_python.models.metadata_elabftw_extra_fields_groups import MetadataElabftwExtraFieldsGroups
 from elabapi_python.models.metadata_extra_fields import MetadataExtraFields
 from elabapi_python.models.notification import Notification
+from elabapi_python.models.notifications_subid_body import NotificationsSubidBody
 from elabapi_python.models.patch_action import PatchAction
 from elabapi_python.models.revision import Revision
 from elabapi_python.models.revisions_subid_body import RevisionsSubidBody

{elabapi_python-5.5.11 → elabapi_python-5.6.1}/elabapi_python/api/__init__.py

@@ -4,10 +4,12 @@ from __future__ import absolute_import
 
 # import apis into api package
 from elabapi_python.api.api_keys_api import ApiKeysApi
+from elabapi_python.api.branding_api import BrandingApi
 from elabapi_python.api.comments_api import CommentsApi
 from elabapi_python.api.compounds_api import CompoundsApi
 from elabapi_python.api.config_api import ConfigApi
 from elabapi_python.api.containers_api import ContainersApi
+from elabapi_python.api.custom_fields_keys_api import CustomFieldsKeysApi
 from elabapi_python.api.d_space_api import DSpaceApi
 from elabapi_python.api.events_api import EventsApi
 from elabapi_python.api.experiments_api import ExperimentsApi
@@ -15,12 +17,12 @@ from elabapi_python.api.experiments_categories_api import ExperimentsCategoriesA
 from elabapi_python.api.experiments_status_api import ExperimentsStatusApi
 from elabapi_python.api.experiments_templates_api import ExperimentsTemplatesApi
 from elabapi_python.api.exports_api import ExportsApi
-from elabapi_python.api.extra_fields_keys_api import ExtraFieldsKeysApi
 from elabapi_python.api.favorite_tags_api import FavoriteTagsApi
 from elabapi_python.api.idps_api import IdpsApi
 from elabapi_python.api.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.instance_api import InstanceApi
 from elabapi_python.api.items_api import ItemsApi
 from elabapi_python.api.items_types__resources_templates_api import ItemsTypesResourcesTemplatesApi
 from elabapi_python.api.links_to_compounds_api import LinksToCompoundsApi

elabapi_python-5.6.1/elabapi_python/api/branding_api.py

@@ -0,0 +1,247 @@
+# 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 BrandingApi(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 get_instance_branding(self, id, format, **kwargs):  # noqa: E501
+        """Read a branding asset as a binary file.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_instance_branding(id, format, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: Branding id. (required)
+        :param str format: Use binary format to retrieve the branding asset. (required)
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_instance_branding_with_http_info(id, format, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_instance_branding_with_http_info(id, format, **kwargs)  # noqa: E501
+            return data
+
+    def get_instance_branding_with_http_info(self, id, format, **kwargs):  # noqa: E501
+        """Read a branding asset as a binary file.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_instance_branding_with_http_info(id, format, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: Branding id. (required)
+        :param str format: Use binary format to retrieve the branding asset. (required)
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['id', 'format']  # 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 get_instance_branding" % 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 `get_instance_branding`")  # noqa: E501
+        # verify the required parameter 'format' is set
+        if ('format' not in params or
+                params['format'] is None):
+            raise ValueError("Missing the required parameter `format` when calling `get_instance_branding`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']  # noqa: E501
+
+        query_params = []
+        if 'format' in params:
+            query_params.append(('format', params['format']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['image/svg+xml', 'image/png', 'image/jpeg', 'image/webp', 'image/x-icon', 'image/vnd.microsoft.icon', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/instance/branding/{id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='str',  # 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_instance_branding(self, action, file, id, **kwargs):  # noqa: E501
+        """Update a branding asset.  # 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_instance_branding(action, file, id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str action: (required)
+        :param str file: (required)
+        :param int id: Branding id. (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.post_instance_branding_with_http_info(action, file, id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.post_instance_branding_with_http_info(action, file, id, **kwargs)  # noqa: E501
+            return data
+
+    def post_instance_branding_with_http_info(self, action, file, id, **kwargs):  # noqa: E501
+        """Update a branding asset.  # 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_instance_branding_with_http_info(action, file, id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str action: (required)
+        :param str file: (required)
+        :param int id: Branding id. (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['action', 'file', '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 post_instance_branding" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'action' is set
+        if ('action' not in params or
+                params['action'] is None):
+            raise ValueError("Missing the required parameter `action` when calling `post_instance_branding`")  # noqa: E501
+        # verify the required parameter 'file' is set
+        if ('file' not in params or
+                params['file'] is None):
+            raise ValueError("Missing the required parameter `file` when calling `post_instance_branding`")  # noqa: E501
+        # 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_instance_branding`")  # 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 = {}
+        if 'action' in params:
+            form_params.append(('action', params['action']))  # noqa: E501
+        if 'file' in params:
+            local_var_files['file'] = params['file']  # noqa: E501
+
+        body_params = None
+        # 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
+            ['multipart/form-data'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/instance/branding/{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)

{elabapi_python-5.5.11 → elabapi_python-5.6.1}/elabapi_python/api/containers_api.py

@@ -146,7 +146,7 @@ class ContainersApi(object):
     def patch_container(self, entity_type, id, subid, **kwargs):  # noqa: E501
         """Modify a container.  # noqa: E501
 
-        Update the quantity stored or the unit of a container.  # noqa: E501
+        Update the quantity stored, the unit, or the storage location of a container. Setting `storage_id` moves the container to a different storage unit while preserving its `id` and `created_at`.   # 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_container(entity_type, id, subid, async_req=True)
@@ -171,7 +171,7 @@ class ContainersApi(object):
     def patch_container_with_http_info(self, entity_type, id, subid, **kwargs):  # noqa: E501
         """Modify a container.  # noqa: E501
 
-        Update the quantity stored or the unit of a container.  # noqa: E501
+        Update the quantity stored, the unit, or the storage location of a container. Setting `storage_id` moves the container to a different storage unit while preserving its `id` and `created_at`.   # 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_container_with_http_info(entity_type, id, subid, async_req=True)

elabapi_python-5.5.11/elabapi_python/api/extra_fields_keys_api.py → elabapi_python-5.6.1/elabapi_python/api/custom_fields_keys_api.py

@@ -20,7 +20,7 @@ import six
 from elabapi_python.api_client import ApiClient
 
 
-class ExtraFieldsKeysApi(object):
+class CustomFieldsKeysApi(object):
     """NOTE: This class is auto generated by the swagger code generator program.
 
     Do not edit the class manually.
@@ -32,39 +32,39 @@ class ExtraFieldsKeysApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
-    def extra_fields_keys(self, **kwargs):  # noqa: E501
-        """Read extra fields keys.  # noqa: E501
+    def custom_fields_keys(self, **kwargs):  # noqa: E501
+        """Read custom fields keys.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.extra_fields_keys(async_req=True)
+        >>> thread = api.custom_fields_keys(async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :param str q: Search for a term in the extra fields keys. 
-        :param int limit: Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP. 
+        :param str q: Search for a term in the custom fields keys. 
+        :param int limit: Number of custom fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP. 
         :return: list[ExtraFieldsKeys]
                  If the method is called asynchronously,
                  returns the request thread.
         """
         kwargs['_return_http_data_only'] = True
         if kwargs.get('async_req'):
-            return self.extra_fields_keys_with_http_info(**kwargs)  # noqa: E501
+            return self.custom_fields_keys_with_http_info(**kwargs)  # noqa: E501
         else:
-            (data) = self.extra_fields_keys_with_http_info(**kwargs)  # noqa: E501
+            (data) = self.custom_fields_keys_with_http_info(**kwargs)  # noqa: E501
             return data
 
-    def extra_fields_keys_with_http_info(self, **kwargs):  # noqa: E501
-        """Read extra fields keys.  # noqa: E501
+    def custom_fields_keys_with_http_info(self, **kwargs):  # noqa: E501
+        """Read custom fields keys.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.extra_fields_keys_with_http_info(async_req=True)
+        >>> thread = api.custom_fields_keys_with_http_info(async_req=True)
         >>> result = thread.get()
 
         :param async_req bool
-        :param str q: Search for a term in the extra fields keys. 
-        :param int limit: Number of extra fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP. 
+        :param str q: Search for a term in the custom fields keys. 
+        :param int limit: Number of custom fields keys that will be returned. Value >= -1; -1: no limit, 0: users default setting from UCP. 
         :return: list[ExtraFieldsKeys]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -81,7 +81,7 @@ class ExtraFieldsKeysApi(object):
             if key not in all_params:
                 raise TypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method extra_fields_keys" % key
+                    " to method custom_fields_keys" % key
                 )
             params[key] = val
         del params['kwargs']

{elabapi_python-5.5.11 → elabapi_python-5.6.1}/elabapi_python/api/experiments_api.py

@@ -552,7 +552,7 @@ class ExperimentsApi(object):
         :param str extended: Extended search (advanced query). 
         :param int related: Look only for entries linked to this entry id. 
         :param str related_origin: When using the \"related\" query parameter, select the type of the related ID (experiments or items) 
-        :param str cat: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
+        :param str category: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
         :param str status: Add a filter on the Status. Supports comma separated list of numbers, including \"null\". 
         :param list[str] tags: An array of tags for filtering results containing all of these tags. 
         :param int limit: Limit the number of results. 
@@ -562,6 +562,7 @@ class ExperimentsApi(object):
         :param str order: Change the ordering of the results. 
         :param str sort: Change the sorting of results: ascending or descending. 
         :param str state: Filter results based on their state: 1 (Normal), 2 (Archived), 3 (Deleted). Supports comma separated values. 
+        :param int full: Return all columns of each entry when set to 1. 
         :return: list[Experiment]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -586,7 +587,7 @@ class ExperimentsApi(object):
         :param str extended: Extended search (advanced query). 
         :param int related: Look only for entries linked to this entry id. 
         :param str related_origin: When using the \"related\" query parameter, select the type of the related ID (experiments or items) 
-        :param str cat: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
+        :param str category: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
         :param str status: Add a filter on the Status. Supports comma separated list of numbers, including \"null\". 
         :param list[str] tags: An array of tags for filtering results containing all of these tags. 
         :param int limit: Limit the number of results. 
@@ -596,12 +597,13 @@ class ExperimentsApi(object):
         :param str order: Change the ordering of the results. 
         :param str sort: Change the sorting of results: ascending or descending. 
         :param str state: Filter results based on their state: 1 (Normal), 2 (Archived), 3 (Deleted). Supports comma separated values. 
+        :param int full: Return all columns of each entry when set to 1. 
         :return: list[Experiment]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['q', 'extended', 'related', 'related_origin', 'cat', 'status', 'tags', 'limit', 'offset', 'owner', 'scope', 'order', 'sort', 'state']  # noqa: E501
+        all_params = ['q', 'extended', 'related', 'related_origin', 'category', 'status', 'tags', 'limit', 'offset', 'owner', 'scope', 'order', 'sort', 'state', 'full']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -630,8 +632,8 @@ class ExperimentsApi(object):
             query_params.append(('related', params['related']))  # noqa: E501
         if 'related_origin' in params:
             query_params.append(('related_origin', params['related_origin']))  # noqa: E501
-        if 'cat' in params:
-            query_params.append(('cat', params['cat']))  # noqa: E501
+        if 'category' in params:
+            query_params.append(('category', params['category']))  # noqa: E501
         if 'status' in params:
             query_params.append(('status', params['status']))  # noqa: E501
         if 'tags' in params:
@@ -651,6 +653,8 @@ class ExperimentsApi(object):
             query_params.append(('sort', params['sort']))  # noqa: E501
         if 'state' in params:
             query_params.append(('state', params['state']))  # noqa: E501
+        if 'full' in params:
+            query_params.append(('full', params['full']))  # noqa: E501
 
         header_params = {}
 

{elabapi_python-5.5.11 → elabapi_python-5.6.1}/elabapi_python/api/experiments_templates_api.py

@@ -528,7 +528,7 @@ class ExperimentsTemplatesApi(object):
         :param str extended: Extended search (advanced query). 
         :param int related: Look only for entries linked to this entry id. 
         :param str related_origin: When using the \"related\" query parameter, select the type of the related ID (experiments or items) 
-        :param str cat: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
+        :param str category: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
         :param str status: Add a filter on the Status. Supports comma separated list of numbers, including \"null\". 
         :param list[str] tags: An array of tags for filtering results containing all of these tags. 
         :param int limit: Limit the number of results. 
@@ -538,6 +538,7 @@ class ExperimentsTemplatesApi(object):
         :param str order: Change the ordering of the results. 
         :param str sort: Change the sorting of results: ascending or descending. 
         :param str state: Filter results based on their state: 1 (Normal), 2 (Archived), 3 (Deleted). Supports comma separated values. 
+        :param int full: Return all columns of each entry when set to 1. 
         :return: list[EntityTemplate]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -562,7 +563,7 @@ class ExperimentsTemplatesApi(object):
         :param str extended: Extended search (advanced query). 
         :param int related: Look only for entries linked to this entry id. 
         :param str related_origin: When using the \"related\" query parameter, select the type of the related ID (experiments or items) 
-        :param str cat: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
+        :param str category: Add a filter on the Category. Supports comma separated list of numbers, including \"null\". 
         :param str status: Add a filter on the Status. Supports comma separated list of numbers, including \"null\". 
         :param list[str] tags: An array of tags for filtering results containing all of these tags. 
         :param int limit: Limit the number of results. 
@@ -572,12 +573,13 @@ class ExperimentsTemplatesApi(object):
         :param str order: Change the ordering of the results. 
         :param str sort: Change the sorting of results: ascending or descending. 
         :param str state: Filter results based on their state: 1 (Normal), 2 (Archived), 3 (Deleted). Supports comma separated values. 
+        :param int full: Return all columns of each entry when set to 1. 
         :return: list[EntityTemplate]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['q', 'extended', 'related', 'related_origin', 'cat', 'status', 'tags', 'limit', 'offset', 'owner', 'scope', 'order', 'sort', 'state']  # noqa: E501
+        all_params = ['q', 'extended', 'related', 'related_origin', 'category', 'status', 'tags', 'limit', 'offset', 'owner', 'scope', 'order', 'sort', 'state', 'full']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -606,8 +608,8 @@ class ExperimentsTemplatesApi(object):
             query_params.append(('related', params['related']))  # noqa: E501
         if 'related_origin' in params:
             query_params.append(('related_origin', params['related_origin']))  # noqa: E501
-        if 'cat' in params:
-            query_params.append(('cat', params['cat']))  # noqa: E501
+        if 'category' in params:
+            query_params.append(('category', params['category']))  # noqa: E501
         if 'status' in params:
             query_params.append(('status', params['status']))  # noqa: E501
         if 'tags' in params:
@@ -627,6 +629,8 @@ class ExperimentsTemplatesApi(object):
             query_params.append(('sort', params['sort']))  # noqa: E501
         if 'state' in params:
             query_params.append(('state', params['state']))  # noqa: E501
+        if 'full' in params:
+            query_params.append(('full', params['full']))  # noqa: E501
 
         header_params = {}