AnnouncementsNamespace

pymoonraker.api.AnnouncementsNamespace

Moonraker announcement system.

Auto-generated from schema/moonraker_api.yaml.

Source code in src/pymoonraker/api/_generated.py

class AnnouncementsNamespace:
    """Moonraker announcement system.

    Auto-generated from schema/moonraker_api.yaml.
    """

    def __init__(self, client: MoonrakerClient) -> None:
        self._client = client

    async def list(self, include_dismissed: bool | None = None) -> AnnouncementsListResponse:
        """List current announcements.

        Args:
            include_dismissed: Include dismissed announcements

        """
        params: dict[str, Any] = {}
        if include_dismissed is not None:
            params["include_dismissed"] = include_dismissed
        raw = await self._client.call("server.announcements.list", params)
        return AnnouncementsListResponse.model_validate(raw)

    async def dismiss(self, entry_id: str) -> AnnouncementDismissResponse:
        """Dismiss an announcement.

        Args:
            entry_id: Announcement entry ID

        """
        params: dict[str, Any] = {}
        params["entry_id"] = entry_id
        raw = await self._client.call("server.announcements.dismiss", params)
        return AnnouncementDismissResponse.model_validate(raw)

dismiss async

dismiss(entry_id: str) -> AnnouncementDismissResponse

Dismiss an announcement.

Parameters:

Name	Type	Description	Default
entry_id	str	Announcement entry ID	required

Source code in src/pymoonraker/api/_generated.py

async def dismiss(self, entry_id: str) -> AnnouncementDismissResponse:
    """Dismiss an announcement.

    Args:
        entry_id: Announcement entry ID

    """
    params: dict[str, Any] = {}
    params["entry_id"] = entry_id
    raw = await self._client.call("server.announcements.dismiss", params)
    return AnnouncementDismissResponse.model_validate(raw)

list async

list(include_dismissed: bool | None = None) -> AnnouncementsListResponse

List current announcements.

Parameters:

Name	Type	Description	Default
include_dismissed	bool | None	Include dismissed announcements	None

Source code in src/pymoonraker/api/_generated.py

async def list(self, include_dismissed: bool | None = None) -> AnnouncementsListResponse:
    """List current announcements.

    Args:
        include_dismissed: Include dismissed announcements

    """
    params: dict[str, Any] = {}
    if include_dismissed is not None:
        params["include_dismissed"] = include_dismissed
    raw = await self._client.call("server.announcements.list", params)
    return AnnouncementsListResponse.model_validate(raw)