weheat 2025.1.14rc1__py3-none-any.whl

weheat/models/read_all_heat_pump_dto.py

@@ -0,0 +1,124 @@
+# 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
+try:
+    from pydantic.v1 import BaseModel, Field, StrictStr, constr
+except ImportError:
+    from pydantic import BaseModel, Field, StrictStr, constr
+from weheat.models.boiler_type import BoilerType
+from weheat.models.device_state import DeviceState
+from weheat.models.dhw_type import DhwType
+from weheat.models.heat_pump_model import HeatPumpModel
+from weheat.models.heat_pump_status_enum import HeatPumpStatusEnum
+from weheat.models.heat_pump_type import HeatPumpType
+
+class ReadAllHeatPumpDto(BaseModel):
+    """
+    Heat Pump dto used for the GetAll operation where the firmware version is needed  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Identifier of the heat pump")
+    control_board_id: StrictStr = Field(..., alias="controlBoardId", description="Identifier of the control board that is connected to the heat pump")
+    serial_number: constr(strict=True, min_length=1) = Field(..., alias="serialNumber", description="Serial Number of this heat pump")
+    part_number: Optional[StrictStr] = Field(None, alias="partNumber", description="Part Number of this heat pump")
+    state: DeviceState = Field(...)
+    name: Optional[StrictStr] = Field(None, description="Internal nickname of this heat pump")
+    model: Optional[HeatPumpModel] = None
+    dhw_type: Optional[DhwType] = Field(None, alias="dhwType")
+    boiler_type: Optional[BoilerType] = Field(None, alias="boilerType")
+    status: Optional[HeatPumpStatusEnum] = None
+    type: Optional[HeatPumpType] = None
+    commissioned_at: Optional[datetime] = Field(None, alias="commissionedAt", description="Date when the heat pump was last commissioned (decommissioning sets this to null)")
+    firmware_version: Optional[StrictStr] = Field(None, alias="firmwareVersion", description="Firmware version of control board connected to heat pump")
+    __properties = ["id", "controlBoardId", "serialNumber", "partNumber", "state", "name", "model", "dhwType", "boilerType", "status", "type", "commissionedAt", "firmwareVersion"]
+
+    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) -> ReadAllHeatPumpDto:
+        """Create an instance of ReadAllHeatPumpDto 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 part_number (nullable) is None
+        # and __fields_set__ contains the field
+        if self.part_number is None and "part_number" in self.__fields_set__:
+            _dict['partNumber'] = None
+
+        # set to None if name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.name is None and "name" in self.__fields_set__:
+            _dict['name'] = None
+
+        # set to None if commissioned_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.commissioned_at is None and "commissioned_at" in self.__fields_set__:
+            _dict['commissionedAt'] = None
+
+        # set to None if firmware_version (nullable) is None
+        # and __fields_set__ contains the field
+        if self.firmware_version is None and "firmware_version" in self.__fields_set__:
+            _dict['firmwareVersion'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReadAllHeatPumpDto:
+        """Create an instance of ReadAllHeatPumpDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReadAllHeatPumpDto.parse_obj(obj)
+
+        _obj = ReadAllHeatPumpDto.parse_obj({
+            "id": obj.get("id"),
+            "control_board_id": obj.get("controlBoardId"),
+            "serial_number": obj.get("serialNumber"),
+            "part_number": obj.get("partNumber"),
+            "state": obj.get("state"),
+            "name": obj.get("name"),
+            "model": obj.get("model"),
+            "dhw_type": obj.get("dhwType"),
+            "boiler_type": obj.get("boilerType"),
+            "status": obj.get("status"),
+            "type": obj.get("type"),
+            "commissioned_at": obj.get("commissionedAt"),
+            "firmware_version": obj.get("firmwareVersion")
+        })
+        return _obj
+
+

weheat/models/read_heat_pump_dto.py

@@ -0,0 +1,117 @@
+# 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
+try:
+    from pydantic.v1 import BaseModel, Field, StrictStr, constr
+except ImportError:
+    from pydantic import BaseModel, Field, StrictStr, constr
+from weheat.models.boiler_type import BoilerType
+from weheat.models.device_state import DeviceState
+from weheat.models.dhw_type import DhwType
+from weheat.models.heat_pump_model import HeatPumpModel
+from weheat.models.heat_pump_status_enum import HeatPumpStatusEnum
+from weheat.models.heat_pump_type import HeatPumpType
+
+class ReadHeatPumpDto(BaseModel):
+    """
+    ReadHeatPumpDto
+    """
+    id: StrictStr = Field(..., description="Identifier of the heat pump")
+    control_board_id: StrictStr = Field(..., alias="controlBoardId", description="Identifier of the control board that is connected to the heat pump")
+    serial_number: constr(strict=True, min_length=1) = Field(..., alias="serialNumber", description="Serial Number of this heat pump")
+    part_number: Optional[StrictStr] = Field(None, alias="partNumber", description="Part Number of this heat pump")
+    state: DeviceState = Field(...)
+    name: Optional[StrictStr] = Field(None, description="Internal nickname of this heat pump")
+    model: Optional[HeatPumpModel] = None
+    dhw_type: Optional[DhwType] = Field(None, alias="dhwType")
+    boiler_type: Optional[BoilerType] = Field(None, alias="boilerType")
+    status: Optional[HeatPumpStatusEnum] = None
+    type: Optional[HeatPumpType] = None
+    commissioned_at: Optional[datetime] = Field(None, alias="commissionedAt", description="Date when the heat pump was last commissioned (decommissioning sets this to null)")
+    __properties = ["id", "controlBoardId", "serialNumber", "partNumber", "state", "name", "model", "dhwType", "boilerType", "status", "type", "commissionedAt"]
+
+    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) -> ReadHeatPumpDto:
+        """Create an instance of ReadHeatPumpDto 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 part_number (nullable) is None
+        # and __fields_set__ contains the field
+        if self.part_number is None and "part_number" in self.__fields_set__:
+            _dict['partNumber'] = None
+
+        # set to None if name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.name is None and "name" in self.__fields_set__:
+            _dict['name'] = None
+
+        # set to None if commissioned_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.commissioned_at is None and "commissioned_at" in self.__fields_set__:
+            _dict['commissionedAt'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReadHeatPumpDto:
+        """Create an instance of ReadHeatPumpDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReadHeatPumpDto.parse_obj(obj)
+
+        _obj = ReadHeatPumpDto.parse_obj({
+            "id": obj.get("id"),
+            "control_board_id": obj.get("controlBoardId"),
+            "serial_number": obj.get("serialNumber"),
+            "part_number": obj.get("partNumber"),
+            "state": obj.get("state"),
+            "name": obj.get("name"),
+            "model": obj.get("model"),
+            "dhw_type": obj.get("dhwType"),
+            "boiler_type": obj.get("boilerType"),
+            "status": obj.get("status"),
+            "type": obj.get("type"),
+            "commissioned_at": obj.get("commissionedAt")
+        })
+        return _obj
+
+

weheat/models/read_user_dto.py

@@ -0,0 +1,102 @@
+# 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
+try:
+    from pydantic.v1 import BaseModel, Field, StrictStr
+except ImportError:
+    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))
+
+