myvsb-developer-api 1.0.0__tar.gz → 1.0.2__tar.gz

{myvsb_developer_api-1.0.0/src/myvsb_developer_api.egg-info → myvsb_developer_api-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: myvsb-developer-api
-Version: 1.0.0
+Version: 1.0.2
 Summary: Asynchronous Python library for the MyVSB Developer API
 Author-email: net0045 <stepan.netolicky@vsb.cz>
 Project-URL: Homepage, https://github.com/mobility-lab-vsb/myvsb-developer-api

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "myvsb-developer-api"
-version = "1.0.0"
+version = "1.0.2"
 authors = [
   { name="net0045", email="stepan.netolicky@vsb.cz" },
 ]

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/src/myskoda_openapi/api_layer/exceptions.py

@@ -25,6 +25,10 @@ class OpenApiVehicleNotFoundError(OpenApiError):
     def __init__(self, message: str = "Vehicle with this VIN does not exist.") -> None:
         super().__init__(message, status_code=404)
 
+class OpenApiUnsupportedError(OpenApiError):
+    """Error 422 - Unsupported operation."""
+    def __init__(self, message: str = "Vehicle does not support this operation") -> None:
+        super().__init__(message, status_code=422)
 
 class OpenApiRateLimitError(OpenApiError):
     """Error 429 - Rate limit exceeded or weak 12V battery."""
@@ -32,6 +36,6 @@ class OpenApiRateLimitError(OpenApiError):
         super().__init__(message, status_code=429)
 
 class OpenApiServerError(OpenApiError):
-    """Error 500 / 504 - Server error or timeout."""
+    """Error 500 - Server error or timeout."""
     def __init__(self, message: str, status_code: int = 500) -> None:
-        super().__init__(message, status_code=status_code)
+        super().__init__(message, status_code=status_code)

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/src/myskoda_openapi/api_layer/open_api_client.py

@@ -11,6 +11,7 @@ from ..models.auxiliary_heating import AuxiliaryHeating
 from ..models.charging import Charging
 from ..models.driving_range import FuelStatus
 from ..models.charging_profiles import ChargingProfiles
+from ..models.configurations import StartAirConditioningConfiguration, StartAuxiliaryHeatingConfiguration, ConfigurationTargetTemperature
 
 class OpenAPIClient:
     """Client for interacting with rest API and used in HomeAssistant."""
@@ -70,10 +71,16 @@ class OpenAPIClient:
     
 
     
-    async def start_air_conditioning(self, vin: str, temperature: float) -> None:
+    async def start_air_conditioning(self, vin: str, temperature: float, unit: str = "CELSIUS", without_external_power: bool = True) -> None:
         """Starts the air conditioning for the vehicle with the given VIN."""
-        payload = {"targetTemperature": temperature}
-        await self.rest_api.start_air_conditioning(vin, payload=payload)
+        config = StartAirConditioningConfiguration(
+            target_temperature=ConfigurationTargetTemperature(
+                temperature_value=temperature,
+                unit_in_car=unit,
+            ),
+            air_conditioning_without_external_power=without_external_power,
+        )
+        await self.rest_api.start_air_conditioning(vin, config)
     
     async def stop_air_conditioning(self, vin: str) -> None:
         """Stops the air_conditioning of the vehicle and return None if it was succesfull else catch an exception in HomeAssistant"""
@@ -81,19 +88,20 @@ class OpenAPIClient:
 
     async def start_auxiliary_heating(self, vin: str, spin: str, duration_in_seconds: int = 120, start_mode: str = "HEATING", target_temperature: Optional[float] = None, unit: str = "CELSIUS") -> None:
         """Starts the auxiliary heating for the vehicle with the given VIN."""
-        payload = {
-            "spin": spin,
-            "durationInSeconds": duration_in_seconds,
-            "startMode": start_mode
-        }
-        # If there is target temperature, add it into the payload
+        temp_obj = None
         if target_temperature is not None:
-            payload["targetTemperature"] = {
-                "value": target_temperature,
-                "unit": unit
-            }
-            
-        await self.rest_api.start_auxiliary_heating(vin, payload=payload)
+            temp_obj = ConfigurationTargetTemperature(
+                temperature_value=target_temperature,
+                unit_in_car=unit,
+            )
+
+        config = StartAuxiliaryHeatingConfiguration(
+            spin=spin,
+            duration_in_seconds=duration_in_seconds,
+            start_mode=start_mode,
+            target_temperature=temp_obj,
+        )
+        await self.rest_api.start_auxiliary_heating(vin, config)
 
     async def stop_auxiliary_heating(self, vin: str) -> None:
         """Stops the auxiliary_heating of the vehicle and return None if it was succesfull else catch an exception in HomeAssistant"""

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/src/myskoda_openapi/api_layer/rest_api.py

@@ -14,12 +14,15 @@ from ..models.charging import Charging
 from ..models.active_ventilation import ActiveVentilation
 from ..models.charging_profiles import ChargingProfiles
 from ..models.driving_range import FuelStatus
+from ..models.configurations import StartAirConditioningConfiguration, StartAuxiliaryHeatingConfiguration
 from .exceptions import (
     OpenApiError,
     OpenApiAuthenticationError,
+    OpenApiUnsupportedError,
     OpenApiForbiddenError,
     OpenApiVehicleNotFoundError,
     OpenApiRateLimitError,
+    OpenApiServerError
 )
 
 T = TypeVar("T")
@@ -65,8 +68,12 @@ class SkodaRestAPI:
                         case 401: raise OpenApiAuthenticationError("Invalid or expired X-API-Key.")
                         case 403: raise OpenApiForbiddenError("Access forbidden. User not allowed to execute operation.")
                         case 404: raise OpenApiVehicleNotFoundError("Vehicle with this VIN does not exist.")
+                        case 422: raise OpenApiUnsupportedError("Vehicle does not support this operation")
                         case 429: raise OpenApiRateLimitError("Rate limit exceeded or insufficient battery level.")
                         case 400: raise OpenApiError("Bad request (e.g. validation or VIN issues).")
+                        case 500: raise OpenApiServerError("An unexpected error occurred while processing the request.", 500)
+                        case 503: raise OpenApiServerError("API key validation is temporarily unavailable. Retry after 10 seconds.", 503)
+                        case 504: raise OpenApiServerError("The vehicle did not respond in time.", 504)
                 
                 return response.status
         except Exception as err:
@@ -86,10 +93,15 @@ class SkodaRestAPI:
             async with self._session.get(full_url, headers=headers, params=params) as response:
                 if response.status not in (200, 202):
                     match response.status:
-                        case 401: raise OpenApiAuthenticationError("Invalid or expired X-API-Key.") 
-                        case 403: raise OpenApiForbiddenError("Access to the requested resource is forbidden.") 
-                        case 404: raise OpenApiVehicleNotFoundError("Vehicle with this VIN does not exist.") 
-                        case 429: raise OpenApiRateLimitError("Rate limit exceeded or weak 12V battery.") 
+                        case 401: raise OpenApiAuthenticationError("Invalid or expired X-API-Key.")
+                        case 403: raise OpenApiForbiddenError("Access forbidden. User not allowed to execute operation.")
+                        case 404: raise OpenApiVehicleNotFoundError("Vehicle with this VIN does not exist.")
+                        case 422: raise OpenApiUnsupportedError("Vehicle does not support this operation")
+                        case 429: raise OpenApiRateLimitError("Rate limit exceeded or insufficient battery level.")
+                        case 400: raise OpenApiError("Bad request (e.g. validation or VIN issues).")
+                        case 500: raise OpenApiServerError("An unexpected error occurred while processing the request.", 500)
+                        case 503: raise OpenApiServerError("API key validation is temporarily unavailable. Retry after 10 seconds.", 503)
+                        case 504: raise OpenApiServerError("The vehicle did not respond in time.", 504)
                 return await response.json()
         except Exception as err:
             raise OpenApiError(f"There has been an error when trying to make the request: {err}") from err
@@ -224,10 +236,11 @@ class SkodaRestAPI:
     # =========================================================================
     # ENDPOINT METHODS - POST
     # =========================================================================
-    async def start_air_conditioning(self, vin: str, payload: dict) -> PostEndpointResult:
+    async def start_air_conditioning(self, vin: str, config: StartAirConditioningConfiguration) -> PostEndpointResult:
         """Starts the air conditioning for the vehicle with the given VIN. The payload should contain any necessary parameters for starting the air conditioning."""
         url = f"/api/v1/vehicles/{vin}/air-conditioning/start"
         
+        payload = config.model_dump(by_alias=True, exclude_none=True)
         status = await self._make_post_request(url, json_data=payload)
         return PostEndpointResult(url=url, status=status, headers={})
     
@@ -238,10 +251,11 @@ class SkodaRestAPI:
         status = await self._make_post_request(url)
         return PostEndpointResult(url=url, status=status, headers={})
     
-    async def start_auxiliary_heating(self, vin: str, payload: dict) -> PostEndpointResult:
+    async def start_auxiliary_heating(self, vin: str, config: StartAuxiliaryHeatingConfiguration) -> PostEndpointResult:
         """Starts the auxiliary heating for the vehicle with the given VIN. The payload should contain any necessary parameters for starting the auxiliary heating."""
         url = f"/api/v1/vehicles/{vin}/auxiliary-heating/start"
         
+        payload = config.model_dump(by_alias=True, exclude_none=True)
         status = await self._make_post_request(url, json_data=payload)
         return PostEndpointResult(url=url, status=status, headers={})
     

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/src/myskoda_openapi/models/air_conditioning.py

@@ -11,7 +11,6 @@ class WindowHeating(BaseModel):
     front: Optional[OnOffState] = None
     rear: Optional[OnOffState] = None
 
-
 class AirConditioning(BaseModel):
     """Information about the vehicle's air conditioning."""
     state: AirConditioningState

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/src/myskoda_openapi/models/auxiliary_heating.py

@@ -6,6 +6,7 @@ from .enums import (
     AuxiliaryHeatingStartMode,
 )
 
+
 class AuxiliaryHeating(BaseModel):
     """Auxiliary heating status."""
     state: AuxiliaryHeatingState

myvsb_developer_api-1.0.2/src/myskoda_openapi/models/configurations.py

@@ -0,0 +1,34 @@
+from typing import Optional
+from pydantic import Field
+from .base_model import BaseModel
+
+class ConfigurationTargetTemperature(BaseModel):
+    temperature_value: float = Field(..., alias="temperatureValue")
+    unit_in_car: str = Field("CELSIUS", alias="unitInCar")
+
+    class Config:
+        populate_by_name = True
+
+
+class StartAirConditioningConfiguration(BaseModel):
+    """Configuration for starting air conditioning."""
+    target_temperature: Optional[ConfigurationTargetTemperature] = Field(None, alias="targetTemperature")
+    spin: Optional[str] = Field(None, alias="spin")
+    heater_source: Optional[str] = Field(None, alias="heaterSource")
+    air_conditioning_without_external_power: Optional[bool] = Field(
+        True, alias="airConditioningWithoutExternalPower"
+    )
+
+    class Config:
+        populate_by_name = True
+
+
+class StartAuxiliaryHeatingConfiguration(BaseModel):
+    """Configuration for starting auxiliary heating."""
+    spin: str = Field(..., alias="spin")
+    duration_in_seconds: Optional[int] = Field(120, alias="durationInSeconds")
+    start_mode: Optional[str] = Field("HEATING", alias="startMode")
+    target_temperature: Optional[ConfigurationTargetTemperature] = Field(None, alias="targetTemperature")
+
+    class Config:
+        populate_by_name = True

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2/src/myvsb_developer_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: myvsb-developer-api
-Version: 1.0.0
+Version: 1.0.2
 Summary: Asynchronous Python library for the MyVSB Developer API
 Author-email: net0045 <stepan.netolicky@vsb.cz>
 Project-URL: Homepage, https://github.com/mobility-lab-vsb/myvsb-developer-api

{myvsb_developer_api-1.0.0 → myvsb_developer_api-1.0.2}/src/myvsb_developer_api.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ src/myskoda_openapi/models/base_model.py
 src/myskoda_openapi/models/charging.py
 src/myskoda_openapi/models/charging_profiles.py
 src/myskoda_openapi/models/common.py
+src/myskoda_openapi/models/configurations.py
 src/myskoda_openapi/models/driving_range.py
 src/myskoda_openapi/models/enums.py
 src/myskoda_openapi/models/parking_position.py