Data API — Docks
dock_by_id
sync(dock_id: UUID, client: AuthenticatedClient | Client) -> DockDetailResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
dock_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: DockDetailResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
dock_cart
sync(dock_id: UUID, cart_id: UUID, client: AuthenticatedClient | Client) -> DockDetailResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
dock_id | UUID | required |
cart_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: DockDetailResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
dock_list
sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, cellario_system_id: UUID | Unset = UNSET, location_id: UUID | Unset = UNSET, is_occupied: bool | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[DockResponse] | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
name | str | Unset | UNSET |
cellario_system_id | UUID | Unset | UNSET |
location_id | UUID | Unset | UNSET |
is_occupied | bool | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[DockResponse] | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
dock_resource
sync(dock_id: UUID, resource_id: UUID, client: AuthenticatedClient | Client) -> DockDetailResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
dock_id | UUID | required |
resource_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: DockDetailResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
dock_update
sync(dock_id: UUID, client: AuthenticatedClient | Client, body: UpdateDockRequest | Unset = UNSET) -> DockResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
dock_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | UpdateDockRequest | Unset | UNSET |
- body — Request model for updating a dock's name and location
Returns: DockResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
undock_cart
sync(dock_id: UUID, cart_id: UUID, client: AuthenticatedClient | Client) -> DockDetailResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
dock_id | UUID | required |
cart_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: DockDetailResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
undock_resource
sync(dock_id: UUID, resource_id: UUID, client: AuthenticatedClient | Client) -> DockDetailResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
dock_id | UUID | required |
resource_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: DockDetailResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |