2026-07-08 23:50:59 +02:00
|
|
|
"""Pydantic schemas for the Report Generator plugin."""
|
|
|
|
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
|
|
|
|
from datetime import datetime
|
|
|
|
|
|
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class TemplateCreate(BaseModel):
|
|
|
|
|
name: str = Field(..., min_length=1, max_length=255)
|
|
|
|
|
description: str = Field("", max_length=2000)
|
|
|
|
|
template_type: str = Field("jinja2", pattern="^(jinja2|sql)$")
|
|
|
|
|
content: str = Field(..., min_length=1)
|
2026-07-23 23:22:33 +02:00
|
|
|
output_format: str = Field("csv", pattern="^(csv|excel|json|pdf|print)$")
|
2026-07-08 23:50:59 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class TemplateUpdate(BaseModel):
|
|
|
|
|
name: str | None = Field(None, min_length=1, max_length=255)
|
|
|
|
|
description: str | None = Field(None, max_length=2000)
|
|
|
|
|
template_type: str | None = Field(None, pattern="^(jinja2|sql)$")
|
|
|
|
|
content: str | None = None
|
2026-07-23 23:22:33 +02:00
|
|
|
output_format: str | None = Field(None, pattern="^(csv|excel|json|pdf|print)$")
|
2026-07-08 23:50:59 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class TemplateResponse(BaseModel):
|
|
|
|
|
id: str
|
|
|
|
|
name: str
|
|
|
|
|
description: str
|
|
|
|
|
template_type: str
|
|
|
|
|
content: str
|
|
|
|
|
output_format: str
|
|
|
|
|
created_by: str
|
|
|
|
|
deleted_at: datetime | None = None
|
|
|
|
|
created_at: datetime | None = None
|
|
|
|
|
updated_at: datetime | None = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class ReportGenerateRequest(BaseModel):
|
|
|
|
|
template_id: str = Field(..., min_length=1)
|
|
|
|
|
data: dict = Field(default_factory=dict)
|
2026-07-23 23:22:33 +02:00
|
|
|
output_format: str | None = Field(None, pattern="^(csv|excel|json|pdf|print)$")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class PresetReportRequest(BaseModel):
|
|
|
|
|
"""Request to generate a preset report by name."""
|
|
|
|
|
|
|
|
|
|
preset: str = Field(
|
|
|
|
|
...,
|
|
|
|
|
pattern="^(contact_list|calendar_week|calendar_month|company_list|audit_log)$",
|
|
|
|
|
)
|
|
|
|
|
output_format: str = Field("pdf", pattern="^(csv|excel|json|pdf|print)$")
|
|
|
|
|
parameters: dict = Field(default_factory=dict)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class PresetReportInfo(BaseModel):
|
|
|
|
|
"""Metadata for a preset report template."""
|
|
|
|
|
|
|
|
|
|
key: str
|
|
|
|
|
name: str
|
|
|
|
|
description: str
|
|
|
|
|
icon: str
|
|
|
|
|
output_formats: list[str]
|
2026-07-08 23:50:59 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class ReportResponse(BaseModel):
|
|
|
|
|
id: str
|
|
|
|
|
template_id: str
|
|
|
|
|
status: str
|
|
|
|
|
output_path: str | None = None
|
|
|
|
|
error_message: str | None = None
|
|
|
|
|
created_by: str
|
|
|
|
|
created_at: datetime | None = None
|
|
|
|
|
updated_at: datetime | None = None
|
2026-08-29 09:49:16 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
# ─── Documents Generator (Phase L1-L3) ──────────────────────────────────────
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class LetterheadCreate(BaseModel):
|
|
|
|
|
name: str = Field(..., min_length=1, max_length=255)
|
|
|
|
|
description: str = Field("", max_length=2000)
|
|
|
|
|
config: dict = Field(default_factory=dict)
|
|
|
|
|
is_default: bool = False
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class LetterheadUpdate(BaseModel):
|
|
|
|
|
name: str | None = Field(None, min_length=1, max_length=255)
|
|
|
|
|
description: str | None = Field(None, max_length=2000)
|
|
|
|
|
config: dict | None = None
|
|
|
|
|
is_default: bool | None = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class LetterheadResponse(BaseModel):
|
|
|
|
|
id: str
|
|
|
|
|
name: str
|
|
|
|
|
description: str
|
|
|
|
|
config: dict
|
|
|
|
|
is_default: bool
|
|
|
|
|
created_by: str
|
|
|
|
|
created_at: datetime | None = None
|
|
|
|
|
updated_at: datetime | None = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class PrintTemplateCreate(BaseModel):
|
|
|
|
|
name: str = Field(..., min_length=1, max_length=255)
|
|
|
|
|
description: str = Field("", max_length=2000)
|
|
|
|
|
letterhead_id: str | None = None
|
|
|
|
|
entity_type: str = Field("contact", max_length=100)
|
|
|
|
|
blocks: list[dict] = Field(default_factory=list)
|
|
|
|
|
output_format: str = Field("pdf", pattern="^(pdf|print)$")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class PrintTemplateUpdate(BaseModel):
|
|
|
|
|
name: str | None = Field(None, min_length=1, max_length=255)
|
|
|
|
|
description: str | None = Field(None, max_length=2000)
|
|
|
|
|
letterhead_id: str | None = None
|
|
|
|
|
entity_type: str | None = Field(None, max_length=100)
|
|
|
|
|
blocks: list[dict] | None = None
|
|
|
|
|
output_format: str | None = Field(None, pattern="^(pdf|print)$")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class PrintTemplateResponse(BaseModel):
|
|
|
|
|
id: str
|
|
|
|
|
name: str
|
|
|
|
|
description: str
|
|
|
|
|
letterhead_id: str | None = None
|
|
|
|
|
entity_type: str
|
|
|
|
|
blocks: list[dict]
|
|
|
|
|
output_format: str
|
|
|
|
|
created_by: str
|
|
|
|
|
created_at: datetime | None = None
|
|
|
|
|
updated_at: datetime | None = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class DocumentPreviewRequest(BaseModel):
|
|
|
|
|
"""Preview: render blocks to HTML (live preview in the editor)."""
|
|
|
|
|
|
|
|
|
|
blocks: list[dict]
|
|
|
|
|
letterhead_config: dict | None = None
|
|
|
|
|
entity_type: str | None = None
|
|
|
|
|
data: dict | None = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class DocumentPreviewResponse(BaseModel):
|
|
|
|
|
html: str
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class DocumentRenderRequest(BaseModel):
|
|
|
|
|
"""Render a stored print template with entity data to PDF."""
|
|
|
|
|
|
|
|
|
|
entity_type: str
|
|
|
|
|
entity_id: str
|
|
|
|
|
output_format: str = Field("pdf", pattern="^(pdf|print)$")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class DocumentAssetResponse(BaseModel):
|
|
|
|
|
id: str
|
|
|
|
|
letterhead_id: str | None = None
|
|
|
|
|
filename: str
|
|
|
|
|
mime_type: str
|
|
|
|
|
size_bytes: int
|
|
|
|
|
data_url: str | None = None
|
|
|
|
|
created_at: datetime | None = None
|