docket-client 0.3.2__py3-none-any.whl

docket/models/fip_fiber.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from ..models.fip_color import FipColor
+from ..types import UNSET, Unset
+
+
+T = TypeVar("T", bound="FipFiber")
+
+
+@_attrs_define
+class FipFiber:
+    """One implanted fiber.
+
+    Attributes:
+        location (str): Implant location, e.g. `mPFC`. Trimmed; must not be blank.
+        patch_cord_number (int): Patch cord the fiber connects to; unique across fibers, zero or greater.
+        color (FipColor): Fiber color. Accepted case-insensitively, stored and returned in canonical casing.
+        enabled (bool | Unset): Disabled fibers are stored and still count toward uniqueness. Default: True.
+    """
+
+    location: str
+    patch_cord_number: int
+    color: FipColor
+    enabled: bool | Unset = True
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        location = self.location
+
+        patch_cord_number = self.patch_cord_number
+
+        color = self.color.value
+
+        enabled = self.enabled
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "location": location,
+                "patch_cord_number": patch_cord_number,
+                "color": color,
+            }
+        )
+        if enabled is not UNSET:
+            field_dict["enabled"] = enabled
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        location = d.pop("location")
+
+        patch_cord_number = d.pop("patch_cord_number")
+
+        color = FipColor(d.pop("color"))
+
+        enabled = d.pop("enabled", UNSET)
+
+        fip_fiber = cls(
+            location=location,
+            patch_cord_number=patch_cord_number,
+            color=color,
+            enabled=enabled,
+        )
+
+        fip_fiber.additional_properties = d
+        return fip_fiber
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/fip_mode.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class FipMode(str, Enum):
+    AXONAL = "Axonal"
+    SOMATIC = "Somatic"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/fip_push_settings_request.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+
+if TYPE_CHECKING:
+    from ..models.fip_settings import FipSettings
+
+
+T = TypeVar("T", bound="FipPushSettingsRequest")
+
+
+@_attrs_define
+class FipPushSettingsRequest:
+    """Push a new settings version for a subject.
+
+    Attributes:
+        subject_id (str): Subject the settings apply to; validated against the metadata service.
+        settings (FipSettings): FIP (fiber photometry) settings for one subject. One live version per subject.
+    """
+
+    subject_id: str
+    settings: FipSettings
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.fip_settings import FipSettings
+
+        subject_id = self.subject_id
+
+        settings = self.settings.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "subject_id": subject_id,
+                "settings": settings,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.fip_settings import FipSettings
+
+        d = dict(src_dict)
+        subject_id = d.pop("subject_id")
+
+        settings = FipSettings.from_dict(d.pop("settings"))
+
+        fip_push_settings_request = cls(
+            subject_id=subject_id,
+            settings=settings,
+        )
+
+        fip_push_settings_request.additional_properties = d
+        return fip_push_settings_request
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/fip_settings.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from ..models.fip_mode import FipMode
+from typing import cast
+
+if TYPE_CHECKING:
+    from ..models.fip_fiber import FipFiber
+
+
+T = TypeVar("T", bound="FipSettings")
+
+
+@_attrs_define
+class FipSettings:
+    """FIP (fiber photometry) settings for one subject. One live version per subject.
+
+    Attributes:
+        mode (FipMode): Fiber photometry acquisition mode.
+        fibers (list[FipFiber]): Fibers; may be empty.
+    """
+
+    mode: FipMode
+    fibers: list[FipFiber]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.fip_fiber import FipFiber
+
+        mode = self.mode.value
+
+        fibers = []
+        for fibers_item_data in self.fibers:
+            fibers_item = fibers_item_data.to_dict()
+            fibers.append(fibers_item)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "mode": mode,
+                "fibers": fibers,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.fip_fiber import FipFiber
+
+        d = dict(src_dict)
+        mode = FipMode(d.pop("mode"))
+
+        fibers = []
+        _fibers = d.pop("fibers")
+        for fibers_item_data in _fibers:
+            fibers_item = FipFiber.from_dict(fibers_item_data)
+
+            fibers.append(fibers_item)
+
+        fip_settings = cls(
+            mode=mode,
+            fibers=fibers,
+        )
+
+        fip_settings.additional_properties = d
+        return fip_settings
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/fip_settings_preview_response.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+
+if TYPE_CHECKING:
+    from ..models.fip_settings import FipSettings
+    from ..models.fip_settings_preview_response_promoted import FipSettingsPreviewResponsePromoted
+
+
+T = TypeVar("T", bound="FipSettingsPreviewResponse")
+
+
+@_attrs_define
+class FipSettingsPreviewResponse:
+    """What a push of this payload would store, without storing it.
+
+    Attributes:
+        settings (FipSettings): FIP (fiber photometry) settings for one subject. One live version per subject.
+        live_scope (str): Live scope the payload belongs to.
+        promoted (FipSettingsPreviewResponsePromoted): Promoted filter fields and their values.
+    """
+
+    settings: FipSettings
+    live_scope: str
+    promoted: FipSettingsPreviewResponsePromoted
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.fip_settings import FipSettings
+        from ..models.fip_settings_preview_response_promoted import (
+            FipSettingsPreviewResponsePromoted,
+        )
+
+        settings = self.settings.to_dict()
+
+        live_scope = self.live_scope
+
+        promoted = self.promoted.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "settings": settings,
+                "live_scope": live_scope,
+                "promoted": promoted,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.fip_settings import FipSettings
+        from ..models.fip_settings_preview_response_promoted import (
+            FipSettingsPreviewResponsePromoted,
+        )
+
+        d = dict(src_dict)
+        settings = FipSettings.from_dict(d.pop("settings"))
+
+        live_scope = d.pop("live_scope")
+
+        promoted = FipSettingsPreviewResponsePromoted.from_dict(d.pop("promoted"))
+
+        fip_settings_preview_response = cls(
+            settings=settings,
+            live_scope=live_scope,
+            promoted=promoted,
+        )
+
+        fip_settings_preview_response.additional_properties = d
+        return fip_settings_preview_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/fip_settings_preview_response_promoted.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+T = TypeVar("T", bound="FipSettingsPreviewResponsePromoted")
+
+
+@_attrs_define
+class FipSettingsPreviewResponsePromoted:
+    """Promoted filter fields and their values."""
+
+    additional_properties: dict[str, str] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        fip_settings_preview_response_promoted = cls()
+
+        fip_settings_preview_response_promoted.additional_properties = d
+        return fip_settings_preview_response_promoted
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> str:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: str) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/fip_settings_version_response.py

@@ -0,0 +1,155 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+import datetime
+
+if TYPE_CHECKING:
+    from ..models.fip_settings import FipSettings
+    from ..models.fip_settings_version_response_promoted import FipSettingsVersionResponsePromoted
+
+
+T = TypeVar("T", bound="FipSettingsVersionResponse")
+
+
+@_attrs_define
+class FipSettingsVersionResponse:
+    """One immutable settings version.
+
+    Attributes:
+        id (int): Version id; schedules pin it and run snapshots reference it.
+        subject_id (str): Canonical subject id.
+        live_scope (str): Scope within the subject; empty when the type has one live version per subject.
+        pushed_at (datetime.datetime): UTC instant, ISO 8601 with offset, e.g. 2026-10-15T16:00:00Z.
+        superseded_at (datetime.datetime | None):
+        pushed_by (str): Display name of the pusher; unverified while authentication is disabled.
+        settings (FipSettings): FIP (fiber photometry) settings for one subject. One live version per subject.
+        promoted (FipSettingsVersionResponsePromoted): Promoted filter fields and their values.
+    """
+
+    id: int
+    subject_id: str
+    live_scope: str
+    pushed_at: datetime.datetime
+    superseded_at: datetime.datetime | None
+    pushed_by: str
+    settings: FipSettings
+    promoted: FipSettingsVersionResponsePromoted
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.fip_settings import FipSettings
+        from ..models.fip_settings_version_response_promoted import (
+            FipSettingsVersionResponsePromoted,
+        )
+
+        id = self.id
+
+        subject_id = self.subject_id
+
+        live_scope = self.live_scope
+
+        pushed_at = self.pushed_at.isoformat()
+
+        superseded_at: None | str
+        if isinstance(self.superseded_at, datetime.datetime):
+            superseded_at = self.superseded_at.isoformat()
+        else:
+            superseded_at = self.superseded_at
+
+        pushed_by = self.pushed_by
+
+        settings = self.settings.to_dict()
+
+        promoted = self.promoted.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "id": id,
+                "subject_id": subject_id,
+                "live_scope": live_scope,
+                "pushed_at": pushed_at,
+                "superseded_at": superseded_at,
+                "pushed_by": pushed_by,
+                "settings": settings,
+                "promoted": promoted,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.fip_settings import FipSettings
+        from ..models.fip_settings_version_response_promoted import (
+            FipSettingsVersionResponsePromoted,
+        )
+
+        d = dict(src_dict)
+        id = d.pop("id")
+
+        subject_id = d.pop("subject_id")
+
+        live_scope = d.pop("live_scope")
+
+        pushed_at = datetime.datetime.fromisoformat(d.pop("pushed_at"))
+
+        def _parse_superseded_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                componentsschemas_instant_nullable_type_1 = datetime.datetime.fromisoformat(data)
+
+                return componentsschemas_instant_nullable_type_1
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        superseded_at = _parse_superseded_at(d.pop("superseded_at"))
+
+        pushed_by = d.pop("pushed_by")
+
+        settings = FipSettings.from_dict(d.pop("settings"))
+
+        promoted = FipSettingsVersionResponsePromoted.from_dict(d.pop("promoted"))
+
+        fip_settings_version_response = cls(
+            id=id,
+            subject_id=subject_id,
+            live_scope=live_scope,
+            pushed_at=pushed_at,
+            superseded_at=superseded_at,
+            pushed_by=pushed_by,
+            settings=settings,
+            promoted=promoted,
+        )
+
+        fip_settings_version_response.additional_properties = d
+        return fip_settings_version_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/fip_settings_version_response_promoted.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+T = TypeVar("T", bound="FipSettingsVersionResponsePromoted")
+
+
+@_attrs_define
+class FipSettingsVersionResponsePromoted:
+    """Promoted filter fields and their values."""
+
+    additional_properties: dict[str, str] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        fip_settings_version_response_promoted = cls()
+
+        fip_settings_version_response_promoted.additional_properties = d
+        return fip_settings_version_response_promoted
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> str:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: str) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/future_occurrences.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class FutureOccurrences(str, Enum):
+    ARCHIVE = "archive"
+    KEEP = "keep"
+
+    def __str__(self) -> str:
+        return str(self.value)