elabapi-python 0.1.6__tar.gz → 0.1.7__tar.gz

{elabapi-python-0.1.6 → elabapi-python-0.1.7}/PKG-INFO

@@ -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 → elabapi-python-0.1.7}/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: 0.1.6
+- Package version: 0.1.7
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -195,6 +195,7 @@ Class | Method | HTTP request | Description
 *UploadsApi* | [**post_upload_replace**](docs/UploadsApi.md#post_upload_replace) | **POST** /{entity_type}/{id}/uploads/{subid} | Replace an existing uploaded file. The existing file will be archived and the new one will be added.
 *UploadsApi* | [**read_upload**](docs/UploadsApi.md#read_upload) | **GET** /{entity_type}/{id}/uploads/{subid} | Read an upload.
 *UploadsApi* | [**read_uploads**](docs/UploadsApi.md#read_uploads) | **GET** /{entity_type}/{id}/uploads | Read attached files of that entity.
+*UsersApi* | [**patch_user**](docs/UsersApi.md#patch_user) | **PATCH** /users/{id} | Modify a user.
 *UsersApi* | [**post_user**](docs/UsersApi.md#post_user) | **POST** /users | Create a new user.
 *UsersApi* | [**read_user**](docs/UsersApi.md#read_user) | **GET** /users/{id} | Read information of a user.
 *UsersApi* | [**read_users**](docs/UsersApi.md#read_users) | **GET** /users | Read users from instance.
@@ -261,6 +262,7 @@ Class | Method | HTTP request | Description
  - [UploadsSubidBody](docs/UploadsSubidBody.md)
  - [Users](docs/Users.md)
  - [UsersBody](docs/UsersBody.md)
+ - [UsersIdBody](docs/UsersIdBody.md)
 
 ## Documentation For Authorization
 

{elabapi-python-0.1.6 → elabapi-python-0.1.7}/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-0.1.6 → elabapi-python-0.1.7}/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-0.1.6 → elabapi-python-0.1.7}/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-0.1.6 → elabapi-python-0.1.7}/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-0.1.6 → elabapi-python-0.1.7}/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-0.1.6 → elabapi-python-0.1.7}/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-0.1.7/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 → elabapi-python-0.1.7}/elabapi_python.egg-info/PKG-INFO

@@ -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 → elabapi-python-0.1.7}/elabapi_python.egg-info/SOURCES.txt

@@ -93,6 +93,7 @@ elabapi_python/models/upload.py
 elabapi_python/models/uploads_subid_body.py
 elabapi_python/models/users.py
 elabapi_python/models/users_body.py
+elabapi_python/models/users_id_body.py
 test/__init__.py
 test/test_api_keys_api.py
 test/test_apikey.py
@@ -175,4 +176,5 @@ test/test_uploads_api.py
 test/test_uploads_subid_body.py
 test/test_users.py
 test/test_users_api.py
-test/test_users_body.py
+test/test_users_body.py
+test/test_users_id_body.py

{elabapi-python-0.1.6 → elabapi-python-0.1.7}/setup.py

@@ -13,7 +13,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "elabapi-python"
-VERSION = "0.1.6"
+VERSION = "0.1.7"
 # To install the library, run the following
 #
 # python setup.py install

{elabapi-python-0.1.6 → elabapi-python-0.1.7}/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
 

elabapi-python-0.1.7/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()