Skip to content

Notification

qgendapy.resources.notification

NotificationResource(client)

Bases: BaseResource

Synchronous notification list endpoints.

Source code in src/qgendapy/resources/_base.py
def __init__(self, client: QGendaClient) -> None:
    self._client = client

list(*, odata=None)

Source code in src/qgendapy/resources/notification.py
def list(self, *, odata: OData | None = None) -> QGendaResponse:
    return self._get("/notificationlist", odata=odata)

create(*, data)

Source code in src/qgendapy/resources/notification.py
def create(self, *, data: dict) -> QGendaResponse:
    return self._post("/notificationlist", json=data)

get(notification_list_key, *, odata=None)

Source code in src/qgendapy/resources/notification.py
def get(self, notification_list_key: str, *, odata: OData | None = None) -> QGendaResponse:
    return self._get(f"/notificationlist/{notification_list_key}", odata=odata)

update(notification_list_key, *, data)

Source code in src/qgendapy/resources/notification.py
def update(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/notificationlist/{notification_list_key}", json=data)

delete(notification_list_key)

Source code in src/qgendapy/resources/notification.py
def delete(self, notification_list_key: str) -> QGendaResponse:
    return self._delete(f"/notificationlist/{notification_list_key}")

contacts(notification_list_key)

Source code in src/qgendapy/resources/notification.py
def contacts(self, notification_list_key: str) -> QGendaResponse:
    return self._get(f"/notificationlist/{notification_list_key}/contact")

add_contact(notification_list_key, *, data)

Source code in src/qgendapy/resources/notification.py
def add_contact(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return self._post(f"/notificationlist/{notification_list_key}/contact", json=data)

update_contact(notification_list_key, *, data)

Source code in src/qgendapy/resources/notification.py
def update_contact(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/notificationlist/{notification_list_key}/contact", json=data)

remove_contact(notification_list_key, *, data)

Source code in src/qgendapy/resources/notification.py
def remove_contact(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return self._delete(f"/notificationlist/{notification_list_key}/contact", json=data)

AsyncNotificationResource(client)

Bases: AsyncBaseResource

Asynchronous notification list endpoints.

Source code in src/qgendapy/resources/_base.py
def __init__(self, client: AsyncQGendaClient) -> None:
    self._client = client

list(*, odata=None) async

Source code in src/qgendapy/resources/notification.py
async def list(self, *, odata: OData | None = None) -> QGendaResponse:
    return await self._get("/notificationlist", odata=odata)

create(*, data) async

Source code in src/qgendapy/resources/notification.py
async def create(self, *, data: dict) -> QGendaResponse:
    return await self._post("/notificationlist", json=data)

get(notification_list_key, *, odata=None) async

Source code in src/qgendapy/resources/notification.py
async def get(
    self, notification_list_key: str, *, odata: OData | None = None
) -> QGendaResponse:
    return await self._get(f"/notificationlist/{notification_list_key}", odata=odata)

update(notification_list_key, *, data) async

Source code in src/qgendapy/resources/notification.py
async def update(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return await self._put(f"/notificationlist/{notification_list_key}", json=data)

delete(notification_list_key) async

Source code in src/qgendapy/resources/notification.py
async def delete(self, notification_list_key: str) -> QGendaResponse:
    return await self._delete(f"/notificationlist/{notification_list_key}")

contacts(notification_list_key) async

Source code in src/qgendapy/resources/notification.py
async def contacts(self, notification_list_key: str) -> QGendaResponse:
    return await self._get(f"/notificationlist/{notification_list_key}/contact")

add_contact(notification_list_key, *, data) async

Source code in src/qgendapy/resources/notification.py
async def add_contact(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return await self._post(f"/notificationlist/{notification_list_key}/contact", json=data)

update_contact(notification_list_key, *, data) async

Source code in src/qgendapy/resources/notification.py
async def update_contact(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return await self._put(f"/notificationlist/{notification_list_key}/contact", json=data)

remove_contact(notification_list_key, *, data) async

Source code in src/qgendapy/resources/notification.py
async def remove_contact(self, notification_list_key: str, *, data: dict) -> QGendaResponse:
    return await self._delete(f"/notificationlist/{notification_list_key}/contact", json=data)