docket-client 0.3.2__py3-none-any.whl

docket/api/settings/list_live_fip_settings.py

@@ -0,0 +1,225 @@
+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.fip_settings_version_response import FipSettingsVersionResponse
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...types import UNSET, Unset
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    subject_id: str | Unset = UNSET,
+    discriminator_field: str | Unset = UNSET,
+    discriminator_value: str | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["subject_id"] = subject_id
+
+    params["discriminator_field"] = discriminator_field
+
+    params["discriminator_value"] = discriminator_value
+
+    json_limit: int | None | Unset
+    if isinstance(limit, Unset):
+        json_limit = UNSET
+    else:
+        json_limit = limit
+    params["limit"] = json_limit
+
+    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/settings/fip/live",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HttpValidationProblemDetails | list[FipSettingsVersionResponse] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = FipSettingsVersionResponse.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[FipSettingsVersionResponse]]:
+    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,
+    subject_id: str | Unset = UNSET,
+    discriminator_field: str | Unset = UNSET,
+    discriminator_value: str | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> Response[HttpValidationProblemDetails | list[FipSettingsVersionResponse]]:
+    """Live fip settings versions, newest first, optionally filtered by a discriminator field.
+
+    Args:
+        subject_id (str | Unset):
+        discriminator_field (str | Unset):
+        discriminator_value (str | Unset):
+        limit (int | None | 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[FipSettingsVersionResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        subject_id=subject_id,
+        discriminator_field=discriminator_field,
+        discriminator_value=discriminator_value,
+        limit=limit,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    discriminator_field: str | Unset = UNSET,
+    discriminator_value: str | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> HttpValidationProblemDetails | list[FipSettingsVersionResponse] | None:
+    """Live fip settings versions, newest first, optionally filtered by a discriminator field.
+
+    Args:
+        subject_id (str | Unset):
+        discriminator_field (str | Unset):
+        discriminator_value (str | Unset):
+        limit (int | None | 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[FipSettingsVersionResponse]
+    """
+
+    return sync_detailed(
+        client=client,
+        subject_id=subject_id,
+        discriminator_field=discriminator_field,
+        discriminator_value=discriminator_value,
+        limit=limit,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    discriminator_field: str | Unset = UNSET,
+    discriminator_value: str | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> Response[HttpValidationProblemDetails | list[FipSettingsVersionResponse]]:
+    """Live fip settings versions, newest first, optionally filtered by a discriminator field.
+
+    Args:
+        subject_id (str | Unset):
+        discriminator_field (str | Unset):
+        discriminator_value (str | Unset):
+        limit (int | None | 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[FipSettingsVersionResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        subject_id=subject_id,
+        discriminator_field=discriminator_field,
+        discriminator_value=discriminator_value,
+        limit=limit,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    subject_id: str | Unset = UNSET,
+    discriminator_field: str | Unset = UNSET,
+    discriminator_value: str | Unset = UNSET,
+    limit: int | None | Unset = UNSET,
+) -> HttpValidationProblemDetails | list[FipSettingsVersionResponse] | None:
+    """Live fip settings versions, newest first, optionally filtered by a discriminator field.
+
+    Args:
+        subject_id (str | Unset):
+        discriminator_field (str | Unset):
+        discriminator_value (str | Unset):
+        limit (int | None | 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[FipSettingsVersionResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            subject_id=subject_id,
+            discriminator_field=discriminator_field,
+            discriminator_value=discriminator_value,
+            limit=limit,
+        )
+    ).parsed

docket/api/settings/preview_behavior_curriculum_settings.py

@@ -0,0 +1,191 @@
+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.behavior_curriculum_settings import BehaviorCurriculumSettings
+from ...models.behavior_curriculum_settings_preview_response import (
+    BehaviorCurriculumSettingsPreviewResponse,
+)
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    body: BehaviorCurriculumSettings,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/settings/behavior-curriculum/preview",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails | None:
+    if response.status_code == 200:
+        response_200 = BehaviorCurriculumSettingsPreviewResponse.from_dict(response.json())
+
+        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[BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails]:
+    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,
+    body: BehaviorCurriculumSettings,
+) -> Response[BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails]:
+    """Validate and canonicalize a behavior_curriculum payload and compute its live scope and promoted
+    fields, without storing it.
+
+    Args:
+        body (BehaviorCurriculumSettings): A curriculum/trainer-state document owned by the
+            downstream training
+            software. Any JSON object; stored exactly as pushed. Docket reads only
+            `stage.task.name`, `curriculum.name`, `curriculum.version` and
+            `is_on_curriculum`.
+
+    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[BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: BehaviorCurriculumSettings,
+) -> BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails | None:
+    """Validate and canonicalize a behavior_curriculum payload and compute its live scope and promoted
+    fields, without storing it.
+
+    Args:
+        body (BehaviorCurriculumSettings): A curriculum/trainer-state document owned by the
+            downstream training
+            software. Any JSON object; stored exactly as pushed. Docket reads only
+            `stage.task.name`, `curriculum.name`, `curriculum.version` and
+            `is_on_curriculum`.
+
+    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:
+        BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: BehaviorCurriculumSettings,
+) -> Response[BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails]:
+    """Validate and canonicalize a behavior_curriculum payload and compute its live scope and promoted
+    fields, without storing it.
+
+    Args:
+        body (BehaviorCurriculumSettings): A curriculum/trainer-state document owned by the
+            downstream training
+            software. Any JSON object; stored exactly as pushed. Docket reads only
+            `stage.task.name`, `curriculum.name`, `curriculum.version` and
+            `is_on_curriculum`.
+
+    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[BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: BehaviorCurriculumSettings,
+) -> BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails | None:
+    """Validate and canonicalize a behavior_curriculum payload and compute its live scope and promoted
+    fields, without storing it.
+
+    Args:
+        body (BehaviorCurriculumSettings): A curriculum/trainer-state document owned by the
+            downstream training
+            software. Any JSON object; stored exactly as pushed. Docket reads only
+            `stage.task.name`, `curriculum.name`, `curriculum.version` and
+            `is_on_curriculum`.
+
+    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:
+        BehaviorCurriculumSettingsPreviewResponse | HttpValidationProblemDetails
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

docket/api/settings/preview_fip_settings.py

@@ -0,0 +1,177 @@
+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.fip_settings import FipSettings
+from ...models.fip_settings_preview_response import FipSettingsPreviewResponse
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    body: FipSettings,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/settings/fip/preview",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> FipSettingsPreviewResponse | HttpValidationProblemDetails | None:
+    if response.status_code == 200:
+        response_200 = FipSettingsPreviewResponse.from_dict(response.json())
+
+        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[FipSettingsPreviewResponse | HttpValidationProblemDetails]:
+    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,
+    body: FipSettings,
+) -> Response[FipSettingsPreviewResponse | HttpValidationProblemDetails]:
+    """Validate and canonicalize a fip payload and compute its live scope and promoted fields, without
+    storing it.
+
+    Args:
+        body (FipSettings): FIP (fiber photometry) settings for one subject. One live version per
+            subject.
+
+    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[FipSettingsPreviewResponse | HttpValidationProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: FipSettings,
+) -> FipSettingsPreviewResponse | HttpValidationProblemDetails | None:
+    """Validate and canonicalize a fip payload and compute its live scope and promoted fields, without
+    storing it.
+
+    Args:
+        body (FipSettings): FIP (fiber photometry) settings for one subject. One live version per
+            subject.
+
+    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:
+        FipSettingsPreviewResponse | HttpValidationProblemDetails
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: FipSettings,
+) -> Response[FipSettingsPreviewResponse | HttpValidationProblemDetails]:
+    """Validate and canonicalize a fip payload and compute its live scope and promoted fields, without
+    storing it.
+
+    Args:
+        body (FipSettings): FIP (fiber photometry) settings for one subject. One live version per
+            subject.
+
+    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[FipSettingsPreviewResponse | HttpValidationProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: FipSettings,
+) -> FipSettingsPreviewResponse | HttpValidationProblemDetails | None:
+    """Validate and canonicalize a fip payload and compute its live scope and promoted fields, without
+    storing it.
+
+    Args:
+        body (FipSettings): FIP (fiber photometry) settings for one subject. One live version per
+            subject.
+
+    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:
+        FipSettingsPreviewResponse | HttpValidationProblemDetails
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed