elabapi-python 0.4.0__tar.gz → 0.4.1__tar.gz

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/PKG-INFO

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

{elabapi-python-0.4.0 → elabapi-python-0.4.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: 0.4.0
+- Package version: 0.4.1
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -118,8 +118,9 @@ Class | Method | HTTP request | Description
 *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
 *EventsApi* | [**delete_event**](docs/EventsApi.md#delete_event) | **DELETE** /event/{id} | Delete a booking slot.
-*EventsApi* | [**patch_event**](docs/EventsApi.md#patch_event) | **PATCH** /events/{id} | Modify a booking slot. Warning: only one value (target) can be edited at a time. 
+*EventsApi* | [**patch_event**](docs/EventsApi.md#patch_event) | **PATCH** /event/{id} | Modify a booking slot. Warning: only one value (target) can be edited at a time. 
 *EventsApi* | [**post_events**](docs/EventsApi.md#post_events) | **POST** /events/{id} | Create an event for the item specified as id.
+*EventsApi* | [**read_event**](docs/EventsApi.md#read_event) | **GET** /event/{id} | Read a booking slot.
 *EventsApi* | [**read_events**](docs/EventsApi.md#read_events) | **GET** /events | Read all events in the team.
 *ExperimentsApi* | [**delete_experiment**](docs/ExperimentsApi.md#delete_experiment) | **DELETE** /experiments/{id} | Delete an experiment.
 *ExperimentsApi* | [**get_experiment**](docs/ExperimentsApi.md#get_experiment) | **GET** /experiments/{id} | Read an experiment
@@ -228,9 +229,9 @@ Class | Method | HTTP request | Description
  - [Config](docs/Config.md)
  - [Entity](docs/Entity.md)
  - [Event](docs/Event.md)
+ - [EventIdBody](docs/EventIdBody.md)
+ - [EventidDelta](docs/EventidDelta.md)
  - [EventsIdBody](docs/EventsIdBody.md)
- - [EventsIdBody1](docs/EventsIdBody1.md)
- - [EventsidDelta](docs/EventsidDelta.md)
  - [Experiment](docs/Experiment.md)
  - [ExperimentTemplate](docs/ExperimentTemplate.md)
  - [ExperimentsBody](docs/ExperimentsBody.md)

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/elabapi_python/__init__.py

@@ -52,9 +52,9 @@ from elabapi_python.models.comment import Comment
 from elabapi_python.models.config import Config
 from elabapi_python.models.entity import Entity
 from elabapi_python.models.event import Event
+from elabapi_python.models.event_id_body import EventIdBody
+from elabapi_python.models.eventid_delta import EventidDelta
 from elabapi_python.models.events_id_body import EventsIdBody
-from elabapi_python.models.events_id_body1 import EventsIdBody1
-from elabapi_python.models.eventsid_delta import EventsidDelta
 from elabapi_python.models.experiment import Experiment
 from elabapi_python.models.experiment_template import ExperimentTemplate
 from elabapi_python.models.experiments_body import ExperimentsBody

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/elabapi_python/api/events_api.py

@@ -134,8 +134,8 @@ class EventsApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the item to book. (required)
-        :param EventsIdBody1 body: Parameters for modifying an event.
+        :param int id: ID of the event to modify. (required)
+        :param EventIdBody body: Parameters for modifying an event.
         :return: Event
                  If the method is called asynchronously,
                  returns the request thread.
@@ -156,8 +156,8 @@ class EventsApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param int id: ID of the item to book. (required)
-        :param EventsIdBody1 body: Parameters for modifying an event.
+        :param int id: ID of the event to modify. (required)
+        :param EventIdBody body: Parameters for modifying an event.
         :return: Event
                  If the method is called asynchronously,
                  returns the request thread.
@@ -211,7 +211,7 @@ class EventsApi(object):
         auth_settings = ['token']  # noqa: E501
 
         return self.api_client.call_api(
-            '/events/{id}', 'PATCH',
+            '/event/{id}', 'PATCH',
             path_params,
             query_params,
             header_params,
@@ -323,6 +323,99 @@ class EventsApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def read_event(self, id, **kwargs):  # noqa: E501
+        """Read a booking slot.  # 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_event(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the event to modify. (required)
+        :return: Event
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.read_event_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.read_event_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def read_event_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Read a booking slot.  # 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_event_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param int id: ID of the event to modify. (required)
+        :return: Event
+                 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 read_event" % 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 `read_event`")  # 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(
+            '/event/{id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Event',  # 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 read_events(self, **kwargs):  # noqa: E501
         """Read all events in the team.  # noqa: E501
 

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/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.4.0/python'
+        self.user_agent = 'Swagger-Codegen/0.4.1/python'
 
     def __del__(self):
         self.pool.close()

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/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.4.0".\
+               "SDK Package Version: 0.4.1".\
                format(env=sys.platform, pyversion=sys.version)

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/elabapi_python/models/__init__.py

@@ -20,9 +20,9 @@ from elabapi_python.models.comment import Comment
 from elabapi_python.models.config import Config
 from elabapi_python.models.entity import Entity
 from elabapi_python.models.event import Event
+from elabapi_python.models.event_id_body import EventIdBody
+from elabapi_python.models.eventid_delta import EventidDelta
 from elabapi_python.models.events_id_body import EventsIdBody
-from elabapi_python.models.events_id_body1 import EventsIdBody1
-from elabapi_python.models.eventsid_delta import EventsidDelta
 from elabapi_python.models.experiment import Experiment
 from elabapi_python.models.experiment_template import ExperimentTemplate
 from elabapi_python.models.experiments_body import ExperimentsBody

elabapi-python-0.4.1/elabapi_python/models/event_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 EventIdBody(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
+        """EventIdBody - 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(EventIdBody, 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, EventIdBody):
+            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.4.0/elabapi_python/models/eventsid_delta.py → elabapi-python-0.4.1/elabapi_python/models/eventid_delta.py

@@ -15,7 +15,7 @@ import re  # noqa: F401
 
 import six
 
-class EventsidDelta(object):
+class EventidDelta(object):
     """NOTE: This class is auto generated by the swagger code generator program.
 
     Do not edit the class manually.
@@ -42,7 +42,7 @@ class EventsidDelta(object):
     }
 
     def __init__(self, days=None, milliseconds=None, months=None, years=None):  # noqa: E501
-        """EventsidDelta - a model defined in Swagger"""  # noqa: E501
+        """EventidDelta - a model defined in Swagger"""  # noqa: E501
         self._days = None
         self._milliseconds = None
         self._months = None
@@ -59,20 +59,20 @@ class EventsidDelta(object):
 
     @property
     def days(self):
-        """Gets the days of this EventsidDelta.  # noqa: E501
+        """Gets the days of this EventidDelta.  # noqa: E501
 
 
-        :return: The days of this EventsidDelta.  # noqa: E501
+        :return: The days of this EventidDelta.  # noqa: E501
         :rtype: int
         """
         return self._days
 
     @days.setter
     def days(self, days):
-        """Sets the days of this EventsidDelta.
+        """Sets the days of this EventidDelta.
 
 
-        :param days: The days of this EventsidDelta.  # noqa: E501
+        :param days: The days of this EventidDelta.  # noqa: E501
         :type: int
         """
 
@@ -80,20 +80,20 @@ class EventsidDelta(object):
 
     @property
     def milliseconds(self):
-        """Gets the milliseconds of this EventsidDelta.  # noqa: E501
+        """Gets the milliseconds of this EventidDelta.  # noqa: E501
 
 
-        :return: The milliseconds of this EventsidDelta.  # noqa: E501
+        :return: The milliseconds of this EventidDelta.  # noqa: E501
         :rtype: int
         """
         return self._milliseconds
 
     @milliseconds.setter
     def milliseconds(self, milliseconds):
-        """Sets the milliseconds of this EventsidDelta.
+        """Sets the milliseconds of this EventidDelta.
 
 
-        :param milliseconds: The milliseconds of this EventsidDelta.  # noqa: E501
+        :param milliseconds: The milliseconds of this EventidDelta.  # noqa: E501
         :type: int
         """
 
@@ -101,20 +101,20 @@ class EventsidDelta(object):
 
     @property
     def months(self):
-        """Gets the months of this EventsidDelta.  # noqa: E501
+        """Gets the months of this EventidDelta.  # noqa: E501
 
 
-        :return: The months of this EventsidDelta.  # noqa: E501
+        :return: The months of this EventidDelta.  # noqa: E501
         :rtype: int
         """
         return self._months
 
     @months.setter
     def months(self, months):
-        """Sets the months of this EventsidDelta.
+        """Sets the months of this EventidDelta.
 
 
-        :param months: The months of this EventsidDelta.  # noqa: E501
+        :param months: The months of this EventidDelta.  # noqa: E501
         :type: int
         """
 
@@ -122,20 +122,20 @@ class EventsidDelta(object):
 
     @property
     def years(self):
-        """Gets the years of this EventsidDelta.  # noqa: E501
+        """Gets the years of this EventidDelta.  # noqa: E501
 
 
-        :return: The years of this EventsidDelta.  # noqa: E501
+        :return: The years of this EventidDelta.  # noqa: E501
         :rtype: int
         """
         return self._years
 
     @years.setter
     def years(self, years):
-        """Sets the years of this EventsidDelta.
+        """Sets the years of this EventidDelta.
 
 
-        :param years: The years of this EventsidDelta.  # noqa: E501
+        :param years: The years of this EventidDelta.  # noqa: E501
         :type: int
         """
 
@@ -162,7 +162,7 @@ class EventsidDelta(object):
                 ))
             else:
                 result[attr] = value
-        if issubclass(EventsidDelta, dict):
+        if issubclass(EventidDelta, dict):
             for key, value in self.items():
                 result[key] = value
 
@@ -178,7 +178,7 @@ class EventsidDelta(object):
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, EventsidDelta):
+        if not isinstance(other, EventidDelta):
             return False
 
         return self.__dict__ == other.__dict__

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/elabapi_python.egg-info/PKG-INFO

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

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/elabapi_python.egg-info/SOURCES.txt

@@ -44,9 +44,9 @@ elabapi_python/models/comment.py
 elabapi_python/models/config.py
 elabapi_python/models/entity.py
 elabapi_python/models/event.py
+elabapi_python/models/event_id_body.py
+elabapi_python/models/eventid_delta.py
 elabapi_python/models/events_id_body.py
-elabapi_python/models/events_id_body1.py
-elabapi_python/models/eventsid_delta.py
 elabapi_python/models/experiment.py
 elabapi_python/models/experiment_template.py
 elabapi_python/models/experiments_body.py
@@ -124,10 +124,10 @@ test/test_config.py
 test/test_config_api.py
 test/test_entity.py
 test/test_event.py
+test/test_event_id_body.py
+test/test_eventid_delta.py
 test/test_events_api.py
 test/test_events_id_body.py
-test/test_events_id_body1.py
-test/test_eventsid_delta.py
 test/test_experiment.py
 test/test_experiment_template.py
 test/test_experiments_api.py

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/setup.py

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

elabapi-python-0.4.1/test/test_event_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.event_id_body import EventIdBody  # noqa: E501
+from elabapi_python.rest import ApiException
+
+
+class TestEventIdBody(unittest.TestCase):
+    """EventIdBody unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testEventIdBody(self):
+        """Test EventIdBody"""
+        # FIXME: construct object with mandatory attributes with example values
+        # model = elabapi_python.models.event_id_body.EventIdBody()  # noqa: E501
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

elabapi-python-0.4.1/test/test_eventid_delta.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.eventid_delta import EventidDelta  # noqa: E501
+from elabapi_python.rest import ApiException
+
+
+class TestEventidDelta(unittest.TestCase):
+    """EventidDelta unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testEventidDelta(self):
+        """Test EventidDelta"""
+        # FIXME: construct object with mandatory attributes with example values
+        # model = elabapi_python.models.eventid_delta.EventidDelta()  # noqa: E501
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

{elabapi-python-0.4.0 → elabapi-python-0.4.1}/test/test_events_api.py

@@ -49,6 +49,13 @@ class TestEventsApi(unittest.TestCase):
         """
         pass
 
+    def test_read_event(self):
+        """Test case for read_event
+
+        Read a booking slot.  # noqa: E501
+        """
+        pass
+
     def test_read_events(self):
         """Test case for read_events
 

elabapi-python-0.4.0/elabapi_python/models/events_id_body1.py

@@ -1,84 +0,0 @@
-# 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 EventsIdBody1(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
-        """EventsIdBody1 - 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(EventsIdBody1, 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, EventsIdBody1):
-            return False
-
-        return self.__dict__ == other.__dict__
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        return not self == other