Skip to content

Time Event

qgendapy.resources.time_event

TimeEventResource(client)

Bases: BaseResource

Synchronous time event endpoints.

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

list(*, start_date, end_date=None, odata=None)

Source code in src/qgendapy/resources/time_event.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def list(
    self,
    *,
    start_date: str,
    end_date: str | None = None,
    odata: OData | None = None,
) -> QGendaResponse[TimeEvent]:
    params: dict[str, str] = {
        "startDate": start_date,
        "companyKey": self._client.company_key,
    }
    if end_date:
        params["endDate"] = end_date
    return self._get("/timeevent", params=params, model=TimeEvent, odata=odata)

create(*, data)

Source code in src/qgendapy/resources/time_event.py 
31
32
def create(self, *, data: dict) -> QGendaResponse[TimeEvent]:
    return self._post("/timeevent", json=data, model=TimeEvent)

update(time_event_key, *, data)

Source code in src/qgendapy/resources/time_event.py 
34
35
def update(self, time_event_key: str, *, data: dict) -> QGendaResponse[TimeEvent]:
    return self._put(f"/timeevent/{time_event_key}", json=data, model=TimeEvent)

delete(time_event_key)

Source code in src/qgendapy/resources/time_event.py 
37
38
def delete(self, time_event_key: str) -> QGendaResponse:
    return self._delete(f"/timeevent/{time_event_key}")

AsyncTimeEventResource(client)

Bases: AsyncBaseResource

Asynchronous time event endpoints.

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

list(*, start_date, end_date=None, odata=None) async

Source code in src/qgendapy/resources/time_event.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
async def list(
    self,
    *,
    start_date: str,
    end_date: str | None = None,
    odata: OData | None = None,
) -> QGendaResponse[TimeEvent]:
    params: dict[str, str] = {
        "startDate": start_date,
        "companyKey": self._client.company_key,
    }
    if end_date:
        params["endDate"] = end_date
    return await self._get("/timeevent", params=params, model=TimeEvent, odata=odata)

create(*, data) async

Source code in src/qgendapy/resources/time_event.py 
59
60
async def create(self, *, data: dict) -> QGendaResponse[TimeEvent]:
    return await self._post("/timeevent", json=data, model=TimeEvent)

update(time_event_key, *, data) async

Source code in src/qgendapy/resources/time_event.py 
62
63
async def update(self, time_event_key: str, *, data: dict) -> QGendaResponse[TimeEvent]:
    return await self._put(f"/timeevent/{time_event_key}", json=data, model=TimeEvent)

delete(time_event_key) async

Source code in src/qgendapy/resources/time_event.py 
65
66
async def delete(self, time_event_key: str) -> QGendaResponse:
    return await self._delete(f"/timeevent/{time_event_key}")