feat: ConfigFlow to show OTP Factor Type (Email/SMS) (#270)

Author: GuyKh

custom_components/iec/config_flow.py

@@ -18,12 +18,12 @@
 from iec_api.models.jwt import JWT
 
 from .const import (
-    CONF_TOTP_SECRET,
-    DOMAIN,
-    CONF_USER_ID,
-    CONF_BP_NUMBER,
     CONF_AVAILABLE_CONTRACTS,
+    CONF_BP_NUMBER,
     CONF_SELECTED_CONTRACTS,
+    CONF_TOTP_SECRET,
+    CONF_USER_ID,
+    DOMAIN,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -150,11 +150,12 @@ async def async_step_mfa(
             schema = {}
 
         schema[vol.Required(CONF_TOTP_SECRET)] = str
-        await client.login_with_id()
+        otp_type = await client.login_with_id()
 
         return self.async_show_form(
             step_id="mfa",
             data_schema=vol.Schema(schema),
+            description_placeholders={"otp_type": otp_type},
             errors=errors,
         )
 
@@ -240,7 +241,7 @@ async def async_step_reauth_confirm(
             )
             client = self.client
 
-        await client.login_with_id()
+        otp_type = await client.login_with_id()
 
         schema = {
             vol.Required(CONF_USER_ID): self.reauth_entry.data[CONF_USER_ID],
@@ -249,6 +250,7 @@ async def async_step_reauth_confirm(
 
         return self.async_show_form(
             step_id="reauth_confirm",
+            description_placeholders={"otp_type": otp_type},
             data_schema=vol.Schema(schema),
             errors=errors,
         )

custom_components/iec/const.py

@@ -43,6 +43,7 @@
 )
 CONF_USER_ID = "user_id"
 CONF_TOTP_SECRET = "totp_secret"
+CONF_TOTP_TYPE = "otp_type"
 CONF_BP_NUMBER = "bp_number"
 CONF_SELECTED_CONTRACTS = "selected_contracts"
 CONF_AVAILABLE_CONTRACTS = "contracts"

custom_components/iec/manifest.json

@@ -8,6 +8,6 @@
     "iot_class": "cloud_polling",
     "issue_tracker": "https://github.com/guykh/iec-custom-component/issues",
     "loggers": ["iec_api"],
-    "requirements": ["iec-api==0.4.11"],
+    "requirements": ["iec-api==0.4.12"],
     "version": "0.0.1"
 }

custom_components/iec/translations/en.json

@@ -77,7 +77,7 @@
             },
             "mfa": {
                 "title": "OTP",
-                "description": "Enter your One Time Password (OTP)",
+                "description": "Enter your One Time Password (OTP) sent to your {otp_type}",
                 "data": {
                     "totp_secret": "e.g. 123456"
                 }
@@ -88,6 +88,7 @@
             },
             "reauth_confirm": {
                 "title": "[%key:common::config_flow::title::reauth%]",
+                "description": "Enter your One Time Password (OTP) send to your {otp_type}",
                 "data": {
                     "user_id": "User ID",
                     "totp_secret": "e.g. 123456"

custom_components/iec/translations/he.json

@@ -80,7 +80,7 @@
             },
             "mfa": {
                 "title": "OTP",
-                "description": "הכניסו את הקוד החד-פעמי שנשלח אליכם (OTP)",
+                "description": "הכניסו את הקוד החד-פעמי שנשלח אליכם (OTP) שנשלח ל-{otp_type}",
                 "data": {
                     "totp_secret": "לדוג' 123456"
                 }
@@ -91,6 +91,7 @@
             },
             "reauth_confirm": {
                 "title": "[%key:common::config_flow::title::reauth%]",
+                "description": "הכניסו את הקוד החד-פעמי שנשלח אליכם (OTP) שנשלח ל-{otp_type}",
                 "data": {
                     "user_id": "מזהה לקוח",
                     "totp_secret": "לדוג' 123456"

requirements.txt

@@ -1,5 +1,5 @@
 colorlog>=6.8.2
 homeassistant==2024.2.0
-iec-api==0.4.11
+iec-api==0.4.12
 pip>=21.0
 ruff>=0.5.6