docket-client 0.3.2__py3-none-any.whl

docket/api/scheduled_acquisitions/get_resolved_settings.py

@@ -0,0 +1,169 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.get_resolved_settings_response_200 import GetResolvedSettingsResponse200
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...models.problem_details import ProblemDetails
+from typing import cast
+
+
+def _get_kwargs(
+    id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/scheduled-acquisitions/{id}/resolved-settings".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails | None:
+    if response.status_code == 200:
+        response_200 = GetResolvedSettingsResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = ProblemDetails.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 422:
+        response_422 = HttpValidationProblemDetails.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails]:
+    """The settings a run started now would use, per acquisition type. Read-only.
+
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails | None:
+    """The settings a run started now would use, per acquisition type. Read-only.
+
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails]:
+    """The settings a run started now would use, per acquisition type. Read-only.
+
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails | None:
+    """The settings a run started now would use, per acquisition type. Read-only.
+
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetResolvedSettingsResponse200 | HttpValidationProblemDetails | ProblemDetails
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

docket/api/scheduled_acquisitions/get_scheduled_acquisition.py

@@ -0,0 +1,159 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.problem_details import ProblemDetails
+from ...models.scheduled_acquisition_response import ScheduledAcquisitionResponse
+from typing import cast
+
+
+def _get_kwargs(
+    id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/scheduled-acquisitions/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ProblemDetails | ScheduledAcquisitionResponse | None:
+    if response.status_code == 200:
+        response_200 = ScheduledAcquisitionResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = ProblemDetails.from_dict(response.json())
+
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ProblemDetails | ScheduledAcquisitionResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[ProblemDetails | ScheduledAcquisitionResponse]:
+    """
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ProblemDetails | ScheduledAcquisitionResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> ProblemDetails | ScheduledAcquisitionResponse | None:
+    """
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ProblemDetails | ScheduledAcquisitionResponse
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[ProblemDetails | ScheduledAcquisitionResponse]:
+    """
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ProblemDetails | ScheduledAcquisitionResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> ProblemDetails | ScheduledAcquisitionResponse | None:
+    """
+    Args:
+        id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ProblemDetails | ScheduledAcquisitionResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

docket/api/scheduled_acquisitions/list_active_acquisitions.py

@@ -0,0 +1,297 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...models.list_active_acquisitions_effective_status_item import (
+    ListActiveAcquisitionsEffectiveStatusItem,
+)
+from ...models.scheduled_acquisition_response import ScheduledAcquisitionResponse
+from ...types import UNSET, Unset
+from typing import cast
+import datetime
+
+
+def _get_kwargs(
+    *,
+    at: datetime.datetime | Unset = UNSET,
+    before_minutes: int | None | Unset = UNSET,
+    after_minutes: int | None | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    subject_id: str | Unset = UNSET,
+    person_id: str | Unset = UNSET,
+    effective_status: list[ListActiveAcquisitionsEffectiveStatusItem] | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_at: str | Unset = UNSET
+    if not isinstance(at, Unset):
+        json_at = at.isoformat()
+    params["at"] = json_at
+
+    json_before_minutes: int | None | Unset
+    if isinstance(before_minutes, Unset):
+        json_before_minutes = UNSET
+    else:
+        json_before_minutes = before_minutes
+    params["before_minutes"] = json_before_minutes
+
+    json_after_minutes: int | None | Unset
+    if isinstance(after_minutes, Unset):
+        json_after_minutes = UNSET
+    else:
+        json_after_minutes = after_minutes
+    params["after_minutes"] = json_after_minutes
+
+    params["instrument_id"] = instrument_id
+
+    params["subject_id"] = subject_id
+
+    params["person_id"] = person_id
+
+    json_effective_status: list[str] | Unset = UNSET
+    if not isinstance(effective_status, Unset):
+        json_effective_status = []
+        for effective_status_item_data in effective_status:
+            effective_status_item = effective_status_item_data.value
+            json_effective_status.append(effective_status_item)
+
+    params["effective_status"] = json_effective_status
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/scheduled-acquisitions/active",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HttpValidationProblemDetails | list[ScheduledAcquisitionResponse] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = ScheduledAcquisitionResponse.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HttpValidationProblemDetails.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    at: datetime.datetime | Unset = UNSET,
+    before_minutes: int | None | Unset = UNSET,
+    after_minutes: int | None | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    subject_id: str | Unset = UNSET,
+    person_id: str | Unset = UNSET,
+    effective_status: list[ListActiveAcquisitionsEffectiveStatusItem] | Unset = UNSET,
+) -> Response[HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]]:
+    """Acquisitions whose planned window overlaps [at - before_minutes, at + after_minutes]; used by rigs
+    at startup.
+
+    Args:
+        at (datetime.datetime | Unset): ISO 8601 timestamp with an offset, e.g.
+            2026-10-15T16:00:00Z.
+        before_minutes (int | None | Unset):
+        after_minutes (int | None | Unset):
+        instrument_id (str | Unset):
+        subject_id (str | Unset):
+        person_id (str | Unset):
+        effective_status (list[ListActiveAcquisitionsEffectiveStatusItem] | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        at=at,
+        before_minutes=before_minutes,
+        after_minutes=after_minutes,
+        instrument_id=instrument_id,
+        subject_id=subject_id,
+        person_id=person_id,
+        effective_status=effective_status,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    at: datetime.datetime | Unset = UNSET,
+    before_minutes: int | None | Unset = UNSET,
+    after_minutes: int | None | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    subject_id: str | Unset = UNSET,
+    person_id: str | Unset = UNSET,
+    effective_status: list[ListActiveAcquisitionsEffectiveStatusItem] | Unset = UNSET,
+) -> HttpValidationProblemDetails | list[ScheduledAcquisitionResponse] | None:
+    """Acquisitions whose planned window overlaps [at - before_minutes, at + after_minutes]; used by rigs
+    at startup.
+
+    Args:
+        at (datetime.datetime | Unset): ISO 8601 timestamp with an offset, e.g.
+            2026-10-15T16:00:00Z.
+        before_minutes (int | None | Unset):
+        after_minutes (int | None | Unset):
+        instrument_id (str | Unset):
+        subject_id (str | Unset):
+        person_id (str | Unset):
+        effective_status (list[ListActiveAcquisitionsEffectiveStatusItem] | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]
+    """
+
+    return sync_detailed(
+        client=client,
+        at=at,
+        before_minutes=before_minutes,
+        after_minutes=after_minutes,
+        instrument_id=instrument_id,
+        subject_id=subject_id,
+        person_id=person_id,
+        effective_status=effective_status,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    at: datetime.datetime | Unset = UNSET,
+    before_minutes: int | None | Unset = UNSET,
+    after_minutes: int | None | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    subject_id: str | Unset = UNSET,
+    person_id: str | Unset = UNSET,
+    effective_status: list[ListActiveAcquisitionsEffectiveStatusItem] | Unset = UNSET,
+) -> Response[HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]]:
+    """Acquisitions whose planned window overlaps [at - before_minutes, at + after_minutes]; used by rigs
+    at startup.
+
+    Args:
+        at (datetime.datetime | Unset): ISO 8601 timestamp with an offset, e.g.
+            2026-10-15T16:00:00Z.
+        before_minutes (int | None | Unset):
+        after_minutes (int | None | Unset):
+        instrument_id (str | Unset):
+        subject_id (str | Unset):
+        person_id (str | Unset):
+        effective_status (list[ListActiveAcquisitionsEffectiveStatusItem] | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        at=at,
+        before_minutes=before_minutes,
+        after_minutes=after_minutes,
+        instrument_id=instrument_id,
+        subject_id=subject_id,
+        person_id=person_id,
+        effective_status=effective_status,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    at: datetime.datetime | Unset = UNSET,
+    before_minutes: int | None | Unset = UNSET,
+    after_minutes: int | None | Unset = UNSET,
+    instrument_id: str | Unset = UNSET,
+    subject_id: str | Unset = UNSET,
+    person_id: str | Unset = UNSET,
+    effective_status: list[ListActiveAcquisitionsEffectiveStatusItem] | Unset = UNSET,
+) -> HttpValidationProblemDetails | list[ScheduledAcquisitionResponse] | None:
+    """Acquisitions whose planned window overlaps [at - before_minutes, at + after_minutes]; used by rigs
+    at startup.
+
+    Args:
+        at (datetime.datetime | Unset): ISO 8601 timestamp with an offset, e.g.
+            2026-10-15T16:00:00Z.
+        before_minutes (int | None | Unset):
+        after_minutes (int | None | Unset):
+        instrument_id (str | Unset):
+        subject_id (str | Unset):
+        person_id (str | Unset):
+        effective_status (list[ListActiveAcquisitionsEffectiveStatusItem] | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        HttpValidationProblemDetails | list[ScheduledAcquisitionResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            at=at,
+            before_minutes=before_minutes,
+            after_minutes=after_minutes,
+            instrument_id=instrument_id,
+            subject_id=subject_id,
+            person_id=person_id,
+            effective_status=effective_status,
+        )
+    ).parsed