weheat 2024.8.30__py3-none-any.whl → 2024.9.4rc1__py3-none-any.whl

weheat/__init__.py

@@ -20,6 +20,7 @@ __version__ = "2024.07.08"
 from weheat.api.energy_log_api import EnergyLogApi
 from weheat.api.heat_pump_api import HeatPumpApi
 from weheat.api.heat_pump_log_api import HeatPumpLogApi
+from weheat.api.user_api import UserApi
 
 # import ApiClient
 from weheat.api_response import ApiResponse
@@ -39,4 +40,6 @@ from weheat.models.heat_pump_log_view_dto import HeatPumpLogViewDto
 from weheat.models.raw_heat_pump_log_dto import RawHeatPumpLogDto
 from weheat.models.read_all_heat_pump_dto import ReadAllHeatPumpDto
 from weheat.models.read_heat_pump_dto import ReadHeatPumpDto
+from weheat.models.read_user_dto import ReadUserDto
+from weheat.models.role import Role
 

weheat/api/__init__.py

@@ -4,3 +4,4 @@
 from weheat.api.energy_log_api import EnergyLogApi
 from weheat.api.heat_pump_api import HeatPumpApi
 from weheat.api.heat_pump_log_api import HeatPumpLogApi
+from weheat.api.user_api import UserApi

weheat/api/user_api.py

@@ -0,0 +1,191 @@
+# coding: utf-8
+
+"""
+    Weheat Backend
+
+    This is the backend for the Weheat project
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import re  # noqa: F401
+import io
+import warnings
+
+from pydantic import validate_arguments, ValidationError
+
+from typing_extensions import Annotated
+from pydantic import Field, StrictStr
+
+from typing import Optional
+
+from weheat.models.read_user_dto import ReadUserDto
+
+from weheat.api_client import ApiClient
+from weheat.api_response import ApiResponse
+from weheat.exceptions import (  # noqa: F401
+    ApiTypeError,
+    ApiValueError
+)
+
+
+class UserApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+    @validate_arguments
+    def api_v1_users_me_get(self, x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ReadUserDto:  # noqa: E501
+        """Me endpoint to verify everything is ok after login (also sets Name of user after registration)  Please always call this after login so backend (and frontend) can verify everything is correct.  # 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_users_me_get(x_version, async_req=True)
+        >>> result = thread.get()
+
+        :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: ReadUserDto
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the api_v1_users_me_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_users_me_get_with_http_info(x_version, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def api_v1_users_me_get_with_http_info(self, 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
+        """Me endpoint to verify everything is ok after login (also sets Name of user after registration)  Please always call this after login so backend (and frontend) can verify everything is correct.  # 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_users_me_get_with_http_info(x_version, async_req=True)
+        >>> result = thread.get()
+
+        :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 _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 _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
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(ReadUserDto, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'x_version'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # 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_users_me_get" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # 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 = {
+            '403': "str",
+            '505': None,
+            '200': "ReadUserDto",
+            '400': None,
+            '404': None,
+            '409': None,
+            '500': None,
+        }
+
+        return self.api_client.call_api(
+            '/api/v1/users/me', 'GET',
+            _path_params,
+            _query_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'))
+

weheat/models/__init__.py

@@ -20,3 +20,5 @@ from weheat.models.heat_pump_log_view_dto import HeatPumpLogViewDto
 from weheat.models.raw_heat_pump_log_dto import RawHeatPumpLogDto
 from weheat.models.read_all_heat_pump_dto import ReadAllHeatPumpDto
 from weheat.models.read_heat_pump_dto import ReadHeatPumpDto
+from weheat.models.read_user_dto import ReadUserDto
+from weheat.models.role import Role

weheat/models/read_user_dto.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Weheat Backend
+
+    This is the backend for the Weheat project
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional
+from pydantic import BaseModel, Field, StrictStr
+from weheat.models.role import Role
+
+class ReadUserDto(BaseModel):
+    """
+    ReadUserDto
+    """
+    id: StrictStr = Field(..., description="Identifier of the user")
+    first_name: Optional[StrictStr] = Field(None, alias="firstName", description="First name of the user if available")
+    last_name: Optional[StrictStr] = Field(None, alias="lastName", description="Last Name of the user if available")
+    role: Role = Field(...)
+    email: Optional[StrictStr] = Field(None, description="Email address of the user")
+    updated_on: datetime = Field(..., alias="updatedOn", description="Timestamp of the last update to the user entry")
+    created_on: datetime = Field(..., alias="createdOn", description="Timestamp of the creation of the user entry")
+    __properties = ["id", "firstName", "lastName", "role", "email", "updatedOn", "createdOn"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ReadUserDto:
+        """Create an instance of ReadUserDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # set to None if first_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.first_name is None and "first_name" in self.__fields_set__:
+            _dict['firstName'] = None
+
+        # set to None if last_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.last_name is None and "last_name" in self.__fields_set__:
+            _dict['lastName'] = None
+
+        # set to None if email (nullable) is None
+        # and __fields_set__ contains the field
+        if self.email is None and "email" in self.__fields_set__:
+            _dict['email'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReadUserDto:
+        """Create an instance of ReadUserDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReadUserDto.parse_obj(obj)
+
+        _obj = ReadUserDto.parse_obj({
+            "id": obj.get("id"),
+            "first_name": obj.get("firstName"),
+            "last_name": obj.get("lastName"),
+            "role": obj.get("role"),
+            "email": obj.get("email"),
+            "updated_on": obj.get("updatedOn"),
+            "created_on": obj.get("createdOn")
+        })
+        return _obj
+
+

weheat/models/role.py

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+"""
+    Weheat Backend
+
+    This is the backend for the Weheat project
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import json
+import pprint
+import re  # noqa: F401
+from aenum import Enum, no_arg
+
+
+
+
+
+class Role(int, Enum):
+    """
+    Roles that can be assigned to a user.\\  Roles enumeration include:  - Admin (0),  - Support (1),  - Logistics (2),  - Sales (3),  - DataScientist (4),  - Production (5),  - Installer (6),  - Consumer (7)
+    """
+
+    """
+    allowed enum values
+    """
+    NUMBER_0 = 0
+    NUMBER_1 = 1
+    NUMBER_2 = 2
+    NUMBER_3 = 3
+    NUMBER_4 = 4
+    NUMBER_5 = 5
+    NUMBER_6 = 6
+    NUMBER_7 = 7
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Role:
+        """Create an instance of Role from a JSON string"""
+        return Role(json.loads(json_str))
+
+

{weheat-2024.8.30.dist-info → weheat-2024.9.4rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weheat
-Version: 2024.8.30
+Version: 2024.9.4rc1
 Summary: Weheat Backend client
 Home-page: https://github.com/wefabricate/wh-python
 Author: Jesper Raemaekers

{weheat-2024.8.30.dist-info → weheat-2024.9.4rc1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-weheat/__init__.py,sha256=vZpdNWQdQDpleRSGL1Y9e90lgROA_Eh0IWEsp8rZlYU,1312
+weheat/__init__.py,sha256=dk7tMBQ9jtkNiWeZW5xWCJoaGIrZVQ-tm5NCZhi2qWU,1440
 weheat/api_client.py,sha256=QNUo_W5MMBajpjN2sWFUIRhOszAE93KECNxdvhVns84,29516
 weheat/api_response.py,sha256=uCehWdXXDnAO2HAHGKe0SgpQ_mJiGDbcu-BHDF3n_IM,852
 weheat/configuration.py,sha256=FerGmYva4hSzbtPV8hASrSF4Fd1zRIFezPzBhHQHV5c,14562
@@ -9,11 +9,12 @@ weheat/abstractions/__init__.py,sha256=cRdA_kyTIooo39I13_mqShSfZMqdzNGHbmrnITqgx
 weheat/abstractions/auth.py,sha256=VCAxJ4OIj7bsYttqJl5-juU0VUlSd3xPu7kUjtHZr3U,979
 weheat/abstractions/discovery.py,sha256=0HEXdtIuw3FIATUwX0xpeUVRnk8i-HRL21pE6b1mej0,1679
 weheat/abstractions/heat_pump.py,sha256=kzi6B6oQ8hFYzxMBZqVwbFRY16vR9OFnlWPErBQ_8uA,4649
-weheat/api/__init__.py,sha256=CNY0PYXwKCKT9xlI0z574W6dMOAqQMjiZHuubLdleX8,203
+weheat/api/__init__.py,sha256=DQnnRs5Z29Nf5sGdFd3f96xM6p_FMym-_-dvQC2VzdU,243
 weheat/api/energy_log_api.py,sha256=yIIqd-C_xHSM_1eNoj2i04IDkJkzU0-a9iFGDSd2zLo,11374
 weheat/api/heat_pump_api.py,sha256=FAf7jxosIAginCom-aUuFdj7jZupv8134OI6rpkdK80,24368
 weheat/api/heat_pump_log_api.py,sha256=Xt4pkXOT1x7dsJse00iXpCMQTDuLzhQrMgL_XK3DzDo,28602
-weheat/models/__init__.py,sha256=OrBvAJHJbH4ui9BGo6-v0Wdgi-gkdnqp4bRnaE0vnoI,678
+weheat/api/user_api.py,sha256=OHRj6Pur5oLxmC4lkcU-pl2o-XWFhasJbMvoXSrDqqg,7766
+weheat/models/__init__.py,sha256=VJsiySw4ndbqm5WCTxehHg-gmjaB_m2czi2FO-AQZn0,766
 weheat/models/boiler_type.py,sha256=jZF4sXhR7SEhj3bEfvmeH48l1APu_gtSlpQUj45vP7o,906
 weheat/models/device_state.py,sha256=Di_i-8IOWQaK25eYGNsgXv1OZh9s8RAH-6vcdacAObo,1035
 weheat/models/dhw_type.py,sha256=IamPcF02M_BDadVxfD7poh1C00mPXTJ9Wbjwh6TUfV8,817
@@ -25,8 +26,10 @@ weheat/models/heat_pump_type.py,sha256=Kft4cXvenK27miFDcsBOHv7p2svAW18iptT_GUcXW
 weheat/models/raw_heat_pump_log_dto.py,sha256=vNn1u8_jYAIV9miBK3Qvq0j-U5OYv56dRU2085fLvcI,34385
 weheat/models/read_all_heat_pump_dto.py,sha256=PDaWb-2qSzAnMoIsNceHavT1ybIZa3-lva3zJZA2BzU,5088
 weheat/models/read_heat_pump_dto.py,sha256=ufDbcHxtB8o2jmk00bMP_xol3uCdoTOqiHS6UUzRic4,4514
-weheat-2024.8.30.dist-info/LICENSE,sha256=rWmFUq0uth2jpet-RQ2QPd2VhZkcPSUs6Dxfmbqkbis,1068
-weheat-2024.8.30.dist-info/METADATA,sha256=VA2tPnSBiukql97GDR0xS-c-P0pz4e8cI6laUZYWCVk,3901
-weheat-2024.8.30.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-weheat-2024.8.30.dist-info/top_level.txt,sha256=hLzdyvGZ9rs4AqK7U48mdHx_-FcP5sDuTSleDUvGAZw,7
-weheat-2024.8.30.dist-info/RECORD,,
+weheat/models/read_user_dto.py,sha256=J1YlL-WsXArbirllI1fHZrguKy5Wv35NIck59ICBSGg,3465
+weheat/models/role.py,sha256=eF6nawkz8mmCGQEmJx26Y2MPFmlKdpOOtJ2Q70b-Qtc,938
+weheat-2024.9.4rc1.dist-info/LICENSE,sha256=rWmFUq0uth2jpet-RQ2QPd2VhZkcPSUs6Dxfmbqkbis,1068
+weheat-2024.9.4rc1.dist-info/METADATA,sha256=k8icKT87_OtUV9nGLGX1_Mso9VLtejB3qxsA0YbfAbs,3903
+weheat-2024.9.4rc1.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
+weheat-2024.9.4rc1.dist-info/top_level.txt,sha256=hLzdyvGZ9rs4AqK7U48mdHx_-FcP5sDuTSleDUvGAZw,7
+weheat-2024.9.4rc1.dist-info/RECORD,,

{weheat-2024.8.30.dist-info → weheat-2024.9.4rc1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (74.1.1)
 Root-Is-Purelib: true
 Tag: py3-none-any