facility_adapter.py

from abc import ABC, abstractmethod
from . import models as facility_models


class FacilityAdapter(ABC):
    """
    Facility-specific code is handled by the implementation of this interface.
    Use the `IRI_API_ADAPTER_<domain>` environment variable to install your
    facility adapter before the API starts.
    """

    @abstractmethod
    async def get_facility(self: "FacilityAdapter", modified_since: str | None = None) -> facility_models.Facility | None:
        pass

    @abstractmethod
    async def list_sites(
        self: "FacilityAdapter", modified_since: str | None = None, name: str | None = None, offset: int | None = None, limit: int | None = None, short_name: str | None = None
    ) -> list[facility_models.Site]:
        pass

    @abstractmethod
    async def get_site(
        self: "FacilityAdapter",
        site_id: str,
        modified_since: str | None = None,
    ) -> facility_models.Site | None:
        pass