electrolux-group-developer-sdk 0.3.0__tar.gz → 0.4.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/PKG-INFO +6 -3
  2. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/README.md +5 -3
  3. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/auth/token_manager.py +7 -6
  4. electrolux_group_developer_sdk-0.4.0/electrolux_group_developer_sdk/auth/token_refresh_failed.py +5 -0
  5. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliance_client.py +25 -4
  6. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliance_data_factory.py +3 -2
  7. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/appliance_data.py +2 -2
  8. electrolux_group_developer_sdk-0.4.0/electrolux_group_developer_sdk/client/bad_credentials_exception.py +9 -0
  9. electrolux_group_developer_sdk-0.4.0/electrolux_group_developer_sdk/client/dto/email.py +5 -0
  10. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/config.py +2 -0
  11. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/constants.py +1 -1
  12. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/pyproject.toml +1 -1
  13. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/LICENSE +0 -0
  14. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/__init__.py +0 -0
  15. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/__init__.py +0 -0
  16. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/ac_config.py +0 -0
  17. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/ap_config.py +0 -0
  18. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/config.py +0 -0
  19. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/cr_config.py +0 -0
  20. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/dam_ac_config.py +0 -0
  21. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/dh_config.py +0 -0
  22. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/dw_config.py +0 -0
  23. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/hb_config.py +0 -0
  24. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/hd_config.py +0 -0
  25. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/ov_config.py +0 -0
  26. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/rvc_config.py +0 -0
  27. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/so_config.py +0 -0
  28. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/td_config.py +0 -0
  29. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/wd_config.py +0 -0
  30. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/appliance_config/wm_config.py +0 -0
  31. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/auth/__init__.py +0 -0
  32. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/auth/auth_data.py +0 -0
  33. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/auth/invalid_credentials_exception.py +0 -0
  34. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/auth/invalid_token_exception.py +0 -0
  35. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/cli_test.py +0 -0
  36. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/__init__.py +0 -0
  37. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/__init__.py +0 -0
  38. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/ac_appliance.py +0 -0
  39. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/ap_appliance.py +0 -0
  40. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/cr_appliance.py +0 -0
  41. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/dam_ac_appliance.py +0 -0
  42. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/dh_appliance.py +0 -0
  43. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/dw_appliance.py +0 -0
  44. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/hb_appliance.py +0 -0
  45. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/hd_appliance.py +0 -0
  46. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/ov_appliance.py +0 -0
  47. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/rvc_appliance.py +0 -0
  48. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/so_appliance.py +0 -0
  49. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/td_appliance.py +0 -0
  50. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/wd_appliance.py +0 -0
  51. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/appliances/wm_appliance.py +0 -0
  52. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/client_exception.py +0 -0
  53. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/client_util.py +0 -0
  54. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/__init__.py +0 -0
  55. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/appliance.py +0 -0
  56. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/appliance_details.py +0 -0
  57. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/appliance_state.py +0 -0
  58. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/interactive_map.py +0 -0
  59. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/livestream_config.py +0 -0
  60. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/dto/memory_map.py +0 -0
  61. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/failed_connection_exception.py +0 -0
  62. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/client/rate_limiter.py +0 -0
  63. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/feature_constants.py +0 -0
  64. {electrolux_group_developer_sdk-0.3.0 → electrolux_group_developer_sdk-0.4.0}/electrolux_group_developer_sdk/py.typed +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: electrolux-group-developer-sdk
3
- Version: 0.3.0
3
+ Version: 0.4.0
4
4
  Summary: A Python async client library for interacting with the Electrolux Developer Portal API.
5
5
  License: Apache-2.0
6
6
  License-File: LICENSE
@@ -68,9 +68,11 @@ from electrolux_group_developer_sdk.client.appliance_client import ApplianceClie
68
68
 
69
69
 
70
70
  # Callback to handle token updates
71
- def on_token_update(new_access_token, new_refresh_token):
71
+ def on_token_update(new_access_token, new_refresh_token, api_key):
72
72
  # Save updated tokens somewhere safe
73
- print("Tokens updated:", new_access_token, new_refresh_token)
73
+ print("Access Token updated:", new_access_token)
74
+ print("Refresh Token updated:", new_refresh_token)
75
+ print("API Key:", api_key)
74
76
 
75
77
  async def main():
76
78
  # Initialize the token manager
@@ -98,3 +100,4 @@ asyncio.run(main())
98
100
  - `ElectroluxTokenManager` handles token refreshing automatically.
99
101
  - `on_token_update` callback is called whenever tokens are refreshed.
100
102
  - `get_appliance_data()` is async and returns a list of `ApplianceData` objects representing your owned appliances.
103
+
@@ -43,9 +43,11 @@ from electrolux_group_developer_sdk.client.appliance_client import ApplianceClie
43
43
 
44
44
 
45
45
  # Callback to handle token updates
46
- def on_token_update(new_access_token, new_refresh_token):
46
+ def on_token_update(new_access_token, new_refresh_token, api_key):
47
47
  # Save updated tokens somewhere safe
48
- print("Tokens updated:", new_access_token, new_refresh_token)
48
+ print("Access Token updated:", new_access_token)
49
+ print("Refresh Token updated:", new_refresh_token)
50
+ print("API Key:", api_key)
49
51
 
50
52
  async def main():
51
53
  # Initialize the token manager
@@ -72,4 +74,4 @@ asyncio.run(main())
72
74
  ## Notes
73
75
  - `ElectroluxTokenManager` handles token refreshing automatically.
74
76
  - `on_token_update` callback is called whenever tokens are refreshed.
75
- - `get_appliance_data()` is async and returns a list of `ApplianceData` objects representing your owned appliances.
77
+ - `get_appliance_data()` is async and returns a list of `ApplianceData` objects representing your owned appliances.
@@ -6,10 +6,11 @@ import jwt
6
6
 
7
7
  from .invalid_credentials_exception import InvalidCredentialsException
8
8
  from .invalid_token_exception import InvalidTokenException
9
+ from .token_refresh_failed import TokenRefreshFailedException
9
10
  from .auth_data import AuthData
10
11
  from ..client.client_util import request
11
- from ..config import TOKEN_REVOKE_URL, TOKEN_REFRESH_URL
12
- from ..constants import REFRESH_TOKEN, POST
12
+ from ..config import TOKEN_REVOKE_URL, TOKEN_REFRESH_URL, USER_EMAIL_URL
13
+ from ..constants import GET, REFRESH_TOKEN, POST
13
14
 
14
15
  _LOGGER = logging.getLogger(__name__)
15
16
 
@@ -81,7 +82,7 @@ class TokenManager:
81
82
 
82
83
  if not auth_data or auth_data.refresh_token is None:
83
84
  _LOGGER.error("Refresh token is missing")
84
- raise Exception("Missing refresh token")
85
+ raise InvalidCredentialsException("Missing refresh token")
85
86
 
86
87
  payload = {REFRESH_TOKEN: auth_data.refresh_token}
87
88
 
@@ -102,7 +103,7 @@ class TokenManager:
102
103
  async def revoke_token(self) -> bool:
103
104
  auth_data = self._auth_data
104
105
  if not auth_data or auth_data.refresh_token is None:
105
- raise Exception("Missing refresh token")
106
+ raise InvalidCredentialsException("Missing refresh token")
106
107
 
107
108
  payload = {REFRESH_TOKEN: auth_data.refresh_token}
108
109
 
@@ -119,13 +120,13 @@ class TokenManager:
119
120
  async def get_auth_data(self) -> AuthData:
120
121
  auth_data = self._auth_data
121
122
  if not auth_data or auth_data.access_token is None or auth_data.api_key is None:
122
- raise Exception("Missing access token or API key")
123
+ raise InvalidCredentialsException("Missing access token or API key")
123
124
 
124
125
  # Check if token is expired
125
126
  if not self.is_token_valid():
126
127
  refreshed = await self.refresh_token()
127
128
  if not refreshed:
128
- raise Exception("Token expired and refresh failed")
129
+ raise TokenRefreshFailedException("Token expired and refresh failed")
129
130
  auth_data = self._auth_data
130
131
 
131
132
  return auth_data
@@ -0,0 +1,5 @@
1
+ class TokenRefreshFailedException(Exception):
2
+ """Exception raised when an token is refreshed and an error is encountered."""
3
+
4
+ def __init__(self, message: str = "Refreshing the token failed."):
5
+ super().__init__(message)
@@ -8,16 +8,21 @@ import aiohttp
8
8
  from aiohttp import ClientTimeout, ClientResponseError
9
9
  from aiohttp.hdrs import USER_AGENT, AUTHORIZATION
10
10
 
11
+ from electrolux_group_developer_sdk.auth.token_refresh_failed import TokenRefreshFailedException
12
+ from electrolux_group_developer_sdk.client.bad_credentials_exception import BadCredentialsException
13
+
11
14
  from .appliance_data_factory import appliance_data_factory
12
15
  from .client_exception import ApplianceClientException
13
16
  from .client_util import request
14
17
  from .dto.appliance import Appliance
15
18
  from .dto.appliance_details import ApplianceDetails
16
19
  from .dto.appliance_state import ApplianceState
20
+ from .dto.email import Email
17
21
  from .dto.interactive_map import InteractiveMap
18
22
  from .dto.livestream_config import LivestreamConfig
19
23
  from .dto.memory_map import MemoryMap
20
24
  from .failed_connection_exception import FailedConnectionException
25
+ from ..auth.invalid_credentials_exception import InvalidCredentialsException
21
26
  from ..auth.token_manager import TokenManager
22
27
  from ..client.appliances.appliance_data import ApplianceData
23
28
  from ..config import (
@@ -28,6 +33,7 @@ from ..config import (
28
33
  GET_INTERACTIVE_MAPS_URL,
29
34
  GET_MEMORY_MAPS_URL,
30
35
  GET_LIVESTREAM_CONFIG_URL,
36
+ USER_EMAIL_URL,
31
37
  )
32
38
  from ..constants import API_KEY, GET, PUT, SDK_USER_AGENT, SDK_VERSION
33
39
 
@@ -80,15 +86,30 @@ class ApplianceClient:
80
86
  async def test_connection(self) -> None:
81
87
  try:
82
88
  await self._send_authorized_request(GET, GET_APPLIANCES_URL)
83
- except ApplianceClientException as e:
84
- _LOGGER.error("Test connection failed: %s", e)
85
- raise FailedConnectionException(f"Failed connection.", status_code=e.status)
86
- except ClientResponseError as e:
89
+ except (ApplianceClientException, ClientResponseError) as e:
87
90
  _LOGGER.error("Test connection failed: %s", e)
91
+ if e.status in [401, 403]:
92
+ raise BadCredentialsException("Invalid credentials detected when testing connection.")
88
93
  raise FailedConnectionException(f"Failed connection.", status_code=e.status)
94
+ except (InvalidCredentialsException, TokenRefreshFailedException) as e:
95
+ raise BadCredentialsException("Invalid credentials detected when testing connection.")
89
96
  except Exception as e:
90
97
  _LOGGER.error("Test connection failed: %s", e)
91
98
  raise FailedConnectionException("Failed connection.")
99
+
100
+ async def get_user_email(self) -> Email:
101
+ """Get the email address of the user that the credentials belong to"""
102
+ try:
103
+ response = await self._send_authorized_request(GET, USER_EMAIL_URL)
104
+ return Email(**response)
105
+ except aiohttp.ClientResponseError as e:
106
+ _LOGGER.error("Error during get user email: %s", e)
107
+ raise ApplianceClientException(
108
+ f"Failed to get user email: {e}", status=e.status
109
+ ) from e
110
+ except Exception as e:
111
+ _LOGGER.error("Error during get user email: %s", e)
112
+ raise ApplianceClientException(f"Failed to get user email: {e}")
92
113
 
93
114
  async def get_appliance_data(self) -> list[ApplianceData]:
94
115
  """Retrieve all the appliances data, returning specific appliance types when available."""
@@ -1,3 +1,4 @@
1
+ from typing import Optional
1
2
  from .appliances.ac_appliance import ACAppliance
2
3
  from .appliances.ap_appliance import APAppliance
3
4
  from .appliances.cr_appliance import CRAppliance
@@ -59,8 +60,8 @@ APPLIANCE_TYPE_CLASS_MAP: dict[str, type[ApplianceData]] = {
59
60
 
60
61
  def appliance_data_factory(
61
62
  appliance: Appliance,
62
- details: ApplianceDetails,
63
- state: ApplianceState,
63
+ details: Optional[ApplianceDetails],
64
+ state: Optional[ApplianceState],
64
65
  ) -> ApplianceData:
65
66
  """
66
67
  Return an instance of the appropriate ApplianceData subclass based on appliance type.
@@ -18,12 +18,12 @@ class ApplianceData(BaseModel):
18
18
  def update_state(self, state: ApplianceState) -> None:
19
19
  self.state = state
20
20
 
21
- @abstractmethod
22
21
  def is_feature_supported(self, feature: str | list[str]) -> bool:
23
22
  """Check if a feature is supported for the appliance."""
23
+ return False
24
24
 
25
- @abstractmethod
26
25
  def get_feature_state_string_options(self, feature: str) -> list[str]:
27
26
  """Get the possible string values the property of a feature can be.
28
27
 
29
28
  This method is only usable for string type features."""
29
+ return []
@@ -0,0 +1,9 @@
1
+ from typing import Optional
2
+
3
+
4
+ class BadCredentialsException(Exception):
5
+ """Exception raised when the credentials are missing or incorrect"""
6
+
7
+ def __init__(self, message: str = "The credentials are incorrect.", status_code: Optional[int] = None):
8
+ super().__init__(message)
9
+ self.status_code = status_code
@@ -0,0 +1,5 @@
1
+ from pydantic import BaseModel
2
+
3
+
4
+ class Email(BaseModel):
5
+ email: str
@@ -10,3 +10,5 @@ SEND_COMMAND_URL = f"{BASE_API_URL}/api/v1/appliances/{{appliance_id}}/command"
10
10
  GET_INTERACTIVE_MAPS_URL = f"{BASE_API_URL}/api/v1/appliances/{{appliance_id}}/interactiveMap"
11
11
  GET_MEMORY_MAPS_URL = f"{BASE_API_URL}/api/v1/appliances/{{appliance_id}}/memoryMap"
12
12
  GET_LIVESTREAM_CONFIG_URL = f"{BASE_API_URL}/api/v1/configurations/livestream"
13
+
14
+ USER_EMAIL_URL = f"{BASE_API_URL}/api/v1/users/current/email"
@@ -3,7 +3,7 @@ API_KEY = "x-api-key"
3
3
  REFRESH_TOKEN = "refreshToken"
4
4
 
5
5
  SDK_USER_AGENT = "ElectroluxGroupDeveloperSDK"
6
- SDK_VERSION = "0.3.0"
6
+ SDK_VERSION = "0.4.0"
7
7
 
8
8
  # Methods
9
9
  POST = "POST"
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "electrolux-group-developer-sdk"
3
- version = "0.3.0"
3
+ version = "0.4.0"
4
4
  description = "A Python async client library for interacting with the Electrolux Developer Portal API."
5
5
  authors = ["Electrolux Developer Portal Team <devportal@electrolux.com>"]
6
6
  readme = "README.md"