teamdbapi 3.2.0__tar.gz → 3.4.0__tar.gz

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/PKG-INFO

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

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/README.md

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

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/pyproject.toml

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

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/__init__.py

@@ -31,7 +31,9 @@ from teamdbapi.api.lap_report_api import LapReportApi
 from teamdbapi.api.model_field_api import ModelFieldApi
 from teamdbapi.api.mounting_api import MountingApi
 from teamdbapi.api.notes_authorization_api import NotesAuthorizationApi
+from teamdbapi.api.overall_api import OverallApi
 from teamdbapi.api.parameter_api import ParameterApi
+from teamdbapi.api.parameter_binding_api import ParameterBindingApi
 from teamdbapi.api.part_api import PartApi
 from teamdbapi.api.report_api import ReportApi
 from teamdbapi.api.revision_api import RevisionApi
@@ -94,7 +96,9 @@ from teamdbapi.models.model_field_authorization import ModelFieldAuthorization
 from teamdbapi.models.mounting import Mounting
 from teamdbapi.models.notes_authorization import NotesAuthorization
 from teamdbapi.models.notes_context import NotesContext
+from teamdbapi.models.overall import Overall
 from teamdbapi.models.parameter import Parameter
+from teamdbapi.models.parameter_binding import ParameterBinding
 from teamdbapi.models.parameter_cross_table import ParameterCrossTable
 from teamdbapi.models.part import Part
 from teamdbapi.models.part_car_parameters import PartCarParameters

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/api/__init__.py

@@ -19,7 +19,9 @@ from teamdbapi.api.lap_report_api import LapReportApi
 from teamdbapi.api.model_field_api import ModelFieldApi
 from teamdbapi.api.mounting_api import MountingApi
 from teamdbapi.api.notes_authorization_api import NotesAuthorizationApi
+from teamdbapi.api.overall_api import OverallApi
 from teamdbapi.api.parameter_api import ParameterApi
+from teamdbapi.api.parameter_binding_api import ParameterBindingApi
 from teamdbapi.api.part_api import PartApi
 from teamdbapi.api.report_api import ReportApi
 from teamdbapi.api.revision_api import RevisionApi

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/api/assembly_api.py

@@ -751,7 +751,7 @@ class AssemblyApi(object):
 
         :param async_req bool
         :param str assembly_id: The unique assembly id corresponding to the assembly to export. (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : MyFile.m (required)
+        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.m (required)
         :return: bool
                  If the method is called asynchronously,
                  returns the request thread.
@@ -773,7 +773,7 @@ class AssemblyApi(object):
 
         :param async_req bool
         :param str assembly_id: The unique assembly id corresponding to the assembly to export. (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : MyFile.m (required)
+        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.m (required)
         :return: bool
                  If the method is called asynchronously,
                  returns the request thread.
@@ -1319,7 +1319,7 @@ class AssemblyApi(object):
         :param str version_id: The version id to which the new assembly will belong
         :param str assembly_name: The assembly name to create
         :param str revision_name: The default revision name used to create the new revisions
-        :param str file_path: The file path containing the parameters
+        :param str file_path: The file path containing the parameters. Example: C:/path/myFile.m
         :return: Assembly
                  If the method is called asynchronously,
                  returns the request thread.
@@ -1343,7 +1343,7 @@ class AssemblyApi(object):
         :param str version_id: The version id to which the new assembly will belong
         :param str assembly_name: The assembly name to create
         :param str revision_name: The default revision name used to create the new revisions
-        :param str file_path: The file path containing the parameters
+        :param str file_path: The file path containing the parameters. Example: C:/path/myFile.m
         :return: Assembly
                  If the method is called asynchronously,
                  returns the request thread.

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/api/component_api.py

@@ -957,6 +957,91 @@ class ComponentApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def trigger_lifing_export_components(self, **kwargs):  # noqa: E501
+        """[Command] Trigger the lifing export components. The export concerns the components lifed linked to a mountinng and updated during the N last days  (depending on the server configuration option: Export lifing component period)  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.trigger_lifing_export_components(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :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.trigger_lifing_export_components_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.trigger_lifing_export_components_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def trigger_lifing_export_components_with_http_info(self, **kwargs):  # noqa: E501
+        """[Command] Trigger the lifing export components. The export concerns the components lifed linked to a mountinng and updated during the N last days  (depending on the server configuration option: Export lifing component period)  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.trigger_lifing_export_components_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: None
+                 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 trigger_lifing_export_components" % 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', 'text/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/teamdbapi/v2.0/component/export', '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 update_component_revision(self, component_id, revision_id, **kwargs):  # noqa: E501
         """Update a component revision from it's unique identifiers.  # noqa: E501
 

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/api/edit_api.py

@@ -137,6 +137,95 @@ class EditApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def get_all_car_parameters_contexts(self, **kwargs):  # noqa: E501
+        """Get all car parameters contexts in all TeamDB client layouts, or the global context only if the Use Global Context option is active.  # 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_all_car_parameters_contexts(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param bool include_hidden_layouts: True to include all layouts including hidden ones, False for only the visible ones
+        :return: list[CarParametersContext]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_all_car_parameters_contexts_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_all_car_parameters_contexts_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_all_car_parameters_contexts_with_http_info(self, **kwargs):  # noqa: E501
+        """Get all car parameters contexts in all TeamDB client layouts, or the global context only if the Use Global Context option is active.  # 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_all_car_parameters_contexts_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param bool include_hidden_layouts: True to include all layouts including hidden ones, False for only the visible ones
+        :return: list[CarParametersContext]
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['include_hidden_layouts']  # 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_all_car_parameters_contexts" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'include_hidden_layouts' in params:
+            query_params.append(('includeHiddenLayouts', params['include_hidden_layouts']))  # 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 = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/teamdbapi/v2.0/allCarParametersContext', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='list[CarParametersContext]',  # 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_current_car_parameters_selected_context(self, **kwargs):  # noqa: E501
         """Get the current Car Parameters selected context in Parameters Editor view  # noqa: E501
 

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/api/import_export_api.py

@@ -43,7 +43,7 @@ class ImportExportApi(object):
         :param async_req bool
         :param str xml_data_format: The XML file format (Wintax or TeamDB) (required)
         :param str source_id: The Source ID string for which you want to export the data (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:\\path\\MyFile.xml (required)
+        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -66,7 +66,7 @@ class ImportExportApi(object):
         :param async_req bool
         :param str xml_data_format: The XML file format (Wintax or TeamDB) (required)
         :param str source_id: The Source ID string for which you want to export the data (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:\\path\\MyFile.xml (required)
+        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -157,7 +157,7 @@ class ImportExportApi(object):
         :param str lap_id: The lap ID from which perform the export or the empty id 00000000-0000-0000-0000-000000000000 (required)
         :param str xml_data_format: The XML file format (Wintax or TeamDB) (required)
         :param str source_id: The Source ID string for which you want to export the data (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:\\path\\MyFile.xml (required)
+        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -185,7 +185,7 @@ class ImportExportApi(object):
         :param str lap_id: The lap ID from which perform the export or the empty id 00000000-0000-0000-0000-000000000000 (required)
         :param str xml_data_format: The XML file format (Wintax or TeamDB) (required)
         :param str source_id: The Source ID string for which you want to export the data (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:\\path\\MyFile.xml (required)
+        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -300,7 +300,7 @@ class ImportExportApi(object):
 
         :param async_req bool
         :param str source_path: The source path configured in the teamdb fields that you want to import (required)
-        :param str input_file_path: The Excel file path you want to import. For example : C:\\path\\MyFile.xlsx (required)
+        :param str input_file_path: The Excel file path you want to import. For example : C:/path/MyFile.xlsx (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -322,7 +322,7 @@ class ImportExportApi(object):
 
         :param async_req bool
         :param str source_path: The source path configured in the teamdb fields that you want to import (required)
-        :param str input_file_path: The Excel file path you want to import. For example : C:\\path\\MyFile.xlsx (required)
+        :param str input_file_path: The Excel file path you want to import. For example : C:/path/MyFile.xlsx (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -402,7 +402,7 @@ class ImportExportApi(object):
         :param async_req bool
         :param str source_path: The source path configured in the teamdb fields that you want to import (required)
         :param str sheetname: The sheet name in the file (required)
-        :param str input_file_path: The Excel file path you want to import. For example : C:\\path\\MyFile.xlsx (required)
+        :param str input_file_path: The Excel file path you want to import. For example : C:/path/MyFile.xlsx (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -425,7 +425,7 @@ class ImportExportApi(object):
         :param async_req bool
         :param str source_path: The source path configured in the teamdb fields that you want to import (required)
         :param str sheetname: The sheet name in the file (required)
-        :param str input_file_path: The Excel file path you want to import. For example : C:\\path\\MyFile.xlsx (required)
+        :param str input_file_path: The Excel file path you want to import. For example : C:/path/MyFile.xlsx (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -510,7 +510,7 @@ class ImportExportApi(object):
 
         :param async_req bool
         :param str source_id: The source ID configured in the teamdb fields that you want to import (required)
-        :param str input_file_path: The XML file path you want to import. For example : C:\\path\\MyFile.xml (required)
+        :param str input_file_path: The XML file path you want to import. For example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -532,7 +532,7 @@ class ImportExportApi(object):
 
         :param async_req bool
         :param str source_id: The source ID configured in the teamdb fields that you want to import (required)
-        :param str input_file_path: The XML file path you want to import. For example : C:\\path\\MyFile.xml (required)
+        :param str input_file_path: The XML file path you want to import. For example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -616,7 +616,7 @@ class ImportExportApi(object):
         :param str run_id: The run ID to which perform the import or the empty id 00000000-0000-0000-0000-000000000000 (required)
         :param str lap_id: The lap ID to which perform the import or the empty id 00000000-0000-0000-0000-000000000000 (required)
         :param str source_id: The source ID configured in the teamdb fields that you want to import (required)
-        :param str input_file_path: The XML file path you want to import. For example : C:\\path\\MyFile.xml (required)
+        :param str input_file_path: The XML file path you want to import. For example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
@@ -643,7 +643,7 @@ class ImportExportApi(object):
         :param str run_id: The run ID to which perform the import or the empty id 00000000-0000-0000-0000-000000000000 (required)
         :param str lap_id: The lap ID to which perform the import or the empty id 00000000-0000-0000-0000-000000000000 (required)
         :param str source_id: The source ID configured in the teamdb fields that you want to import (required)
-        :param str input_file_path: The XML file path you want to import. For example : C:\\path\\MyFile.xml (required)
+        :param str input_file_path: The XML file path you want to import. For example : C:/path/MyFile.xml (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.

{teamdbapi-3.2.0 → teamdbapi-3.4.0}/teamdbapi/api/lap_report_api.py

@@ -296,7 +296,7 @@ class LapReportApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param str file_path: The lap report path (required)
+        :param str file_path: The lap report path. Example: C:/path/myFile.csv (required)
         :param str lap_report_file_format: The lap report file format: Wintax or Atlas (required)
         :param str session_id: The identifier of the session in which the report is to be loaded; if there is none, the report is imported into the current session.
         :return: None
@@ -319,7 +319,7 @@ class LapReportApi(object):
         >>> result = thread.get()
 
         :param async_req bool
-        :param str file_path: The lap report path (required)
+        :param str file_path: The lap report path. Example: C:/path/myFile.csv (required)
         :param str lap_report_file_format: The lap report file format: Wintax or Atlas (required)
         :param str session_id: The identifier of the session in which the report is to be loaded; if there is none, the report is imported into the current session.
         :return: None

teamdbapi-3.4.0/teamdbapi/api/overall_api.py

@@ -0,0 +1,118 @@
+# coding: utf-8
+
+"""
+    Trackside Software TeamDB API v2.0
+
+    This API enables you to access TeamDB data  # noqa: E501
+
+    OpenAPI spec version: 2.0
+    Contact: support@trackside.fr
+    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 teamdbapi.api_client import ApiClient
+
+
+class OverallApi(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 get_current_overall(self, **kwargs):  # noqa: E501
+        """Get the current Overall.  # 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_current_overall(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: Overall
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_current_overall_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_current_overall_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_current_overall_with_http_info(self, **kwargs):  # noqa: E501
+        """Get the current Overall.  # 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_current_overall_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: Overall
+                 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_current_overall" % 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', 'text/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/teamdbapi/v2.0/overall/current', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Overall',  # 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)