Skip to content

Task

qgendapy.resources.task

TaskResource(client)

Bases: BaseResource

Synchronous task endpoints.

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

list(*, odata=None)

Source code in src/qgendapy/resources/task.py 
16
17
18
def list(self, *, odata: OData | None = None) -> QGendaResponse[Task]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    return self._get("/task", params=params, model=Task, odata=odata)

create(*, data)

Source code in src/qgendapy/resources/task.py 
20
21
def create(self, *, data: dict) -> QGendaResponse[Task]:
    return self._post("/task", json=data, model=Task)

update(*, data)

Source code in src/qgendapy/resources/task.py 
23
24
def update(self, *, data: dict) -> QGendaResponse[Task]:
    return self._put("/task", json=data, model=Task)

locations(task_key)

Source code in src/qgendapy/resources/task.py 
26
27
def locations(self, task_key: str) -> QGendaResponse:
    return self._get(f"/task/{task_key}/location")

tags(task_key)

Source code in src/qgendapy/resources/task.py 
29
30
def tags(self, task_key: str) -> QGendaResponse:
    return self._get(f"/task/{task_key}/tag")

add_tag(task_key, *, data)

Source code in src/qgendapy/resources/task.py 
32
33
def add_tag(self, task_key: str, *, data: dict) -> QGendaResponse:
    return self._post(f"/task/{task_key}/tag", json=data)

shifts(task_key)

Source code in src/qgendapy/resources/task.py 
35
36
def shifts(self, task_key: str) -> QGendaResponse[TaskShift]:
    return self._get(f"/task/{task_key}/taskshift", model=TaskShift)

create_shift(task_key, *, data)

Source code in src/qgendapy/resources/task.py 
38
39
def create_shift(self, task_key: str, *, data: dict) -> QGendaResponse[TaskShift]:
    return self._post(f"/task/{task_key}/taskshift", json=data, model=TaskShift)

update_shift(task_key, shift_key, *, data)

Source code in src/qgendapy/resources/task.py 
41
42
43
44
def update_shift(
    self, task_key: str, shift_key: str, *, data: dict
) -> QGendaResponse[TaskShift]:
    return self._put(f"/task/{task_key}/taskshift/{shift_key}", json=data, model=TaskShift)

delete_shift(task_key, shift_key)

Source code in src/qgendapy/resources/task.py 
46
47
def delete_shift(self, task_key: str, shift_key: str) -> QGendaResponse:
    return self._delete(f"/task/{task_key}/taskshift/{shift_key}")

AsyncTaskResource(client)

Bases: AsyncBaseResource

Asynchronous task endpoints.

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

list(*, odata=None) async

Source code in src/qgendapy/resources/task.py 
53
54
55
async def list(self, *, odata: OData | None = None) -> QGendaResponse[Task]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    return await self._get("/task", params=params, model=Task, odata=odata)

create(*, data) async

Source code in src/qgendapy/resources/task.py 
57
58
async def create(self, *, data: dict) -> QGendaResponse[Task]:
    return await self._post("/task", json=data, model=Task)

update(*, data) async

Source code in src/qgendapy/resources/task.py 
60
61
async def update(self, *, data: dict) -> QGendaResponse[Task]:
    return await self._put("/task", json=data, model=Task)

locations(task_key) async

Source code in src/qgendapy/resources/task.py 
63
64
async def locations(self, task_key: str) -> QGendaResponse:
    return await self._get(f"/task/{task_key}/location")

tags(task_key) async

Source code in src/qgendapy/resources/task.py 
66
67
async def tags(self, task_key: str) -> QGendaResponse:
    return await self._get(f"/task/{task_key}/tag")

add_tag(task_key, *, data) async

Source code in src/qgendapy/resources/task.py 
69
70
async def add_tag(self, task_key: str, *, data: dict) -> QGendaResponse:
    return await self._post(f"/task/{task_key}/tag", json=data)

shifts(task_key) async

Source code in src/qgendapy/resources/task.py 
72
73
async def shifts(self, task_key: str) -> QGendaResponse[TaskShift]:
    return await self._get(f"/task/{task_key}/taskshift", model=TaskShift)

create_shift(task_key, *, data) async

Source code in src/qgendapy/resources/task.py 
75
76
async def create_shift(self, task_key: str, *, data: dict) -> QGendaResponse[TaskShift]:
    return await self._post(f"/task/{task_key}/taskshift", json=data, model=TaskShift)

update_shift(task_key, shift_key, *, data) async

Source code in src/qgendapy/resources/task.py 
78
79
80
81
82
83
async def update_shift(
    self, task_key: str, shift_key: str, *, data: dict
) -> QGendaResponse[TaskShift]:
    return await self._put(
        f"/task/{task_key}/taskshift/{shift_key}", json=data, model=TaskShift
    )

delete_shift(task_key, shift_key) async

Source code in src/qgendapy/resources/task.py 
85
86
async def delete_shift(self, task_key: str, shift_key: str) -> QGendaResponse:
    return await self._delete(f"/task/{task_key}/taskshift/{shift_key}")