teamdbapi 3.14.0__tar.gz → 3.15.0__tar.gz

{teamdbapi-3.14.0 → teamdbapi-3.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: teamdbapi
-Version: 3.14.0
+Version: 3.15.0
 Summary: Easily access the TeamDB Web API.
 Keywords: teamdbapi,Trackside,Trackside Software,TeamDB
 Author-email: Trackside Software <support@trackside.fr>
@@ -20,13 +20,13 @@ Project-URL: Home, https://www.tracksidesoftware.fr/teamdb
 # teamdbapi
 This module enables you to easily access the TeamDB Web API.
 
-- Package version: 3.14.0
+- Package version: 3.15.0
 - TeamDB Web API version: 2.0
 
 ## Requirements.
 
 - Python 3.4+
-- TeamDB 3.14.0
+- TeamDB 3.15.0
 
 ## Installation and usage
 ### pip install

{teamdbapi-3.14.0 → teamdbapi-3.15.0}/README.md

@@ -1,13 +1,13 @@
 # teamdbapi
 This module enables you to easily access the TeamDB Web API.
 
-- Package version: 3.14.0
+- Package version: 3.15.0
 - TeamDB Web API version: 2.0
 
 ## Requirements.
 
 - Python 3.4+
-- TeamDB 3.14.0
+- TeamDB 3.15.0
 
 ## Installation and usage
 ### pip install

{teamdbapi-3.14.0 → teamdbapi-3.15.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "teamdbapi"
-version = "3.14.0"
+version = "3.15.0"
 description = "Easily access the TeamDB Web API."
 authors = [{name = "Trackside Software", email = "support@trackside.fr"}]
 readme = "README.md"

{teamdbapi-3.14.0 → teamdbapi-3.15.0}/teamdbapi/api/assembly_api.py

@@ -347,7 +347,7 @@ class AssemblyApi(object):
         :param async_req bool
         :param str assembly_a_id: Assembly A unique Id (required)
         :param str assembly_b_id: Assembly B unique Id (required)
-        :param CompareOptions compare_options: The import options. You can leave options empty.              By defaut, there will be no filter and no file export.              To apply a filter you have to fill ParametersSelectionFilters and ExcludeParametersInSelection.              To export a file you must fill OutPathFilePath. The file extension will be automatically replaced by the good one.              DiffGroup allows you to select the content of the diff file generated. You can choose A or B. By default B is selected.
+        :param CompareOptions compare_options: The import options. You can leave options empty.              By defaut, there will be no filter and no file export.              To apply a filter you have to fill ParametersSelectionFilters and ExcludeParametersInSelection.              To export a file you must fill OutPathFilePath (example: C:/path/myFile.m). The file extension will be automatically replaced by the good one.              DiffGroup allows you to select the content of the diff file generated. You can choose A or B. By default B is selected.              DiffFileFormat allows you to specify the format of the diff file generated: calibration file (default) or HTML.
         :return: list[CompareResultDetail]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -370,7 +370,7 @@ class AssemblyApi(object):
         :param async_req bool
         :param str assembly_a_id: Assembly A unique Id (required)
         :param str assembly_b_id: Assembly B unique Id (required)
-        :param CompareOptions compare_options: The import options. You can leave options empty.              By defaut, there will be no filter and no file export.              To apply a filter you have to fill ParametersSelectionFilters and ExcludeParametersInSelection.              To export a file you must fill OutPathFilePath. The file extension will be automatically replaced by the good one.              DiffGroup allows you to select the content of the diff file generated. You can choose A or B. By default B is selected.
+        :param CompareOptions compare_options: The import options. You can leave options empty.              By defaut, there will be no filter and no file export.              To apply a filter you have to fill ParametersSelectionFilters and ExcludeParametersInSelection.              To export a file you must fill OutPathFilePath (example: C:/path/myFile.m). The file extension will be automatically replaced by the good one.              DiffGroup allows you to select the content of the diff file generated. You can choose A or B. By default B is selected.              DiffFileFormat allows you to specify the format of the diff file generated: calibration file (default) or HTML.
         :return: list[CompareResultDetail]
                  If the method is called asynchronously,
                  returns the request thread.
@@ -445,6 +445,115 @@ class AssemblyApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def compare_assemblies_ui(self, assembly_a_id, assembly_b_id, **kwargs):  # noqa: E501
+        """[Command] Set the selected assemblies in the compare view UI and run the compare.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.compare_assemblies_ui(assembly_a_id, assembly_b_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str assembly_a_id: The assembly A unique ID (required)
+        :param str assembly_b_id: The assembly B unique ID (required)
+        :param str assembly_c_id: The assembly C unique ID (optionnal)
+        :param bool run_compare: Whether to run the compare after selecting the assemblies (optionnal, true as default)
+        :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.compare_assemblies_ui_with_http_info(assembly_a_id, assembly_b_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.compare_assemblies_ui_with_http_info(assembly_a_id, assembly_b_id, **kwargs)  # noqa: E501
+            return data
+
+    def compare_assemblies_ui_with_http_info(self, assembly_a_id, assembly_b_id, **kwargs):  # noqa: E501
+        """[Command] Set the selected assemblies in the compare view UI and run the compare.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.compare_assemblies_ui_with_http_info(assembly_a_id, assembly_b_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str assembly_a_id: The assembly A unique ID (required)
+        :param str assembly_b_id: The assembly B unique ID (required)
+        :param str assembly_c_id: The assembly C unique ID (optionnal)
+        :param bool run_compare: Whether to run the compare after selecting the assemblies (optionnal, true as default)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['assembly_a_id', 'assembly_b_id', 'assembly_c_id', 'run_compare']  # 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 compare_assemblies_ui" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'assembly_a_id' is set
+        if self.api_client.client_side_validation and ('assembly_a_id' not in params or
+                                                       params['assembly_a_id'] is None):  # noqa: E501
+            raise ValueError("Missing the required parameter `assembly_a_id` when calling `compare_assemblies_ui`")  # noqa: E501
+        # verify the required parameter 'assembly_b_id' is set
+        if self.api_client.client_side_validation and ('assembly_b_id' not in params or
+                                                       params['assembly_b_id'] is None):  # noqa: E501
+            raise ValueError("Missing the required parameter `assembly_b_id` when calling `compare_assemblies_ui`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'assembly_a_id' in params:
+            query_params.append(('assemblyAId', params['assembly_a_id']))  # noqa: E501
+        if 'assembly_b_id' in params:
+            query_params.append(('assemblyBId', params['assembly_b_id']))  # noqa: E501
+        if 'assembly_c_id' in params:
+            query_params.append(('assemblyCId', params['assembly_c_id']))  # noqa: E501
+        if 'run_compare' in params:
+            query_params.append(('runCompare', params['run_compare']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json', 'text/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['TdbApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/teamdbapi/v2.0/assembly/compareui', '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)
+
     def create_assembly(self, assembly, **kwargs):  # noqa: E501
         """Create an assembly. The revisions list content will be ignored. You must call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
 

{teamdbapi-3.14.0 → teamdbapi-3.15.0}/teamdbapi/models/calibration.py

@@ -55,7 +55,8 @@ class Calibration(object):
         'StringFormat': 'str',
         'UpperLimit': 'float',
         'LowerLimit': 'float',
-        'ReadOnly': 'bool'
+        'ReadOnly': 'bool',
+        'LiveTune': 'bool'
     }
 
     attribute_map = {
@@ -81,10 +82,11 @@ class Calibration(object):
         'StringFormat': 'StringFormat',
         'UpperLimit': 'UpperLimit',
         'LowerLimit': 'LowerLimit',
-        'ReadOnly': 'ReadOnly'
+        'ReadOnly': 'ReadOnly',
+        'LiveTune': 'LiveTune'
     }
 
-    def __init__(self, Name=None, Description=None, Reference=None, Data=None, DataType=None, NX=None, NY=None, NZ=None, AxeX=None, AxeY=None, AxeZ=None, CalibrationType=None, GroupePath=None, Unit=None, DataAxeX=None, DataAxeY=None, DataAxeZ=None, IsAxe=None, GroupFullPath=None, StringFormat=None, UpperLimit=None, LowerLimit=None, ReadOnly=None, _configuration=None):  # noqa: E501
+    def __init__(self, Name=None, Description=None, Reference=None, Data=None, DataType=None, NX=None, NY=None, NZ=None, AxeX=None, AxeY=None, AxeZ=None, CalibrationType=None, GroupePath=None, Unit=None, DataAxeX=None, DataAxeY=None, DataAxeZ=None, IsAxe=None, GroupFullPath=None, StringFormat=None, UpperLimit=None, LowerLimit=None, ReadOnly=None, LiveTune=None, _configuration=None):  # noqa: E501
         """Calibration - a model defined in Swagger"""  # noqa: E501
         if _configuration is None:
             _configuration = Configuration()
@@ -113,6 +115,7 @@ class Calibration(object):
         self._UpperLimit = None
         self._LowerLimit = None
         self._ReadOnly = None
+        self._LiveTune = None
         self.discriminator = None
 
         if Name is not None:
@@ -161,6 +164,8 @@ class Calibration(object):
             self.LowerLimit = LowerLimit
         if ReadOnly is not None:
             self.ReadOnly = ReadOnly
+        if LiveTune is not None:
+            self.LiveTune = LiveTune
 
     @property
     def Name(self):
@@ -705,6 +710,29 @@ class Calibration(object):
 
         self._ReadOnly = ReadOnly
 
+    @property
+    def LiveTune(self):
+        """Gets the LiveTune of this Calibration.  # noqa: E501
+
+        True if the parameter value can be tuned in live  # noqa: E501
+
+        :return: The LiveTune of this Calibration.  # noqa: E501
+        :rtype: bool
+        """
+        return self._LiveTune
+
+    @LiveTune.setter
+    def LiveTune(self, LiveTune):
+        """Sets the LiveTune of this Calibration.
+
+        True if the parameter value can be tuned in live  # noqa: E501
+
+        :param LiveTune: The LiveTune of this Calibration.  # noqa: E501
+        :type: bool
+        """
+
+        self._LiveTune = LiveTune
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}

{teamdbapi-3.14.0 → teamdbapi-3.15.0}/teamdbapi/models/compare_options.py

@@ -36,17 +36,19 @@ class CompareOptions(object):
         'ParametersSelectionFilters': 'list[str]',
         'ExcludeParametersInSelection': 'bool',
         'DiffFilePath': 'str',
-        'DiffGroup': 'str'
+        'DiffGroup': 'str',
+        'DiffFileFormat': 'str'
     }
 
     attribute_map = {
         'ParametersSelectionFilters': 'ParametersSelectionFilters',
         'ExcludeParametersInSelection': 'ExcludeParametersInSelection',
         'DiffFilePath': 'DiffFilePath',
-        'DiffGroup': 'DiffGroup'
+        'DiffGroup': 'DiffGroup',
+        'DiffFileFormat': 'DiffFileFormat'
     }
 
-    def __init__(self, ParametersSelectionFilters=None, ExcludeParametersInSelection=None, DiffFilePath=None, DiffGroup=None, _configuration=None):  # noqa: E501
+    def __init__(self, ParametersSelectionFilters=None, ExcludeParametersInSelection=None, DiffFilePath=None, DiffGroup=None, DiffFileFormat=None, _configuration=None):  # noqa: E501
         """CompareOptions - a model defined in Swagger"""  # noqa: E501
         if _configuration is None:
             _configuration = Configuration()
@@ -56,6 +58,7 @@ class CompareOptions(object):
         self._ExcludeParametersInSelection = None
         self._DiffFilePath = None
         self._DiffGroup = None
+        self._DiffFileFormat = None
         self.discriminator = None
 
         if ParametersSelectionFilters is not None:
@@ -66,6 +69,8 @@ class CompareOptions(object):
             self.DiffFilePath = DiffFilePath
         if DiffGroup is not None:
             self.DiffGroup = DiffGroup
+        if DiffFileFormat is not None:
+            self.DiffFileFormat = DiffFileFormat
 
     @property
     def ParametersSelectionFilters(self):
@@ -166,6 +171,36 @@ class CompareOptions(object):
 
         self._DiffGroup = DiffGroup
 
+    @property
+    def DiffFileFormat(self):
+        """Gets the DiffFileFormat of this CompareOptions.  # noqa: E501
+
+        The differences output file format to use to generate the diff file when DiffFilePath is filled.   Calibration format (default) uses the target file format (M, DCM, etc.).  HTML format writes a HTML report of the differences.  # noqa: E501
+
+        :return: The DiffFileFormat of this CompareOptions.  # noqa: E501
+        :rtype: str
+        """
+        return self._DiffFileFormat
+
+    @DiffFileFormat.setter
+    def DiffFileFormat(self, DiffFileFormat):
+        """Sets the DiffFileFormat of this CompareOptions.
+
+        The differences output file format to use to generate the diff file when DiffFilePath is filled.   Calibration format (default) uses the target file format (M, DCM, etc.).  HTML format writes a HTML report of the differences.  # noqa: E501
+
+        :param DiffFileFormat: The DiffFileFormat of this CompareOptions.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["Calibration", "HTML"]  # noqa: E501
+        if (self._configuration.client_side_validation and
+                DiffFileFormat not in allowed_values):
+            raise ValueError(
+                "Invalid value for `DiffFileFormat` ({0}), must be one of {1}"  # noqa: E501
+                .format(DiffFileFormat, allowed_values)
+            )
+
+        self._DiffFileFormat = DiffFileFormat
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}