fix: doorbells are not supported with yale global brand

Author: bdraco

yalexs/api_async.py

@@ -109,7 +109,9 @@ async def async_validate_verification_code(
             )
         )
 
-    async def async_get_doorbells(self, access_token: str) -> Doorbell:
+    async def async_get_doorbells(self, access_token: str) -> list[Doorbell]:
+        if not self.brand_supports_doorbells:
+            return []
         response = await self._async_dict_to_api(
             self._build_get_doorbells_request(access_token)
         )

yalexs/api_common.py

@@ -11,6 +11,7 @@
 from .doorbell import Doorbell
 from .lock import Lock, LockDoorStatus, determine_door_state, door_state_to_string
 from .time import parse_datetime
+from .backports.functools import cached_property
 
 API_EXCEPTION_RETRY_TIME = 0.1
 API_RETRY_TIME = 2.5
@@ -63,10 +64,14 @@
 _LOGGER = logging.getLogger(__name__)
 
 
+def _get_brand_config(brand: Brand) -> BrandConfig:
+    return BRAND_CONFIG.get(brand, BRAND_CONFIG[DEFAULT_BRAND])
+
+
 def _api_headers(
     access_token: str | None = None, brand: Brand | None = None
 ) -> dict[str, str]:
-    brand_config: BrandConfig = BRAND_CONFIG.get(brand, BRAND_CONFIG[DEFAULT_BRAND])
+    brand_config = _get_brand_config(brand)
 
     headers = {
         HEADER_ACCEPT_VERSION: HEADER_VALUE_ACCEPT_VERSION,
@@ -169,6 +174,12 @@ def __init__(self, brand: Brand) -> None:
         """Init."""
         self._base_url = BASE_URLS[brand]
         self.brand = brand
+        self.brand_config = _get_brand_config(brand)
+
+    @cached_property
+    def brand_supports_doorbells(self) -> bool:
+        """Return if the brand supports doorbells."""
+        return self.brand_config.supports_doorbells
 
     def get_brand_url(self, url_str: str) -> str:
         """Get url."""

yalexs/const.py

@@ -45,6 +45,7 @@ class BrandConfig:
     api_key_header: str
     branding_header: str
     api_key: str
+    supports_doorbells: bool
 
 
 HEADER_VALUE_API_KEY_OLD = "7cab4bbd-2693-4fc1-b99b-dec0fb20f9d4"
@@ -66,6 +67,7 @@ class BrandConfig:
         api_key_header=HEADER_AUGUST_API_KEY,
         branding_header=HEADER_AUGUST_BRANDING,
         api_key=HEADER_VALUE_API_KEY,
+        supports_doorbells=True,
     ),
     Brand.YALE_ACCESS: BrandConfig(
         name="Yale Access",
@@ -74,6 +76,7 @@ class BrandConfig:
         api_key_header=HEADER_AUGUST_API_KEY,
         branding_header=HEADER_AUGUST_BRANDING,
         api_key=HEADER_VALUE_API_KEY,
+        supports_doorbells=True,
     ),
     Brand.YALE_HOME: BrandConfig(
         name="Yale Home",
@@ -82,6 +85,7 @@ class BrandConfig:
         api_key_header=HEADER_API_KEY,
         branding_header=HEADER_BRANDING,
         api_key=HEADER_VALUE_API_KEY,
+        supports_doorbells=True,
     ),
     Brand.YALE_GLOBAL: BrandConfig(
         name="Yale Global",
@@ -93,6 +97,7 @@ class BrandConfig:
         # having the API key in the code because it must
         # run on the user's device
         api_key="d16a1029-d823-4b55-a4ce-a769a9b56f0e",
+        supports_doorbells=False,
     ),
 }