elabapi-python 5.2.0__tar.gz → 5.2.3__tar.gz

{elabapi_python-5.2.0 → elabapi_python-5.2.3}/PKG-INFO

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

{elabapi_python-5.2.0 → elabapi_python-5.2.3}/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.2.0
+- Package version: 5.2.3
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -114,6 +114,10 @@ Class | Method | HTTP request | Description
 *CommentsApi* | [**post_entity_comments**](docs/CommentsApi.md#post_entity_comments) | **POST** /{entity_type}/{id}/comments | Create a comment.
 *CommentsApi* | [**read_entity_comment**](docs/CommentsApi.md#read_entity_comment) | **GET** /{entity_type}/{id}/comments/{subid} | Read a comment of that entity.
 *CommentsApi* | [**read_entity_comments**](docs/CommentsApi.md#read_entity_comments) | **GET** /{entity_type}/{id}/comments | Read all comments of that entity.
+*CompoundsApi* | [**delete_compound**](docs/CompoundsApi.md#delete_compound) | **DELETE** /compounds/{id} | Soft-delete a compound
+*CompoundsApi* | [**get_compound**](docs/CompoundsApi.md#get_compound) | **GET** /compounds/{id} | Get a single compound
+*CompoundsApi* | [**get_compounds**](docs/CompoundsApi.md#get_compounds) | **GET** /compounds | Read compounds
+*CompoundsApi* | [**post_compounds**](docs/CompoundsApi.md#post_compounds) | **POST** /compounds | Create or import a compound
 *ConfigApi* | [**delete_config**](docs/ConfigApi.md#delete_config) | **DELETE** /config | Reset the config to default values
 *ConfigApi* | [**get_config**](docs/ConfigApi.md#get_config) | **GET** /config | Read the config
 *ConfigApi* | [**patch_config**](docs/ConfigApi.md#patch_config) | **PATCH** /config | Modify the config
@@ -237,6 +241,10 @@ Class | Method | HTTP request | Description
  - [Apikey](docs/Apikey.md)
  - [ApikeysBody](docs/ApikeysBody.md)
  - [Comment](docs/Comment.md)
+ - [Compound](docs/Compound.md)
+ - [CompoundCreateRequest](docs/CompoundCreateRequest.md)
+ - [CompoundDuplicateRequest](docs/CompoundDuplicateRequest.md)
+ - [CompoundsBody](docs/CompoundsBody.md)
  - [Config](docs/Config.md)
  - [Entity](docs/Entity.md)
  - [EntityEditable](docs/EntityEditable.md)
@@ -298,6 +306,7 @@ Class | Method | HTTP request | Description
  - [MetadataElabftwExtraFieldsGroups](docs/MetadataElabftwExtraFieldsGroups.md)
  - [MetadataExtraFields](docs/MetadataExtraFields.md)
  - [Notification](docs/Notification.md)
+ - [OneOfCompoundDuplicateRequest](docs/OneOfCompoundDuplicateRequest.md)
  - [Revision](docs/Revision.md)
  - [RevisionsSubidBody](docs/RevisionsSubidBody.md)
  - [Statuslike](docs/Statuslike.md)

{elabapi_python-5.2.0 → elabapi_python-5.2.3}/elabapi_python/__init__.py

@@ -17,6 +17,7 @@ from __future__ import absolute_import
 # import apis into sdk package
 from elabapi_python.api.api_keys_api import ApiKeysApi
 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.events_api import EventsApi
 from elabapi_python.api.experiments_api import ExperimentsApi
@@ -55,6 +56,10 @@ from elabapi_python.models.any_ofuploads_subid_body1 import AnyOfuploadsSubidBod
 from elabapi_python.models.apikey import Apikey
 from elabapi_python.models.apikeys_body import ApikeysBody
 from elabapi_python.models.comment import Comment
+from elabapi_python.models.compound import Compound
+from elabapi_python.models.compound_create_request import CompoundCreateRequest
+from elabapi_python.models.compound_duplicate_request import CompoundDuplicateRequest
+from elabapi_python.models.compounds_body import CompoundsBody
 from elabapi_python.models.config import Config
 from elabapi_python.models.entity import Entity
 from elabapi_python.models.entity_editable import EntityEditable
@@ -116,6 +121,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.one_of_compound_duplicate_request import OneOfCompoundDuplicateRequest
 from elabapi_python.models.revision import Revision
 from elabapi_python.models.revisions_subid_body import RevisionsSubidBody
 from elabapi_python.models.statuslike import Statuslike

{elabapi_python-5.2.0 → elabapi_python-5.2.3}/elabapi_python/api/__init__.py

@@ -5,6 +5,7 @@ from __future__ import absolute_import
 # import apis into api package
 from elabapi_python.api.api_keys_api import ApiKeysApi
 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.events_api import EventsApi
 from elabapi_python.api.experiments_api import ExperimentsApi

elabapi_python-5.2.3/elabapi_python/api/compounds_api.py

@@ -0,0 +1,401 @@
+# 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 CompoundsApi(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_compound(self, id, **kwargs):  # noqa: E501
+        """Soft-delete a compound  # noqa: E501
+
+        The compound gets marked as 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_compound(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the compound (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_compound_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_compound_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def delete_compound_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Soft-delete a compound  # noqa: E501
+
+        The compound gets marked as 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_compound_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the compound (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_compound" % 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_compound`")  # 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
+        # Authentication setting
+        auth_settings = ['token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/compounds/{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 get_compound(self, id, **kwargs):  # noqa: E501
+        """Get a single compound  # noqa: E501
+
+        Retrieve one compound by 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.get_compound(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the compound (required)
+        :return: Compound
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_compound_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_compound_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def get_compound_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Get a single compound  # noqa: E501
+
+        Retrieve one compound by 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.get_compound_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the compound (required)
+        :return: Compound
+                 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 get_compound" % 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_compound`")  # 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(
+            '/compounds/{id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Compound',  # 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 get_compounds(self, **kwargs):  # noqa: E501
+        """Read compounds  # noqa: E501
+
+        Get a list of compounds  # 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_compounds(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: list[Compound]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_compounds_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_compounds_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_compounds_with_http_info(self, **kwargs):  # noqa: E501
+        """Read compounds  # noqa: E501
+
+        Get a list of compounds  # 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_compounds_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: list[Compound]
+                 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 get_compounds" % 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(
+            '/compounds', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[Compound]',  # 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_compounds(self, body, **kwargs):  # noqa: E501
+        """Create or import a compound  # noqa: E501
+
+        Add a compound to the database. Add action => duplicate parameter with a CAS or PubChem CID to import from PubChem. If the action parameter is something else, the compound will be created directly.   # 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_compounds(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param CompoundsBody body: (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_compounds_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.post_compounds_with_http_info(body, **kwargs)  # noqa: E501
+            return data
+
+    def post_compounds_with_http_info(self, body, **kwargs):  # noqa: E501
+        """Create or import a compound  # noqa: E501
+
+        Add a compound to the database. Add action => duplicate parameter with a CAS or PubChem CID to import from PubChem. If the action parameter is something else, the compound will be created directly.   # 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_compounds_with_http_info(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param CompoundsBody body: (required)
+        :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_compounds" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `post_compounds`")  # noqa: E501
+
+        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 `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(
+            '/compounds', '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.2.0 → elabapi_python-5.2.3}/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.2.0/python'
+        self.user_agent = 'Swagger-Codegen/5.2.3/python'
 
     def __del__(self):
         self.pool.close()

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

{elabapi_python-5.2.0 → elabapi_python-5.2.3}/elabapi_python/models/__init__.py

@@ -18,6 +18,10 @@ from elabapi_python.models.any_ofuploads_subid_body1 import AnyOfuploadsSubidBod
 from elabapi_python.models.apikey import Apikey
 from elabapi_python.models.apikeys_body import ApikeysBody
 from elabapi_python.models.comment import Comment
+from elabapi_python.models.compound import Compound
+from elabapi_python.models.compound_create_request import CompoundCreateRequest
+from elabapi_python.models.compound_duplicate_request import CompoundDuplicateRequest
+from elabapi_python.models.compounds_body import CompoundsBody
 from elabapi_python.models.config import Config
 from elabapi_python.models.entity import Entity
 from elabapi_python.models.entity_editable import EntityEditable
@@ -79,6 +83,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.one_of_compound_duplicate_request import OneOfCompoundDuplicateRequest
 from elabapi_python.models.revision import Revision
 from elabapi_python.models.revisions_subid_body import RevisionsSubidBody
 from elabapi_python.models.statuslike import Statuslike