Skip to content

Facility

qgendapy.resources.facility

FacilityResource(client)

Bases: BaseResource

Synchronous facility / location 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/facility.py 
16
17
18
def list(self, *, odata: OData | None = None) -> QGendaResponse[Facility]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    return self._get("/location", params=params, model=Facility, odata=odata)

create(*, data)

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

get(location_key, *, odata=None)

Source code in src/qgendapy/resources/facility.py 
23
24
def get(self, location_key: str, *, odata: OData | None = None) -> QGendaResponse[Facility]:
    return self._get(f"/location/{location_key}", model=Facility, odata=odata)

update(location_key, *, data)

Source code in src/qgendapy/resources/facility.py 
26
27
def update(self, location_key: str, *, data: dict) -> QGendaResponse[Facility]:
    return self._put(f"/location/{location_key}", json=data, model=Facility)

delete(location_key)

Source code in src/qgendapy/resources/facility.py 
29
30
def delete(self, location_key: str) -> QGendaResponse:
    return self._delete(f"/location/{location_key}")

staff(location_key)

Source code in src/qgendapy/resources/facility.py 
32
33
def staff(self, location_key: str) -> QGendaResponse:
    return self._get(f"/location/{location_key}/staff")

add_staff(location_key, *, data)

Source code in src/qgendapy/resources/facility.py 
35
36
def add_staff(self, location_key: str, *, data: dict) -> QGendaResponse:
    return self._post(f"/location/{location_key}/staff", json=data)

update_staff(location_key, staff_key, *, data)

Source code in src/qgendapy/resources/facility.py 
38
39
def update_staff(self, location_key: str, staff_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/location/{location_key}/staff/{staff_key}", json=data)

remove_staff(location_key, staff_key)

Source code in src/qgendapy/resources/facility.py 
41
42
def remove_staff(self, location_key: str, staff_key: str) -> QGendaResponse:
    return self._delete(f"/location/{location_key}/staff/{staff_key}")

staff_credentials(location_key, staff_key)

Source code in src/qgendapy/resources/facility.py 
44
45
def staff_credentials(self, location_key: str, staff_key: str) -> QGendaResponse:
    return self._get(f"/location/{location_key}/staff/{staff_key}/credential")

staff_fte(location_key, staff_key)

Source code in src/qgendapy/resources/facility.py 
47
48
def staff_fte(self, location_key: str, staff_key: str) -> QGendaResponse:
    return self._get(f"/location/{location_key}/staff/{staff_key}/FTE")

update_staff_fte(location_key, staff_key, *, data)

Source code in src/qgendapy/resources/facility.py 
50
51
def update_staff_fte(self, location_key: str, staff_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/location/{location_key}/staff/{staff_key}/FTE", json=data)

staff_tags(location_key, staff_key)

Source code in src/qgendapy/resources/facility.py 
53
54
def staff_tags(self, location_key: str, staff_key: str) -> QGendaResponse:
    return self._get(f"/location/{location_key}/staff/{staff_key}/tag")

update_staff_tag(location_key, staff_key, *, data)

Source code in src/qgendapy/resources/facility.py 
56
57
def update_staff_tag(self, location_key: str, staff_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/location/{location_key}/staff/{staff_key}/tag", json=data)

tags(location_key)

Source code in src/qgendapy/resources/facility.py 
59
60
def tags(self, location_key: str) -> QGendaResponse:
    return self._get(f"/location/{location_key}/tag")

update_tag(location_key, *, data)

Source code in src/qgendapy/resources/facility.py 
62
63
def update_tag(self, location_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/location/{location_key}/tag", json=data)

tasks(location_key)

Source code in src/qgendapy/resources/facility.py 
65
66
def tasks(self, location_key: str) -> QGendaResponse:
    return self._get(f"/location/{location_key}/tasks")

add_task(location_key, *, data)

Source code in src/qgendapy/resources/facility.py 
68
69
def add_task(self, location_key: str, *, data: dict) -> QGendaResponse:
    return self._post(f"/location/{location_key}/task", json=data)

update_task(location_key, task_key, *, data)

Source code in src/qgendapy/resources/facility.py 
71
72
def update_task(self, location_key: str, task_key: str, *, data: dict) -> QGendaResponse:
    return self._put(f"/location/{location_key}/task/{task_key}", json=data)

remove_task(location_key, task_key)

Source code in src/qgendapy/resources/facility.py 
74
75
def remove_task(self, location_key: str, task_key: str) -> QGendaResponse:
    return self._delete(f"/location/{location_key}/task/{task_key}")

AsyncFacilityResource(client)

Bases: AsyncBaseResource

Asynchronous facility / location 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/facility.py 
81
82
83
async def list(self, *, odata: OData | None = None) -> QGendaResponse[Facility]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    return await self._get("/location", params=params, model=Facility, odata=odata)

create(*, data) async

Source code in src/qgendapy/resources/facility.py 
85
86
async def create(self, *, data: dict) -> QGendaResponse[Facility]:
    return await self._post("/location", json=data, model=Facility)

get(location_key, *, odata=None) async

Source code in src/qgendapy/resources/facility.py 
88
89
90
91
async def get(
    self, location_key: str, *, odata: OData | None = None
) -> QGendaResponse[Facility]:
    return await self._get(f"/location/{location_key}", model=Facility, odata=odata)

update(location_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
93
94
async def update(self, location_key: str, *, data: dict) -> QGendaResponse[Facility]:
    return await self._put(f"/location/{location_key}", json=data, model=Facility)

delete(location_key) async

Source code in src/qgendapy/resources/facility.py 
96
97
async def delete(self, location_key: str) -> QGendaResponse:
    return await self._delete(f"/location/{location_key}")

staff(location_key) async

Source code in src/qgendapy/resources/facility.py 
 99
100
async def staff(self, location_key: str) -> QGendaResponse:
    return await self._get(f"/location/{location_key}/staff")

add_staff(location_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
102
103
async def add_staff(self, location_key: str, *, data: dict) -> QGendaResponse:
    return await self._post(f"/location/{location_key}/staff", json=data)

update_staff(location_key, staff_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
105
106
107
108
async def update_staff(
    self, location_key: str, staff_key: str, *, data: dict
) -> QGendaResponse:
    return await self._put(f"/location/{location_key}/staff/{staff_key}", json=data)

remove_staff(location_key, staff_key) async

Source code in src/qgendapy/resources/facility.py 
110
111
async def remove_staff(self, location_key: str, staff_key: str) -> QGendaResponse:
    return await self._delete(f"/location/{location_key}/staff/{staff_key}")

staff_credentials(location_key, staff_key) async

Source code in src/qgendapy/resources/facility.py 
113
114
async def staff_credentials(self, location_key: str, staff_key: str) -> QGendaResponse:
    return await self._get(f"/location/{location_key}/staff/{staff_key}/credential")

staff_fte(location_key, staff_key) async

Source code in src/qgendapy/resources/facility.py 
116
117
async def staff_fte(self, location_key: str, staff_key: str) -> QGendaResponse:
    return await self._get(f"/location/{location_key}/staff/{staff_key}/FTE")

update_staff_fte(location_key, staff_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
119
120
121
122
async def update_staff_fte(
    self, location_key: str, staff_key: str, *, data: dict
) -> QGendaResponse:
    return await self._put(f"/location/{location_key}/staff/{staff_key}/FTE", json=data)

staff_tags(location_key, staff_key) async

Source code in src/qgendapy/resources/facility.py 
124
125
async def staff_tags(self, location_key: str, staff_key: str) -> QGendaResponse:
    return await self._get(f"/location/{location_key}/staff/{staff_key}/tag")

update_staff_tag(location_key, staff_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
127
128
129
130
async def update_staff_tag(
    self, location_key: str, staff_key: str, *, data: dict
) -> QGendaResponse:
    return await self._put(f"/location/{location_key}/staff/{staff_key}/tag", json=data)

tags(location_key) async

Source code in src/qgendapy/resources/facility.py 
132
133
async def tags(self, location_key: str) -> QGendaResponse:
    return await self._get(f"/location/{location_key}/tag")

update_tag(location_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
135
136
async def update_tag(self, location_key: str, *, data: dict) -> QGendaResponse:
    return await self._put(f"/location/{location_key}/tag", json=data)

tasks(location_key) async

Source code in src/qgendapy/resources/facility.py 
138
139
async def tasks(self, location_key: str) -> QGendaResponse:
    return await self._get(f"/location/{location_key}/tasks")

add_task(location_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
141
142
async def add_task(self, location_key: str, *, data: dict) -> QGendaResponse:
    return await self._post(f"/location/{location_key}/task", json=data)

update_task(location_key, task_key, *, data) async

Source code in src/qgendapy/resources/facility.py 
144
145
async def update_task(self, location_key: str, task_key: str, *, data: dict) -> QGendaResponse:
    return await self._put(f"/location/{location_key}/task/{task_key}", json=data)

remove_task(location_key, task_key) async

Source code in src/qgendapy/resources/facility.py 
147
148
async def remove_task(self, location_key: str, task_key: str) -> QGendaResponse:
    return await self._delete(f"/location/{location_key}/task/{task_key}")