"""Request bodies. Unknown fields are rejected.""" from __future__ import annotations from datetime import date from typing import Annotated, Literal from uuid import UUID from pydantic import BaseModel, ConfigDict, Field Email = Annotated[str, Field(min_length=3, max_length=320, pattern=r"^[^@\s]+@[^@\s]+\.[^@\s]+$")] class APIModel(BaseModel): model_config = ConfigDict(extra="forbid") class LoginIn(APIModel): email: Email password: str = Field(min_length=1, max_length=200) class BootstrapIn(APIModel): email: Email display_name: str = Field(min_length=1, max_length=120) password: str = Field(min_length=10, max_length=200) class AccountIn(APIModel): """Without a password the server generates a one-time password.""" email: Email display_name: str = Field(min_length=1, max_length=120) password: str | None = Field(default=None, min_length=10, max_length=200) is_operator: bool = False class AccountPatchIn(APIModel): display_name: str | None = Field(default=None, min_length=1, max_length=120) is_operator: bool | None = None status: Literal["active", "disabled"] | None = None account_kind: Literal["main"] | None = None class TeamPatchIn(APIModel): status: Literal["active", "disabled"] class PasswordChangeIn(APIModel): current_password: str = Field(min_length=1, max_length=200) new_password: str = Field(min_length=10, max_length=200) class ScopeIn(APIModel): kind: Literal["personal", "organization"] id: UUID class AcceptInviteIn(APIModel): token: str = Field(min_length=20, max_length=200) display_name: str = Field(min_length=1, max_length=120) password: str = Field(min_length=10, max_length=200) class InvitationIn(APIModel): email: Email room_id: UUID role: Literal["member", "manager", "reader"] = "member" class RoomIn(APIModel): name: str = Field(min_length=1, max_length=160) default_visibility: Literal["private", "room"] = "room" class VisibilityIn(APIModel): visibility: Literal["private", "room"] class ShareItemIn(APIModel): kind: Literal["case", "matter"] id: UUID class BatchShareIn(APIModel): items: list[ShareItemIn] = Field(min_length=1, max_length=200) access: Literal["read", "edit"] = "edit" class RoomShareIn(APIModel): access: Literal["read", "edit"] = "edit" class ExclusionIn(APIModel): excluded: bool class OwnerIn(APIModel): subject_id: UUID class OperatorOwnerIn(APIModel): email: Email class MemberIn(APIModel): email: Email role: Literal["member", "manager", "reader"] class MemberRoleIn(APIModel): role: Literal["member", "manager", "reader"] class RoomPatchIn(APIModel): name: str | None = Field(default=None, min_length=1, max_length=160) status: Literal["active", "archived"] | None = None default_visibility: Literal["private", "room"] | None = None class OperatorManagerIn(APIModel): email: Email class ContextIn(APIModel): kind: Literal["case", "matter"] id: UUID class CaseIn(APIModel): title: str = Field(min_length=1, max_length=200) parent_case_id: UUID | None = None rights_mode: Literal["inherit_parent", "explicit"] = "inherit_parent" home_scope_id: UUID | None = None share_with_room_id: UUID | None = None class CasePatch(APIModel): expected_version: int = Field(ge=1) title: str | None = Field(default=None, min_length=1, max_length=200) status: Literal["open", "closed"] | None = None class ChapterIn(APIModel): title: str = Field(min_length=1, max_length=200) position: int | None = Field(default=None, ge=0, le=10000) document_on: date | None = None parent_chapter_id: UUID | None = None class ChapterOrderIn(APIModel): expected_version: int = Field(ge=1) chapter_ids: list[UUID] = Field(min_length=0, max_length=200) context: ContextIn | None = None class ChapterDateIn(APIModel): expected_version: int = Field(ge=1) document_on: date | None = None context: ContextIn | None = None class ChapterTitleIn(APIModel): expected_version: int = Field(ge=1) title: str = Field(min_length=1, max_length=200) context: ContextIn | None = None class ChapterDeleteIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn | None = None class ChapterParentIn(APIModel): expected_version: int = Field(ge=1) parent_chapter_id: UUID | None = None context: ContextIn | None = None class BindingChaptersIn(APIModel): expected_version: int = Field(ge=1) binding_ids: list[UUID] = Field(min_length=1, max_length=500) chapter_id: UUID | None = None context: ContextIn | None = None class RecordDeleteIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn | None = None class MatterMoveIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn | None = None case_id: UUID | None = None parent_matter_id: UUID | None = None clear_parent: bool = False class CommunicationIn(APIModel): expected_version: int = Field(ge=1) direction: Literal["in", "out", "local"] | None = None context: ContextIn | None = None class MatterIn(APIModel): title: str = Field(min_length=1, max_length=200) parent_matter_id: UUID | None = None context: ContextIn | None = None home_scope_id: UUID | None = None share_with_room_id: UUID | None = None class MatterPatch(APIModel): expected_version: int = Field(ge=1) title: str | None = Field(default=None, min_length=1, max_length=200) status: Literal["open", "closed"] | None = None context: ContextIn | None = None class CaseLinkIn(APIModel): case_id: UUID context: ContextIn | None = None class CrossLinkIn(APIModel): target_matter_id: UUID target_context: ContextIn source_context: ContextIn | None = None class GrantIn(APIModel): email: Email can_read: bool = True can_edit: bool = False can_share: bool = False use_owner_sources: bool = False class ExceptionIn(APIModel): resource_kind: Literal["element", "matter", "task", "deadline"] resource_id: UUID context: ContextIn remove_read: bool = False remove_edit: bool = False remove_share: bool = False class DocumentIn(APIModel): version: Literal[1] = 1 blocks: list[dict] class NoteIn(APIModel): title: str = Field(min_length=1, max_length=200) document: DocumentIn context: ContextIn placement: ContextIn | None = None chapter_id: UUID | None = None dates: DatesIn | None = None communication_direction: Literal["in", "out", "local"] | None = None class ContentOrderIn(APIModel): expected_version: int = Field(ge=1) mode: Literal["date", "position"] direction: Literal["asc", "desc"] = "asc" view: Literal["structure", "chronology"] | None = None context: ContextIn | None = None class BindingOrderIn(APIModel): expected_version: int = Field(ge=1) binding_ids: list[UUID] = Field(min_length=0, max_length=500) context: ContextIn | None = None class DatesPatch(APIModel): expected_version: int = Field(ge=1) document_on: date | None = None sent_on: date | None = None received_on: date | None = None context: ContextIn | None = None class SummaryPatch(APIModel): expected_version: int = Field(ge=1) summary: str | None = Field(default=None, max_length=400) context: ContextIn | None = None class TitlePatch(APIModel): expected_version: int = Field(ge=1) title: str = Field(min_length=1, max_length=200) context: ContextIn | None = None class ChapterMoveIn(APIModel): expected_version: int = Field(ge=1) chapter_id: UUID | None = None context: ContextIn | None = None class NotePatch(APIModel): expected_version: int = Field(ge=1) document: DocumentIn context: ContextIn | None = None class BindingIn(APIModel): element_id: UUID source_context: ContextIn target: ContextIn target_context: ContextIn | None = None chapter_id: UUID | None = None class AnnotationIn(APIModel): body: str = Field(min_length=1, max_length=4000) class DatesIn(APIModel): document_on: date | None = None sent_on: date | None = None received_on: date | None = None class MailAttachment(APIModel): filename: str = Field(min_length=1, max_length=200) content_type: str | None = Field(default=None, max_length=120) class ExternalDetail(APIModel): correspondent: str | None = Field(default=None, max_length=200) message_from: str | None = Field(default=None, max_length=200) message_to: str | None = Field(default=None, max_length=500) message_cc: str | None = Field(default=None, max_length=500) direction: Literal["in", "out"] | None = None mailbox: str | None = Field(default=None, max_length=200) connector_id: UUID | None = None uid: int | None = Field(default=None, ge=1) attachments: list[MailAttachment] = Field(default_factory=list, max_length=40) open_url: str | None = Field(default=None, max_length=500, pattern=r"^https?://") class ExternalIn(APIModel): title: str = Field(min_length=1, max_length=200) source: str = Field(min_length=1, max_length=40) external_id: str = Field(min_length=1, max_length=200) context: ContextIn placement: ContextIn | None = None chapter_id: UUID | None = None dates: DatesIn = DatesIn() detail: ExternalDetail | None = None # "ask": a document that is already present at the account's check level answers 409. # "insert": the user chose to insert it again. `bind_element_id` binds that element instead of creating one. duplicate: Literal["ask", "insert"] = "ask" bind_element_id: UUID | None = None class ExistingItemIn(APIModel): source: str = Field(min_length=1, max_length=40) external_id: str = Field(min_length=1, max_length=200) connector_id: UUID | None = None class ExistingIn(APIModel): context: ContextIn placement: ContextIn | None = None items: list[ExistingItemIn] = Field(min_length=1, max_length=100) class ConnectorIn(APIModel): """Kind is checked against the source registry. Source fields stay optional. Paperless and IMAP still send their existing fields. A further module uses ``config`` and validates that bag itself. """ kind: str = Field(min_length=1, max_length=40) name: str = Field(min_length=1, max_length=120) base_url: str | None = None token: str | None = None host: str | None = None port: int | None = Field(default=None, ge=1, le=65535) username: str | None = None password: str | None = None mailbox: str | None = Field(default=None, max_length=200) security: Literal["ssl", "starttls"] | None = None config: dict[str, str | int | None] | None = None class SourceAssignmentIn(APIModel): connector_id: UUID class DeleteElementIn(APIModel): expected_version: int = Field(ge=1) class TaskIn(APIModel): title: str = Field(min_length=1, max_length=200) due_on: date | None = None matter_id: UUID | None = None context: ContextIn | None = None class TaskPatch(APIModel): expected_version: int = Field(ge=1) title: str | None = Field(default=None, min_length=1, max_length=200) due_on: date | None = None clear_due_on: bool = False status: Literal["open", "done"] | None = None context: ContextIn | None = None class AssigneeIn(APIModel): email: str | None = None context: ContextIn | None = None class DeadlineIn(APIModel): title: str = Field(min_length=1, max_length=200) due_on: date matter_id: UUID | None = None context: ContextIn | None = None class DeadlinePatch(APIModel): expected_version: int = Field(ge=1) title: str | None = Field(default=None, min_length=1, max_length=200) due_on: date | None = None context: ContextIn | None = None class FulfillIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn | None = None class TaskDeadlineIn(APIModel): deadline_id: UUID context: ContextIn | None = None class TaskElementsIn(APIModel): element_ids: list[UUID] = Field(default_factory=list, max_length=40) context: ContextIn | None = None class TaskDependencyIn(APIModel): depends_on_task_id: UUID context: ContextIn | None = None class ElementReferenceIn(APIModel): refers_to_element_id: UUID context: ContextIn | None = None class ExportIn(APIModel): context: ContextIn | None = None selected: list[str] = Field(default_factory=list, max_length=2000) assignments: dict[str, UUID] = Field(default_factory=dict) class EvidenceIn(APIModel): element_id: UUID role: Literal["email", "submission", "delivery", "other"] fold: Literal["keep", "evidence"] = "keep" class AttachmentAssignIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None attachment_element_ids: list[UUID] = Field(min_length=1, max_length=100) fold: Literal["keep", "attachment"] = "keep" class AttachmentOrderIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None attachment_element_ids: list[UUID] = Field(min_length=1, max_length=100) class AttachmentDetachIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None class FoldIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None fold: Literal["attachment", "evidence"] | None = None class DispatchIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None channel: Literal["email", "post", "other"] sent_on: date | None = None counterpart: str | None = Field(default=None, max_length=200) attachment_element_ids: list[UUID] = Field(default_factory=list, max_length=100) evidence: list[EvidenceIn] = Field(default_factory=list, max_length=20) historical_gap: bool = False capture_editions: bool = True class DispatchEvidenceIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None element_id: UUID role: Literal["email", "submission", "delivery", "other"] fold: Literal["keep", "evidence"] = "keep" class DispatchEvidenceDetachIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None class DispatchCorrectIn(APIModel): expected_version: int = Field(ge=1) context: ContextIn placement: ContextIn | None = None channel: Literal["email", "post", "other"] | None = None sent_on: date | None = None clear_sent_on: bool = False counterpart: str | None = Field(default=None, max_length=200) clear_counterpart: bool = False class PreferenceIn(APIModel): """`value` replaces the own value; null means: inherit. `team_mode` is for main users and stays as it is when absent.""" value: str | None = Field(default=None, max_length=40) team_mode: Literal["free", "locked"] | None = None class DownloadPolicyIn(APIModel): """Who may save or open the original outside of Tsumugu. `direct` only applies to the account default.""" manager: bool member: bool reader: bool direct: bool | None = None