docket-client 0.3.2__py3-none-any.whl

docket/models/occurrence_warnings.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 typing import cast
+import datetime
+
+if TYPE_CHECKING:
+    from ..models.acquisition_warning import AcquisitionWarning
+
+
+T = TypeVar("T", bound="OccurrenceWarnings")
+
+
+@_attrs_define
+class OccurrenceWarnings:
+    """The occurrences with at least one overlap warning.
+
+    Attributes:
+        occurrence_local_date (datetime.date): Calendar date, e.g. 2026-10-15.
+        warnings (list[AcquisitionWarning]):
+    """
+
+    occurrence_local_date: datetime.date
+    warnings: list[AcquisitionWarning]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.acquisition_warning import AcquisitionWarning
+
+        occurrence_local_date = self.occurrence_local_date.isoformat()
+
+        warnings = []
+        for warnings_item_data in self.warnings:
+            warnings_item = warnings_item_data.to_dict()
+            warnings.append(warnings_item)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "occurrence_local_date": occurrence_local_date,
+                "warnings": warnings,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.acquisition_warning import AcquisitionWarning
+
+        d = dict(src_dict)
+        occurrence_local_date = datetime.date.fromisoformat(d.pop("occurrence_local_date"))
+
+        warnings = []
+        _warnings = d.pop("warnings")
+        for warnings_item_data in _warnings:
+            warnings_item = AcquisitionWarning.from_dict(warnings_item_data)
+
+            warnings.append(warnings_item)
+
+        occurrence_warnings = cls(
+            occurrence_local_date=occurrence_local_date,
+            warnings=warnings,
+        )
+
+        occurrence_warnings.additional_properties = d
+        return occurrence_warnings
+
+    @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/permission_action.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class PermissionAction(str, Enum):
+    ARCHIVE = "archive"
+    CREATE = "create"
+    EXECUTE = "execute"
+    READ = "read"
+    UPDATE = "update"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/person_assignment.py

@@ -0,0 +1,74 @@
+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.person_role import PersonRole
+
+
+T = TypeVar("T", bound="PersonAssignment")
+
+
+@_attrs_define
+class PersonAssignment:
+    """
+    Attributes:
+        person_id (str): Active Directory username; canonicalized.
+        role (PersonRole):
+    """
+
+    person_id: str
+    role: PersonRole
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        person_id = self.person_id
+
+        role = self.role.value
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "person_id": person_id,
+                "role": role,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        person_id = d.pop("person_id")
+
+        role = PersonRole(d.pop("role"))
+
+        person_assignment = cls(
+            person_id=person_id,
+            role=role,
+        )
+
+        person_assignment.additional_properties = d
+        return person_assignment
+
+    @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/person_lookup_response.py

@@ -0,0 +1,131 @@
+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
+
+
+T = TypeVar("T", bound="PersonLookupResponse")
+
+
+@_attrs_define
+class PersonLookupResponse:
+    """Answer to "is this a real person?". Returned with 200 even when bool PersonLookupResponse.Valid is false.
+
+    Attributes:
+        valid (bool): Whether Active Directory knows the username.
+        username (None | str): Canonical username when valid.
+        canonicalised (bool): True when Username differs from what was asked.
+        detail (None | str): Why the username is not valid; null when valid.
+        full_name (None | str): Display name from Active Directory, if any.
+        email (None | str): Email from Active Directory, if any.
+    """
+
+    valid: bool
+    username: None | str
+    canonicalised: bool
+    detail: None | str
+    full_name: None | str
+    email: None | str
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        valid = self.valid
+
+        username: None | str
+        username = self.username
+
+        canonicalised = self.canonicalised
+
+        detail: None | str
+        detail = self.detail
+
+        full_name: None | str
+        full_name = self.full_name
+
+        email: None | str
+        email = self.email
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "valid": valid,
+                "username": username,
+                "canonicalised": canonicalised,
+                "detail": detail,
+                "full_name": full_name,
+                "email": email,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        valid = d.pop("valid")
+
+        def _parse_username(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        username = _parse_username(d.pop("username"))
+
+        canonicalised = d.pop("canonicalised")
+
+        def _parse_detail(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        detail = _parse_detail(d.pop("detail"))
+
+        def _parse_full_name(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        full_name = _parse_full_name(d.pop("full_name"))
+
+        def _parse_email(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        email = _parse_email(d.pop("email"))
+
+        person_lookup_response = cls(
+            valid=valid,
+            username=username,
+            canonicalised=canonicalised,
+            detail=detail,
+            full_name=full_name,
+            email=email,
+        )
+
+        person_lookup_response.additional_properties = d
+        return person_lookup_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/person_response.py

@@ -0,0 +1,103 @@
+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
+
+
+T = TypeVar("T", bound="PersonResponse")
+
+
+@_attrs_define
+class PersonResponse:
+    """
+    Attributes:
+        id (str):
+        full_name (None | str):
+        email (None | str):
+        validated_at (datetime.datetime): UTC instant, ISO 8601 with offset, e.g. 2026-10-15T16:00:00Z.
+    """
+
+    id: str
+    full_name: None | str
+    email: None | str
+    validated_at: datetime.datetime
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        id = self.id
+
+        full_name: None | str
+        full_name = self.full_name
+
+        email: None | str
+        email = self.email
+
+        validated_at = self.validated_at.isoformat()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "id": id,
+                "full_name": full_name,
+                "email": email,
+                "validated_at": validated_at,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        id = d.pop("id")
+
+        def _parse_full_name(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        full_name = _parse_full_name(d.pop("full_name"))
+
+        def _parse_email(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        email = _parse_email(d.pop("email"))
+
+        validated_at = datetime.datetime.fromisoformat(d.pop("validated_at"))
+
+        person_response = cls(
+            id=id,
+            full_name=full_name,
+            email=email,
+            validated_at=validated_at,
+        )
+
+        person_response.additional_properties = d
+        return person_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/person_role.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class PersonRole(str, Enum):
+    EXPERIMENTER = "experimenter"
+    SCIENTIFIC_CONTACT = "scientific_contact"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/personal_token_limits.py

@@ -0,0 +1,92 @@
+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
+
+
+T = TypeVar("T", bound="PersonalTokenLimits")
+
+
+@_attrs_define
+class PersonalTokenLimits:
+    """The limits of personal API tokens, as configured.
+
+    Attributes:
+        lifetime_choices_days (list[int]): Lifetimes to offer when creating one, longest at most `MaxLifetimeDays`.
+        max_lifetime_days (int): The longest lifetime the server accepts.
+        max_active (int): Most active personal tokens one person may hold.
+        requires_sign_in_within_days (int): A personal token stops working if its owner has not signed in to Docket
+            interactively within this many days.
+    """
+
+    lifetime_choices_days: list[int]
+    max_lifetime_days: int
+    max_active: int
+    requires_sign_in_within_days: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        lifetime_choices_days = self.lifetime_choices_days
+
+        max_lifetime_days = self.max_lifetime_days
+
+        max_active = self.max_active
+
+        requires_sign_in_within_days = self.requires_sign_in_within_days
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "lifetime_choices_days": lifetime_choices_days,
+                "max_lifetime_days": max_lifetime_days,
+                "max_active": max_active,
+                "requires_sign_in_within_days": requires_sign_in_within_days,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        lifetime_choices_days = cast(list[int], d.pop("lifetime_choices_days"))
+
+        max_lifetime_days = d.pop("max_lifetime_days")
+
+        max_active = d.pop("max_active")
+
+        requires_sign_in_within_days = d.pop("requires_sign_in_within_days")
+
+        personal_token_limits = cls(
+            lifetime_choices_days=lifetime_choices_days,
+            max_lifetime_days=max_lifetime_days,
+            max_active=max_active,
+            requires_sign_in_within_days=requires_sign_in_within_days,
+        )
+
+        personal_token_limits.additional_properties = d
+        return personal_token_limits
+
+    @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/planning_status.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class PlanningStatus(str, Enum):
+    CANCELLED = "cancelled"
+    FAILED = "failed"
+    SCHEDULED = "scheduled"
+    SUCCEEDED = "succeeded"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/principal_kind.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class PrincipalKind(str, Enum):
+    APPLICATION = "application"
+    PERSON = "person"
+
+    def __str__(self) -> str:
+        return str(self.value)