Skip to content

Schedule

qgendapy.resources.schedule

ScheduleResource(client)

Bases: BaseResource

Synchronous schedule 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, includes=None, odata=None, expand=None)

Source code in src/qgendapy/resources/schedule.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def list(
    self,
    *,
    start_date: str,
    end_date: str | None = None,
    includes: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[ScheduleEntry]:
    if end_date and _date_chunks(start_date, end_date) != [(start_date, end_date)]:
        return self._chunked_list(
            start_date=start_date,
            end_date=end_date,
            includes=includes,
            odata=odata,
            expand=expand,
        )
    params: dict[str, str] = {
        "startDate": start_date,
        "companyKey": self._client.company_key,
    }
    if end_date:
        params["endDate"] = end_date
    if includes:
        params["includes"] = includes
    return self._get(
        "/schedule",
        params=params,
        model=ScheduleEntry,
        odata=merge_expand(expand, odata),
    )

audit_log(*, schedule_start_date=None, schedule_end_date=None, since_modified_timestamp=None, odata=None, expand=None)

Source code in src/qgendapy/resources/schedule.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def audit_log(
    self,
    *,
    schedule_start_date: str | None = None,
    schedule_end_date: str | None = None,
    since_modified_timestamp: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[AuditLogEntry]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    if schedule_start_date:
        params["scheduleStartDate"] = schedule_start_date
    if schedule_end_date:
        params["scheduleEndDate"] = schedule_end_date
    if since_modified_timestamp:
        params["sinceModifiedTimestamp"] = since_modified_timestamp
    return self._get(
        "/schedule/auditLog",
        params=params,
        model=AuditLogEntry,
        odata=merge_expand(expand, odata),
    )

open_shifts(*, start_date, end_date=None, includes=None, odata=None, expand=None)

Source code in src/qgendapy/resources/schedule.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def open_shifts(
    self,
    *,
    start_date: str,
    end_date: str | None = None,
    includes: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[OpenShift]:
    if end_date and _date_chunks(start_date, end_date) != [(start_date, end_date)]:
        return self._chunked_open_shifts(
            start_date=start_date,
            end_date=end_date,
            includes=includes,
            odata=odata,
            expand=expand,
        )
    params: dict[str, str] = {
        "startDate": start_date,
        "companyKey": self._client.company_key,
    }
    if end_date:
        params["endDate"] = end_date
    if includes:
        params["includes"] = includes
    return self._get(
        "/schedule/openshifts",
        params=params,
        model=OpenShift,
        odata=merge_expand(expand, odata),
    )

rotations(*, range_start_date=None, range_end_date=None, odata=None, expand=None)

Source code in src/qgendapy/resources/schedule.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def rotations(
    self,
    *,
    range_start_date: str | None = None,
    range_end_date: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[Rotation]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    if range_start_date:
        params["rangeStartDate"] = range_start_date
    if range_end_date:
        params["rangeEndDate"] = range_end_date
    return self._get(
        "/schedule/rotations",
        params=params,
        model=Rotation,
        odata=merge_expand(expand, odata),
    )

AsyncScheduleResource(client)

Bases: AsyncBaseResource

Asynchronous schedule 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, includes=None, odata=None, expand=None) async

Source code in src/qgendapy/resources/schedule.py 
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
async def list(
    self,
    *,
    start_date: str,
    end_date: str | None = None,
    includes: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[ScheduleEntry]:
    if end_date and _date_chunks(start_date, end_date) != [(start_date, end_date)]:
        return await self._chunked_list(
            start_date=start_date,
            end_date=end_date,
            includes=includes,
            odata=odata,
            expand=expand,
        )
    params: dict[str, str] = {
        "startDate": start_date,
        "companyKey": self._client.company_key,
    }
    if end_date:
        params["endDate"] = end_date
    if includes:
        params["includes"] = includes
    return await self._get(
        "/schedule",
        params=params,
        model=ScheduleEntry,
        odata=merge_expand(expand, odata),
    )

audit_log(*, schedule_start_date=None, schedule_end_date=None, since_modified_timestamp=None, odata=None, expand=None) async

Source code in src/qgendapy/resources/schedule.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
async def audit_log(
    self,
    *,
    schedule_start_date: str | None = None,
    schedule_end_date: str | None = None,
    since_modified_timestamp: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[AuditLogEntry]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    if schedule_start_date:
        params["scheduleStartDate"] = schedule_start_date
    if schedule_end_date:
        params["scheduleEndDate"] = schedule_end_date
    if since_modified_timestamp:
        params["sinceModifiedTimestamp"] = since_modified_timestamp
    return await self._get(
        "/schedule/auditLog",
        params=params,
        model=AuditLogEntry,
        odata=merge_expand(expand, odata),
    )

open_shifts(*, start_date, end_date=None, includes=None, odata=None, expand=None) async

Source code in src/qgendapy/resources/schedule.py 
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
async def open_shifts(
    self,
    *,
    start_date: str,
    end_date: str | None = None,
    includes: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[OpenShift]:
    if end_date and _date_chunks(start_date, end_date) != [(start_date, end_date)]:
        return await self._chunked_open_shifts(
            start_date=start_date,
            end_date=end_date,
            includes=includes,
            odata=odata,
            expand=expand,
        )
    params: dict[str, str] = {
        "startDate": start_date,
        "companyKey": self._client.company_key,
    }
    if end_date:
        params["endDate"] = end_date
    if includes:
        params["includes"] = includes
    return await self._get(
        "/schedule/openshifts",
        params=params,
        model=OpenShift,
        odata=merge_expand(expand, odata),
    )

rotations(*, range_start_date=None, range_end_date=None, odata=None, expand=None) async

Source code in src/qgendapy/resources/schedule.py 
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
async def rotations(
    self,
    *,
    range_start_date: str | None = None,
    range_end_date: str | None = None,
    odata: OData | None = None,
    expand: str | Sequence[str] | None = None,
) -> QGendaResponse[Rotation]:
    params: dict[str, str] = {"companyKey": self._client.company_key}
    if range_start_date:
        params["rangeStartDate"] = range_start_date
    if range_end_date:
        params["rangeEndDate"] = range_end_date
    return await self._get(
        "/schedule/rotations",
        params=params,
        model=Rotation,
        odata=merge_expand(expand, odata),
    )