Data API — Time Reservation

12 min

time_reservation_by_id

sync(time_reservation_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Parameter	Type	Default
time_reservation_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

time_reservation_create

sync(client: AuthenticatedClient | Client, body: CreateTimeReservationRequest | Unset = UNSET) -> ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateTimeReservationRequest \| Unset	UNSET

body — Information used to create a new time reservation activity

Returns: ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

time_reservation_delete

sync(time_reservation_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
time_reservation_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

time_reservation_list

sync(client: AuthenticatedClient | Client, include: list[TimeReservationInclude] | Unset = UNSET, organization_id: UUID | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, last_modified_by_user_id: UUID | Unset = UNSET, name: str | Unset = UNSET, description: str | Unset = UNSET, thumbnail_ref: str | Unset = UNSET, image_ref: str | Unset = UNSET, version: int | Unset = UNSET, is_requestable: bool | Unset = UNSET, date_created: datetime.datetime | Unset = UNSET, date_last_modified: datetime.datetime | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[TimeReservationListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
include	list[TimeReservationInclude] \| Unset	UNSET
organization_id	UUID \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
last_modified_by_user_id	UUID \| Unset	UNSET
name	str \| Unset	UNSET
description	str \| Unset	UNSET
thumbnail_ref	str \| Unset	UNSET
image_ref	str \| Unset	UNSET
version	int \| Unset	UNSET
is_requestable	bool \| Unset	UNSET
date_created	datetime.datetime \| Unset	UNSET
date_last_modified	datetime.datetime \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[TimeReservationListItemResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

time_reservation_patch

sync(time_reservation_id: UUID, client: AuthenticatedClient | Client, body: PatchTimeReservationRequest | Unset = UNSET) -> ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Parameter	Type	Default
time_reservation_id	UUID	required
client	AuthenticatedClient \| Client	required
body	PatchTimeReservationRequest \| Unset	UNSET

body — Information used to patch a time reservation activity

Returns: ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

time_reservation_update

sync(time_reservation_id: UUID, client: AuthenticatedClient | Client, body: UpdateTimeReservationRequest | Unset = UNSET) -> ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Parameter	Type	Default
time_reservation_id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateTimeReservationRequest \| Unset	UNSET

body — Information used to update a time reservation activity

Returns: ProblemDetails | TimeReservationResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.