elabapi-python 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

elabapi_python/__init__.py

@@ -101,3 +101,4 @@ from elabapi_python.models.upload import Upload
 from elabapi_python.models.uploads_subid_body import UploadsSubidBody
 from elabapi_python.models.users import Users
 from elabapi_python.models.users_body import UsersBody
+from elabapi_python.models.users_id_body import UsersIdBody

elabapi_python/api/items_api.py

@@ -137,6 +137,7 @@ class ItemsApi(object):
 
         :param async_req bool
         :param int id: ID of the item (required)
+        :param str format: Get the entity in a different format like csv, pdf, eln or zip. \"pdfa\" means archive pdf (PDF/A), same with \"zipa\". 
         :return: Item
                  If the method is called asynchronously,
                  returns the request thread.
@@ -158,12 +159,13 @@ class ItemsApi(object):
 
         :param async_req bool
         :param int id: ID of the item (required)
+        :param str format: Get the entity in a different format like csv, pdf, eln or zip. \"pdfa\" means archive pdf (PDF/A), same with \"zipa\". 
         :return: Item
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['id']  # noqa: E501
+        all_params = ['id', 'format']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -190,6 +192,8 @@ class ItemsApi(object):
             path_params['id'] = params['id']  # noqa: E501
 
         query_params = []
+        if 'format' in params:
+            query_params.append(('format', params['format']))  # noqa: E501
 
         header_params = {}
 

elabapi_python/api/users_api.py

@@ -32,6 +32,109 @@ class UsersApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
+    def patch_user(self, id, **kwargs):  # noqa: E501
+        """Modify a user.  # noqa: E501
+
+        Note: it is possible to use \"me\" instead of the userid to access the user of the API key.   # 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_user(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param Id id: ID of the user or `me`. (required)
+        :param UsersIdBody body: Parameters for modifying a user.
+        :return: Users
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.patch_user_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.patch_user_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def patch_user_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Modify a user.  # noqa: E501
+
+        Note: it is possible to use \"me\" instead of the userid to access the user of the API key.   # 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_user_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param Id id: ID of the user or `me`. (required)
+        :param UsersIdBody body: Parameters for modifying a user.
+        :return: Users
+                 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_user" % 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_user`")  # 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(
+            '/users/{id}', 'PATCH',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Users',  # 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_user(self, **kwargs):  # noqa: E501
         """Create a new user.  # noqa: E501
 

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/0.1.6/python'
+        self.user_agent = 'Swagger-Codegen/0.1.7/python'
 
     def __del__(self):
         self.pool.close()

elabapi_python/configuration.py

@@ -247,5 +247,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: 0.1.6".\
+               "SDK Package Version: 0.1.7".\
                format(env=sys.platform, pyversion=sys.version)

elabapi_python/models/__init__.py

@@ -74,3 +74,4 @@ from elabapi_python.models.upload import Upload
 from elabapi_python.models.uploads_subid_body import UploadsSubidBody
 from elabapi_python.models.users import Users
 from elabapi_python.models.users_body import UsersBody
+from elabapi_python.models.users_id_body import UsersIdBody

elabapi_python/models/users_id_body.py

@@ -0,0 +1,84 @@
+# 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
+"""
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+class UsersIdBody(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self):  # noqa: E501
+        """UsersIdBody - a model defined in Swagger"""  # noqa: E501
+        self.discriminator = None
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(UsersIdBody, dict):
+            for key, value in self.items():
+                result[key] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, UsersIdBody):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

{elabapi_python-0.1.6.dist-info → elabapi_python-0.1.7.dist-info}/METADATA

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

{elabapi_python-0.1.6.dist-info → elabapi_python-0.1.7.dist-info}/RECORD

@@ -1,6 +1,6 @@
-elabapi_python/__init__.py,sha256=sMooG1BYiOiFE4M_OA9-zJB15LKkjESHiXc9Lc9e7og,5431
-elabapi_python/api_client.py,sha256=rbEojspkhJH8BOf4KwyGjTj-AeYezRWwduDu2UKiAoE,25079
-elabapi_python/configuration.py,sha256=mo6AGfZOGZwP6BnTQg9wb8FQ7zS7RxcIWjCcoVl3V3A,8263
+elabapi_python/__init__.py,sha256=uQ1bobO4iSD5AoGpfsO8bJPjbXMGfN2UxiTnRMv1nqs,5491
+elabapi_python/api_client.py,sha256=B3yBj_rLPS1awtovyQ07HGnKSybk94oDTiD8LxP3T2s,25079
+elabapi_python/configuration.py,sha256=1cWiKwY9fEoB0FIeClhqxogypr-oBiLgju_-nsiEU6A,8263
 elabapi_python/rest.py,sha256=zVk_B5g308vKBtZ4jb8fpaeXXEO4GZzTGNPfZK_zkY0,13031
 elabapi_python/api/__init__.py,sha256=OOk3CfzFbxOpwq7MZZPDs12PlCZehGQFMf03d-OXSZc,1379
 elabapi_python/api/api_keys_api.py,sha256=u_SZ2stg1KsRnPY2s1dpjvHVrJeFKj-L6hLRFaitvZo,10666
@@ -10,7 +10,7 @@ elabapi_python/api/events_api.py,sha256=Mcg-3v053ocERa73uqOCv29KeNwRBfqtbSbGAtx_
 elabapi_python/api/experiments_api.py,sha256=ydAxfpiPOu5Iu6_4pR7NGpYDUaUjRnI4rdgBeSpOcKs,20487
 elabapi_python/api/experiments_templates_api.py,sha256=RzTyv0rxKqdMO_gBEqgkN1oGsKMZ9MT0-2dIuorS8kc,18664
 elabapi_python/api/favorite_tags_api.py,sha256=Riyr1S_sYjnLc460AhGehv8tuiFPXHhjWEQGndnxLcg,10417
-elabapi_python/api/items_api.py,sha256=Lvr2gOUQyLE-GFeTQxaVaj6Z8J3B2g_4rL9ii_GCEEI,19333
+elabapi_python/api/items_api.py,sha256=X_D7SlAxngbZrWDKygCUx5uaOaRVw_xLb05zK8gQGNw,19746
 elabapi_python/api/items_types_api.py,sha256=ioGXuFCw5Vfly-DiwSWo4f6j_2jbIOo1ZBFtCgc2T68,17478
 elabapi_python/api/links_to_experiments_api.py,sha256=c18lWZMFEitrCS5QUlLid7mcV-pFFepqPpD5FtVE2n4,14876
 elabapi_python/api/links_to_items_api.py,sha256=GgkcghazGu2tZQCnCtgKMfzqtYnmUlyfhrvX48g3FkE,14628
@@ -24,8 +24,8 @@ elabapi_python/api/teams_api.py,sha256=crTQ6nMSgLLUzs87h2obR1wzefhNjU4IEiEntzJdJ
 elabapi_python/api/todolist_api.py,sha256=CZvN9CqRhj0DI4g1nmZ73zbHbQUk78iSF3E6Umvpv7w,17653
 elabapi_python/api/unfinished_steps_api.py,sha256=Zxp0VGbn5VwTjZjoGjD0GDh49XD2WoQV26d1Y4nGM1s,4153
 elabapi_python/api/uploads_api.py,sha256=JpUVgK7Lb2dv_nSBS8bbqdvX_tH3TARFFj5_zE0Kw-g,28747
-elabapi_python/api/users_api.py,sha256=HoUZlFRIU04-17MjEAiA4eHF_kdfwbkqjpKU11zDEz0,10989
-elabapi_python/models/__init__.py,sha256=qaPoDbUxKd3WPw9WT18MoRlyAEk3AaKk9rh3oAGt7ZM,3987
+elabapi_python/api/users_api.py,sha256=dS6-7qKKl8Oj_nTaqJ11SIBMFYwTvVQga22U2LK_Xb0,14987
+elabapi_python/models/__init__.py,sha256=VQXPBN0fgZjSvyZGWQZBGHZvaaBjEEhMZusJARg6ijc,4047
 elabapi_python/models/apikey.py,sha256=OlLlUZKfa_P0bKIgYAycT9yxtrbgZbk-p8E4YTW2E2M,5370
 elabapi_python/models/apikeys_body.py,sha256=8Rdoft5f80PRZaxbxncNZyGba9D8H4JDbBJOOtWI4mI,3900
 elabapi_python/models/comment.py,sha256=niUGHXr-rV07CYtYAZI1_bcsepigAq9_LYJ4NkowV4k,8659
@@ -86,6 +86,7 @@ elabapi_python/models/upload.py,sha256=p-2SW8SiDd0UIMzKe6Do9nAM-aPYV2B1XuVIshZt_
 elabapi_python/models/uploads_subid_body.py,sha256=EeSgQAtTciI0PInnm0PmoDAY0jvaHeqikJBwP5p40is,3451
 elabapi_python/models/users.py,sha256=ZCLUVIYHi9jPO7tsrbr9DILzRVfbJkt3G-VvpHdvrJo,9360
 elabapi_python/models/users_body.py,sha256=6V46vSMTtnrZlrewGVC-llyWt4VUEPkNYWsNIJyFatU,7416
+elabapi_python/models/users_id_body.py,sha256=ofNLr9t6Yc3mvLGo6B4EU9M9fdteKuq9Ky1uz1w6Ezw,2447
 test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/test_api_keys_api.py,sha256=7RpC-1rj3WDoZuW9fDEBYSfbqCURdAYohLIel2U9d7k,1119
 test/test_apikey.py,sha256=KmCGehf1zVp8rTN_IVf7WHe0NMAIt1V6RqO_LRqgaCw,876
@@ -167,9 +168,10 @@ test/test_upload.py,sha256=Eku9biI2tgI6pkq1IABtDFg-0mhO_wZn8Edd4z9cwzY,876
 test/test_uploads_api.py,sha256=wfujdKlHZ1Kwx4uIqfRuYof0p8pG-8P5L0wZ7IkCawE,1651
 test/test_uploads_subid_body.py,sha256=gzX7QRy2TDbwb0JmxqI_gwnL879pudViKaFwpU0bFzg,960
 test/test_users.py,sha256=ksfv3iXjBchgcvFQnbBwZYLHCr9oGj7ZJVpmafi73GE,868
-test/test_users_api.py,sha256=LSuIEd_5cYtzwZJAjMDEUrCpuVmYki9cCyZ6la4KEik,1114
+test/test_users_api.py,sha256=kg9_Dt3yO4CgXNWI0npPCtbQHyaWMQ-qkK1F8gX2Ryk,1245
 test/test_users_body.py,sha256=fcBZe3SisFS-_Td6Voqu3GjCyIa60OWc81yFus96vIc,902
-elabapi_python-0.1.6.dist-info/METADATA,sha256=VxAfSXP9A9-HuOI89KomR_9p99WNb1y81FbouLFbyvw,454
-elabapi_python-0.1.6.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-elabapi_python-0.1.6.dist-info/top_level.txt,sha256=BPZOy4tB7V5mJMvvpw5nc6Ou5L4KByC5IWWyNYD3fME,20
-elabapi_python-0.1.6.dist-info/RECORD,,
+test/test_users_id_body.py,sha256=SUH_AGVzw_8sPRBV3giq87oJhxgd7j00ZtoybuRxl-g,920
+elabapi_python-0.1.7.dist-info/METADATA,sha256=pJVJ_sZUe2ZGhtI71aIj6Pa2piGRK8qDsG_fpbWh-bI,454
+elabapi_python-0.1.7.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+elabapi_python-0.1.7.dist-info/top_level.txt,sha256=BPZOy4tB7V5mJMvvpw5nc6Ou5L4KByC5IWWyNYD3fME,20
+elabapi_python-0.1.7.dist-info/RECORD,,

test/test_users_api.py

@@ -28,6 +28,13 @@ class TestUsersApi(unittest.TestCase):
     def tearDown(self):
         pass
 
+    def test_patch_user(self):
+        """Test case for patch_user
+
+        Modify a user.  # noqa: E501
+        """
+        pass
+
     def test_post_user(self):
         """Test case for post_user
 

test/test_users_id_body.py

@@ -0,0 +1,39 @@
+# 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 unittest
+
+import elabapi_python
+from elabapi_python.models.users_id_body import UsersIdBody  # noqa: E501
+from elabapi_python.rest import ApiException
+
+
+class TestUsersIdBody(unittest.TestCase):
+    """UsersIdBody unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testUsersIdBody(self):
+        """Test UsersIdBody"""
+        # FIXME: construct object with mandatory attributes with example values
+        # model = elabapi_python.models.users_id_body.UsersIdBody()  # noqa: E501
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()