weheat 2024.11.1__py3-none-any.whl → 2025.11.24rc1__py3-none-any.whl

weheat/api/heat_pump_api.py

@@ -12,27 +12,31 @@
 """  # noqa: E501
 
 
-import re  # noqa: F401
 import io
 import warnings
 
-from pydantic import validate_arguments, ValidationError
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Dict, List, Optional, Tuple, Union, Any
 
+try:
+    from typing import Annotated
+except ImportError:
+    from typing_extensions import Annotated
+
+from pydantic import Field
 from typing_extensions import Annotated
-from pydantic import Field, StrictInt, StrictStr
+from pydantic import StrictInt, StrictStr
 
 from typing import List, Optional
 
 from weheat.models.device_state import DeviceState
-from weheat.models.read_all_heat_pump_dto import ReadAllHeatPumpDto
+from weheat.models.read_all_heat_pump_dto_paged_response import ReadAllHeatPumpDtoPagedResponse
 from weheat.models.read_heat_pump_dto import ReadHeatPumpDto
+from weheat.models.heat_pump_model import HeatPumpModel
 
 from weheat.api_client import ApiClient
 from weheat.api_response import ApiResponse
-from weheat.exceptions import (  # noqa: F401
-    ApiTypeError,
-    ApiValueError
-)
+from weheat.rest import RESTResponseType
 
 
 class HeatPumpApi:
@@ -47,484 +51,686 @@ class HeatPumpApi:
             api_client = ApiClient.get_default()
         self.api_client = api_client
 
-    @validate_arguments
-    def api_v1_heat_pumps_get(self, search : Annotated[Optional[StrictStr], Field(description="String with keywords (split by spaces) to search on SN, PN and Name of a heat pump")] = None, page : Annotated[Optional[StrictInt], Field(description="The page number")] = None, page_size : Annotated[Optional[StrictInt], Field(description="The page size")] = None, state : Annotated[Optional[DeviceState], Field(description="Filter for which device state the heat pump should be in using Device")] = None, x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> List[ReadAllHeatPumpDto]:  # noqa: E501
-        """Gets all heat pumps (Paged, Searchable)  # noqa: E501
 
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+    @validate_call
+    async def api_v1_heat_pumps_get(
+        self,
+        page: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]], Field(description="The page number")] = None,
+        page_size: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]], Field(description="The page size")] = None,
+        model: Annotated[Optional[List[HeatPumpModel]], Field(description="Optional filter for which model(s) the heat pump are valid for this query")] = None,
+        organisation_id: Annotated[Optional[StrictStr], Field(description="An ID of the organisation which we want to filter on to get its stock")] = None,
+        search: Annotated[Optional[Annotated[str, Field(min_length=0, strict=True, max_length=100)]], Field(description="String with keywords (split by spaces) to search on SN, PN and Name of a heat pump")] = None,
+        state: Annotated[Optional[DeviceState], Field(description="Filter for which device state the heat pump should be in using Device")] = None,
+        x_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None,
+        x_backend_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ReadAllHeatPumpDtoPagedResponse:
+        """Gets all heat pumps (Paged, Searchable)
 
-        >>> thread = api.api_v1_heat_pumps_get(search, page, page_size, state, x_version, async_req=True)
-        >>> result = thread.get()
 
-        :param search: String with keywords (split by spaces) to search on SN, PN and Name of a heat pump
-        :type search: str
         :param page: The page number
         :type page: int
         :param page_size: The page size
         :type page_size: int
+        :param model: Optional filter for which model(s) the heat pump are valid for this query
+        :type model: List[HeatPumpModel]
+        :param organisation_id: An ID of the organisation which we want to filter on to get its stock
+        :type organisation_id: str
+        :param search: String with keywords (split by spaces) to search on SN, PN and Name of a heat pump
+        :type search: str
         :param state: Filter for which device state the heat pump should be in using Device
         :type state: DeviceState
         :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
         :type x_version: str
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _request_timeout: timeout setting for this request.
-               If one number provided, it will be total request
-               timeout. It can also be a pair (tuple) of
-               (connection, read) timeouts.
+        :param x_backend_version: Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.
+        :type x_backend_version: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
         :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: List[ReadAllHeatPumpDto]
-        """
-        kwargs['_return_http_data_only'] = True
-        if '_preload_content' in kwargs:
-            message = "Error! Please call the api_v1_heat_pumps_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
-            raise ValueError(message)
-        return self.api_v1_heat_pumps_get_with_http_info(search, page, page_size, state, x_version, **kwargs)  # noqa: E501
-
-    @validate_arguments
-    def api_v1_heat_pumps_get_with_http_info(self, search : Annotated[Optional[StrictStr], Field(description="String with keywords (split by spaces) to search on SN, PN and Name of a heat pump")] = None, page : Annotated[Optional[StrictInt], Field(description="The page number")] = None, page_size : Annotated[Optional[StrictInt], Field(description="The page size")] = None, state : Annotated[Optional[DeviceState], Field(description="Filter for which device state the heat pump should be in using Device")] = None, x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ApiResponse:  # noqa: E501
-        """Gets all heat pumps (Paged, Searchable)  # noqa: E501
-
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api_v1_heat_pumps_get_with_http_info(search, page, page_size, state, x_version, async_req=True)
-        >>> result = thread.get()
+        """ # noqa: E501
+
+        _param = self._api_v1_heat_pumps_get_serialize(
+            page=page,
+            page_size=page_size,
+            model=model,
+            organisation_id=organisation_id,
+            search=search,
+            state=state,
+            x_version=x_version,
+            x_backend_version=x_backend_version,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '403': "str",
+            '500': None,
+            '505': None,
+            '400': "BadRequestCodesEnumeration",
+            '200': "ReadAllHeatPumpDtoPagedResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def api_v1_heat_pumps_get_with_http_info(
+        self,
+        page: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]], Field(description="The page number")] = None,
+        page_size: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]], Field(description="The page size")] = None,
+        model: Annotated[Optional[List[HeatPumpModel]], Field(description="Optional filter for which model(s) the heat pump are valid for this query")] = None,
+        organisation_id: Annotated[Optional[StrictStr], Field(description="An ID of the organisation which we want to filter on to get its stock")] = None,
+        search: Annotated[Optional[Annotated[str, Field(min_length=0, strict=True, max_length=100)]], Field(description="String with keywords (split by spaces) to search on SN, PN and Name of a heat pump")] = None,
+        state: Annotated[Optional[DeviceState], Field(description="Filter for which device state the heat pump should be in using Device")] = None,
+        x_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None,
+        x_backend_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ReadAllHeatPumpDtoPagedResponse]:
+        """Gets all heat pumps (Paged, Searchable)
+
 
-        :param search: String with keywords (split by spaces) to search on SN, PN and Name of a heat pump
-        :type search: str
         :param page: The page number
         :type page: int
         :param page_size: The page size
         :type page_size: int
+        :param model: Optional filter for which model(s) the heat pump are valid for this query
+        :type model: List[HeatPumpModel]
+        :param organisation_id: An ID of the organisation which we want to filter on to get its stock
+        :type organisation_id: str
+        :param search: String with keywords (split by spaces) to search on SN, PN and Name of a heat pump
+        :type search: str
         :param state: Filter for which device state the heat pump should be in using Device
         :type state: DeviceState
         :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
         :type x_version: str
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _preload_content: if False, the ApiResponse.data will
-                                 be set to none and raw_data will store the
-                                 HTTP response body without reading/decoding.
-                                 Default is True.
-        :type _preload_content: bool, optional
-        :param _return_http_data_only: response data instead of ApiResponse
-                                       object with status code, headers, etc
-        :type _return_http_data_only: bool, optional
+        :param x_backend_version: Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.
+        :type x_backend_version: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
         :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the authentication
-                              in the spec for a single request.
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
         :type _request_auth: dict, optional
-        :type _content_type: string, optional: force content-type for the request
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
         :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: tuple(List[ReadAllHeatPumpDto], status_code(int), headers(HTTPHeaderDict))
-        """
-
-        _params = locals()
-
-        _all_params = [
-            'search',
-            'page',
-            'page_size',
-            'state',
-            'x_version'
-        ]
-        _all_params.extend(
-            [
-                'async_req',
-                '_return_http_data_only',
-                '_preload_content',
-                '_request_timeout',
-                '_request_auth',
-                '_content_type',
-                '_headers'
-            ]
+        """ # noqa: E501
+
+        _param = self._api_v1_heat_pumps_get_serialize(
+            page=page,
+            page_size=page_size,
+            model=model,
+            organisation_id=organisation_id,
+            search=search,
+            state=state,
+            x_version=x_version,
+            x_backend_version=x_backend_version,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
         )
 
-        # validate the arguments
-        for _key, _val in _params['kwargs'].items():
-            if _key not in _all_params:
-                raise ApiTypeError(
-                    "Got an unexpected keyword argument '%s'"
-                    " to method api_v1_heat_pumps_get" % _key
-                )
-            _params[_key] = _val
-        del _params['kwargs']
+        _response_types_map: Dict[str, Optional[str]] = {
+            '403': "str",
+            '500': None,
+            '505': None,
+            '400': "BadRequestCodesEnumeration",
+            '200': "ReadAllHeatPumpDtoPagedResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
 
-        _collection_formats = {}
 
-        # process the path parameters
-        _path_params = {}
+    @validate_call
+    async def api_v1_heat_pumps_get_without_preload_content(
+        self,
+        page: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]], Field(description="The page number")] = None,
+        page_size: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]], Field(description="The page size")] = None,
+        model: Annotated[Optional[List[HeatPumpModel]], Field(description="Optional filter for which model(s) the heat pump are valid for this query")] = None,
+        organisation_id: Annotated[Optional[StrictStr], Field(description="An ID of the organisation which we want to filter on to get its stock")] = None,
+        search: Annotated[Optional[Annotated[str, Field(min_length=0, strict=True, max_length=100)]], Field(description="String with keywords (split by spaces) to search on SN, PN and Name of a heat pump")] = None,
+        state: Annotated[Optional[DeviceState], Field(description="Filter for which device state the heat pump should be in using Device")] = None,
+        x_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None,
+        x_backend_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Gets all heat pumps (Paged, Searchable)
 
-        # process the query parameters
-        _query_params = []
-        if _params.get('search') is not None:  # noqa: E501
-            _query_params.append(('search', _params['search']))
 
-        if _params.get('page') is not None:  # noqa: E501
-            _query_params.append(('page', _params['page']))
+        :param page: The page number
+        :type page: int
+        :param page_size: The page size
+        :type page_size: int
+        :param model: Optional filter for which model(s) the heat pump are valid for this query
+        :type model: List[HeatPumpModel]
+        :param organisation_id: An ID of the organisation which we want to filter on to get its stock
+        :type organisation_id: str
+        :param search: String with keywords (split by spaces) to search on SN, PN and Name of a heat pump
+        :type search: str
+        :param state: Filter for which device state the heat pump should be in using Device
+        :type state: DeviceState
+        :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
+        :type x_version: str
+        :param x_backend_version: Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.
+        :type x_backend_version: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._api_v1_heat_pumps_get_serialize(
+            page=page,
+            page_size=page_size,
+            model=model,
+            organisation_id=organisation_id,
+            search=search,
+            state=state,
+            x_version=x_version,
+            x_backend_version=x_backend_version,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
 
-        if _params.get('page_size') is not None:  # noqa: E501
-            _query_params.append(('pageSize', _params['page_size']))
+        _response_types_map: Dict[str, Optional[str]] = {
+            '403': "str",
+            '500': None,
+            '505': None,
+            '400': "BadRequestCodesEnumeration",
+            '200': "ReadAllHeatPumpDtoPagedResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _api_v1_heat_pumps_get_serialize(
+        self,
+        page,
+        page_size,
+        model,
+        organisation_id,
+        search,
+        state,
+        x_version,
+        x_backend_version,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            'Model': 'multi',
+        }
 
-        if _params.get('state') is not None:  # noqa: E501
-            _query_params.append(('state', _params['state'].value))
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
 
+        # process the path parameters
+        # process the query parameters
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if page_size is not None:
+            
+            _query_params.append(('pageSize', page_size))
+            
+        if model is not None:
+            
+            _query_params.append(('Model', model))
+            
+        if organisation_id is not None:
+            
+            _query_params.append(('OrganisationId', organisation_id))
+            
+        if search is not None:
+            
+            _query_params.append(('Search', search))
+            
+        if state is not None:
+            
+            _query_params.append(('State', state.value))
+            
         # process the header parameters
-        _header_params = dict(_params.get('_headers', {}))
-        if _params['x_version'] is not None:
-            _header_params['x-version'] = _params['x_version']
-
+        if x_version is not None:
+            _header_params['x-version'] = x_version
+        if x_backend_version is not None:
+            _header_params['x-backend-version'] = x_backend_version
         # process the form parameters
-        _form_params = []
-        _files = {}
         # process the body parameter
-        _body_params = None
+
+
         # set the HTTP header `Accept`
         _header_params['Accept'] = self.api_client.select_header_accept(
-            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+            [
+                'text/plain', 
+                'application/json', 
+                'text/json'
+            ]
+        )
 
-        # authentication setting
-        _auth_settings = ['oauth2']  # noqa: E501
 
-        _response_types_map = {
-            '403': "str",
-            '505': None,
-            '200': "List[ReadAllHeatPumpDto]",
-            '500': None,
-        }
+        # authentication setting
+        _auth_settings: List[str] = [
+            'oauth2'
+        ]
 
-        return self.api_client.call_api(
-            '/api/v1/heat-pumps', 'GET',
-            _path_params,
-            _query_params,
-            _header_params,
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/heat-pumps',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
             body=_body_params,
             post_params=_form_params,
             files=_files,
-            response_types_map=_response_types_map,
             auth_settings=_auth_settings,
-            async_req=_params.get('async_req'),
-            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
-            _preload_content=_params.get('_preload_content', True),
-            _request_timeout=_params.get('_request_timeout'),
             collection_formats=_collection_formats,
-            _request_auth=_params.get('_request_auth'))
-
-
+            _host=_host,
+            _request_auth=_request_auth
+        )
 
-    @validate_arguments
-    def api_v1_heat_pumps_heat_pump_id_get(self, heat_pump_id : Annotated[StrictStr, Field(..., description="The heatPumpId of the heat pump you want to get")], x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ReadHeatPumpDto:  # noqa: E501
-        """Gets a heat pump by heatPumpId  # noqa: E501
 
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+    @validate_call
+    async def api_v1_heat_pumps_heat_pump_id_get(
+        self,
+        heat_pump_id: Annotated[StrictStr, Field(description="The heatPumpId of the heat pump you want to get")],
+        x_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None,
+        x_backend_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ReadHeatPumpDto:
+        """Gets a heat pump by heatPumpId
 
-        >>> thread = api.api_v1_heat_pumps_heat_pump_id_get(heat_pump_id, x_version, async_req=True)
-        >>> result = thread.get()
 
         :param heat_pump_id: The heatPumpId of the heat pump you want to get (required)
         :type heat_pump_id: str
         :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
         :type x_version: str
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _request_timeout: timeout setting for this request.
-               If one number provided, it will be total request
-               timeout. It can also be a pair (tuple) of
-               (connection, read) timeouts.
+        :param x_backend_version: Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.
+        :type x_backend_version: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
         :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: ReadHeatPumpDto
-        """
-        kwargs['_return_http_data_only'] = True
-        if '_preload_content' in kwargs:
-            message = "Error! Please call the api_v1_heat_pumps_heat_pump_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
-            raise ValueError(message)
-        return self.api_v1_heat_pumps_heat_pump_id_get_with_http_info(heat_pump_id, x_version, **kwargs)  # noqa: E501
-
-    @validate_arguments
-    def api_v1_heat_pumps_heat_pump_id_get_with_http_info(self, heat_pump_id : Annotated[StrictStr, Field(..., description="The heatPumpId of the heat pump you want to get")], x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ApiResponse:  # noqa: E501
-        """Gets a heat pump by heatPumpId  # noqa: E501
-
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api_v1_heat_pumps_heat_pump_id_get_with_http_info(heat_pump_id, x_version, async_req=True)
-        >>> result = thread.get()
+        """ # noqa: E501
+
+        _param = self._api_v1_heat_pumps_heat_pump_id_get_serialize(
+            heat_pump_id=heat_pump_id,
+            x_version=x_version,
+            x_backend_version=x_backend_version,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '403': "str",
+            '500': None,
+            '505': None,
+            '200': "ReadHeatPumpDto",
+            '404': None,
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def api_v1_heat_pumps_heat_pump_id_get_with_http_info(
+        self,
+        heat_pump_id: Annotated[StrictStr, Field(description="The heatPumpId of the heat pump you want to get")],
+        x_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None,
+        x_backend_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ReadHeatPumpDto]:
+        """Gets a heat pump by heatPumpId
+
 
         :param heat_pump_id: The heatPumpId of the heat pump you want to get (required)
         :type heat_pump_id: str
         :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
         :type x_version: str
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _preload_content: if False, the ApiResponse.data will
-                                 be set to none and raw_data will store the
-                                 HTTP response body without reading/decoding.
-                                 Default is True.
-        :type _preload_content: bool, optional
-        :param _return_http_data_only: response data instead of ApiResponse
-                                       object with status code, headers, etc
-        :type _return_http_data_only: bool, optional
+        :param x_backend_version: Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.
+        :type x_backend_version: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
         :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the authentication
-                              in the spec for a single request.
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
         :type _request_auth: dict, optional
-        :type _content_type: string, optional: force content-type for the request
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
         :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: tuple(ReadHeatPumpDto, status_code(int), headers(HTTPHeaderDict))
-        """
-
-        _params = locals()
-
-        _all_params = [
-            'heat_pump_id',
-            'x_version'
-        ]
-        _all_params.extend(
-            [
-                'async_req',
-                '_return_http_data_only',
-                '_preload_content',
-                '_request_timeout',
-                '_request_auth',
-                '_content_type',
-                '_headers'
-            ]
+        """ # noqa: E501
+
+        _param = self._api_v1_heat_pumps_heat_pump_id_get_serialize(
+            heat_pump_id=heat_pump_id,
+            x_version=x_version,
+            x_backend_version=x_backend_version,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
         )
 
-        # validate the arguments
-        for _key, _val in _params['kwargs'].items():
-            if _key not in _all_params:
-                raise ApiTypeError(
-                    "Got an unexpected keyword argument '%s'"
-                    " to method api_v1_heat_pumps_heat_pump_id_get" % _key
-                )
-            _params[_key] = _val
-        del _params['kwargs']
-
-        _collection_formats = {}
-
-        # process the path parameters
-        _path_params = {}
-        if _params['heat_pump_id'] is not None:
-            _path_params['heatPumpId'] = _params['heat_pump_id']
-
-
-        # process the query parameters
-        _query_params = []
-        # process the header parameters
-        _header_params = dict(_params.get('_headers', {}))
-        if _params['x_version'] is not None:
-            _header_params['x-version'] = _params['x_version']
-
-        # process the form parameters
-        _form_params = []
-        _files = {}
-        # process the body parameter
-        _body_params = None
-        # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
-
-        # authentication setting
-        _auth_settings = ['oauth2']  # noqa: E501
-
-        _response_types_map = {
+        _response_types_map: Dict[str, Optional[str]] = {
             '403': "str",
+            '500': None,
             '505': None,
             '200': "ReadHeatPumpDto",
             '404': None,
-            '500': None,
         }
-
-        return self.api_client.call_api(
-            '/api/v1/heat-pumps/{heatPumpId}', 'GET',
-            _path_params,
-            _query_params,
-            _header_params,
-            body=_body_params,
-            post_params=_form_params,
-            files=_files,
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
             response_types_map=_response_types_map,
-            auth_settings=_auth_settings,
-            async_req=_params.get('async_req'),
-            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
-            _preload_content=_params.get('_preload_content', True),
-            _request_timeout=_params.get('_request_timeout'),
-            collection_formats=_collection_formats,
-            _request_auth=_params.get('_request_auth'))
-
-
-
-
-
+        )
 
-    @validate_arguments
-    def api_v1_heat_pumps_sn_serial_number_get(self, serial_number : Annotated[StrictStr, Field(..., description="The serial number of the heat pump you want to get")], x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ReadHeatPumpDto:  # noqa: E501
-        """Gets a heat pump by Serial Number  # noqa: E501
 
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
+    @validate_call
+    async def api_v1_heat_pumps_heat_pump_id_get_without_preload_content(
+        self,
+        heat_pump_id: Annotated[StrictStr, Field(description="The heatPumpId of the heat pump you want to get")],
+        x_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None,
+        x_backend_version: Annotated[Optional[StrictStr], Field(description="Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Gets a heat pump by heatPumpId
 
-        >>> thread = api.api_v1_heat_pumps_sn_serial_number_get(serial_number, x_version, async_req=True)
-        >>> result = thread.get()
 
-        :param serial_number: The serial number of the heat pump you want to get (required)
-        :type serial_number: str
-        :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
-        :type x_version: str
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _request_timeout: timeout setting for this request.
-               If one number provided, it will be total request
-               timeout. It can also be a pair (tuple) of
-               (connection, read) timeouts.
-        :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: ReadHeatPumpDto
-        """
-        kwargs['_return_http_data_only'] = True
-        if '_preload_content' in kwargs:
-            message = "Error! Please call the api_v1_heat_pumps_sn_serial_number_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
-            raise ValueError(message)
-        return self.api_v1_heat_pumps_sn_serial_number_get_with_http_info(serial_number, x_version, **kwargs)  # noqa: E501
-
-    @validate_arguments
-    def api_v1_heat_pumps_sn_serial_number_get_with_http_info(self, serial_number : Annotated[StrictStr, Field(..., description="The serial number of the heat pump you want to get")], x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ApiResponse:  # noqa: E501
-        """Gets a heat pump by Serial Number  # noqa: E501
-
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.api_v1_heat_pumps_sn_serial_number_get_with_http_info(serial_number, x_version, async_req=True)
-        >>> result = thread.get()
-
-        :param serial_number: The serial number of the heat pump you want to get (required)
-        :type serial_number: str
+        :param heat_pump_id: The heatPumpId of the heat pump you want to get (required)
+        :type heat_pump_id: str
         :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
         :type x_version: str
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _preload_content: if False, the ApiResponse.data will
-                                 be set to none and raw_data will store the
-                                 HTTP response body without reading/decoding.
-                                 Default is True.
-        :type _preload_content: bool, optional
-        :param _return_http_data_only: response data instead of ApiResponse
-                                       object with status code, headers, etc
-        :type _return_http_data_only: bool, optional
+        :param x_backend_version: Optional version parameter that the frontend can use to know whether this specific endpoint got a backwards incompatible change.
+        :type x_backend_version: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
                                  (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
         :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the authentication
-                              in the spec for a single request.
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
         :type _request_auth: dict, optional
-        :type _content_type: string, optional: force content-type for the request
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
         :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: tuple(ReadHeatPumpDto, status_code(int), headers(HTTPHeaderDict))
-        """
-
-        _params = locals()
+        """ # noqa: E501
+
+        _param = self._api_v1_heat_pumps_heat_pump_id_get_serialize(
+            heat_pump_id=heat_pump_id,
+            x_version=x_version,
+            x_backend_version=x_backend_version,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
 
-        _all_params = [
-            'serial_number',
-            'x_version'
-        ]
-        _all_params.extend(
-            [
-                'async_req',
-                '_return_http_data_only',
-                '_preload_content',
-                '_request_timeout',
-                '_request_auth',
-                '_content_type',
-                '_headers'
-            ]
+        _response_types_map: Dict[str, Optional[str]] = {
+            '403': "str",
+            '500': None,
+            '505': None,
+            '200': "ReadHeatPumpDto",
+            '404': None,
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
         )
+        return response_data.response
 
-        # validate the arguments
-        for _key, _val in _params['kwargs'].items():
-            if _key not in _all_params:
-                raise ApiTypeError(
-                    "Got an unexpected keyword argument '%s'"
-                    " to method api_v1_heat_pumps_sn_serial_number_get" % _key
-                )
-            _params[_key] = _val
-        del _params['kwargs']
 
-        _collection_formats = {}
+    def _api_v1_heat_pumps_heat_pump_id_get_serialize(
+        self,
+        heat_pump_id,
+        x_version,
+        x_backend_version,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
 
-        # process the path parameters
-        _path_params = {}
-        if _params['serial_number'] is not None:
-            _path_params['serialNumber'] = _params['serial_number']
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
 
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
 
+        # process the path parameters
+        if heat_pump_id is not None:
+            _path_params['heatPumpId'] = heat_pump_id
         # process the query parameters
-        _query_params = []
         # process the header parameters
-        _header_params = dict(_params.get('_headers', {}))
-        if _params['x_version'] is not None:
-            _header_params['x-version'] = _params['x_version']
-
+        if x_version is not None:
+            _header_params['x-version'] = x_version
+        if x_backend_version is not None:
+            _header_params['x-backend-version'] = x_backend_version
         # process the form parameters
-        _form_params = []
-        _files = {}
         # process the body parameter
-        _body_params = None
+
+
         # set the HTTP header `Accept`
         _header_params['Accept'] = self.api_client.select_header_accept(
-            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+            [
+                'text/plain', 
+                'application/json', 
+                'text/json'
+            ]
+        )
 
-        # authentication setting
-        _auth_settings = ['oauth2']  # noqa: E501
 
-        _response_types_map = {
-            '403': "str",
-            '505': None,
-            '200': "ReadHeatPumpDto",
-            '404': None,
-            '500': None,
-        }
+        # authentication setting
+        _auth_settings: List[str] = [
+            'oauth2'
+        ]
 
-        return self.api_client.call_api(
-            '/api/v1/heat-pumps/sn/{serialNumber}', 'GET',
-            _path_params,
-            _query_params,
-            _header_params,
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/heat-pumps/{heatPumpId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
             body=_body_params,
             post_params=_form_params,
             files=_files,
-            response_types_map=_response_types_map,
             auth_settings=_auth_settings,
-            async_req=_params.get('async_req'),
-            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
-            _preload_content=_params.get('_preload_content', True),
-            _request_timeout=_params.get('_request_timeout'),
             collection_formats=_collection_formats,
-            _request_auth=_params.get('_request_auth'))
+            _host=_host,
+            _request_auth=_request_auth
+        )