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

weheat/models/read_all_heat_pump_dto.py

@@ -18,103 +18,119 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Optional
-from pydantic import BaseModel, Field, StrictStr, constr
+from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
 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
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
 
 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")
+    Heat Pump dto used for the GetAll operation where the firmware version is needed
+    """ # noqa: E501
+    control_board_id: StrictStr = Field(description="Identifier of the control board that is connected to the heat pump", alias="controlBoardId")
+    name: Optional[StrictStr] = Field(default=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")
+    dhw_type: Optional[DhwType] = Field(default=None, alias="dhwType")
+    boiler_type: Optional[BoilerType] = Field(default=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"]
+    commissioned_at: Optional[datetime] = Field(default=None, description="Date when the heat pump was last commissioned (decommissioning sets this to null)", alias="commissionedAt")
+    serial_number: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Serial Number of this heat pump", alias="serialNumber")
+    part_number: Optional[StrictStr] = Field(default=None, description="Part Number of this heat pump", alias="partNumber")
+    state: DeviceState
+    id: StrictStr = Field(description="Identifier of the heat pump")
+    firmware_version: Optional[StrictStr] = Field(default=None, description="Firmware version of control board connected to heat pump", alias="firmwareVersion")
+    __properties: ClassVar[List[str]] = ["controlBoardId", "name", "model", "dhwType", "boilerType", "status", "commissionedAt", "serialNumber", "partNumber", "state", "id", "firmwareVersion"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
 
-    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))
+        return pprint.pformat(self.model_dump(by_alias=True))
 
     def to_json(self) -> str:
         """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> ReadAllHeatPumpDto:
+    def from_json(cls, json_str: str) -> Self:
         """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
-
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
         # 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__:
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_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__:
+        # and model_fields_set contains the field
+        if self.commissioned_at is None and "commissioned_at" in self.model_fields_set:
             _dict['commissionedAt'] = None
 
+        # set to None if part_number (nullable) is None
+        # and model_fields_set contains the field
+        if self.part_number is None and "part_number" in self.model_fields_set:
+            _dict['partNumber'] = 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__:
+        # and model_fields_set contains the field
+        if self.firmware_version is None and "firmware_version" in self.model_fields_set:
             _dict['firmwareVersion'] = None
 
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> ReadAllHeatPumpDto:
+    def from_dict(cls, obj: Dict) -> Self:
         """Create an instance of ReadAllHeatPumpDto from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return ReadAllHeatPumpDto.parse_obj(obj)
+            return cls.model_validate(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"),
+        _obj = cls.model_validate({
+            "controlBoardId": obj.get("controlBoardId"),
             "name": obj.get("name"),
             "model": obj.get("model"),
-            "dhw_type": obj.get("dhwType"),
-            "boiler_type": obj.get("boilerType"),
+            "dhwType": obj.get("dhwType"),
+            "boilerType": obj.get("boilerType"),
             "status": obj.get("status"),
-            "type": obj.get("type"),
-            "commissioned_at": obj.get("commissionedAt"),
-            "firmware_version": obj.get("firmwareVersion")
+            "commissionedAt": obj.get("commissionedAt"),
+            "serialNumber": obj.get("serialNumber"),
+            "partNumber": obj.get("partNumber"),
+            "state": obj.get("state"),
+            "id": obj.get("id"),
+            "firmwareVersion": obj.get("firmwareVersion")
         })
         return _obj
 

weheat/models/read_all_heat_pump_dto_paged_response.py

@@ -0,0 +1,107 @@
+# 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 typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel
+from weheat.models.pagination_metadata import PaginationMetadata
+from weheat.models.read_all_heat_pump_dto import ReadAllHeatPumpDto
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class ReadAllHeatPumpDtoPagedResponse(BaseModel):
+    """
+    ReadAllHeatPumpDtoPagedResponse
+    """ # noqa: E501
+    metadata: Optional[PaginationMetadata] = None
+    data: Optional[List[ReadAllHeatPumpDto]] = None
+    __properties: ClassVar[List[str]] = ["metadata", "data"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ReadAllHeatPumpDtoPagedResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of metadata
+        if self.metadata:
+            _dict['metadata'] = self.metadata.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
+        _items = []
+        if self.data:
+            for _item in self.data:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['data'] = _items
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of ReadAllHeatPumpDtoPagedResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "metadata": PaginationMetadata.from_dict(obj.get("metadata")) if obj.get("metadata") is not None else None,
+            "data": [ReadAllHeatPumpDto.from_dict(_item) for _item in obj.get("data")] if obj.get("data") is not None else None
+        })
+        return _obj
+
+

weheat/models/read_heat_pump_dto.py

@@ -18,96 +18,112 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Optional
-from pydantic import BaseModel, Field, StrictStr, constr
+from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
 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
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
 
 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")
+    """ # noqa: E501
+    control_board_id: StrictStr = Field(description="Identifier of the control board that is connected to the heat pump", alias="controlBoardId")
+    name: Optional[StrictStr] = Field(default=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")
+    dhw_type: Optional[DhwType] = Field(default=None, alias="dhwType")
+    boiler_type: Optional[BoilerType] = Field(default=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"]
+    commissioned_at: Optional[datetime] = Field(default=None, description="Date when the heat pump was last commissioned (decommissioning sets this to null)", alias="commissionedAt")
+    serial_number: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Serial Number of this heat pump", alias="serialNumber")
+    part_number: Optional[StrictStr] = Field(default=None, description="Part Number of this heat pump", alias="partNumber")
+    state: DeviceState
+    id: StrictStr = Field(description="Identifier of the heat pump")
+    __properties: ClassVar[List[str]] = ["controlBoardId", "name", "model", "dhwType", "boilerType", "status", "commissionedAt", "serialNumber", "partNumber", "state", "id"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
 
-    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))
+        return pprint.pformat(self.model_dump(by_alias=True))
 
     def to_json(self) -> str:
         """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> ReadHeatPumpDto:
+    def from_json(cls, json_str: str) -> Self:
         """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
-
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
         # 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__:
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_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__:
+        # and model_fields_set contains the field
+        if self.commissioned_at is None and "commissioned_at" in self.model_fields_set:
             _dict['commissionedAt'] = None
 
+        # set to None if part_number (nullable) is None
+        # and model_fields_set contains the field
+        if self.part_number is None and "part_number" in self.model_fields_set:
+            _dict['partNumber'] = None
+
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> ReadHeatPumpDto:
+    def from_dict(cls, obj: Dict) -> Self:
         """Create an instance of ReadHeatPumpDto from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return ReadHeatPumpDto.parse_obj(obj)
+            return cls.model_validate(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"),
+        _obj = cls.model_validate({
+            "controlBoardId": obj.get("controlBoardId"),
             "name": obj.get("name"),
             "model": obj.get("model"),
-            "dhw_type": obj.get("dhwType"),
-            "boiler_type": obj.get("boilerType"),
+            "dhwType": obj.get("dhwType"),
+            "boilerType": obj.get("boilerType"),
             "status": obj.get("status"),
-            "type": obj.get("type"),
-            "commissioned_at": obj.get("commissionedAt")
+            "commissionedAt": obj.get("commissionedAt"),
+            "serialNumber": obj.get("serialNumber"),
+            "partNumber": obj.get("partNumber"),
+            "state": obj.get("state"),
+            "id": obj.get("id")
         })
         return _obj
 

weheat/models/read_user_dto.py

@@ -18,81 +18,99 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Optional
-from pydantic import BaseModel, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, StrictStr
+from pydantic import Field
 from weheat.models.role import Role
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
 
 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
+    """ # noqa: E501
+    id: StrictStr = Field(description="Identifier of the user")
+    first_name: Optional[StrictStr] = Field(default=None, description="First name of the user if available", alias="firstName")
+    last_name: Optional[StrictStr] = Field(default=None, description="Last Name of the user if available", alias="lastName")
+    role: Role
+    email: Optional[StrictStr] = Field(default=None, description="Email address of the user")
+    updated_on: datetime = Field(description="Timestamp of the last update to the user entry", alias="updatedOn")
+    created_on: datetime = Field(description="Timestamp of the creation of the user entry", alias="createdOn")
+    __properties: ClassVar[List[str]] = ["id", "firstName", "lastName", "role", "email", "updatedOn", "createdOn"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
 
     def to_str(self) -> str:
         """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.dict(by_alias=True))
+        return pprint.pformat(self.model_dump(by_alias=True))
 
     def to_json(self) -> str:
         """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> ReadUserDto:
+    def from_json(cls, json_str: str) -> Self:
         """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)
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            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__:
+        # and model_fields_set contains the field
+        if self.first_name is None and "first_name" in self.model_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__:
+        # and model_fields_set contains the field
+        if self.last_name is None and "last_name" in self.model_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__:
+        # and model_fields_set contains the field
+        if self.email is None and "email" in self.model_fields_set:
             _dict['email'] = None
 
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> ReadUserDto:
+    def from_dict(cls, obj: Dict) -> Self:
         """Create an instance of ReadUserDto from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return ReadUserDto.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = ReadUserDto.parse_obj({
+        _obj = cls.model_validate({
             "id": obj.get("id"),
-            "first_name": obj.get("firstName"),
-            "last_name": obj.get("lastName"),
+            "firstName": obj.get("firstName"),
+            "lastName": obj.get("lastName"),
             "role": obj.get("role"),
             "email": obj.get("email"),
-            "updated_on": obj.get("updatedOn"),
-            "created_on": obj.get("createdOn")
+            "updatedOn": obj.get("updatedOn"),
+            "createdOn": obj.get("createdOn")
         })
         return _obj