Data API — Calendar

20 min

calendar_availability_for_participants

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

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

body — Filter model for querying calendar availability for specific participants

Returns: AvailabilityResponse | 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.

calendar_availability_window

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

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

body — Request for a point-in-time availability snapshot for a set of participants across a time window. Feeds the Schedule Order drawer's valid-start-times precomputation (client-side) and the Schedule Anyway conflict disclosure. Distinct from Cellario.Cloud.Data.Api.Models.Calendar.CalendarAvailabilityParticipantsFilterApiModel, which targets the pre-calendaring availability surface (systems, flex-carts, work orders). This shape is purpose-built for the workflow-calendaring placement service: it returns a CalendarAvailabilitySnapshot with both hard commitments and pool claims intersecting the window.

Returns: CalendarAvailabilitySnapshot | 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.

calendar_current_commitments

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

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

body — Filter model for querying current commitments for specific participants. Including participant type allows the service to optimize queries by only checking relevant entity tables.

Returns: CurrentCommitmentsResponse | 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.

calendar_entries

sync(client: AuthenticatedClient | Client, start: datetime.datetime | Unset = UNSET, end: datetime.datetime | Unset = UNSET, include_released: bool | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[CalendarEntryResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
start	datetime.datetime \| Unset	UNSET
end	datetime.datetime \| Unset	UNSET
include_released	bool \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[CalendarEntryResponse] | 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.

calendar_participants

sync(client: AuthenticatedClient | Client, participant_ids: list[UUID] | Unset = UNSET, ids: list[UUID] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ParticipantResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
participant_ids	list[UUID] \| Unset	UNSET
ids	list[UUID] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[ParticipantResponse] | 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.

calendar_plan_template

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

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

Returns: ProblemDetails | WorkflowPlanTemplate | 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.

calendar_release

sync(calendar_entry_id: UUID, client: AuthenticatedClient | Client, body: ReleaseCalendarEntryRequest | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
calendar_entry_id	UUID	required
client	AuthenticatedClient \| Client	required
body	ReleaseCalendarEntryRequest \| Unset	UNSET

body — Request to release a scheduled workflow order. The parent and every child entry have their Release JSONB populated (with the current user id and the supplied Cellario.Cloud.Data.Api.Models.Calendar.ReleaseCalendarEntryRequest.Reason); the associated Commitment rows are deleted so the freed participant windows become available again. Released rows remain in the table for audit.

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.

calendar_reschedule

sync(calendar_entry_id: UUID, client: AuthenticatedClient | Client, body: RescheduleCalendarEntryRequest | Unset = UNSET) -> PlacementResult | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
calendar_entry_id	UUID	required
client	AuthenticatedClient \| Client	required
body	RescheduleCalendarEntryRequest \| Unset	UNSET

body — Request to move a previously-placed workflow order to a new start time. Semantically equivalent to releasing the current parent+children (reason: "Rescheduled") and re-running the schedule flow at Cellario.Cloud.Data.Api.Models.Calendar.RescheduleCalendarEntryRequest.PlannedStart. The released rows remain for audit.

Returns: PlacementResult | 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.

calendar_schedule_workflow_order

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

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

body — Request to place a workflow order on the calendar at a specific start time. Triggers the plan builder to emit a WorkflowPlanTemplate, translates its step offsets against Cellario.Cloud.Data.Api.Models.Calendar.ScheduleWorkflowOrderRequest.PlannedStart, checks availability, and writes the parent/child CalendarEntry rows plus their Commitments in a single transaction.

Returns: PlacementResult | 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.

post_v_1_calendar_availability_work_order_order_id

sync(order_id: UUID, client: AuthenticatedClient | Client, body: CalendarAvailabilityOrderFilterApiModel | Unset = UNSET) -> AvailabilityResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
order_id	UUID	required
client	AuthenticatedClient \| Client	required
body	CalendarAvailabilityOrderFilterApiModel \| Unset	UNSET

body — A set of reductive refinements that can be applied when searching for a time slot that is available for the work order

Returns: AvailabilityResponse | 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.