docket-client 0.3.2__py3-none-any.whl

docket/models/me_caller.py

@@ -0,0 +1,118 @@
+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.caller_kind import CallerKind
+from typing import cast
+
+
+T = TypeVar("T", bound="MeCaller")
+
+
+@_attrs_define
+class MeCaller:
+    """The caller as the API sees it.
+
+    Attributes:
+        kind (CallerKind): What kind of principal made a request.
+        display_name (str): For display only; never an identity key.
+        object_id (None | str): Directory object id; null when anonymous.
+        tenant_id (None | str): Directory tenant; null when anonymous.
+        calling_application_id (None | str): The client application that obtained the token.
+    """
+
+    kind: CallerKind
+    display_name: str
+    object_id: None | str
+    tenant_id: None | str
+    calling_application_id: None | str
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        kind = self.kind.value
+
+        display_name = self.display_name
+
+        object_id: None | str
+        object_id = self.object_id
+
+        tenant_id: None | str
+        tenant_id = self.tenant_id
+
+        calling_application_id: None | str
+        calling_application_id = self.calling_application_id
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "kind": kind,
+                "display_name": display_name,
+                "object_id": object_id,
+                "tenant_id": tenant_id,
+                "calling_application_id": calling_application_id,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        kind = CallerKind(d.pop("kind"))
+
+        display_name = d.pop("display_name")
+
+        def _parse_object_id(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        object_id = _parse_object_id(d.pop("object_id"))
+
+        def _parse_tenant_id(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        tenant_id = _parse_tenant_id(d.pop("tenant_id"))
+
+        def _parse_calling_application_id(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        calling_application_id = _parse_calling_application_id(d.pop("calling_application_id"))
+
+        me_caller = cls(
+            kind=kind,
+            display_name=display_name,
+            object_id=object_id,
+            tenant_id=tenant_id,
+            calling_application_id=calling_application_id,
+        )
+
+        me_caller.additional_properties = d
+        return me_caller
+
+    @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/me_permission.py

@@ -0,0 +1,98 @@
+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.permission_action import PermissionAction
+from typing import cast
+
+
+T = TypeVar("T", bound="MePermission")
+
+
+@_attrs_define
+class MePermission:
+    """One permission granted to the caller.
+
+    Attributes:
+        resource (str): Resource kind, e.g. `scheduled-acquisition`.
+        action (PermissionAction): What a mutation does. Classified by effect, not by HTTP method.
+        scope (None | str): Acquisition-type key the grant is limited to; null means any.
+        own_only (bool): True when it covers only resources the caller created.
+    """
+
+    resource: str
+    action: PermissionAction
+    scope: None | str
+    own_only: bool
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        resource = self.resource
+
+        action = self.action.value
+
+        scope: None | str
+        scope = self.scope
+
+        own_only = self.own_only
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "resource": resource,
+                "action": action,
+                "scope": scope,
+                "own_only": own_only,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        resource = d.pop("resource")
+
+        action = PermissionAction(d.pop("action"))
+
+        def _parse_scope(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        scope = _parse_scope(d.pop("scope"))
+
+        own_only = d.pop("own_only")
+
+        me_permission = cls(
+            resource=resource,
+            action=action,
+            scope=scope,
+            own_only=own_only,
+        )
+
+        me_permission.additional_properties = d
+        return me_permission
+
+    @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/me_response.py

@@ -0,0 +1,158 @@
+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.auth_mode import AuthMode
+from typing import cast
+
+if TYPE_CHECKING:
+    from ..models.me_caller import MeCaller
+    from ..models.me_permission import MePermission
+    from ..models.me_role import MeRole
+    from ..models.personal_token_limits import PersonalTokenLimits
+
+
+T = TypeVar("T", bound="MeResponse")
+
+
+@_attrs_define
+class MeResponse:
+    """Who the API thinks you are and what you may do. Public, like every read.
+
+    Attributes:
+        auth_mode (AuthMode): Authentication mode, set by configuration key `Auth:Mode`.
+        all_allowed (bool): True when authentication is disabled: every mutation is accepted, so the list below is
+            informational.
+        caller (MeCaller): The caller as the API sees it.
+        roles (list[str]): Docket roles the caller holds. Assigned in Docket; the token's own roles claim is ignored.
+        role_sources (list[MeRole]): The same roles with where each comes from: assignment, default or bootstrap.
+        permissions (list[MePermission]): Everything the caller may do (reads are public and not listed).
+        self_service_tokens (bool): True when people can create their own API tokens here: Entra mode and
+            `Auth:ApiTokens:SelfService` on.
+        personal_tokens (PersonalTokenLimits): The limits of personal API tokens, as configured.
+    """
+
+    auth_mode: AuthMode
+    all_allowed: bool
+    caller: MeCaller
+    roles: list[str]
+    role_sources: list[MeRole]
+    permissions: list[MePermission]
+    self_service_tokens: bool
+    personal_tokens: PersonalTokenLimits
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.me_caller import MeCaller
+        from ..models.me_permission import MePermission
+        from ..models.me_role import MeRole
+        from ..models.personal_token_limits import PersonalTokenLimits
+
+        auth_mode = self.auth_mode.value
+
+        all_allowed = self.all_allowed
+
+        caller = self.caller.to_dict()
+
+        roles = self.roles
+
+        role_sources = []
+        for role_sources_item_data in self.role_sources:
+            role_sources_item = role_sources_item_data.to_dict()
+            role_sources.append(role_sources_item)
+
+        permissions = []
+        for permissions_item_data in self.permissions:
+            permissions_item = permissions_item_data.to_dict()
+            permissions.append(permissions_item)
+
+        self_service_tokens = self.self_service_tokens
+
+        personal_tokens = self.personal_tokens.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "auth_mode": auth_mode,
+                "all_allowed": all_allowed,
+                "caller": caller,
+                "roles": roles,
+                "role_sources": role_sources,
+                "permissions": permissions,
+                "self_service_tokens": self_service_tokens,
+                "personal_tokens": personal_tokens,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.me_caller import MeCaller
+        from ..models.me_permission import MePermission
+        from ..models.me_role import MeRole
+        from ..models.personal_token_limits import PersonalTokenLimits
+
+        d = dict(src_dict)
+        auth_mode = AuthMode(d.pop("auth_mode"))
+
+        all_allowed = d.pop("all_allowed")
+
+        caller = MeCaller.from_dict(d.pop("caller"))
+
+        roles = cast(list[str], d.pop("roles"))
+
+        role_sources = []
+        _role_sources = d.pop("role_sources")
+        for role_sources_item_data in _role_sources:
+            role_sources_item = MeRole.from_dict(role_sources_item_data)
+
+            role_sources.append(role_sources_item)
+
+        permissions = []
+        _permissions = d.pop("permissions")
+        for permissions_item_data in _permissions:
+            permissions_item = MePermission.from_dict(permissions_item_data)
+
+            permissions.append(permissions_item)
+
+        self_service_tokens = d.pop("self_service_tokens")
+
+        personal_tokens = PersonalTokenLimits.from_dict(d.pop("personal_tokens"))
+
+        me_response = cls(
+            auth_mode=auth_mode,
+            all_allowed=all_allowed,
+            caller=caller,
+            roles=roles,
+            role_sources=role_sources,
+            permissions=permissions,
+            self_service_tokens=self_service_tokens,
+            personal_tokens=personal_tokens,
+        )
+
+        me_response.additional_properties = d
+        return me_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/me_role.py

@@ -0,0 +1,75 @@
+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.role_source_kind import RoleSourceKind
+
+
+T = TypeVar("T", bound="MeRole")
+
+
+@_attrs_define
+class MeRole:
+    """A held role and its origin.
+
+    Attributes:
+        role (str): Role value, e.g. `Docket.User` or `Docket.AcquisitionSettingsMaintainer.fip`.
+        source (RoleSourceKind): Where a held role comes from.
+    """
+
+    role: str
+    source: RoleSourceKind
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        role = self.role
+
+        source = self.source.value
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "role": role,
+                "source": source,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        role = d.pop("role")
+
+        source = RoleSourceKind(d.pop("source"))
+
+        me_role = cls(
+            role=role,
+            source=source,
+        )
+
+        me_role.additional_properties = d
+        return me_role
+
+    @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/occurrence_preview.py

@@ -0,0 +1,121 @@
+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 ..types import UNSET, Unset
+from typing import cast
+import datetime
+
+if TYPE_CHECKING:
+    from ..models.acquisition_warning import AcquisitionWarning
+
+
+T = TypeVar("T", bound="OccurrencePreview")
+
+
+@_attrs_define
+class OccurrencePreview:
+    """An occurrence the rule produces, as it would be (or was) scheduled.
+
+    Attributes:
+        occurrence_local_date (datetime.date): Calendar date, e.g. 2026-10-15.
+        scheduled_start (datetime.datetime): UTC instant, ISO 8601 with offset, e.g. 2026-10-15T16:00:00Z.
+        scheduled_end (datetime.datetime): UTC instant, ISO 8601 with offset, e.g. 2026-10-15T16:00:00Z.
+        warnings (list[AcquisitionWarning]): Instrument overlaps with other acquisitions (same rules as a single
+            acquisition).
+        attached (bool | Unset): True for the existing session a series is started from (`source_acquisition_id`): it is
+            the first
+            occurrence, shown with its own times, and no new session is created for it. It has no warnings: only the
+            sessions the rule creates are checked for overlaps. Default: False.
+    """
+
+    occurrence_local_date: datetime.date
+    scheduled_start: datetime.datetime
+    scheduled_end: datetime.datetime
+    warnings: list[AcquisitionWarning]
+    attached: bool | Unset = False
+    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()
+
+        scheduled_start = self.scheduled_start.isoformat()
+
+        scheduled_end = self.scheduled_end.isoformat()
+
+        warnings = []
+        for warnings_item_data in self.warnings:
+            warnings_item = warnings_item_data.to_dict()
+            warnings.append(warnings_item)
+
+        attached = self.attached
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "occurrence_local_date": occurrence_local_date,
+                "scheduled_start": scheduled_start,
+                "scheduled_end": scheduled_end,
+                "warnings": warnings,
+            }
+        )
+        if attached is not UNSET:
+            field_dict["attached"] = attached
+
+        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"))
+
+        scheduled_start = datetime.datetime.fromisoformat(d.pop("scheduled_start"))
+
+        scheduled_end = datetime.datetime.fromisoformat(d.pop("scheduled_end"))
+
+        warnings = []
+        _warnings = d.pop("warnings")
+        for warnings_item_data in _warnings:
+            warnings_item = AcquisitionWarning.from_dict(warnings_item_data)
+
+            warnings.append(warnings_item)
+
+        attached = d.pop("attached", UNSET)
+
+        occurrence_preview = cls(
+            occurrence_local_date=occurrence_local_date,
+            scheduled_start=scheduled_start,
+            scheduled_end=scheduled_end,
+            warnings=warnings,
+            attached=attached,
+        )
+
+        occurrence_preview.additional_properties = d
+        return occurrence_preview
+
+    @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/occurrence_summary.py

@@ -0,0 +1,126 @@
+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="OccurrenceSummary")
+
+
+@_attrs_define
+class OccurrenceSummary:
+    """Summary of a series' occurrences (archived ones included).
+
+    Attributes:
+        count (int): Number of scheduled acquisitions in the series.
+        first_scheduled_start (datetime.datetime | None):
+        last_scheduled_start (datetime.datetime | None):
+        ids (list[int]): Their ids, ordered by start.
+    """
+
+    count: int
+    first_scheduled_start: datetime.datetime | None
+    last_scheduled_start: datetime.datetime | None
+    ids: list[int]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        count = self.count
+
+        first_scheduled_start: None | str
+        if isinstance(self.first_scheduled_start, datetime.datetime):
+            first_scheduled_start = self.first_scheduled_start.isoformat()
+        else:
+            first_scheduled_start = self.first_scheduled_start
+
+        last_scheduled_start: None | str
+        if isinstance(self.last_scheduled_start, datetime.datetime):
+            last_scheduled_start = self.last_scheduled_start.isoformat()
+        else:
+            last_scheduled_start = self.last_scheduled_start
+
+        ids = self.ids
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "count": count,
+                "first_scheduled_start": first_scheduled_start,
+                "last_scheduled_start": last_scheduled_start,
+                "ids": ids,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        count = d.pop("count")
+
+        def _parse_first_scheduled_start(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)
+
+        first_scheduled_start = _parse_first_scheduled_start(d.pop("first_scheduled_start"))
+
+        def _parse_last_scheduled_start(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)
+
+        last_scheduled_start = _parse_last_scheduled_start(d.pop("last_scheduled_start"))
+
+        ids = cast(list[int], d.pop("ids"))
+
+        occurrence_summary = cls(
+            count=count,
+            first_scheduled_start=first_scheduled_start,
+            last_scheduled_start=last_scheduled_start,
+            ids=ids,
+        )
+
+        occurrence_summary.additional_properties = d
+        return occurrence_summary
+
+    @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