homeassistant-stubs 2024.4.3__py3-none-any.whl → 2024.5.0__py3-none-any.whl

homeassistant-stubs/components/recorder/pool.pyi

@@ -2,7 +2,7 @@ import threading
 from .const import DB_WORKER_PREFIX as DB_WORKER_PREFIX
 from _typeshed import Incomplete
 from homeassistant.helpers.frame import report as report
-from homeassistant.util.async_ import check_loop as check_loop
+from homeassistant.util.loop import check_loop as check_loop
 from sqlalchemy.pool import ConnectionPoolEntry as ConnectionPoolEntry, NullPool, SingletonThreadPool, StaticPool
 from typing import Any
 

homeassistant-stubs/components/recorder/services.pyi

@@ -2,6 +2,7 @@ from .const import ATTR_APPLY_FILTER as ATTR_APPLY_FILTER, ATTR_KEEP_DAYS as ATT
 from .core import Recorder as Recorder
 from .tasks import PurgeEntitiesTask as PurgeEntitiesTask, PurgeTask as PurgeTask
 from _typeshed import Incomplete
+from homeassistant.const import ATTR_ENTITY_ID as ATTR_ENTITY_ID
 from homeassistant.core import HomeAssistant as HomeAssistant, ServiceCall as ServiceCall, callback as callback
 from homeassistant.helpers.entityfilter import generate_filter as generate_filter
 from homeassistant.helpers.service import async_extract_entity_ids as async_extract_entity_ids, async_register_admin_service as async_register_admin_service

homeassistant-stubs/components/recorder/statistics.pyi

@@ -89,14 +89,14 @@ def _compile_statistics(instance: Recorder, session: Session, start: datetime, f
 def _adjust_sum_statistics(session: Session, table: type[StatisticsBase], metadata_id: int, start_time: datetime, adj: float) -> None: ...
 def _insert_statistics(session: Session, table: type[StatisticsBase], metadata_id: int, statistic: StatisticData) -> StatisticsBase | None: ...
 def _update_statistics(session: Session, table: type[StatisticsBase], stat_id: int, statistic: StatisticData) -> None: ...
-def get_metadata_with_session(instance: Recorder, session: Session, *, statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
-def get_metadata(hass: HomeAssistant, *, statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
+def get_metadata_with_session(instance: Recorder, session: Session, *, statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
+def get_metadata(hass: HomeAssistant, *, statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
 def clear_statistics(instance: Recorder, statistic_ids: list[str]) -> None: ...
 def update_statistics_metadata(instance: Recorder, statistic_id: str, new_statistic_id: str | None | UndefinedType, new_unit_of_measurement: str | None | UndefinedType) -> None: ...
-async def async_list_statistic_ids(hass: HomeAssistant, statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None) -> list[dict]: ...
+async def async_list_statistic_ids(hass: HomeAssistant, statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None) -> list[dict]: ...
 def _statistic_by_id_from_metadata(hass: HomeAssistant, metadata: dict[str, tuple[int, StatisticMetaData]]) -> dict[str, dict[str, Any]]: ...
 def _flatten_list_statistic_ids_metadata_result(result: dict[str, dict[str, Any]]) -> list[dict]: ...
-def list_statistic_ids(hass: HomeAssistant, statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None) -> list[dict]: ...
+def list_statistic_ids(hass: HomeAssistant, statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None) -> list[dict]: ...
 def _reduce_statistics(stats: dict[str, list[StatisticsRow]], same_period: Callable[[float, float], bool], period_start_end: Callable[[float], tuple[float, float]], period: timedelta, types: set[Literal['last_reset', 'max', 'mean', 'min', 'state', 'sum']]) -> dict[str, list[StatisticsRow]]: ...
 def reduce_day_ts_factory() -> tuple[Callable[[float, float], bool], Callable[[float], tuple[float, float]]]: ...
 def _reduce_statistics_per_day(stats: dict[str, list[StatisticsRow]], types: set[Literal['last_reset', 'max', 'mean', 'min', 'state', 'sum']]) -> dict[str, list[StatisticsRow]]: ...

homeassistant-stubs/components/recorder/table_managers/__init__.pyi

@@ -1,18 +1,19 @@
 from ..core import Recorder as Recorder
 from _typeshed import Incomplete
+from homeassistant.util.event_type import EventType as EventType
 from lru import LRU
-from typing import Generic, TypeVar
+from typing import Any, Generic, TypeVar
 
 _DataT = TypeVar('_DataT')
 
 class BaseTableManager(Generic[_DataT]):
-    _id_map: LRU[str, int]
+    _id_map: LRU[EventType[Any] | str, int]
     active: bool
     recorder: Incomplete
     _pending: Incomplete
     def __init__(self, recorder: Recorder) -> None: ...
     def get_from_cache(self, data: str) -> int | None: ...
-    def get_pending(self, shared_data: str) -> _DataT | None: ...
+    def get_pending(self, shared_data: EventType[Any] | str) -> _DataT | None: ...
     def reset(self) -> None: ...
 
 class BaseLRUTableManager(BaseTableManager[_DataT]):

homeassistant-stubs/components/recorder/table_managers/event_types.pyi

@@ -7,7 +7,9 @@ from ..util import chunked as chunked, execute_stmt_lambda_element as execute_st
 from _typeshed import Incomplete
 from collections.abc import Iterable
 from homeassistant.core import Event as Event
+from homeassistant.util.event_type import EventType as EventType
 from sqlalchemy.orm.session import Session as Session
+from typing import Any
 
 CACHE_SIZE: int
 
@@ -15,9 +17,9 @@ class EventTypeManager(BaseLRUTableManager[EventTypes]):
     _non_existent_event_types: Incomplete
     def __init__(self, recorder: Recorder) -> None: ...
     def load(self, events: list[Event], session: Session) -> None: ...
-    def get(self, event_type: str, session: Session, from_recorder: bool = False) -> int | None: ...
-    def get_many(self, event_types: Iterable[str], session: Session, from_recorder: bool = False) -> dict[str, int | None]: ...
+    def get(self, event_type: EventType[Any] | str, session: Session, from_recorder: bool = False) -> int | None: ...
+    def get_many(self, event_types: Iterable[EventType[Any] | str], session: Session, from_recorder: bool = False) -> dict[EventType[Any] | str, int | None]: ...
     def add_pending(self, db_event_type: EventTypes) -> None: ...
     def post_commit_pending(self) -> None: ...
-    def clear_non_existent(self, event_type: str) -> None: ...
+    def clear_non_existent(self, event_type: EventType[Any] | str) -> None: ...
     def evict_purged(self, event_types: Iterable[str]) -> None: ...

homeassistant-stubs/components/recorder/table_managers/state_attributes.pyi

@@ -5,7 +5,7 @@ from ..queries import get_shared_attributes as get_shared_attributes
 from ..util import chunked as chunked, execute_stmt_lambda_element as execute_stmt_lambda_element
 from _typeshed import Incomplete
 from collections.abc import Iterable
-from homeassistant.core import Event as Event
+from homeassistant.core import Event as Event, EventStateChangedData as EventStateChangedData
 from homeassistant.util.json import JSON_ENCODE_EXCEPTIONS as JSON_ENCODE_EXCEPTIONS
 from sqlalchemy.orm.session import Session as Session
 
@@ -15,8 +15,8 @@ _LOGGER: Incomplete
 class StateAttributesManager(BaseLRUTableManager[StateAttributes]):
     active: bool
     def __init__(self, recorder: Recorder) -> None: ...
-    def serialize_from_event(self, event: Event) -> bytes | None: ...
-    def load(self, events: list[Event], session: Session) -> None: ...
+    def serialize_from_event(self, event: Event[EventStateChangedData]) -> bytes | None: ...
+    def load(self, events: list[Event[EventStateChangedData]], session: Session) -> None: ...
     def get(self, shared_attr: str, data_hash: int, session: Session) -> int | None: ...
     def get_many(self, shared_attrs_data_hashes: Iterable[tuple[str, int]], session: Session) -> dict[str, int | None]: ...
     def _load_from_hashes(self, hashes: Iterable[int], session: Session) -> dict[str, int | None]: ...

homeassistant-stubs/components/recorder/table_managers/states_meta.pyi

@@ -4,7 +4,7 @@ from ..db_schema import StatesMeta as StatesMeta
 from ..queries import find_all_states_metadata_ids as find_all_states_metadata_ids, find_states_metadata_ids as find_states_metadata_ids
 from ..util import chunked as chunked, execute_stmt_lambda_element as execute_stmt_lambda_element
 from collections.abc import Iterable
-from homeassistant.core import Event as Event
+from homeassistant.core import Event as Event, EventStateChangedData as EventStateChangedData
 from sqlalchemy.orm.session import Session as Session
 
 CACHE_SIZE: int
@@ -12,7 +12,7 @@ CACHE_SIZE: int
 class StatesMetaManager(BaseLRUTableManager[StatesMeta]):
     _did_first_load: bool
     def __init__(self, recorder: Recorder) -> None: ...
-    def load(self, events: list[Event], session: Session) -> None: ...
+    def load(self, events: list[Event[EventStateChangedData]], session: Session) -> None: ...
     def get(self, entity_id: str, session: Session, from_recorder: bool) -> int | None: ...
     def get_metadata_id_to_entity_id(self, session: Session) -> dict[int, str]: ...
     def get_many(self, entity_ids: Iterable[str], session: Session, from_recorder: bool) -> dict[str, int | None]: ...

homeassistant-stubs/components/recorder/table_managers/statistics_meta.pyi

@@ -11,7 +11,7 @@ CACHE_SIZE: int
 _LOGGER: Incomplete
 QUERY_STATISTIC_META: Incomplete
 
-def _generate_get_metadata_stmt(statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None, statistic_source: str | None = None) -> StatementLambdaElement: ...
+def _generate_get_metadata_stmt(statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None, statistic_source: str | None = None) -> StatementLambdaElement: ...
 def _statistics_meta_to_id_statistics_metadata(meta: StatisticsMeta) -> tuple[int, StatisticMetaData]: ...
 
 class StatisticsMetaManager:
@@ -19,13 +19,13 @@ class StatisticsMetaManager:
     _stat_id_to_id_meta: Incomplete
     def __init__(self, recorder: Recorder) -> None: ...
     def _clear_cache(self, statistic_ids: list[str]) -> None: ...
-    def _get_from_database(self, session: Session, statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
+    def _get_from_database(self, session: Session, statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
     def _assert_in_recorder_thread(self) -> None: ...
     def _add_metadata(self, session: Session, statistic_id: str, new_metadata: StatisticMetaData) -> int: ...
     def _update_metadata(self, session: Session, statistic_id: str, new_metadata: StatisticMetaData, old_metadata_dict: dict[str, tuple[int, StatisticMetaData]]) -> tuple[str | None, int]: ...
     def load(self, session: Session) -> None: ...
     def get(self, session: Session, statistic_id: str) -> tuple[int, StatisticMetaData] | None: ...
-    def get_many(self, session: Session, statistic_ids: set[str] | None = None, statistic_type: Literal['mean'] | Literal['sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
+    def get_many(self, session: Session, statistic_ids: set[str] | None = None, statistic_type: Literal['mean', 'sum'] | None = None, statistic_source: str | None = None) -> dict[str, tuple[int, StatisticMetaData]]: ...
     def get_from_cache_threadsafe(self, statistic_ids: set[str]) -> dict[str, tuple[int, StatisticMetaData]]: ...
     def update_or_add(self, session: Session, new_metadata: StatisticMetaData, old_metadata_dict: dict[str, tuple[int, StatisticMetaData]]) -> tuple[str | None, int]: ...
     def update_unit_of_measurement(self, session: Session, statistic_id: str, new_unit: str | None) -> None: ...

homeassistant-stubs/components/recorder/tasks.pyi

@@ -12,6 +12,7 @@ from collections.abc import Callable as Callable, Iterable
 from dataclasses import dataclass
 from datetime import datetime
 from homeassistant.helpers.typing import UndefinedType as UndefinedType
+from homeassistant.util.event_type import EventType as EventType
 from typing import Any
 
 _LOGGER: Incomplete
@@ -186,6 +187,6 @@ class EventIdMigrationTask(RecorderTask):
 
 @dataclass(slots=True)
 class RefreshEventTypesTask(RecorderTask):
-    event_types: list[str]
+    event_types: list[EventType[Any] | str]
     def run(self, instance: Recorder) -> None: ...
     def __init__(self, event_types) -> None: ...

homeassistant-stubs/components/recorder/websocket_api.pyi

@@ -19,7 +19,7 @@ async def ws_get_statistic_during_period(hass: HomeAssistant, connection: websoc
 def _ws_get_statistics_during_period(hass: HomeAssistant, msg_id: int, start_time: dt, end_time: dt | None, statistic_ids: set[str] | None, period: Literal['5minute', 'day', 'hour', 'week', 'month'], units: dict[str, str], types: set[Literal['change', 'last_reset', 'max', 'mean', 'min', 'state', 'sum']]) -> bytes: ...
 async def ws_handle_get_statistics_during_period(hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
 async def ws_get_statistics_during_period(hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict[str, Any]) -> None: ...
-def _ws_get_list_statistic_ids(hass: HomeAssistant, msg_id: int, statistic_type: Literal['mean'] | Literal['sum'] | None = None) -> bytes: ...
+def _ws_get_list_statistic_ids(hass: HomeAssistant, msg_id: int, statistic_type: Literal['mean', 'sum'] | None = None) -> bytes: ...
 async def ws_handle_list_statistic_ids(hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
 async def ws_list_statistic_ids(hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict[str, Any]) -> None: ...
 async def ws_validate_statistics(hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict[str, Any]) -> None: ...

homeassistant-stubs/components/rest/__init__.pyi

@@ -1,4 +1,4 @@
-from .const import CONF_ENCODING as CONF_ENCODING, CONF_SSL_CIPHER_LIST as CONF_SSL_CIPHER_LIST, COORDINATOR as COORDINATOR, DEFAULT_SSL_CIPHER_LIST as DEFAULT_SSL_CIPHER_LIST, DOMAIN as DOMAIN, PLATFORM_IDX as PLATFORM_IDX, REST as REST, REST_DATA as REST_DATA, REST_IDX as REST_IDX
+from .const import CONF_ENCODING as CONF_ENCODING, CONF_PAYLOAD_TEMPLATE as CONF_PAYLOAD_TEMPLATE, CONF_SSL_CIPHER_LIST as CONF_SSL_CIPHER_LIST, COORDINATOR as COORDINATOR, DEFAULT_SSL_CIPHER_LIST as DEFAULT_SSL_CIPHER_LIST, DOMAIN as DOMAIN, PLATFORM_IDX as PLATFORM_IDX, REST as REST, REST_DATA as REST_DATA, REST_IDX as REST_IDX
 from .data import RestData as RestData
 from .schema import CONFIG_SCHEMA as CONFIG_SCHEMA, RESOURCE_SCHEMA as RESOURCE_SCHEMA
 from _typeshed import Incomplete
@@ -21,5 +21,5 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: ...
 def _async_setup_shared_data(hass: HomeAssistant) -> None: ...
 async def _async_process_config(hass: HomeAssistant, config: ConfigType) -> bool: ...
 async def async_get_config_and_coordinator(hass: HomeAssistant, platform_domain: str, discovery_info: DiscoveryInfoType) -> tuple[ConfigType, DataUpdateCoordinator[None], RestData]: ...
-def _rest_coordinator(hass: HomeAssistant, rest: RestData, resource_template: template.Template | None, update_interval: timedelta) -> DataUpdateCoordinator[None]: ...
+def _rest_coordinator(hass: HomeAssistant, rest: RestData, resource_template: template.Template | None, payload_template: template.Template | None, update_interval: timedelta) -> DataUpdateCoordinator[None]: ...
 def create_rest_data_from_config(hass: HomeAssistant, config: ConfigType) -> RestData: ...

homeassistant-stubs/components/rest/const.pyi

@@ -20,3 +20,4 @@ REST: str
 REST_DATA: str
 METHODS: Incomplete
 XML_MIME_TYPES: Incomplete
+CONF_PAYLOAD_TEMPLATE: str

homeassistant-stubs/components/rest/data.pyi

@@ -27,6 +27,7 @@ class RestData:
     last_exception: Incomplete
     headers: Incomplete
     def __init__(self, hass: HomeAssistant, method: str, resource: str, encoding: str, auth: httpx.DigestAuth | tuple[str, str] | None, headers: dict[str, str] | None, params: dict[str, str] | None, data: str | None, verify_ssl: bool, ssl_cipher_list: str, timeout: int = ...) -> None: ...
+    def set_payload(self, payload: str) -> None: ...
     @property
     def url(self) -> str: ...
     def set_url(self, url: str) -> None: ...

homeassistant-stubs/components/rest/schema.pyi

@@ -1,4 +1,4 @@
-from .const import CONF_ENCODING as CONF_ENCODING, CONF_JSON_ATTRS as CONF_JSON_ATTRS, CONF_JSON_ATTRS_PATH as CONF_JSON_ATTRS_PATH, CONF_SSL_CIPHER_LIST as CONF_SSL_CIPHER_LIST, DEFAULT_ENCODING as DEFAULT_ENCODING, DEFAULT_FORCE_UPDATE as DEFAULT_FORCE_UPDATE, DEFAULT_METHOD as DEFAULT_METHOD, DEFAULT_SSL_CIPHER_LIST as DEFAULT_SSL_CIPHER_LIST, DEFAULT_VERIFY_SSL as DEFAULT_VERIFY_SSL, DOMAIN as DOMAIN, METHODS as METHODS
+from .const import CONF_ENCODING as CONF_ENCODING, CONF_JSON_ATTRS as CONF_JSON_ATTRS, CONF_JSON_ATTRS_PATH as CONF_JSON_ATTRS_PATH, CONF_PAYLOAD_TEMPLATE as CONF_PAYLOAD_TEMPLATE, CONF_SSL_CIPHER_LIST as CONF_SSL_CIPHER_LIST, DEFAULT_ENCODING as DEFAULT_ENCODING, DEFAULT_FORCE_UPDATE as DEFAULT_FORCE_UPDATE, DEFAULT_METHOD as DEFAULT_METHOD, DEFAULT_SSL_CIPHER_LIST as DEFAULT_SSL_CIPHER_LIST, DEFAULT_VERIFY_SSL as DEFAULT_VERIFY_SSL, DOMAIN as DOMAIN, METHODS as METHODS
 from .data import DEFAULT_TIMEOUT as DEFAULT_TIMEOUT
 from _typeshed import Incomplete
 from homeassistant.const import CONF_AUTHENTICATION as CONF_AUTHENTICATION, CONF_DEVICE_CLASS as CONF_DEVICE_CLASS, CONF_FORCE_UPDATE as CONF_FORCE_UPDATE, CONF_HEADERS as CONF_HEADERS, CONF_METHOD as CONF_METHOD, CONF_PARAMS as CONF_PARAMS, CONF_PASSWORD as CONF_PASSWORD, CONF_PAYLOAD as CONF_PAYLOAD, CONF_RESOURCE as CONF_RESOURCE, CONF_RESOURCE_TEMPLATE as CONF_RESOURCE_TEMPLATE, CONF_SCAN_INTERVAL as CONF_SCAN_INTERVAL, CONF_TIMEOUT as CONF_TIMEOUT, CONF_USERNAME as CONF_USERNAME, CONF_VALUE_TEMPLATE as CONF_VALUE_TEMPLATE, CONF_VERIFY_SSL as CONF_VERIFY_SSL, HTTP_BASIC_AUTHENTICATION as HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION as HTTP_DIGEST_AUTHENTICATION

homeassistant-stubs/components/rfxtrx/__init__.pyi

@@ -7,7 +7,7 @@ from homeassistant.const import ATTR_DEVICE_ID as ATTR_DEVICE_ID, CONF_DEVICE as
 from homeassistant.core import Event as Event, HomeAssistant as HomeAssistant, ServiceCall as ServiceCall, callback as callback
 from homeassistant.exceptions import ConfigEntryNotReady as ConfigEntryNotReady
 from homeassistant.helpers import device_registry as dr
-from homeassistant.helpers.device_registry import DeviceInfo as DeviceInfo
+from homeassistant.helpers.device_registry import DeviceInfo as DeviceInfo, EventDeviceRegistryUpdatedData as EventDeviceRegistryUpdatedData
 from homeassistant.helpers.dispatcher import async_dispatcher_connect as async_dispatcher_connect, async_dispatcher_send as async_dispatcher_send
 from homeassistant.helpers.entity import Entity as Entity
 from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback

homeassistant-stubs/components/rfxtrx/config_flow.pyi

@@ -4,10 +4,10 @@ from .const import CONF_AUTOMATIC_ADD as CONF_AUTOMATIC_ADD, CONF_DATA_BITS as C
 from _typeshed import Incomplete
 from homeassistant.config_entries import ConfigEntry as ConfigEntry, ConfigFlow as ConfigFlow, ConfigFlowResult as ConfigFlowResult, OptionsFlow as OptionsFlow
 from homeassistant.const import CONF_COMMAND_OFF as CONF_COMMAND_OFF, CONF_COMMAND_ON as CONF_COMMAND_ON, CONF_DEVICE as CONF_DEVICE, CONF_DEVICES as CONF_DEVICES, CONF_DEVICE_ID as CONF_DEVICE_ID, CONF_HOST as CONF_HOST, CONF_PORT as CONF_PORT, CONF_TYPE as CONF_TYPE
-from homeassistant.core import State as State, callback as callback
+from homeassistant.core import Event as Event, EventStateChangedData as EventStateChangedData, callback as callback
 from homeassistant.exceptions import HomeAssistantError as HomeAssistantError
 from homeassistant.helpers import device_registry as dr
-from homeassistant.helpers.event import async_track_state_change as async_track_state_change
+from homeassistant.helpers.event import async_track_state_change_event as async_track_state_change_event
 from typing import Any, TypedDict
 
 CONF_EVENT_CODE: str

homeassistant-stubs/components/rfxtrx/event.pyi

@@ -1,4 +1,5 @@
 from . import DeviceTuple as DeviceTuple, RfxtrxEntity as RfxtrxEntity, async_setup_platform_entry as async_setup_platform_entry
+from .const import DEVICE_PACKET_TYPE_LIGHTING4 as DEVICE_PACKET_TYPE_LIGHTING4
 from RFXtrx import RFXtrxDevice as RFXtrxDevice, RFXtrxEvent as RFXtrxEvent
 from _typeshed import Incomplete
 from homeassistant.components.event import EventEntity as EventEntity

homeassistant-stubs/components/ring/__init__.pyi

@@ -0,0 +1,25 @@
+from .const import DOMAIN as DOMAIN, PLATFORMS as PLATFORMS
+from .coordinator import RingDataCoordinator as RingDataCoordinator, RingNotificationsCoordinator as RingNotificationsCoordinator
+from _typeshed import Incomplete
+from dataclasses import dataclass
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.const import APPLICATION_NAME as APPLICATION_NAME, CONF_TOKEN as CONF_TOKEN, __version__ as __version__
+from homeassistant.core import HomeAssistant as HomeAssistant, ServiceCall as ServiceCall, callback as callback
+from homeassistant.helpers import device_registry as dr
+from homeassistant.helpers.issue_registry import IssueSeverity as IssueSeverity, async_create_issue as async_create_issue
+from ring_doorbell import Ring, RingDevices as RingDevices
+
+_LOGGER: Incomplete
+
+@dataclass
+class RingData:
+    api: Ring
+    devices: RingDevices
+    devices_coordinator: RingDataCoordinator
+    notifications_coordinator: RingNotificationsCoordinator
+    def __init__(self, api, devices, devices_coordinator, notifications_coordinator) -> None: ...
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: ...
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: ...
+async def async_remove_config_entry_device(hass: HomeAssistant, config_entry: ConfigEntry, device_entry: dr.DeviceEntry) -> bool: ...
+async def _migrate_old_unique_ids(hass: HomeAssistant, entry_id: str) -> None: ...

homeassistant-stubs/components/ring/binary_sensor.pyi

@@ -0,0 +1,35 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from .coordinator import RingNotificationsCoordinator as RingNotificationsCoordinator
+from .entity import RingBaseEntity as RingBaseEntity
+from _typeshed import Incomplete
+from collections.abc import Callable as Callable, Mapping
+from dataclasses import dataclass
+from homeassistant.components.binary_sensor import BinarySensorDeviceClass as BinarySensorDeviceClass, BinarySensorEntity as BinarySensorEntity, BinarySensorEntityDescription as BinarySensorEntityDescription
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from ring_doorbell import Ring as Ring, RingEvent as RingEvent, RingGeneric as RingGeneric
+from typing import Any
+
+@dataclass(frozen=True, kw_only=True)
+class RingBinarySensorEntityDescription(BinarySensorEntityDescription):
+    exists_fn: Callable[[RingGeneric], bool]
+    def __init__(self, *, key, device_class, entity_category, entity_registry_enabled_default, entity_registry_visible_default, force_update, icon, has_entity_name, name, translation_key, translation_placeholders, unit_of_measurement, exists_fn) -> None: ...
+
+BINARY_SENSOR_TYPES: tuple[RingBinarySensorEntityDescription, ...]
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None: ...
+
+class RingBinarySensor(RingBaseEntity[RingNotificationsCoordinator], BinarySensorEntity):
+    _active_alert: RingEvent | None
+    entity_description: RingBinarySensorEntityDescription
+    _ring: Incomplete
+    _attr_unique_id: Incomplete
+    def __init__(self, ring: Ring, device: RingGeneric, coordinator: RingNotificationsCoordinator, description: RingBinarySensorEntityDescription) -> None: ...
+    def _handle_coordinator_update(self, _: Any = None) -> None: ...
+    def _update_alert(self) -> None: ...
+    @property
+    def is_on(self) -> bool: ...
+    @property
+    def extra_state_attributes(self) -> Mapping[str, Any] | None: ...

homeassistant-stubs/components/ring/button.pyi

@@ -0,0 +1,20 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from .coordinator import RingDataCoordinator as RingDataCoordinator
+from .entity import RingEntity as RingEntity, exception_wrap as exception_wrap
+from _typeshed import Incomplete
+from homeassistant.components.button import ButtonEntity as ButtonEntity, ButtonEntityDescription as ButtonEntityDescription
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.core import HomeAssistant as HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from ring_doorbell import RingOther
+
+BUTTON_DESCRIPTION: Incomplete
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None: ...
+
+class RingDoorButton(RingEntity[RingOther], ButtonEntity):
+    entity_description: Incomplete
+    _attr_unique_id: Incomplete
+    def __init__(self, device: RingOther, coordinator: RingDataCoordinator, description: ButtonEntityDescription) -> None: ...
+    def press(self) -> None: ...

homeassistant-stubs/components/ring/camera.pyi

@@ -0,0 +1,43 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from .coordinator import RingDataCoordinator as RingDataCoordinator
+from .entity import RingEntity as RingEntity, exception_wrap as exception_wrap
+from _typeshed import Incomplete
+from aiohttp import web as web
+from homeassistant.components import ffmpeg as ffmpeg
+from homeassistant.components.camera import Camera as Camera
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.aiohttp_client import async_aiohttp_proxy_stream as async_aiohttp_proxy_stream
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from ring_doorbell import RingDoorBell
+from typing import Any
+
+FORCE_REFRESH_INTERVAL: Incomplete
+MOTION_DETECTION_CAPABILITY: str
+_LOGGER: Incomplete
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None: ...
+
+class RingCam(RingEntity[RingDoorBell], Camera):
+    _attr_name: Incomplete
+    _ffmpeg_manager: Incomplete
+    _last_event: Incomplete
+    _last_video_id: Incomplete
+    _video_url: Incomplete
+    _image: Incomplete
+    _expires_at: Incomplete
+    _attr_unique_id: Incomplete
+    _attr_motion_detection_enabled: Incomplete
+    def __init__(self, device: RingDoorBell, coordinator: RingDataCoordinator, ffmpeg_manager: ffmpeg.FFmpegManager) -> None: ...
+    _device: Incomplete
+    def _handle_coordinator_update(self) -> None: ...
+    @property
+    def extra_state_attributes(self) -> dict[str, Any]: ...
+    async def async_camera_image(self, width: int | None = None, height: int | None = None) -> bytes | None: ...
+    async def handle_async_mjpeg_stream(self, request: web.Request) -> web.StreamResponse | None: ...
+    async def async_update(self) -> None: ...
+    def _get_video(self) -> str | None: ...
+    def _set_motion_detection_enabled(self, new_state: bool) -> None: ...
+    def enable_motion_detection(self) -> None: ...
+    def disable_motion_detection(self) -> None: ...

homeassistant-stubs/components/ring/config_flow.pyi

@@ -0,0 +1,26 @@
+from .const import CONF_2FA as CONF_2FA, DOMAIN as DOMAIN
+from _typeshed import Incomplete
+from collections.abc import Mapping
+from homeassistant.config_entries import ConfigEntry as ConfigEntry, ConfigFlow as ConfigFlow, ConfigFlowResult as ConfigFlowResult
+from homeassistant.const import APPLICATION_NAME as APPLICATION_NAME, CONF_PASSWORD as CONF_PASSWORD, CONF_TOKEN as CONF_TOKEN, CONF_USERNAME as CONF_USERNAME
+from homeassistant.core import HomeAssistant as HomeAssistant
+from homeassistant.exceptions import HomeAssistantError as HomeAssistantError
+from typing import Any
+
+_LOGGER: Incomplete
+STEP_USER_DATA_SCHEMA: Incomplete
+STEP_REAUTH_DATA_SCHEMA: Incomplete
+
+async def validate_input(hass: HomeAssistant, data: dict[str, str]) -> dict[str, Any]: ...
+
+class RingConfigFlow(ConfigFlow, domain=DOMAIN):
+    VERSION: int
+    user_pass: dict[str, Any]
+    reauth_entry: ConfigEntry | None
+    async def async_step_user(self, user_input: dict[str, Any] | None = None) -> ConfigFlowResult: ...
+    async def async_step_2fa(self, user_input: dict[str, Any] | None = None) -> ConfigFlowResult: ...
+    async def async_step_reauth(self, entry_data: Mapping[str, Any]) -> ConfigFlowResult: ...
+    async def async_step_reauth_confirm(self, user_input: dict[str, Any] | None = None) -> ConfigFlowResult: ...
+
+class Require2FA(HomeAssistantError): ...
+class InvalidAuth(HomeAssistantError): ...

homeassistant-stubs/components/ring/const.pyi

@@ -0,0 +1,12 @@
+from _typeshed import Incomplete
+from homeassistant.const import Platform as Platform
+
+ATTRIBUTION: str
+NOTIFICATION_ID: str
+NOTIFICATION_TITLE: str
+DOMAIN: str
+DEFAULT_ENTITY_NAMESPACE: str
+PLATFORMS: Incomplete
+SCAN_INTERVAL: Incomplete
+NOTIFICATIONS_SCAN_INTERVAL: Incomplete
+CONF_2FA: str

homeassistant-stubs/components/ring/coordinator.pyi

@@ -0,0 +1,25 @@
+from .const import NOTIFICATIONS_SCAN_INTERVAL as NOTIFICATIONS_SCAN_INTERVAL, SCAN_INTERVAL as SCAN_INTERVAL
+from _typeshed import Incomplete
+from collections.abc import Callable as Callable
+from homeassistant.core import HomeAssistant as HomeAssistant
+from homeassistant.exceptions import ConfigEntryAuthFailed as ConfigEntryAuthFailed
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator as DataUpdateCoordinator, UpdateFailed as UpdateFailed
+from ring_doorbell import Ring as Ring, RingDevices
+from typing import TypeVar, TypeVarTuple
+
+_LOGGER: Incomplete
+_R = TypeVar('_R')
+_Ts = TypeVarTuple('_Ts')
+
+async def _call_api(hass: HomeAssistant, target: Callable[[Unpack[_Ts]], _R], *args: Unpack[_Ts], msg_suffix: str = '') -> _R: ...
+
+class RingDataCoordinator(DataUpdateCoordinator[RingDevices]):
+    ring_api: Incomplete
+    first_call: bool
+    def __init__(self, hass: HomeAssistant, ring_api: Ring) -> None: ...
+    async def _async_update_data(self) -> RingDevices: ...
+
+class RingNotificationsCoordinator(DataUpdateCoordinator[None]):
+    ring_api: Incomplete
+    def __init__(self, hass: HomeAssistant, ring_api: Ring) -> None: ...
+    async def _async_update_data(self) -> None: ...

homeassistant-stubs/components/ring/diagnostics.pyi

@@ -0,0 +1,11 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from _typeshed import Incomplete
+from homeassistant.components.diagnostics import async_redact_data as async_redact_data
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.core import HomeAssistant as HomeAssistant
+from typing import Any
+
+TO_REDACT: Incomplete
+
+async def async_get_config_entry_diagnostics(hass: HomeAssistant, entry: ConfigEntry) -> dict[str, Any]: ...

homeassistant-stubs/components/ring/entity.pyi

@@ -0,0 +1,33 @@
+from .const import ATTRIBUTION as ATTRIBUTION, DOMAIN as DOMAIN
+from .coordinator import RingDataCoordinator as RingDataCoordinator, RingNotificationsCoordinator as RingNotificationsCoordinator
+from _typeshed import Incomplete
+from collections.abc import Callable as Callable
+from homeassistant.core import callback as callback
+from homeassistant.exceptions import HomeAssistantError as HomeAssistantError
+from homeassistant.helpers.device_registry import DeviceInfo as DeviceInfo
+from homeassistant.helpers.update_coordinator import CoordinatorEntity as CoordinatorEntity
+from ring_doorbell import RingDevices as RingDevices, RingGeneric
+from typing import Concatenate, Generic, ParamSpec
+from typing_extensions import TypeVar
+
+RingDeviceT = TypeVar('RingDeviceT', bound=RingGeneric, default=RingGeneric)
+_RingCoordinatorT = TypeVar('_RingCoordinatorT', bound=RingDataCoordinator | RingNotificationsCoordinator)
+_RingBaseEntityT = TypeVar('_RingBaseEntityT', bound='RingBaseEntity[Any, Any]')
+_R = TypeVar('_R')
+_P = ParamSpec('_P')
+
+def exception_wrap(func: Callable[Concatenate[_RingBaseEntityT, _P], _R]) -> Callable[Concatenate[_RingBaseEntityT, _P], _R]: ...
+
+class RingBaseEntity(CoordinatorEntity[_RingCoordinatorT], Generic[_RingCoordinatorT, RingDeviceT]):
+    _attr_attribution = ATTRIBUTION
+    _attr_should_poll: bool
+    _attr_has_entity_name: bool
+    _device: Incomplete
+    _attr_extra_state_attributes: Incomplete
+    _attr_device_info: Incomplete
+    def __init__(self, device: RingDeviceT, coordinator: _RingCoordinatorT) -> None: ...
+
+class RingEntity(RingBaseEntity[RingDataCoordinator, RingDeviceT]):
+    def _get_coordinator_data(self) -> RingDevices: ...
+    _device: Incomplete
+    def _handle_coordinator_update(self) -> None: ...

homeassistant-stubs/components/ring/light.pyi

@@ -0,0 +1,34 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from .coordinator import RingDataCoordinator as RingDataCoordinator
+from .entity import RingEntity as RingEntity, exception_wrap as exception_wrap
+from _typeshed import Incomplete
+from enum import StrEnum
+from homeassistant.components.light import ColorMode as ColorMode, LightEntity as LightEntity
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from ring_doorbell import RingStickUpCam
+from typing import Any
+
+_LOGGER: Incomplete
+SKIP_UPDATES_DELAY: Incomplete
+
+class OnOffState(StrEnum):
+    ON: Incomplete
+    OFF: Incomplete
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None: ...
+
+class RingLight(RingEntity[RingStickUpCam], LightEntity):
+    _attr_color_mode: Incomplete
+    _attr_supported_color_modes: Incomplete
+    _attr_translation_key: str
+    _attr_unique_id: Incomplete
+    _attr_is_on: Incomplete
+    _no_updates_until: Incomplete
+    def __init__(self, device: RingStickUpCam, coordinator: RingDataCoordinator) -> None: ...
+    def _handle_coordinator_update(self) -> None: ...
+    def _set_light(self, new_state: OnOffState) -> None: ...
+    def turn_on(self, **kwargs: Any) -> None: ...
+    def turn_off(self, **kwargs: Any) -> None: ...

homeassistant-stubs/components/ring/sensor.pyi

@@ -0,0 +1,39 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from .coordinator import RingDataCoordinator as RingDataCoordinator
+from .entity import RingDeviceT as RingDeviceT, RingEntity as RingEntity
+from _typeshed import Incomplete
+from collections.abc import Callable as Callable
+from dataclasses import dataclass
+from homeassistant.components.sensor import SensorDeviceClass as SensorDeviceClass, SensorEntity as SensorEntity, SensorEntityDescription as SensorEntityDescription, SensorStateClass as SensorStateClass
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.const import EntityCategory as EntityCategory, PERCENTAGE as PERCENTAGE, SIGNAL_STRENGTH_DECIBELS_MILLIWATT as SIGNAL_STRENGTH_DECIBELS_MILLIWATT
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from homeassistant.helpers.typing import StateType as StateType
+from ring_doorbell import RingEventKind, RingGeneric
+from typing import Any, Generic
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None: ...
+
+class RingSensor(RingEntity[RingDeviceT], SensorEntity):
+    entity_description: RingSensorEntityDescription[RingDeviceT]
+    _attr_unique_id: Incomplete
+    _attr_entity_registry_enabled_default: Incomplete
+    _attr_native_value: Incomplete
+    def __init__(self, device: RingDeviceT, coordinator: RingDataCoordinator, description: RingSensorEntityDescription[RingDeviceT]) -> None: ...
+    _device: Incomplete
+    _attr_extra_state_attributes: Incomplete
+    def _handle_coordinator_update(self) -> None: ...
+
+def _get_last_event(history_data: list[dict[str, Any]], kind: RingEventKind | None) -> dict[str, Any] | None: ...
+def _get_last_event_attrs(history_data: list[dict[str, Any]], kind: RingEventKind | None) -> dict[str, Any] | None: ...
+
+@dataclass(frozen=True, kw_only=True)
+class RingSensorEntityDescription(SensorEntityDescription, Generic[RingDeviceT]):
+    value_fn: Callable[[RingDeviceT], StateType] = ...
+    exists_fn: Callable[[RingGeneric], bool] = ...
+    extra_state_attributes_fn: Callable[[RingDeviceT], dict[str, Any] | None] = ...
+    def __init__(self, *, key, device_class, entity_category, entity_registry_enabled_default, entity_registry_visible_default, force_update, icon, has_entity_name, name, translation_key, translation_placeholders, unit_of_measurement, last_reset, native_unit_of_measurement, options, state_class, suggested_display_precision, suggested_unit_of_measurement, value_fn, exists_fn, extra_state_attributes_fn) -> None: ...
+
+SENSOR_TYPES: tuple[RingSensorEntityDescription[Any], ...]

homeassistant-stubs/components/ring/siren.pyi

@@ -0,0 +1,23 @@
+from . import RingData as RingData
+from .const import DOMAIN as DOMAIN
+from .coordinator import RingDataCoordinator as RingDataCoordinator
+from .entity import RingEntity as RingEntity, exception_wrap as exception_wrap
+from _typeshed import Incomplete
+from homeassistant.components.siren import ATTR_TONE as ATTR_TONE, SirenEntity as SirenEntity, SirenEntityFeature as SirenEntityFeature
+from homeassistant.config_entries import ConfigEntry as ConfigEntry
+from homeassistant.core import HomeAssistant as HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from ring_doorbell import RingChime
+from typing import Any
+
+_LOGGER: Incomplete
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None: ...
+
+class RingChimeSiren(RingEntity[RingChime], SirenEntity):
+    _attr_available_tones: Incomplete
+    _attr_supported_features: Incomplete
+    _attr_translation_key: str
+    _attr_unique_id: Incomplete
+    def __init__(self, device: RingChime, coordinator: RingDataCoordinator) -> None: ...
+    def turn_on(self, **kwargs: Any) -> None: ...